|
|
||
|---|---|---|
| .github | ||
| .vscode | ||
| api | ||
| auth | ||
| cmd | ||
| command | ||
| context | ||
| docs | ||
| git | ||
| internal | ||
| pkg | ||
| script | ||
| test | ||
| update | ||
| utils | ||
| .gitattributes | ||
| .gitignore | ||
| .golangci.yml | ||
| .goreleaser.yml | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| wix.json | ||
GitHub CLI
gh is GitHub on the command line, and it's now available in beta. It brings pull requests, issues, and other GitHub concepts to
the terminal next to where you are already working with git and your code.
Availability
While in beta, GitHub CLI is available for repos hosted on GitHub.com only. It currently does not support repositories hosted on GitHub Enterprise Server or other hosting providers. We are planning on adding support for GitHub Enterprise Server after GitHub CLI is out of beta (likely towards the end of 2020), and we want to ensure that the API endpoints we use are more widely available for GHES versions that most GitHub customers are on.
We want your feedback
We'd love to hear your feedback about gh. If you spot bugs or have features that you'd really like to see in gh, please check out the contributing page.
Usage
gh pr [status, list, view, checkout, create]gh issue [status, list, view, create]gh repo [view, create, clone, fork]gh gist [create, list, view, edit]gh auth [login, logout, refresh, status]gh config [get, set]gh help
Documentation
Read the official docs for more information.
Comparison with hub
For many years, hub was 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 to git, and gh is a standalone
tool. Check out our more detailed explanation to learn more.
Installation
macOS
gh is available via Homebrew and MacPorts.
Homebrew
Install:
brew install gh
Upgrade:
brew upgrade gh
MacPorts
Install:
sudo port install gh
Upgrade:
sudo port selfupdate && sudo port upgrade gh
Linux
Windows
gh is available via scoop, Chocolatey, and as downloadable MSI.
scoop
Install:
scoop bucket add github-gh https://github.com/cli/scoop-gh.git
scoop install gh
Upgrade:
scoop update gh
Chocolatey
Install:
choco install gh
Upgrade:
choco upgrade gh
Signed MSI
MSI installers are available for download on the releases page.
Other platforms
Download packaged binaries from the releases page.
Build from source
See here on how to build GitHub CLI from source.