name: github-cli description: 在处理GitHub相关任务时,鼓励主动使用GitHub CLI(gh)来收集关于PR、问题、评论和仓库信息的上下文。
GitHub CLI 上下文收集
此技能鼓励在处理GitHub相关任务时,主动使用GitHub CLI(gh)来收集丰富的上下文信息。
核心理念
当用户提及PR、问题、分支、代码审查、评论或任何与GitHub相关的内容时,主动使用gh命令来收集上下文,而不是仅仅依赖本地git命令。
本地git 告诉你关于提交和分支的信息。 GitHub CLI 告诉你围绕这些变更的对话——PR描述、审查评论、问题讨论、CI状态等。
何时主动使用 gh
当用户提及或询问以下内容时,使用gh命令:
- PR / 拉取请求 — 查看、差异、评论、审查、检查
- 问题 — 查看、评论、标签、分配者
- 代码审查 — 审查评论、请求的更改
- CI/CD 状态 — 检查运行、工作流状态
- 仓库信息 — 分支、发布、协作者
- GitHub 链接 — 任何
github.comURL都可以通过gh检查
关键命令参考
拉取请求
# 查看 PR 详情(描述、状态、检查)
gh pr view PR_NUMBER
# 查看 PR 差异
gh pr diff PR_NUMBER
# 列出 PR 评论
gh api repos/OWNER/REPO/pulls/PR_NUMBER/comments
# 列出审查评论(内联代码评论)
gh api repos/OWNER/REPO/pulls/PR_NUMBER/reviews
# 检查 PR 状态和 CI 检查
gh pr checks PR_NUMBER
# 列出打开的 PR
gh pr list
# 按作者列出 PR
gh pr list --author USERNAME
问题
# 查看问题详情
gh issue view ISSUE_NUMBER
# 列出问题评论
gh api repos/OWNER/REPO/issues/ISSUE_NUMBER/comments
# 列出打开的问题
gh issue list
# 搜索问题
gh issue list --search "QUERY"
仓库信息
# 查看仓库详情
gh repo view
# 列出分支
gh api repos/OWNER/REPO/branches
# 查看最近发布
gh release list
# 查看工作流运行
gh run list
处理 GitHub URL
当给出 GitHub URL 时,提取相关信息并使用gh:
# 从: https://github.com/monzo/analytics/pull/123
gh pr view 123 --repo monzo/analytics
# 从: https://github.com/monzo/analytics/issues/456
gh issue view 456 --repo monzo/analytics
上下文收集模式
审查 PR 之前
# 获取完整视图
gh pr view PR_NUMBER # 描述和状态
gh pr diff PR_NUMBER # 变更内容
gh pr checks PR_NUMBER # CI 状态
gh api repos/OWNER/REPO/pulls/PR_NUMBER/comments # 讨论
调查问题
gh issue view ISSUE_NUMBER # 问题详情
gh api repos/OWNER/REPO/issues/ISSUE_NUMBER/comments # 讨论
理解分支上下文
# 此分支存在哪些 PR?
gh pr list --head BRANCH_NAME
# 我的 PR 状态如何?
gh pr status
与 Git 命令集成
结合gh和本地 git 以获得完整上下文:
# 本地:此分支上有哪些提交?
git log origin/master..HEAD --oneline
# GitHub:PR 讨论说了什么?
gh pr view --comments
提示
-
需要解析数据时,使用
--json获取结构化输出:gh pr view PR_NUMBER --json title,body,reviews,comments -
对于高级命令未涵盖的内容,使用
gh api— 它提供对 GitHub API 的直接访问 -
在仓库目录外工作或存在歧义时,指定
--repo OWNER/REPO -
默认先收集上下文 — 在深入研究代码之前,先阅读 PR 描述和评论
何时调用此技能
每当 GitHub 相关上下文有价值时,此技能应指导行为。您无需显式调用它 — 只需记住当用户提及以下内容时使用gh:
- PR、拉取请求、合并请求
- 问题、工单、缺陷
- 代码审查、审查评论
- CI 检查、流水线、工作流
- 协作上下文中的分支
- 任何 GitHub URL