GitHub CLI

GitHub CLI for pull requests, issues, repos, actions, and code review — all from your terminal.

74 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Auth

Authentication

7commands

Repos

Repository management

10commands

Pull Requests

PR operations

14commands

Issues

Issue tracking

9commands

Workflows

GitHub Actions

8commands

Releases

Release management

6commands

Gists

Gist operations

6commands

Codespaces

Cloud development

6commands

API

GitHub API access

5commands

Install GitHub CLI (macOS)

$ brew install gh

Install GitHub CLI using Homebrew on macOS

Check GitHub CLI version

$ gh --version

Verify GitHub CLI is installed and display the current version

Authenticate with GitHub

$ gh auth login

Start an interactive login flow to authenticate with GitHub

Login to GitHub

$ gh auth login

Authenticate with GitHub account interactively

Login with token

$ gh auth login --with-token < token.txt

Authenticate using a personal access token from file

Login via web browser

$ gh auth login --web

Authenticate using web browser flow

Logout from GitHub

$ gh auth logout

Remove authentication credentials

Refresh auth credentials

$ gh auth refresh

Refresh stored authentication credentials

Check auth status

$ gh auth status

View authentication status and active account

Print auth token

$ gh auth token

Print the auth token for the current account

Clone repository

$ gh repo clone <owner>/<repo>

Clone a GitHub repository to local machine

Create new repository

$ gh repo create <name> --public

Create a new public GitHub repository

Create private repository

$ gh repo create <name> --private

Create a new private GitHub repository

Delete repository

$ gh repo delete <owner>/<repo> --yes

Delete a GitHub repository (requires confirmation)

Fork repository

$ gh repo fork <owner>/<repo> --clone

Fork a repository and clone it locally

List repositories

$ gh repo list

List repositories for authenticated user

Rename repository

$ gh repo rename <new-name>

Rename the current repository

Sync fork with upstream

$ gh repo sync

Sync a fork with its upstream repository

View repository

$ gh repo view

View repository details in terminal

Open repo in browser

$ gh repo view --web

Open repository in web browser

Checkout pull request

$ gh pr checkout <number>

Check out a pull request branch locally

View PR checks

$ gh pr checks <number>

View status checks for a pull request

Close pull request

$ gh pr close <number>

Close a pull request without merging

Create pull request

$ gh pr create

Create a new pull request interactively

Create draft PR

$ gh pr create --draft

Create a draft pull request

Create PR with auto-fill

$ gh pr create --fill

Create PR using commit info for title and body

View PR diff

$ gh pr diff <number>

View the diff of a pull request

List pull requests

$ gh pr list

List open pull requests in repository

Merge pull request

$ gh pr merge <number>

Merge a pull request

Squash merge PR

$ gh pr merge <number> --squash

Squash and merge a pull request

Mark PR ready for review

$ gh pr ready <number>

Mark a draft PR as ready for review

Review pull request

$ gh pr review <number> --approve

Approve a pull request

View pull request

$ gh pr view <number>

View pull request details

Open PR in browser

$ gh pr view <number> --web

Open pull request in web browser

Close issue

$ gh issue close <number>

Close an issue

Comment on issue

$ gh issue comment <number> --body "<comment>"

Add a comment to an issue

Create issue

$ gh issue create

Create a new issue interactively

Create issue with title

$ gh issue create --title "<title>" --body "<body>"

Create issue with specified title and body

Edit issue

$ gh issue edit <number> --title "<new-title>"

Edit an existing issue

List issues

$ gh issue list

List open issues in repository

List my issues

$ gh issue list --assignee @me

List issues assigned to you

Reopen issue

$ gh issue reopen <number>

Reopen a closed issue

View issue

$ gh issue view <number>

View issue details

Download artifacts

$ gh run download <run-id>

Download artifacts from a workflow run

List workflow runs

$ gh run list

List recent workflow runs

Rerun workflow

$ gh run rerun <run-id>

Rerun a failed workflow run

View workflow run

$ gh run view <run-id>

