ccb830ca36
The default authentication mode is a web-based browser flow. After completion, an
authentication token will be stored securely in the system credential store.
If a credential store is not found or there is an issue using it gh will fallback
to writing the token to a plain text file. See `gh auth status` for its
stored location.
Alternatively, use `--with-token` to pass in a token on standard input.
The minimum required scopes for the token are: `repo`, `read:org`, and `gist`.
Alternatively, gh will use the authentication token found in environment variables.
This method is most suitable for "headless" use of gh such as in automation. See
`gh help environment` for more info.
To use gh in GitHub Actions, add `GH_TOKEN: ${{ github.token }}` to `env`.
The git protocol to use for git operations on this host can be set with `--git-protocol`,
or during the interactive prompting. Although login is for a single account on a host, setting
the git protocol will take effect for all users on the host.
Specifying `ssh` for the git protocol will detect existing SSH keys to upload,
prompting to create and upload a new key if one is not found. This can be skipped with
`--skip-ssh-key` flag.
USAGE
gh auth login [flags]
FLAGS
-p, --git-protocol string The protocol to use for git operations on this host: {ssh|https}
-h, --hostname string The hostname of the GitHub instance to authenticate with
--insecure-storage Save authentication credentials in plain text instead of credential store
-s, --scopes strings Additional authentication scopes to request
--skip-ssh-key Skip generate/upload SSH key prompt
-w, --web Open a browser to authenticate
--with-token Read token from standard input
INHERITED FLAGS
--help Show help for command
EXAMPLES
# Start interactive setup
$ gh auth login
# Authenticate against github.com by reading the token from a file
$ gh auth login --with-token < mytoken.txt
# Authenticate with specific host
$ gh auth login --hostname enterprise.internal
LEARN MORE
Use `gh <command> <subcommand> --help` for more information about a command.
Read the manual at https://cli.github.com/manual
Learn about exit codes using `gh help exit-codes` around Tylers-GitHub-MacBook.local
|
||
|---|---|---|
| .devcontainer | ||
| .github | ||
| api | ||
| build | ||
| cmd | ||
| context | ||
| docs | ||
| git | ||
| internal | ||
| pkg | ||
| script | ||
| test | ||
| utils | ||
| .gitattributes | ||
| .gitignore | ||
| .golangci.yml | ||
| .goreleaser.yml | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
GitHub CLI
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 with git and your code.
GitHub CLI is supported for users on GitHub.com and GitHub Enterprise Server 2.20+ with support for macOS, Windows, and Linux.
Documentation
For installation options see below, for usage instructions see the manual.
Contributing
If anything feels off, or if you feel that some functionality is missing, please check out the contributing 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 our doc on internal contributions.
Installation
macOS
gh is available via Homebrew, MacPorts, Conda, Spack, Webi, and as a downloadable binary including Mac OS installer .pkg from the releases 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 the gh-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 see its homepage.
Flox
| Install: | Upgrade: |
|---|---|
flox install gh |
flox upgrade toplevel |
For more information about Flox, see its homepage
Linux & BSD
gh is available via:
- our Debian and RPM repositories;
- community-maintained repositories in various Linux distros;
- OS-agnostic package managers such as Homebrew, Conda, Spack, Webi; and
- our releases page as precompiled binaries.
For more information, see Linux & BSD installation.
Windows
gh is available via WinGet, 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 to open a new window for the changes to take effect. (Simply opening a new tab will not be 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 the releases page.
Codespaces
To add GitHub CLI to your codespace, add the following to your devcontainer file:
"features": {
"ghcr.io/devcontainers/features/github-cli:1": {}
}
GitHub Actions
GitHub CLI comes pre-installed in all GitHub-Hosted Runners.
Other platforms
Download packaged binaries from the releases page.
Build from source
See here on how to build GitHub CLI from source.
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.