gh-reference

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

GitHub CLI Reference (gh)

GitHub CLI 参考指南 (gh)

IMPORTANT: This skill is for READ-ONLY operations only. DO NOT execute any commands that create, modify, or delete resources.

重要提示：本技能仅用于执行只读操作，请勿执行任何创建、修改或删除资源的命令。

Repository Identification

仓库识别

Always be specific about which repository to use.

Method	Command
Use `-R` flag	`gh <command> -R owner/repo`
List remotes	`git remote -v`

Best Practice: Use

-R owner/repo

explicitly instead of relying on the default repository to avoid ambiguity.

请始终明确指定要使用的仓库。

方法	命令
使用 `-R` 标志	`gh <command> -R owner/repo`
列出远程仓库	`git remote -v`

最佳实践：显式使用

-R owner/repo

参数，而非依赖默认仓库，避免出现歧义。

Issues (Read-Only)

Issues (只读)

Task	Command
List issues	`gh issue list -R owner/repo`
View issue	`gh issue view <number> -R owner/repo`
View issue (web)	`gh issue view <number> -R owner/repo --web`
Issue status	`gh issue status -R owner/repo`

List options:

--state open|closed|all

--label bug

--assignee @me

--limit 10

任务	命令
列出Issue	`gh issue list -R owner/repo`
查看Issue	`gh issue view <number> -R owner/repo`
（网页端）查看Issue	`gh issue view <number> -R owner/repo --web`
Issue状态	`gh issue status -R owner/repo`

列表筛选参数：

--state open|closed|all

、

--label bug

、

--assignee @me

、

--limit 10

Pull Requests (Read-Only)

Pull Requests (只读)

Task	Command
List PRs	`gh pr list -R owner/repo`
View PR	`gh pr view <number> -R owner/repo`
View PR diff	`gh pr diff <number> -R owner/repo`
View PR checks	`gh pr checks <number> -R owner/repo`
PR status	`gh pr status -R owner/repo`

List options:

--state open|closed|merged|all

--label enhancement

--draft

--limit 10

任务	命令
列出PR	`gh pr list -R owner/repo`
查看PR	`gh pr view <number> -R owner/repo`
查看PR diff	`gh pr diff <number> -R owner/repo`
查看PR检查项	`gh pr checks <number> -R owner/repo`
PR状态	`gh pr status -R owner/repo`

列表筛选参数：

--state open|closed|merged|all

、

--label enhancement

、

--draft

、

--limit 10

Repository (Read-Only)

仓库 (只读)

Task	Command
View repo info	`gh repo view owner/repo`
View repo (web)	`gh repo view owner/repo --web`
List your repos	`gh repo list`
List org repos	`gh repo list <org>`

任务	命令
查看仓库信息	`gh repo view owner/repo`
（网页端）查看仓库	`gh repo view owner/repo --web`
列出你的仓库	`gh repo list`
列出组织仓库	`gh repo list <org>`

GitHub Actions - Workflow Runs (Read-Only)

GitHub Actions - 工作流运行 (只读)

Task	Command
List runs	`gh run list -R owner/repo`
View run	`gh run view <run-id> -R owner/repo`
View run log	`gh run view <run-id> -R owner/repo --log`
Watch run	`gh run watch <run-id> -R owner/repo`

List options:

--workflow <name>

--branch <branch>

--limit 10

--status completed|failed|in_progress

任务	命令
列出运行记录	`gh run list -R owner/repo`
查看运行记录	`gh run view <run-id> -R owner/repo`
查看运行日志	`gh run view <run-id> -R owner/repo --log`
监控运行进度	`gh run watch <run-id> -R owner/repo`

列表筛选参数：

--workflow <name>

、

--branch <branch>

、

--limit 10

、

--status completed|failed|in_progress

GitHub Actions - Workflows (Read-Only)

GitHub Actions - 工作流 (只读)

Task	Command
List workflows	`gh workflow list -R owner/repo`
View workflow	`gh workflow view <name
View workflow YAML	`gh workflow view <name

任务	命令
列出工作流	`gh workflow list -R owner/repo`
查看工作流	`gh workflow view <name
查看工作流YAML配置	`gh workflow view <name

GitHub Actions - Cache (Read-Only)

GitHub Actions - 缓存 (只读)

