STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
load test
2265 commits 87 branches 0 tags 160 MiB
Find a file
Mislav Marohnić 016df6af1c Consolidate Linux installation docs 
- Move all Linux installation docs to the separate page to eliminate repetition
- Indicate that only Ubuntu 20.04 is supported for apt-add-repository method
- Pull openSUSE/SUSE out of the "unofficial" section since it refers to
  downloading our official packages
- Point out manual installation methods as well
2020-09-07 17:06:03 +02:00
.github Exercise most of the release process on prereleases 2020-09-07 16:11:27 +02:00
.vscode Add VS Code settings 2019-10-07 16:36:23 +02:00
api Merge pull request #1603 from cli/create-pr-metadata-failure 2020-09-01 10:51:55 -05:00
auth Handle HTTP 422 response to OAuth Device flow detection 2020-08-31 22:26:04 +02:00
cmd forgot to run goimports 2020-08-24 13:32:20 -05:00
command Merge branch 'pr-commands-isolate-2' into pr-commands-isolate-3 2020-08-11 15:30:09 +02:00
context Correctly surface errors when parsing pr create --repo override 2020-08-27 14:26:27 +02:00
docs Consolidate Linux installation docs 2020-09-07 17:06:03 +02:00
git Ignore non-pre-authenticated hosts when parsing git remotes 2020-08-12 18:13:05 +02:00
internal Ensure correct ANSI color output during OAuth flow on Windows 2020-09-01 12:31:36 +02:00
pkg Merge pull request #1606 from cli/ghe-oauth-422-response 2020-09-02 13:12:11 +02:00
script linux repo creation 2020-09-03 13:47:48 -05:00
test Isolate all alias commands 2020-08-11 13:57:48 +02:00
update Respect the hostname of current repository in queries 2020-07-23 22:31:08 +02:00
utils Merge branch 'pr-commands-isolate-2' into pr-commands-isolate-3 2020-08-11 15:30:09 +02:00
.gitattributes Retire copy-release-to-another-repo action 2020-01-29 16:13:07 +01:00
.gitignore generate manpages into ./share/man/man1 2020-05-19 18:43:26 -04:00
.golangci.yml Enable simplifycompositelit check in CI 2020-06-12 15:59:25 +02:00
.goreleaser.yml Remove Homebrew tap from goreleaser config 2020-09-07 16:28:51 +02:00
go.mod Enable custom color themes with the GLAMOUR_STYLE environment variable 2020-07-28 15:23:48 +02:00
go.sum Enable custom color themes with the GLAMOUR_STYLE environment variable 2020-07-28 15:23:48 +02:00
LICENSE Create LICENSE 2019-11-21 13:22:23 -06:00
Makefile Exercise most of the release process on prereleases 2020-09-07 16:11:27 +02:00
README.md Consolidate Linux installation docs 2020-09-07 17:06:03 +02:00
wix.json Rename "master" to "trunk" in various links 2020-05-26 20:57:26 +02:00

README.md

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.

screenshot of gh pr status

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

See Linux installation docs.

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.