Github-CLI

Github-CLI

Github 的官方命令行工具 Github CLI。Mac 系统可以通过 homebrew 安装或者直接下载免安装包来使用。

命令

Github CLI 的所有命令均以gh开头，命令较为规律，容易记忆。下面是一些命令清单。

别名 alias

gh alias delete <alias> [flags]  #删除别名
gh alias list [flags]            #列出所有别名
gh alias set <alias> <expansion> [flags] #设置一个别名

认证 auth

gh auth login [flags]  #使用GitHub主机进行身份验证
gh auth logout [flags] #从Github主机中移除验证
gh auth refresh [flags] #刷新存储的身份验证凭据
gh auth status [flags]  #查看身份认证状态

配置 config

gh config get <key> [flags] #得到指定配置的值
gh config set <key> <value> [flags] #用指定值更新配置

问题 issue

gh issue close {<number> | <url>} [flags] #关闭issue
gh issue create [flags] #创建一个issue
gh issue list [flags] #列出并过滤此仓库中的issue
gh issue reopen {<number | <url>} [flags] #重开issue
gh issue status [flags] #查看issue状态
gh issue view {<number> | <url>} [flags] #查看一个issue

拉取请求 pull request

gh pr checkout {<number> | <url> | <branch>} [flags] #查看并切换分支,可以指定pr数目或分支名
gh pr checks [flags] #检查一个分支的CI状态
gh pr close {<number> | <url> | <branch>} [flags] #关闭一个pr
gh pr create [flags] #创建一个pr
gh pr diff [<number> | <url> | <branch>] [flags] #查看pr的变动
gh pr list [flags] #列出并过滤此仓库中的pr
gh pr merge [<number> | <url> | <branch>] [flags] #合并pr
gh pr ready [<number> | <url> | <branch>] [flags] #使一个pr准备审查
gh pr reopen {<number> | <url> | <branch>} [flags] #重开pr
gh pr review [<number> | <url> | <branch>] [flags] #给一个pr添加review
gh pr status [flags] #显示相关pr的状态
gh pr view [<number> | <url> | <branch>] [flags] #查看一个pr

发布 release

gh release create <tag> [<files>...] [flags] #创建一个新发布
gh release delete <tag> [flags] #删除一个发布
gh release download [<tags>] [flags] #下载发布
gh release list [flags] #显示该仓库所有发布
gh release upload <tag> <files>...[flags] #上传一个发布
gh release view [<tags>] [flags] #查看发布信息

仓库 repo

gh repo clone <repository> [<directory>] [-- <gitflags>...] #在本地克隆一个仓库
gh repo create [<name>] [flags] #创建一个新仓库
gh repo fork [<repository>] [flags] #fork指定仓库
gh repo view [<repository>] [flags] #查看一个仓库