02.29 GitHub 開源官方命令行工具登頂 TOP1,5 分鐘極速上手

官方版的 GitHub CLI 終於問世了,一經開源便火速衝上了 GitHub Trending 榜 TOP1,接下來,就讓我們一起來看,如何在短短 5 分鐘便可迅速上手玩轉 CLI!

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

作者 | Nabil Nalakath

頭圖 | CSDN

出品 | CSDN(ID:CSDNnews)

多年來,作為全球最受歡迎的代碼託管平臺 GitHub 竟然一直沒有提供官方的 CLI 工具。畢竟 GitHub 是開放源代碼項目中最常用的平臺,難免讓人感到驚訝。

但是成為開源生態系統一部分的優勢在於,無論有無官方支持,社區都會在需要時構建相應的工具,GitHub 就有相同的經歷。

Hub 是最受歡迎的非官方 GitHub CLI。據其網站表示:“Hub 是命令行 Git 的擴展,可幫助您完成 GitHub 的日常工作,而無需離開終端。”

我不得不承認,這個工具已經兌現了承諾。然而,最近 GitHub 一直為發佈官方工具和產品做努力,而且他們的進展良好,這還要多虧了微軟收購帶來的鉅額資金和方向調整。

之前,GitHub 發佈了一個帶有 GUI 的桌面應用程序,而且正式的命令行工具也提上了日程。如今,官方版的 GitHub CLI 終於問世了。

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

GitHub CLI

GitHub CLI 是官方版的命令行工具,目前處於 beta 測試階段。

雖然,這個工具還沒有正式發佈,但鑑於開發人員和 GitHub 的高度關注,我不得不說 beta 版的發行指日可待。下面就讓我們來了解一下這個工具以及如何在日常工作中使用。

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

安裝

Github CLI 的安裝非常簡單明瞭。

對於 macOS 上:

<code>brew install github/gh/gh/<code>

對於 Windows,有三種安裝方式,其中之一如下所示:

<code>scoop bucket add github-gh https://github.com/cli/scoop-gh.git
scoop install gh/<code>

你也可以通過 Chocolately 獲得,只需運行:

<code>choco install gh/<code>

最後,如果你需要 MSI 安裝程序文件,則可以前往發行頁面(https://github.com/cli/cli/releases/tag/v0.5.7),下載所需的文件。

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

命令

截止到目前為止,GitHub 已發佈了 Beta 版的 CLI,其中包含兩個主要命令:issue 和 pull request。因為這兩個是開源社區中開發人員最常用的命令。

雖然 hub 支持更多命令,但 hub 只是 Git 的代理,而 gh 是獨立的工具。

由於是官方的工具,所以我們希望可以看到更多的命令,但首先讓我們瞭解一下現有的命令。CLI 中所有的命令均以 gh 開頭。

Issue

issue 命令用於處理 GitHub 上與 issue 相關的所有事宜。issue 有四個子命令:create、list、status 和 view。具體語法是:gh issue 。

下面讓我們來看看這四個命令:

  • create:從命令行創建 issue 非常簡單。你可以直接使用帶有 title 和 body 標籤的命令:

<code>gh issue create --title "Issue title" --body "Issue body"
/<code>
GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

也可以通過交互的方式輸入詳細信息。它還提供了選項可以直接提交 issue,也可以在瀏覽器中打開鏈接,供你進行代碼審查和提交問題。

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手
  • list:list 命令用於列出代碼庫中當前的 issue。命令為:gh issue list。它還有過濾器,你可以根據 assignee、label、current state(open、closed)等條件過濾列表。

示例如下:

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

不帶過濾的 issue 列表

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

closed 的 issue 列表

  • status:這個命令僅顯示與當前用戶有關的 issue 的狀態。命令很簡單:gh issue status。

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

顯示相關 issue 的狀態

  • view:這個命令是在瀏覽器中快速打開問題的快捷方式。你只需輸入命令,然後輸入 issue 的編號,即可在瀏覽器中打開這個 issue,例如:gh issue view 6。

PR

PR 是 Pull Request 的縮寫,它是 CLI 中的第二大主要命令。

你可以利用 PR 直接從命令行處理 GitHub 拉取請求,它也有四個子命令:create、list、status、view,還有一個附加的子命令:checkout。語法為:gh pr 。

  • checkout:該命令用於從 Git 中檢出拉取請求。你可以通過拉取請求編號或 URL 檢出。用法為:gh pr checkout { <number> | }。該命令可以立即從拉取請求中檢出到新分支。/<number>

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

pr checkout

  • create:顧名思義,用於從 CLI 創建拉取請求。用法為:gh pr create [flags]。該命令有很多標誌,例如 title、body、branch 等。你可以在 pr 中添加詳細信息並選擇要與之合併的分支。它還允許使用以下標誌輸入信息:

<code>gh pr create --title "Pull request title" --body "Pull request body" 
/<code>

或者,你也可以使用交互式 CLI。它還提供了選項可以直接提交問題,也可以在瀏覽器中打開其鏈接,供你進行代碼審查和提交。

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

從命令行創建 pr

  • list:該命令可以列出代碼庫當前的拉取請求。命令為:gh pr list。它還有過濾器,你可以根據 assignee、label、current state(open、closed)等條件過濾列表。示例如下。

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

列出代碼庫中的 pr

  • status:這個命令僅顯示與當前用戶有關的 issue 的狀態。具體命令為:gh pr status。它可以按照各個條件顯示這些信息:Current branch、Created by you 以及 Requesting a code review from you。

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

pr 狀態

  • view:這個命令是在瀏覽器中快速打開 pr 的快捷方式。你只需輸入命令,然後輸入 pr 編號,即可在瀏覽器中打開這個 issue,例如:gh pr view 6。此外,你也可以使用--preview 標誌在瀏覽器中快速預覽。

GitHub 开源官方命令行工具登顶 TOP1,5 分钟极速上手

總結

以上,我們快速瀏覽了 GitHub 官方 CLI 的命令,更多信息請參閱官方頁面的詳細文檔。相信正式發佈時,還會添加更多命令。

GitHub CLI 官方地址:https://cli.github.com/

英文:The Official GitHub CLI Is Here

鏈接:https://medium.com/better-programming/the-official-github-cli-is-here-9fb7276e2e15


分享到:


相關文章: