Skip to content
The GitHub CLI
Go Other
  1. Go 98.4%
  2. Other 1.6%
Branch: master
Clone or download
vilmibm Merge pull request #483 from cli/pr-create-web-base
Respect overriden base branch in `pr create --web`
Latest commit f6856d9 Feb 18, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github No need to configure production OAuth app on release anymore Feb 18, 2020
.vscode Add VS Code settings Oct 7, 2019
api add helper for stubbing repo resolve response Feb 12, 2020
auth Improve randomString func Feb 13, 2020
cmd Update `make site-docs` to reflect latest setup Jan 31, 2020
command Merge pull request #483 from cli/pr-create-web-base Feb 18, 2020
context Add back comments explaining OAuth app credentials Feb 18, 2020
git Fix wrong repo url being used for pushing Feb 13, 2020
internal Extract vendored fish completion for Cobra to a temporary package Jan 29, 2020
pkg Use if/else/if instead Feb 12, 2020
script Merge pull request #201 from github/cleanup-scripts Jan 8, 2020
test added fix for empty body in pr preview Feb 13, 2020
update Correct typoes Feb 16, 2020
utils Merge branch 'master' into glamour-markdown Feb 18, 2020
.gitattributes Retire `copy-release-to-another-repo` action Jan 29, 2020
.gitignore Add .vscode and .DS_Store to .gitignore Feb 9, 2020
.goreleaser.yml Merge pull request #459 from sh7dm/feat/arm64 Feb 18, 2020
LICENSE Create LICENSE Nov 21, 2019
Makefile [Makefile] Support reproducible builds Feb 13, 2020
README.md Add openSUSE/SUSE install instructions to README Feb 18, 2020
go.mod Use glamour as markdown rendering backend for issue & pr previews Feb 5, 2020
go.sum Use glamour as markdown rendering backend for issue & pr previews Feb 5, 2020
releasing.md minor doc updates Jan 28, 2020
source.md Update note about required Go version Feb 17, 2020
wix.json Rename to `cli/cli` Jan 24, 2020

README.md

gh - The GitHub CLI tool

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.

screenshot

Availability

While in beta, GitHub CLI is available for repos hosted on GitHub.com only. It does not currently support repositories hosted on GitHub Enterprise Server or other hosting providers.

We need your feedback

GitHub CLI is currently early in its development, and we're hoping to get feedback from people using it.

If you've installed and used gh, we'd love for you to take a short survey here (no more than five minutes): https://forms.gle/umxd3h31c7aMQFKG7

And 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 help

Check out the docs for more information.

Comparison with hub

For many years, hub was the unofficial GitHub CLI tool. gh is a new project for us to 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.

Installation and Upgrading

macOS

Install: brew install github/gh/gh

Upgrade: brew update && brew upgrade gh

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.

Debian/Ubuntu Linux

Install and upgrade:

  1. Download the .deb file from the releases page
  2. sudo apt install git && sudo dpkg -i gh_*_linux_amd64.deb install the downloaded file

Fedora/Centos Linux

Install and upgrade:

  1. Download the .rpm file from the releases page
  2. sudo yum localinstall gh_*_linux_amd64.rpm install the downloaded file

openSUSE/SUSE Linux

Install and upgrade:

  1. Download the .rpm file from the releases page
  2. sudo zypper in gh_*_linux_amd64.rpm install the downloaded file

Arch Linux

Arch Linux users can install from the AUR: https://aur.archlinux.org/packages/github-cli/

$ yay -S github-cli

Other platforms

Install a prebuilt binary from the releases page

Build from source

You can’t perform that action at this time.