SuperAPI AI 工具集

github-gh

部署与运维

查看项目

更新于 10-16 06:57

技能介绍

用途

GitHub Skill 用于通过 gh CLI 与 GitHub 进行交互。当需要管理 issue、PR、工作流运行,或通过 gh issue、gh pr、gh run、gh api 进行高级 API 查询时,可以使用该技能。

主要能力

  • 拉取请求(Pull Requests):检查某个 PR 的 CI 状态。
  • 工作流运行(Workflow Runs):列出最近的工作流运行、查看某次运行并了解哪些步骤失败、仅查看失败步骤的日志。
  • 高级 API 查询:gh api 命令可用于访问其他子命令无法提供的数据,例如获取 PR 的特定字段。
  • JSON 输出:大多数命令支持 --json 以输出结构化数据,并可使用 --jq 进行过滤。

使用方式

使用 gh CLI 与 GitHub 交互。当不在 git 目录中时,始终指定 --repo owner/repo,或直接使用 URL。

检查 PR 的 CI 状态:

gh pr checks 55 --repo owner/repo

列出最近的工作流运行:

gh run list --repo owner/repo --limit 10

查看某次运行并了解哪些步骤失败:

gh run view <run-id> --repo owner/repo

仅查看失败步骤的日志:

gh run view <run-id> --repo owner/repo --log-failed

使用 gh api 进行高级查询,获取 PR 的特定字段:

gh api repos/owner/repo/pulls/55 --jq '.title, .state, .user.login'

使用 --json 输出结构化数据,并用 --jq 过滤:

gh issue list --repo owner/repo --json number,title --jq '.[] | "\(.number): \(.title)"'

适用场景

  • 在非 git 目录中管理 GitHub 上的 issue、PR 和工作流运行。
  • 检查 PR 的 CI 状态。
  • 查看工作流运行列表、运行详情及失败步骤日志。
  • 通过 gh api 获取其他子命令无法提供的数据。
  • 需要结构化 JSON 输出并对结果进行过滤时。

限制

资料中未提供关于安装方式、认证要求、权限范围、平台支持、收费或价格的信息,暂未提供。