GitHub CLI(gh)是 GitHub 官方命令行工具。本资料为其完整参考手册,按功能模块列出常用命令与用法。
一、认证 支持交互式登录(浏览器或令牌),可指定 GitHub Enterprise 主机名;可查看当前认证状态、打印当前令牌、刷新并添加权限范围(如 workflow)、登出。
二、仓库操作 支持克隆仓库(可指定目标目录)、创建仓库(公开/私有,可克隆、可指定源目录并推送)、复刻仓库并克隆、查看仓库(终端或浏览器)、列出仓库、归档、删除、重命名。
三、拉取请求(PR) 创建:可指定标题与正文、从提交自动填充、创建草稿、指定基础分支、审查者与标签,或在浏览器中打开表单。 列表、查看与检出:可按状态、作者、标签筛选;查看详情、在浏览器打开、查看差异、以 JSON 输出指定字段、检出到本地。 审查:批准、请求修改(附正文)、评论。 合并与关闭:支持 squash、merge、rebase 合并并可删除分支;支持自动合并(检查通过后);可关闭(附评论)与重新打开。
四、议题(Issue) 创建与编辑:可指定标题、正文、标签、指派者、模板;可编辑标题、增删标签与指派者;可转移到其他仓库。 列表与查看:可按标签、状态、指派者筛选,支持搜索;查看详情、在浏览器打开、以 JSON 输出指定字段。 关闭与管理:可关闭(附评论)、重新打开、置顶、取消置顶、增删标签。
五、GitHub Actions 可列出运行记录(可按工作流筛选)、查看运行详情与日志(含仅失败日志)、实时监视、重跑失败任务、取消运行、下载产物;可手动触发工作流(带参数)、列出工作流、禁用/启用、查看工作流。
六、发布(Release) 可创建发布(指定标题与说明、自动生成说明、草稿、预发布、附带产物文件)、后续上传产物、列出、查看、删除(可同时清理标签)。
七、Gist 可创建(公开、带描述、多文件、从标准输入)、列出、查看(终端或浏览器)、编辑(含添加文件)、克隆、删除。
八、API 调用 使用 gh api 调用任意 REST 或 GraphQL 端点。REST 示例包括获取议题、创建议题、修改议题状态、删除标签、分页、用 jq 提取字段、访问 PR 评论等;GraphQL 示例包括查询当前用户、查询最近更新的仓库等。
九、搜索 支持搜索仓库、议题、PR、代码、提交,可使用限定符(如语言、星标数、标签、状态、审查状态、作者等),并支持 JSON 输出与数量限制。
十、别名 可设置别名(含 shell 别名)、列出、删除,并给出使用示例。
十一、扩展 可列出、浏览、安装、升级(单个或全部)、移除扩展,并可脚手架创建新扩展。
十二、Codespaces 可创建(指定仓库、机器类型)、列出、SSH 连接、在 VS Code 中打开、停止、删除、端口转发。
十三、配置与环境变量 可设置编辑器、Git 协议,列出配置。环境变量包括 GH_TOKEN、GITHUB_TOKEN、GH_REPO、GH_HOST、GH_ENTERPRISE_TOKEN、NO_COLOR 及其用途。
十四、JSON 输出与脚本化 支持以 JSON 输出指定字段,配合 jq 或模板格式化,并可与其他命令组合(如 xargs)实现脚本化处理。
十五、常见工作流 包括从分支创建 PR、审查循环、发布工作流、议题分诊等示例流程。
适用场景:在终端中完成 GitHub 日常操作、批量处理、自动化脚本与 CI 环境中的 GitHub 交互。 限制:本资料为命令参考,未提供安装方式、版本要求、平台支持、收费或价格等信息,这些内容暂未提供。