View details of a workflow run

Watch workflow run

$ gh run watch <run-id>

Watch a workflow run until completion

List workflows

$ gh workflow list

List GitHub Actions workflows

Run workflow

$ gh workflow run <workflow>

Trigger a workflow dispatch event

View workflow

$ gh workflow view <workflow>

View workflow details and recent runs

Create release

$ gh release create <tag> --title "<title>" --notes "<notes>"

Create a new release with tag

Create release with auto notes

$ gh release create <tag> --generate-notes

Create release with auto-generated notes

Delete release

$ gh release delete <tag> --yes

Delete a release

Download release assets

$ gh release download <tag>

Download release assets

List releases

$ gh release list

List releases in repository

View release

$ gh release view <tag>

View release details

Clone gist

$ gh gist clone <gist-id>

Clone a gist locally

Create gist

$ gh gist create <file>

Create a new gist from file

Create public gist

$ gh gist create <file> --public

Create a public gist

Edit gist

$ gh gist edit <gist-id>

Edit an existing gist

List gists

$ gh gist list

List your gists

View gist

$ gh gist view <gist-id>

View gist content

Open in VS Code

$ gh codespace code

Open codespace in VS Code

Create codespace

$ gh codespace create

Create a new codespace

Delete codespace

$ gh codespace delete

Delete a codespace

List codespaces

$ gh codespace list

List your codespaces

SSH to codespace

$ gh codespace ssh

SSH into a codespace

Stop codespace

$ gh codespace stop

Stop a running codespace

API GET request

$ gh api <endpoint>

Make GET request to GitHub API

GraphQL query

$ gh api graphql -f query='<query>'

Execute GraphQL query against GitHub API

Paginate API results

$ gh api <endpoint> --paginate

Automatically paginate through all results

API POST request

$ gh api <endpoint> --method POST -f key=value

Make POST request to GitHub API

Get repo info via API

$ gh api repos/<owner>/<repo>

Get repository information via API

Discussion

Loading comments...

GitHub CLI

GitHub CLI for pull requests, issues, repos, actions, and code review — all from your terminal.

74 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Auth

Authentication

7commands

Repos

Repository management

10commands

Pull Requests

PR operations

14commands

Issues

Issue tracking

9commands

Workflows

GitHub Actions

8commands

Releases

Release management

6commands

Gists

Gist operations

6commands

Codespaces

Cloud development

6commands

API

GitHub API access

5commands

Install GitHub CLI (macOS)

$ brew install gh

Install GitHub CLI using Homebrew on macOS

Check GitHub CLI version

$ gh --version

Verify GitHub CLI is installed and display the current version

Authenticate with GitHub

$ gh auth login

Start an interactive login flow to authenticate with GitHub

Login to GitHub

$ gh auth login

Authenticate with GitHub account interactively

Login with token

$ gh auth login --with-token < token.txt

Authenticate using a personal access token from file

Login via web browser

$ gh auth login --web

Authenticate using web browser flow

Logout from GitHub

$ gh auth logout

Remove authentication credentials

Refresh auth credentials

$ gh auth refresh

Refresh stored authentication credentials

Check auth status

$ gh auth status

View authentication status and active account

Print auth token

$ gh auth token

Print the auth token for the current account

Clone repository

$ gh repo clone <owner>/<repo>

Clone a GitHub repository to local machine

Create new repository

$ gh repo create <name> --public

Create a new public GitHub repository

Create private repository

$ gh repo create <name> --private

Create a new private GitHub repository

Delete repository

$ gh repo delete <owner>/<repo> --yes

Delete a GitHub repository (requires confirmation)

Fork repository

$ gh repo fork <owner>/<repo> --clone

Fork a repository and clone it locally

List repositories

$ gh repo list

List repositories for authenticated user

Rename repository

$ gh repo rename <new-name>

Rename the current repository

Sync fork with upstream

$ gh repo sync

Sync a fork with its upstream repository

View repository

$ gh repo view

View repository details in terminal

