About GitHub CLI
GitHub CLI is an open source tool for using GitHub from your computer's command line. When you're working from the command line, you can use the GitHub CLI to save time and avoid switching context.
Install GitHub CLI on macOS, Windows, or Linux.
In the command line, authenticate to GitHub. Replace
HOSTNAMEwith the name of GitHub.com. For example,
gh auth login
Start working with GitHub in the command line. For example, find an issue to work on with
gh issue statusor
gh issue list --assignee @me. Create a pull request with
gh pr create. Review a pull request with
gh pr checkout,
gh pr diffand
gh pr review.
Tell GitHub CLI which text editor to use for commands that open a text editor. For example, enter
gh config set editor "code -w"to set your preferred text editor to Visual Studio Code. For more information, see
gh config set.
Define aliases for commands that you commonly run. For example, if you run
gh alias set prd "pr create --draft", you will then be able to run
gh prdto quickly open a draft pull request. For more information, see
Create or add custom commands with GitHub CLI extensions. For more information, see "Using GitHub CLI extensions" and "Creating GitHub CLI extensions."
For more information about all of the commands that you can run with GitHub CLI, see "GitHub CLI reference."