Task	Command
List caches	`gh cache list -R owner/repo`

List options:

--limit 10

--sort size|created_at

--order asc|desc

任务	命令
列出缓存	`gh cache list -R owner/repo`

列表筛选参数：

--limit 10

、

--sort size|created_at

、

--order asc|desc

Releases (Read-Only)

发布 (只读)

Task	Command
List releases	`gh release list -R owner/repo`
View release	`gh release view <tag> -R owner/repo`
View latest	`gh release view --latest -R owner/repo`

任务	命令
列出发版记录	`gh release list -R owner/repo`
查看发版信息	`gh release view <tag> -R owner/repo`
查看最新发版	`gh release view --latest -R owner/repo`

Search (Read-Only)

搜索 (只读)

Task	Command
Search repos	`gh search repos <query>`
Search issues	`gh search issues <query>`
Search PRs	`gh search prs <query>`
Search code	`gh search code <query>`
Search commits	`gh search commits <query>`

Examples:

bash

gh search repos "language:go stars:>1000"
gh search issues "is:open label:bug repo:cli/cli"
gh search code "function main" --language=go

任务	命令
搜索仓库	`gh search repos <query>`
搜索Issue	`gh search issues <query>`
搜索PR	`gh search prs <query>`
搜索代码	`gh search code <query>`
搜索提交	`gh search commits <query>`

示例:

bash

gh search repos "language:go stars:>1000"
gh search issues "is:open label:bug repo:cli/cli"
gh search code "function main" --language=go

Status (Read-Only)

状态 (只读)

Task	Command
View status	`gh status`
Org status	`gh status -o <org>`
Exclude repos	`gh status -e owner/repo1 -e owner/repo2`

Shows assigned issues, PRs, review requests, mentions across your subscribed repositories.

任务	命令
查看状态	`gh status`
组织状态	`gh status -o <org>`
排除指定仓库	`gh status -e owner/repo1 -e owner/repo2`

该命令会展示你已订阅仓库中分配给你的Issue、PR、评审请求、@提及等信息。

API (Read-Only GET Requests)

API (只读GET请求)

Task	Command
GET endpoint	`gh api <endpoint> -R owner/repo`
With jq filter	`gh api <endpoint> -R owner/repo --jq '.[]'`
Paginate	`gh api <endpoint> -R owner/repo --paginate`

Examples:

bash

gh api repos/owner/repo/issues --paginate
gh api repos/owner/repo/pulls -q '.[] | {number, title}'
gh api graphql -f query='query { viewer { login } }'

任务	命令
调用GET接口	`gh api <endpoint> -R owner/repo`
搭配jq过滤	`gh api <endpoint> -R owner/repo --jq '.[]'`
分页获取结果	`gh api <endpoint> -R owner/repo --paginate`

示例:

bash

gh api repos/owner/repo/issues --paginate
gh api repos/owner/repo/pulls -q '.[] | {number, title}'
gh api graphql -f query='query { viewer { login } }'

Common Output Options

常用输出选项

Goal	Flag	Example
JSON output	`--json`	`gh issue list -R owner/repo --json number,title,state`
JSON fields	`--json <fields>`	`gh pr view 123 -R owner/repo --json headRefName,baseRefName`
Quiet (IDs only)	`--jq '.[]	.number'`
Web browser	`--web`	`gh issue view 123 -R owner/repo --web`

目标	标志	示例
JSON格式输出	`--json`	`gh issue list -R owner/repo --json number,title,state`
指定JSON返回字段	`--json <fields>`	`gh pr view 123 -R owner/repo --json headRefName,baseRefName`
静默输出（仅返回ID）	`--jq '.[]	.number'`
网页浏览器打开	`--web`	`gh issue view 123 -R owner/repo --web`

Identifying the Current Repository

识别当前仓库

Before running commands, determine the repository:

bash

undefined

运行命令前，请先确认当前操作的仓库：

bash

undefined

From git remote

从git远程仓库获取

git remote -v

From jj (if using Jujutsu)

从jj获取（如果使用Jujutsu）

jj git remote list


**Always use explicit `-R owner/repo`** to ensure you're querying the correct repository.

jj git remote list


**请始终显式指定 `-R owner/repo` 参数**，确保你查询的是正确的仓库。