GitHub CLI 快速入门

关于 GitHub CLI

GitHub CLI 是一款开源工具，可在电脑的命令行中使用 GitHub。使用命令行时，你可以利用 GitHub CLI 节省时间，避免切换上下文。

先决条件

在 macOS、Windows 或 Linux 上安装 GitHub CLI。有关详细信息，请参阅 GitHub CLI 仓库中的安装。
要对 GitHub 进行身份验证，请在终端中运行以下命令。
```
gh auth login
```
选择要进行身份验证的位置
- 如果你在 GitHub.com 访问 GitHub，请选择 GitHub.com。
- 如果你在其他域名访问 GitHub，请选择 Other，然后输入你的主机名（例如：octocorp.ghe.com）。
按照屏幕上的其余提示操作。

当你选择 HTTPS 作为 Git 操作的首选协议，并在提示是否使用 GitHub 凭据对 Git 进行身份验证时回答“是”，GitHub CLI 会自动为你存储 Git 凭据。这很有用，因为它允许你在无需单独的凭据管理器或使用 SSH 的情况下使用 git push 和 git pull 等 Git 命令。

一些有用的命令

注意

当你首次使用某些命令——例如 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 clone OWNER/REPO。例如，gh repo clone octo-org/octo-repo 会将 octo-org/octo-repo 仓库克隆到你运行此命令的本地目录。

创建仓库

输入 gh repo create 并按照屏幕指示操作。你可以在 GitHub 上创建一个新的空仓库，然后可选择将其克隆到本地。或者，你可以将已有的本地仓库推送到 GitHub，并可选择将其设为本地仓库的远程。有关将本地目录设为 Git 仓库的说明，请参阅将本地主机代码添加到 GitHub。

输入 gh issue list --repo OWNER/REPO 列出指定仓库中最近创建且仍处于打开状态的议题。如果你在本地 Git 仓库目录中运行 issue 子命令且该仓库在 GitHub 上有远程仓库，则可以省略 --repo OWNER/REPO。例如，输入 gh issue list --assignee "@me" 列出分配给你的议题，或输入 gh issue list --author monalisa 列出由用户 “monalisa” 创建的议题。

你还可以创建新议题，参见创建议题，或搜索议题，参见筛选和搜索议题及拉取请求。

使用拉取请求（Pull Requests）

输入 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 并按照屏幕指示操作。更多信息，请参阅创建拉取请求。

使用 Codespaces

要创建新的 codespace，输入 gh codespace create 并按照屏幕指示操作。

要显示已有的 codespaces，输入 gh codespace list。要在 VS Code 的 Web 版中打开 codespace，输入 gh codespace code -w 并选择一个 codespace。

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

获取帮助

输入 gh 可以查看可用的顶层 GitHub CLI 命令提醒。例如，issue、pr、repo 等。

对于每个命令及其子命令，你可以添加 --help 标志以了解如何使用。例如，gh issue --help 或 gh issue create --help。

自定义 GitHub CLI

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

输入 gh config set SUBCOMMANDS 来配置 GitHub CLI 的设置，将 SUBCOMMANDS 替换为你想调整的设置。

例如，你可以指定在 GitHub CLI 命令需要编辑文本时使用的文本编辑器——比如在添加新议题的正文时。要将首选文本编辑器设置为 Visual Studio Code，输入 gh config set editor "code -w"。此示例中的 -w（或 --wait）标志会使命令在 Visual Studio Code 中关闭文件之前等待，从而在终端中继续下一步。

欲了解更多信息，请参阅 gh config set。
为常用命令定义别名。例如，如果你运行 gh alias set prd "pr create --draft"，以后就可以通过 gh prd 快速打开草稿拉取请求。欲了解更多信息，请参阅 gh alias。
使用 GitHub CLI 扩展创建或添加自定义命令。欲了解更多信息，请参阅使用 GitHub CLI 扩展和创建 GitHub CLI 扩展。

在多个账户之间使用 GitHub CLI

如果在同一 GitHub 平台（如 GitHub.com）上拥有多个账户，你可以对每个账户进行身份验证，并使用 gh auth switch 命令在它们之间切换。请参阅 GitHub CLI 手册中的 gh auth switch。

如果需要在多个 GitHub 平台之间使用 GitHub CLI，例如在 GitHub.com 上的个人账户和在 GHE.com 上的受管用户账户，请参阅在多个 GitHub 平台之间使用 GitHub CLI。

本文内容