簡(jiǎn)介

gh，是由 GitHub 官方使用 Go 語(yǔ)言開(kāi)發(fā)和維護(hù)的命令行工具，旨在腳本或是命令行中便捷管理和操作 GitHub 的工作流程。

• 注意:
  由于 x-cmd 提供了同名模塊，因此使用官方 gh 命令，只能以如下方式使用 x env use gh 命令安裝 github CLI，而不能直接 x gh:

  x env use gh
  gh --help
  

首次用戶

1. 使用 x env use gh 即可自動(dòng)下載并使用

   • 在終端運(yùn)行 eval "$(curl https://get.x-cmd.com)" 即可完成 x 命令安裝, 詳情參考 x-cmd 官網(wǎng)

2. x-cmd 提供1分鐘教程，其中包含了 gh 命令常用功能的 demo 示例，可以幫你快速上手 gh 。

3. 使用案例:

   

   # 安裝 github CLI
   x env use gh# 克隆 github 中的 x-cmd/x-cmd 倉(cāng)庫(kù)
   gh repo clone x-cmd/x-cmd# 查看倉(cāng)庫(kù)信息
   cd x-cmd/
   gh repo view# 列出倉(cāng)庫(kù) issue 的摘要信息
   gh issue list# 檢查 pull 請(qǐng)求的狀態(tài)
   gh pr status
   

功能特點(diǎn)

1. 涵蓋 GitHub 的基本操作：提供常見(jiàn)的倉(cāng)庫(kù)，成員，ISSUE，PR，工作流以及環(huán)境變量等管理功能。
2. REST API 與 GraphQL API 支持：GitHub API 相結(jié)合，可實(shí)現(xiàn)定制化操作，應(yīng)對(duì)復(fù)雜的功能需求。
3. 美觀的 Terminal UI 渲染顯示：借助于 Go 生態(tài)中的 Terminal UI 可在終端中渲染出直觀而簡(jiǎn)潔的信息。

與 x-cmd gh 模塊的關(guān)系

x gh 是由 x-cmd 團(tuán)隊(duì)基于 GitHub API 使用 Shell 與 AWK 封裝 GitHub CLI 模塊。

一般來(lái)說(shuō)，同名模塊都是對(duì)同名包的二次封裝，而 gh 模塊則是少有的同名包完全沒(méi)有依賴關(guān)系的模塊。這就意味著與大多數(shù)包不同，用戶想使用 gh 包，只能使用 x env use 命令這種安裝的方式。而不能使用 x gh 這種模式。

GitHub 官方的 gh 使用 go 實(shí)現(xiàn)，運(yùn)行高效，且擁有插件體系，功能強(qiáng)大。

相較而言，gh 模塊:

1. 采用 sh/awk/curl 實(shí)現(xiàn)，實(shí)現(xiàn)更為輕便。這也是我們實(shí)現(xiàn) gh 的初衷
2. 因?yàn)樽鳛?x-cmd 的模塊發(fā)布，無(wú)需額外安裝，開(kāi)箱即用
3. 目前已涵蓋官方 gh 命令的管理功能，在參數(shù)設(shè)計(jì)提供更多的選項(xiàng)
4. 一致化體驗(yàn)：為了符合 x-cmd cli 的設(shè)計(jì)哲學(xué)，進(jìn)而保持與其它 cli 的一致性。但也因此導(dǎo)致與官方 gh 命令的設(shè)計(jì)略有不同。
5. 使用 x-cmd 的 tui 體系，提供與其它 x-cmd 模塊一致且友好易用的命令行交互界面

相關(guān)作品

• gh-dash：一款 gh CLI 增強(qiáng)擴(kuò)展插件。提供出色的 GitHub PR 與 ISSUE 終端操作儀表臺(tái)。

進(jìn)一步探索

• gh 官網(wǎng)
• gh 文檔
• GitHub: gh
• 中文資源
  • 云原生：GitHub CLI 命令行工具

X-CMD 官網(wǎng)

• x-cmd-pkg

• x-cmd-1min