GitHub CLI 快速入门
发布时间:2026-09-19 | 浏览:1
开始使用GitHub CLI在命令行中操作GitHub。
GitHub CLI 是用于从计算机的命令行使用 GitHub 的开源工具。 从命令行操作时,您可以使用 GitHub CLI 来节省时间并避免切换上下文。
在 macOS、Windows 或 Linux 上安装 GitHub CLI。 有关安装说明的详细信息,请参阅 GitHub CLI 存储库中的 安装 。
在 macOS、Windows 或 Linux 上安装 GitHub CLI。 有关安装说明的详细信息,请参阅 GitHub CLI 存储库中的 安装 。
若要向 GitHub 进行身份验证,请从终端运行以下命令。 gh auth login
若要向 GitHub 进行身份验证,请从终端运行以下命令。
选择要进行身份验证的位置: 如果通过 GitHub 访问 GitHub.com,请选择“GitHub.com”****。 如果通过其他域访问 GitHub,请选择“其他”,然后输入主机名(例如 ****) octocorp.ghe.com 。
如果通过 GitHub 访问 GitHub.com,请选择“GitHub.com”****。
如果通过其他域访问 GitHub,请选择“其他”,然后输入主机名(例如 ****) octocorp.ghe.com 。
按照屏幕上的其余提示操作。 选择 HTTPS 作为 Git 操作的首选协议时,GitHub CLI 将自动存储 Git 凭据,并对询问是否要使用 GitHub 凭据向 Git 进行身份验证的提示回答“是”。 此操作非常有用,因为这允许直接使用 git push 、 git pull 等 Git 命令,无需设置单独的凭据管理器或使用 SSH。
选择 HTTPS 作为 Git 操作的首选协议时,GitHub CLI 将自动存储 Git 凭据,并对询问是否要使用 GitHub 凭据向 Git 进行身份验证的提示回答“是”。 此操作非常有用,因为这允许直接使用 git push 、 git pull 等 Git 命令,无需设置单独的凭据管理器或使用 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 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”创建的问题。
还可以创建新问题,请参阅 创建议题 或搜索问题,请参阅 筛选和搜索议题以及拉取请求 。
输入 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 ,然后按照屏幕说明进行操作。 有关详细信息,请参阅“ 创建拉取请求 ”。
若要创建新的 codespace,输入 gh codespace create ,然后按照屏幕说明进行操作。
若要显示现有 codespace,输入 gh codespace list 。 要在 VS Code 的 Web 版本中打开代码空间,请输入 gh codespace code -w 并选择一个代码空间。
在这些命令中,可以用 cs 替代 codespace 。
输入 gh 以查看可使用的顶级 GitHub CLI 命令提示。 例如 issue 、 pr 、 repo 等。
对于每个命令和每个附属子命令,可以追加 --help 标志了解其用法。 例如 gh issue --help 或 gh issue create --help 。
可以更改配置设置并添加别名或扩展,使 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 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 。
为通常运行的命令定义别名。 例如,如果运行 gh alias set prd "pr create --draft" ,则你可以运行 gh prd 以快速打开草稿拉取请求。 有关详细信息,请参阅 gh alias 。
创建或添加带有 GitHub CLI 扩展的自定义命令。 有关详细信息,请参阅 使用 GitHub 命令行工具 (CLI) 扩展 和 创建 GitHub CLI 扩展 。
创建或添加带有 GitHub CLI 扩展的自定义命令。 有关详细信息,请参阅 使用 GitHub 命令行工具 (CLI) 扩展 和 创建 GitHub CLI 扩展 。
使用多个账户登录 GitHub CLI
如果在同一 GitHub 平台上有多个帐户,例如 GitHub.com,可以向每个帐户进行身份验证,并使用 gh auth switch 命令在它们之间切换。 请参阅手册中的 GitHub CLI。
如果您需要在多个 GitHub CLI 平台上使用 GitHub,例如在 GitHub.com 上的个人账户以及在 托管用户帐户 上的 GHE.com,请参阅 跨 GitHub 平台使用 GitHub CLI 。
GitHub CLI 参考文档
GitHub CLI 在线手册