GitHub CLI 使用示例
在本地检出拉取请求
使用拉取请求编号
您可以使用拉取请求编号检出任何拉取请求，包括来自 fork 的请求。
// Checking out a pull request locally
~/Projects/my-project$ gh pr checkout 12
remote: Enumerating objects: 66, done.
remote: Counting objects: 100% (66/66), done.
remote: Total 83 (delta 66), reused 66 (delta 66), pack-reused 17
Unpacking objects: 100% (83/83), done.
From https://github.com/owner/repo
* [new ref] refs/pull/8896/head -> patch-2
M README.md
Switched to branch 'patch-2'
~/Projects/my-project$使用其他选择器
您也可以使用 URL 和分支名称来检出拉取请求。
// Checking out a pull request locally
~/Projects/my-project$ gh pr checkout branch-name
Switched to branch 'branch-name'
Your branch is up to date with 'origin/branch-name'.
Already up to date.
~/Projects/my-project$克隆仓库
使用 OWNER/REPO 语法
您可以使用 OWNER/REPO 语法克隆任何仓库。
# Cloning a repository
~/Projects$ gh repo clone cli/cli
Cloning into 'cli'...
~/Projects$ cd cli
~/Projects/cli$使用其他选择器
您也可以使用 GitHub URL 克隆仓库。
# Cloning a repository
~/Projects/my-project$ gh repo clone https://github.com/cli/cli
Cloning into 'cli'...
remote: Enumerating objects: 99, done.
remote: Counting objects: 100% (99/99), done.
remote: Compressing objects: 100% (76/76), done.
remote: Total 21160 (delta 49), reused 35 (delta 18), pack-reused 21061
Receiving objects: 100% (21160/21160), 57.93 MiB | 10.82 MiB/s, done.
Resolving deltas: 100% (16051/16051), done.
~/Projects/my-project$创建问题和拉取请求
交互式
# Create a pull request interactively
~/Projects/my-project$ gh pr create
Creating pull request for feature-branch into main in owner/repo
? Title My new pull request
? Body [(e) to launch nano, enter to skip]
http://github.com/owner/repo/pull/1
~/Projects/my-project$# Create an issue interactively
~/Projects/my-project$ gh issue create
Creating issue in owner/repo
? Title My new issue
? Body [(e) to launch nano, enter to skip]
http://github.com/owner/repo/issues/1
~/Projects/my-project$使用标记
# Create a pull request using flags
~/Projects/my-project$ gh pr create --title "Pull request title" --body "Pull request body"
http://github.com/owner/repo/pull/1
~/Projects/my-project$# Create an issue using flags
~/Projects/my-project$ gh issue create --title "Issue title" --body "Issue body"
http://github.com/owner/repo/issues/1
~/Projects/my-project$在浏览器中
// Quickly navigate to the pull request creation page
~/Projects/my-project$ gh pr create --web
Opening https://github.com/owner/repo/pull/branch in your browser.
~/Projects/my-project$// Quickly navigate to the issue creation page
~/Projects/my-project$ gh issue create --web
Opening https://github.com/owner/repo/issues/new in your browser.
~/Projects/my-project$使用 fork
如果您在一个没有推送权限的仓库中，此命令会自动为您创建一个 fork。
Fork 仓库
不带参数
在 git 仓库内，且不带任何参数，我们将自动在您的帐户上为当前目录在 GitHub 上创建一个 fork。 然后，它会提示您是否要设置上游远程仓库。
# Create a fork for the current repository.
~/Projects/cli$ gh repo fork
- Forking cli/cli...
✓ Created fork user/cli
? Would you like to add a remote for the fork? Yes
✓ Renamed origin remote to upstream
✓ Added remote origin
~/Projects/cli$带参数
如果您以 OWNER/REPO 格式传递一个仓库，`gh` 将自动在您的帐户上在 GitHub 上创建一个 fork，并询问您是否要克隆它。 这在 git 仓库内或仓库外都有效。
# Create a fork for another repository.
~/Projects$ gh repo fork cli/cli
- Forking cli/cli...
✓ Created fork cli/cli
? Would you like to clone the fork? Yes
Cloning into 'cli'...
✓ Cloned fork
~/Projects$ cd cli
~/Projects/cli$使用标记
使用标记跳过有关为 fork 添加 git 远程仓库或在本地克隆 fork 仓库的提示。
# Skipping remote prompts using flags
~/Projects/cli$ gh repo fork --remote=false
- Forking cli/cli...
✓ Created fork user/cli
~/Projects/cli$# Skipping clone prompts using flags
~/Projects$ gh repo fork cli/cli --clone=false
- Forking cli/cli...
✓ Created fork user/cli
~/Projects$在仓库中使用问题或拉取请求列表
默认行为
您将看到最近的 30 个开放项目。
# Viewing a list of open pull requests
~/Projects/my-project$ gh pr list
Pull requests for owner/repo
#14 Upgrade to Prettier 1.19 prettier
#14 Extend arrow navigation in lists for MacOS arrow-nav
#13 Add Support for Windows Automatic Dark Mode dark-mode
#8 Create and use keyboard shortcut react component shortcut
~/Projects/my-project$# Viewing a list of open issues
~/Projects/my-project$ gh issue list
Issues for owner/repo
#14 Update the remote url if it changed (bug)
#14 PR commands on a detached head (enhancement)
#13 Support for GitHub Enterprise (wontfix)
#8 Add an easier upgrade command (bug)
~/Projects/my-project$使用标记进行过滤
您可以使用标记根据您的特定用例过滤列表。
# Viewing a list of closed pull requests assigned to a user
~/Projects/my-project$ gh pr list --state closed --assignee user
Pull requests for owner/repo
#13 Upgrade to Electron 7 electron-7
#8 Release Notes Writing Guide release-notes
~/Projects/my-project$# Viewing a list of closed issues assigned to a user
~/Projects/my-project$ gh issue list --state closed --assignee user
Issues for owner/repo
#13 Enable discarding submodule changes (bug)
#8 Upgrade to latest react (upgrade)
~/Projects/my-project$查看相关工作的状态
拉取请求
# Viewing the status of your relevant pull requests
~/Projects/my-project$ gh pr status
Current branch
#12 Remove the test feature [user:patch-2]
- All checks failing - Review required
Created by you
You have no open pull requests
Requesting a code review from you
#13 Fix tests [branch]
- 3/4 checks failing - Review required
#15 New feature [branch]
- Checks passing - Approved
~/Projects/my-project$问题
# Viewing issues relevant to you
~/Projects/my-project$ gh issue status
Issues assigned to you
#8509 [Fork] Improve how Desktop handles forks (epic:fork, meta)
Issues mentioning you
#8938 [Fork] Add create fork flow entry point at commit warning (epic:fork)
#8509 [Fork] Improve how Desktop handles forks (epic:fork, meta)
Issues opened by you
#8936 [Fork] Hide PR number badges on branches that have an upstream PR (epic:fork)
#6386 Improve no editor detected state on conflicts modal (enhancement)
~/Projects/my-project$查看拉取请求、问题或仓库
在终端中
默认情况下，我们将显示终端中的项目。
# Viewing a pull request in terminal
~/Projects/my-project$ gh pr view 21
Pull request title
opened by user. 0 comments. (label)
Pull request body
View this pull request on GitHub: https://github.com/owner/repo/pull/21
~/Projects/my-project$# Viewing an issue in terminal
~/Projects/my-project$ gh issue view 21
Issue title
opened by user. 0 comments. (label)
Issue body
View this issue on GitHub: https://github.com/owner/repo/issues/21
~/Projects/my-project$# Viewing a repository in terminal
~/Projects/my-project$ gh repo view owner/repo
owner/repo
Repository description
Repository README
View this repository on GitHub: https://github.com/owner/repo/
~/Projects/my-project$在浏览器中
使用 `--web` 或 `-w` 快速在浏览器中打开项目
# Viewing a pull request in the browser
~/Projects/my-project$ gh pr view 21 --web
Opening https://github.com/owner/repo/pull/21 in your browser.
~/Projects/my-project$# Viewing an issue in the browser
~/Projects/my-project$ gh issue view 21 --web
Opening https://github.com/owner/repo/issues/21 in your browser.
~/Projects/my-project$# Viewing a repository in the browser
~/Projects$ gh repo view owner/repo --web
Opening https://github.com/owner/repo/ in your browser.
~/Projects$不带参数
我们将显示您当前所在分支的拉取请求。
# Viewing the pull request of the branch you're on
~/Projects/my-project$ gh pr view
Pull request title
opened by user. 0 comments. (label)
Pull request body
View this pull request on GitHub: https://github.com/owner/repo/pull/21
~/Projects/my-project$我们将显示您当前所在的仓库。
# Viewing the repository you're in
~/Projects/my-project$ gh repo view
owner/my-project
Repository description
Repository README
View this repository on GitHub: https://github.com/owner/repo/
~/Projects/my-project$