CheatPress

GitHub CLI GitHub from the terminal

Version 2.102.0 · source

GitHub CLI, Postcard, light preview Light · Postcard 102 × 152 mm · PDF GitHub CLI, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF GitHub CLI, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
GitHub CLI, A5, light preview Light · A5 148 × 210 mm · PDF GitHub CLI, A5, dark preview Dark · A5 148 × 210 mm · PDF GitHub CLI, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
GitHub CLI, A4, light preview Light · A4 210 × 297 mm · PDF GitHub CLI, A4, dark preview Dark · A4 210 × 297 mm · PDF GitHub CLI, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
GitHub CLI, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF GitHub CLI, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF GitHub CLI, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
GitHub CLI, A3, light preview Light · A3 297 × 420 mm · PDF GitHub CLI, A3, dark preview Dark · A3 297 × 420 mm · PDF GitHub CLI, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
GitHub CLI, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF GitHub CLI, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF GitHub CLI, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
GitHub CLI, Letter, light preview Light · Letter 8.5 × 11 in · PDF GitHub CLI, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF GitHub CLI, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
GitHub CLI, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF GitHub CLI, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF GitHub CLI, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

gh auth login
Sign in to GitHub
gh repo clone <owner>/<repo>
Clone a repository
gh pr create --fill
Open a pull request
gh pr checkout <number>
Try out a pull request
gh pr merge --squash
Merge a pull request
gh issue list
See open issues
gh run watch
Follow a CI run
gh api <endpoint>
Call the REST API

Concepts

  1. Branch local commits
  2. Pull request review and checks
  3. Merged base branch
  4. Actions run CI and deploy

Auth and setup

gh auth login
Sign in interactively
gh auth status
Show who you are signed in as
gh auth login --with-token < <file>
Sign in with a token from stdin
gh auth setup-git
Use gh as git credential helper

Repositories

gh repo clone <owner>/<repo>
Clone a repository
gh repo create <name> --public --clone
Create a repo and clone it
gh repo create <name> --private --source=. --push
Publish the current folder
gh repo view --web
Open the repo in the browser
gh repo fork --clone
Fork and clone
gh repo list <owner>
List an owner's repos
gh repo set-default
Pick the default repo for gh
gh browse
Open the repo, file or PR in the browser

Pull requests

gh pr create --fill
Open a PR with title from commits
gh pr create --draft --title "<t>" --body "<b>"
Open a draft PR
gh pr list
List open PRs
gh pr view <number>
Show a PR
gh pr checkout <number>
Check out a PR branch
gh pr status
PRs that involve you
gh pr diff <number>
Show the PR diff
gh pr checks --watch
Watch CI checks on this PR
gh pr review --approve
Approve a PR
gh pr review --request-changes -b "<text>"
Request changes
gh pr comment <number> -b "<text>"
Comment on a PR
gh pr merge --squash --delete-branch
Squash-merge and clean up
gh pr merge --auto --squash
Merge when checks pass
gh pr ready
Mark a draft as ready
gh pr edit <number> --add-label <name>
Change labels, reviewers, base
gh pr list --author @me --state all
Your PRs in any state
gh pr create --reviewer <user> --label <name>
Request review while opening
gh pr close <number>
Close without merging

Issues

gh issue list
List open issues
gh issue create --title "<t>" --body "<b>"
File an issue
gh issue view <number>
Show an issue
gh issue comment <number> -b "<text>"
Comment on an issue
gh issue close <number>
Close an issue
gh issue list --assignee @me
Issues assigned to you
gh issue list --label <name> --state all
Filter by label and state
gh issue create --assignee @me --label <name>
File and self-assign
gh issue develop <number> --checkout
Create a linked branch for an issue
gh issue edit <number> --add-label <name>
Change labels or assignees
gh issue reopen <number>
Reopen an issue

Actions

gh run list
Recent workflow runs
gh run view <run-id>
Summary of a run
gh run watch
Follow a run live
gh run view <run-id> --log-failed
Logs of failed steps only
gh run rerun <run-id> --failed
Rerun only failed jobs
gh run list --branch <branch> --workflow <name>
Filter runs
gh run download <run-id>
Download run artifacts
gh workflow list
List workflows
gh workflow run <workflow> -f <key>=<value>
Trigger a workflow_dispatch

Releases and gists

gh release list
List releases
gh release create <tag> --generate-notes
Publish a release
gh release create <tag> <file>...
Release with attached assets
gh release download <tag>
Download release assets
gh gist create <file>
Share a file as a gist

Search and status

gh search repos <query>
Search repositories
gh search issues <query>
Search issues across GitHub
gh search prs --author @me --state open
Your open PRs everywhere
gh search code <query>
Search code
gh status
Your PRs, issues and notifications
gh secret set <name>
Set an Actions secret

API and scripting

gh api repos/{owner}/{repo}/issues
GET a REST endpoint
{owner} and {repo} are filled in from the current repo
gh api <endpoint> --jq '<expr>'
Filter the response with jq
gh api <endpoint> --paginate
Fetch every page
gh api <endpoint> -f <key>=<value>
Send a string field (POST)
gh api <endpoint> -F <key>=<value>
Typed field: numbers, bools, @file
gh api -X PATCH <endpoint> -f <key>=<value>
Choose the HTTP method
gh api graphql -f query='<query>'
Run a GraphQL query
gh pr list --json number,title --jq '.[].title'
JSON fields, then jq
gh pr list --json <fields> --template '<tmpl>'
Format with a Go template

Recipes

Feature branch to merged PR
git switch -c feature/x# commit your workgit push -u origin feature/xgh pr create --fillgh pr checks --watchgh pr merge --squash --delete-branch
Review someone's PR
gh pr checkout <number>gh pr diffgh pr review --approve -b "LGTM"
Debug a failed CI run
gh run list --branch <branch> --limit 5gh run view <run-id> --log-failedgh run rerun <run-id> --failed
Publish a local project
git initgit add . && git commit -m "Initial commit"gh repo create <name> --private --source=. --push