Open repo in browser

$ gh repo view --web

Open repository in web browser

Checkout pull request

$ gh pr checkout <number>

Check out a pull request branch locally

View PR checks

$ gh pr checks <number>

View status checks for a pull request

Close pull request

$ gh pr close <number>

Close a pull request without merging

Create pull request

$ gh pr create

Create a new pull request interactively

Create draft PR

$ gh pr create --draft

Create a draft pull request

Create PR with auto-fill

$ gh pr create --fill

Create PR using commit info for title and body

View PR diff

$ gh pr diff <number>

View the diff of a pull request

List pull requests

$ gh pr list

List open pull requests in repository

Merge pull request

$ gh pr merge <number>

Merge a pull request

Squash merge PR

$ gh pr merge <number> --squash

Squash and merge a pull request

Mark PR ready for review

$ gh pr ready <number>

Mark a draft PR as ready for review

Review pull request

$ gh pr review <number> --approve

Approve a pull request

View pull request

$ gh pr view <number>

View pull request details

Open PR in browser

$ gh pr view <number> --web

Open pull request in web browser

Close issue

$ gh issue close <number>

Close an issue

Comment on issue

$ gh issue comment <number> --body "<comment>"

Add a comment to an issue

Create issue

$ gh issue create

Create a new issue interactively

Create issue with title

$ gh issue create --title "<title>" --body "<body>"

Create issue with specified title and body

Edit issue

$ gh issue edit <number> --title "<new-title>"

Edit an existing issue

List issues

$ gh issue list

List open issues in repository

List my issues

$ gh issue list --assignee @me

List issues assigned to you

Reopen issue

$ gh issue reopen <number>

Reopen a closed issue

View issue

$ gh issue view <number>

View issue details

Download artifacts

$ gh run download <run-id>

Download artifacts from a workflow run

List workflow runs

$ gh run list

List recent workflow runs

Rerun workflow

$ gh run rerun <run-id>

Rerun a failed workflow run

View workflow run

$ gh run view <run-id>

View details of a workflow run

Watch workflow run

$ gh run watch <run-id>

Watch a workflow run until completion

List workflows

$ gh workflow list

List GitHub Actions workflows

Run workflow

$ gh workflow run <workflow>

Trigger a workflow dispatch event

View workflow

$ gh workflow view <workflow>

View workflow details and recent runs

Create release

$ gh release create <tag> --title "<title>" --notes "<notes>"

Create a new release with tag

Create release with auto notes

$ gh release create <tag> --generate-notes

Create release with auto-generated notes

Delete release

$ gh release delete <tag> --yes

Delete a release

Download release assets

$ gh release download <tag>

Download release assets

List releases

$ gh release list

List releases in repository

View release

$ gh release view <tag>

View release details

Clone gist

$ gh gist clone <gist-id>

Clone a gist locally

Create gist

$ gh gist create <file>

Create a new gist from file

Create public gist

$ gh gist create <file> --public

Create a public gist

Edit gist

$ gh gist edit <gist-id>

Edit an existing gist

List gists

$ gh gist list

List your gists

View gist

$ gh gist view <gist-id>

View gist content

Open in VS Code

$ gh codespace code

Open codespace in VS Code

Create codespace

$ gh codespace create

Create a new codespace

Delete codespace

$ gh codespace delete

Delete a codespace

List codespaces

$ gh codespace list

List your codespaces

SSH to codespace

$ gh codespace ssh

SSH into a codespace

Stop codespace

$ gh codespace stop

Stop a running codespace

API GET request

$ gh api <endpoint>

Make GET request to GitHub API

GraphQL query

$ gh api graphql -f query='<query>'

Execute GraphQL query against GitHub API

Paginate API results

$ gh api <endpoint> --paginate

Automatically paginate through all results

API POST request

$ gh api <endpoint> --method POST -f key=value

Make POST request to GitHub API

Get repo info via API

$ gh api repos/<owner>/<repo>

Get repository information via API

Discussion

Loading comments...