关于 GitHub CLI

GitHub CLI 是一个开源工具，用于从计算机的命令行使用 GitHub。当您使用命令行工作时，您可以使用 GitHub CLI 来节省时间并避免切换上下文。

先决条件

  1. 在 macOS、Windows 或 Linux 上安装 GitHub CLI。有关更多信息，请参阅 GitHub CLI 存储库中的安装。

  2. 通过从终端运行此命令来向 GitHub 进行身份验证。

    1.  gh auth login

  3. 按照屏幕上的提示进行操作。

    当您选择 HTTPS 作为 Git 操作的首选协议并对询问您是否要使用 GitHub 凭证向 Git 进行身份验证的提示回答 是 时，GitHub CLI 会自动为您存储您的 Git 凭证。这很有用，因为它允许您使用 Git 命令，如 git push 和 git pull ，而无需设置单独的凭据管理器或使用 SSH。

一些有用的命令

当您第一次使用某些命令时 - 例如 gh codespace SUBCOMMAND - 系统会提示您向身份验证令牌添加额外的范围。按照屏幕上的说明进行操作。

查看您的状态

输入 gh status 可查看您在 GitHub 上订阅的所有存储库中当前工作的详细信息。

查看存储库

输入 gh repo view OWNER/REPO 以查看存储库描述和存储库的 README.md 。输入 gh repo view OWNER/REPO --web 以在默认浏览器中查看存储库。

如果您从本地 Git 存储库的目录中运行 repo 子命令，而该存储库在 GitHub 上有远程，则可以省略 OWNER/REPO 。

克隆存储库

输入 gh repo 克隆 OWNER/REPO 。例如， gh repo clone octo-org/octo-repo 将 octo-org/octo-repo 存储库克隆到您在本地计算机上运行此命令的目录。

创建存储库

输入 gh repo create 并按照屏幕上的说明进行操作。您可以在 GitHub 上创建一个新的空存储库，然后（可选）将其克隆到本地。或者，您可以将现有的本地存储库推送到 GitHub，并可选择将其设置为本地存储库的远程存储库。有关将本地目录设置为 Git 存储库的信息，请参阅 [AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code -to-github#initializing-a-git-repository)。

处理问题

输入 gh issues list --repo OWNER/REPO 以列出当前为指定存储库打开的最近创建的问题。如果您在 GitHub 上有远程的本地 Git 存储库的目录中运行 issue 子命令，则可以省略 --repo OWNER/REPO 。例如，输入 gh issues list --assignee "@me" 以列出此存储库中分配给您的问题，或输入 gh issues list --author monalisa 以列出用户 monalisa 创建的问题。

您还可以创建新问题，请参阅 AUTOTITLE ，或搜索问题，请参阅 AUTOTITLE。

处理拉取请求

输入 gh pr list --repo OWNER/REPO 以列出当前为指定存储库打开的最近创建的拉取请求。如果您从本地 Git 存储库的目录中运行 pr 子命令（该存储库在 GitHub 上有远程），则可以省略 —repo OWNER/REPO 。例如，输入 gh pr list --author "@me" 以列出您在此存储库中创建的开放拉取请求。

输入 gh pr list --label LABEL-NAME 以列出具有特定标签的开放拉取请求。输入 gh search prs --review-requested=@me --state=open 以列出要求您审核的拉取请求。

要创建拉取请求，请输入 gh pr create 并按照屏幕上的说明进行操作。有关更多信息，请参阅 [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/propose-changes-to-your-work-with-pull-requests/creating-a-pull-request?tool=cli #创建拉取请求）。

使用代码空间

要创建新的代码空间，请输入 gh codespace create 并按照屏幕上的说明进行操作。

要显示现有的代码空间，请输入 gh codespace list 。要在 VS Code 的 Web 版本中打开代码空间，请输入 gh codespace code -w 并选择一个代码空间。

在所有这些命令中，您可以用 cs 替换 codespace 。

寻求帮助

输入 gh 以提醒您可以使用的顶级 GitHub CLI 命令。例如， issue 、 pr 、 repo 等。

对于每个命令和每个辅助子命令，您可以附加 --help 标志以了解其使用方式。例如， gh issues --help 或 gh issues create --help 。

自定义 GitHub CLI

您可以更改配置设置并添加别名或扩展名，以使 GitHub CLI 以最适合您的方式工作。

  • 输入 gh config set SUBCOMMANDS 以配置 GitHub CLI 的设置，将 SUBCOMMANDS 替换为您要调整的设置。

    例如，您可以指定当 GitHub CLI 命令要求您编辑文本时使用的文本编辑器 - 例如，当您为正在创建的新问题添加正文时。要将首选文本编辑器设置为 VS Code，请输入 gh config set editor "code -w"。本示例中的 -w （或 --wait ）标志导致命令等待文件在 VS Code 中关闭，然后再在终端中继续执行下一步。

    有关更多信息，请参阅 gh 配置集。

  • 为您经常运行的命令定义别名。例如，如果您运行 gh alias set prd "pr create --draft"，那么您将能够运行 gh prd 来快速打开草稿拉取请求。有关更多信息，请参阅 gh 别名。

  • 使用 GitHub CLI 扩展创建或添加自定义命令。有关更多信息，请参阅 AUTOTITLE 和 [AUTOTITLE](/github-cli/github-cli/creating-github-cli-extensions ） 。

进一步阅读