load test
Find a file
Mislav Marohnić cfb7e66d2b
Merge pull request #6260 from cli/fix-branch-delete
Fix deleting remote branches with `#` in their name
2022-09-15 11:06:04 +02:00
.devcontainer add devcontainer (#5592) 2022-05-10 14:27:46 +00:00
.github Use secret public key instead of file (#6204) 2022-09-06 17:26:09 +04:00
.vscode Add VS Code settings 2019-10-07 16:36:23 +02:00
api Merge pull request #6260 from cli/fix-branch-delete 2022-09-15 11:06:04 +02:00
build/windows Resolve PR feedback 2021-09-18 09:23:43 -07:00
cmd Migrate to go-gh text package (#6236) 2022-09-14 09:23:55 +04:00
context fix linting 2022-07-27 14:15:27 -05:00
docs Restore Debian installation instructions 2022-09-06 16:43:03 +02:00
git Use go-gh for SSH hostname alias translation (#5654) 2022-06-08 21:32:29 +00:00
internal Merge pull request #6251 from cli/fix-prompter-default 2022-09-14 12:17:04 -05:00
pkg Merge pull request #6260 from cli/fix-branch-delete 2022-09-15 11:06:04 +02:00
script Remove pubkey as it is no longer necessary (#6208) 2022-09-06 14:31:24 +00:00
test Pass web browser to each individual command 2021-03-19 21:22:37 +01:00
utils Migrate to go-gh text package (#6236) 2022-09-14 09:23:55 +04:00
.gitattributes Retire copy-release-to-another-repo action 2020-01-29 16:13:07 +01:00
.gitignore Port select portions of Makefile to script/build.go 2021-01-08 22:35:57 +01:00
.golangci.yml Re-enable linters now that golangci-lint has been updated (#5615) 2022-05-11 16:57:57 +02:00
.goreleaser.yml Added Arm64 compilation 2022-05-25 16:47:50 -07:00
CODEOWNERS Fix CODEOWNERS for codespaces 2021-11-15 20:05:54 +01:00
go.mod Migrate to go-gh text package (#6236) 2022-09-14 09:23:55 +04:00
go.sum Migrate to go-gh text package (#6236) 2022-09-14 09:23:55 +04:00
LICENSE Create LICENSE 2019-11-21 13:22:23 -06:00
Makefile Tweak build scripts to enable cross-compiling 2021-04-09 15:48:12 +02:00
README.md Improve setup instructions (#6156) 2022-09-02 09:43:41 +00:00

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.

screenshot of gh pr status

GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on 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.

Installation

macOS

gh is available via Homebrew, MacPorts, Conda, Spack, and as a downloadable binary from the releases page.

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

Linux & BSD

gh is available via Homebrew, Conda, Spack, and as downloadable binaries from the releases page.

For instructions on specific distributions and package managers, see Linux & BSD installation.

Windows

gh is available via WinGet, scoop, Chocolatey, Conda, and as downloadable MSI.

WinGet

Install: Upgrade:
winget install --id GitHub.cli winget upgrade --id GitHub.cli

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.

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.