GitHub CLI

ghis GitHub on the command line. It brings pull requests, issues, and other GitHub concepts to the terminal next to where you are already working withgitand your code.

GitHub CLI is supported for users on GitHub and GitHub Enterprise Server 2.20+ with support for macOS, Windows, and Linux.

Documentation

Forinstallation options see below,for usage instructionssee the manual.

Contributing

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.

Installation

macOS

ghis available viaHomebrew,MacPorts,Conda,Spack,Webi,and as a downloadable binary including Mac OS installer.pkgfrom thereleases page.

Note

As of May 29th, Mac OS installer.pkgare unsigned with efforts prioritized incli/cli#9139to support signing them.

Homebrew

Install:	Upgrade:
brew install gh	brew upgrade gh

MacPorts

Install:	Upgrade:
sudo port install gh	sudo port selfupdate && sudo port upgrade gh

Conda

Install:	Upgrade:
conda install gh --channel conda-forge	conda update gh --channel conda-forge

Additional Conda installation options available on thegh-feedstock page.

Spack

Install:	Upgrade:
spack install gh	spack uninstall gh && spack install gh

Webi

Install:	Upgrade:
curl -sS https://webi.sh/gh | sh	webi gh@stable

For more information about the Webi installer seeits homepage.

Flox

Install:	Upgrade:
flox install gh	flox upgrade toplevel

For more information about Flox, seeits homepage

Linux & BSD

ghis 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.

Windows

ghis available viaWinGet,scoop,Chocolatey,Conda,Webi,and as downloadable MSI.

WinGet

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.)

scoop

Install:	Upgrade:
scoop install gh	scoop update gh

Chocolatey

Install:	Upgrade:
choco install gh	choco upgrade gh

Signed MSI

MSI installers are available for download on thereleases page.

Codespaces

To add GitHub CLI to your codespace, add the following to yourdevcontainer file:

"features":{
"ghcr.io/devcontainers/features/github-cli:1":{}
}

GitHub Actions

GitHub CLI comes pre-installed in allGitHub-Hosted Runners.

Other platforms

Download packaged binaries from thereleases page.

Build from source

See here on how tobuild GitHub CLI from source.

Comparison with hub

For many years,hubwas the unofficial GitHub CLI tool.ghis 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,hubbehaves as a proxy togit,andghis a standalone tool. Check out ourmore detailed explanationto learn more.