SuperAPI AI 工具集

github-cli

编程与开发

查看项目

更新于 10-15 08:10

技能介绍

GitHub CLI 是 GitHub 官方提供的命令行工具,命令名为 gh,用于在终端中直接完成 GitHub 上的各类操作。该技能适用于认证、仓库工作、议题、拉取请求、发布、Actions、项目以及 gh api 调用等场景。

用途 GitHub CLI 的目标是让用户在终端中高效地操作 GitHub,减少在网页界面与本地终端之间切换。资料将其描述为“从终端使用 GitHub 的最快方式”。

主要能力 资料按命令分组列出了可覆盖的功能范围:

  • 核心命令:gh auth(认证)、gh browse(浏览)、gh codespace(代码空间)、gh gist(代码片段)、gh issue(议题)、gh org(组织)、gh pr(拉取请求)、gh project(项目)、gh release(发布)、gh repo(仓库)。
  • Actions 相关:gh cache(缓存)、gh run(运行)、gh workflow(工作流)。
  • 其他命令:gh agent-task、gh alias(别名)、gh api(API 调用)、gh attestation(证明)、gh completion(补全)、gh config(配置)、gh copilot、gh extension(扩展)、gh gpg-key、gh label(标签)、gh licenses(许可证)、gh preview、gh ruleset(规则集)、gh search(搜索)、gh secret(密钥)、gh ssh-key、gh status(状态)、gh variable(变量)。 每个命令在资料中都对应一份参考文档(references 目录下的 .md 文件),例如 gh auth 对应 references/auth.md,gh pr 对应 references/pr.md。

使用方式 资料给出的入门步骤:

  1. 先认证:gh auth login
  2. 查看当前上下文:gh auth status
  3. 需要时指定其他仓库:-R OWNER/REPO
  4. 随时获取命令帮助:gh <command> --help

常见工作流示例: gh auth login gh repo clone OWNER/REPO gh issue list gh pr create --fill gh run watch

资料中的注意事项:

  • 在脚本中优先使用 --json、--jq 或 --template。
  • 对于没有专用命令覆盖的操作,gh api 可作为兜底方案。
  • 使用 GitHub Enterprise 时,可通过 --hostname 指定主机,或设置 GH_HOST 环境变量。

适用场景 适合需要在终端中完成 GitHub 认证、克隆仓库、查看议题、创建拉取请求、查看 Actions 运行、管理发布与项目等日常开发协作任务的用户。也适合需要以脚本方式调用 GitHub 数据(借助 --json、--jq、--template 或 gh api)的自动化场景。

限制 资料未提供该技能的安装方式、版本要求、收费情况、平台支持范围或具体使用效果等信息,这些内容暂未提供。