gh
is GitHub on the command line. It brings pull requests, issues, and other GitHub concepts to the terminal next to where you are already working withgit
and your code.
GitHub CLI is supported for users on GitHub, GitHub Enterprise Cloud, and GitHub Enterprise Server 2.20+ with support for macOS, Windows, and Linux.
Forinstallation options see below,for usage instructionssee the manual.
If anything feels off, or if you feel that some functionality is missing, please check out thecontributing page.There you will find instructions for sharing your feedback, building the tool locally, and submitting pull requests to the project.
If you are a hubber and are interested in shipping new commands for the CLI, check out ourdoc on internal contributions.
gh
is available viaHomebrew,MacPorts,Conda,Spack,Webi,and as a downloadable binary including Mac OS installer.pkg
from thereleases page.
Note
As of May 29th, Mac OS installer.pkg
are unsigned with efforts prioritized incli/cli#9139
to support signing them.
Install: | Upgrade: |
---|---|
brew install gh |
brew upgrade gh |
Install: | Upgrade: |
---|---|
sudo port install gh |
sudo port selfupdate && sudo port upgrade gh |
Install: | Upgrade: |
---|---|
conda install gh --channel conda-forge |
conda update gh --channel conda-forge |
Additional Conda installation options available on thegh-feedstock page.
Install: | Upgrade: |
---|---|
spack install gh |
spack uninstall gh && spack install gh |
Install: | Upgrade: |
---|---|
curl -sS https://webi.sh/gh | sh |
webi gh@stable |
For more information about the Webi installer seeits homepage.
Install: | Upgrade: |
---|---|
flox install gh |
flox upgrade toplevel |
For more information about Flox, seeits homepage
gh
is available via:
- our Debian and RPM repositories;
- community-maintained repositories in various Linux distros;
- OS-agnostic package managers such asHomebrew,Conda,Spack,Webi;and
- ourreleases pageas precompiled binaries.
For more information, seeLinux & BSD installation.
gh
is available viaWinGet,scoop,Chocolatey,Conda,Webi,and as downloadable MSI.
Install: | Upgrade: |
---|---|
winget install --id GitHub.cli |
winget upgrade --id GitHub.cli |
Note
The Windows installer modifies your PATH. When using Windows Terminal, you will need toopen a new windowfor the changes to take effect. (Simply opening a new tab willnotbe sufficient.)
Install: | Upgrade: |
---|---|
scoop install gh |
scoop update gh |
Install: | Upgrade: |
---|---|
choco install gh |
choco upgrade gh |
MSI installers are available for download on thereleases page.
To add GitHub CLI to your codespace, add the following to yourdevcontainer file:
"features":{
"ghcr.io/devcontainers/features/github-cli:1":{}
}
GitHub CLI comes pre-installed in allGitHub-Hosted Runners.
Download packaged binaries from thereleases page.
See here on how tobuild GitHub CLI from source.
For many years,hubwas the unofficial GitHub CLI tool.gh
is a new project that helps us explore
what an official GitHub CLI tool can look like with a fundamentally different design. While both
tools bring GitHub to the terminal,hub
behaves as a proxy togit
,andgh
is a standalone
tool. Check out ourmore detailed explanationto learn more.