github.com/andrewhsu/cli/v2@v2.0.1-0.20210910131313-d4b4061f5b89/README.md (about) 1 # GitHub CLI 2 3 `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. 4 5 ![screenshot of gh pr status](https://user-images.githubusercontent.com/98482/84171218-327e7a80-aa40-11ea-8cd1-5177fc2d0e72.png) 6 7 GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on macOS, Windows, and Linux. 8 9 ## Documentation 10 11 [See the manual][manual] for setup and usage instructions. 12 13 ## Contributing 14 15 If anything feels off, or if you feel that some functionality is missing, please check out the [contributing page][contributing]. There you will find instructions for sharing your feedback, building the tool locally, and submitting pull requests to the project. 16 17 <!-- this anchor is linked to from elsewhere, so avoid renaming it --> 18 ## Installation 19 20 ### macOS 21 22 `gh` is available via [Homebrew][], [MacPorts][], [Conda][], and as a downloadable binary from the [releases page][]. 23 24 #### Homebrew 25 26 | Install: | Upgrade: | 27 | ----------------- | ----------------- | 28 | `brew install gh` | `brew upgrade gh` | 29 30 #### MacPorts 31 32 | Install: | Upgrade: | 33 | ---------------------- | ---------------------------------------------- | 34 | `sudo port install gh` | `sudo port selfupdate && sudo port upgrade gh` | 35 36 #### Conda 37 38 | Install: | Upgrade: | 39 |------------------------------------------|-----------------------------------------| 40 | `conda install gh --channel conda-forge` | `conda update gh --channel conda-forge` | 41 42 Additional Conda installation options available on the [gh-feedstock page](https://github.com/conda-forge/gh-feedstock#installing-gh). 43 44 ### Linux & BSD 45 46 `gh` is available via [Homebrew](#homebrew), [Conda](#Conda), and as downloadable binaries from the [releases page][]. 47 48 For instructions on specific distributions and package managers, see [Linux & BSD installation](./docs/install_linux.md). 49 50 ### Windows 51 52 `gh` is available via [WinGet][], [scoop][], [Chocolatey][], [Conda](#Conda), and as downloadable MSI. 53 54 #### WinGet 55 56 | Install: | Upgrade: | 57 | ------------------- | --------------------| 58 | `winget install gh` | `winget upgrade gh` | 59 60 #### scoop 61 62 | Install: | Upgrade: | 63 | ------------------ | ------------------ | 64 | `scoop install gh` | `scoop update gh` | 65 66 #### Chocolatey 67 68 | Install: | Upgrade: | 69 | ------------------ | ------------------ | 70 | `choco install gh` | `choco upgrade gh` | 71 72 #### Signed MSI 73 74 MSI installers are available for download on the [releases page][]. 75 76 ### GitHub Actions 77 78 GitHub CLI comes pre-installed in all [GitHub-Hosted Runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners). 79 80 ### Other platforms 81 82 Download packaged binaries from the [releases page][]. 83 84 ### Build from source 85 86 See here on how to [build GitHub CLI from source][build from source]. 87 88 ## Comparison with hub 89 90 For many years, [hub][] was the unofficial GitHub CLI tool. `gh` is a new project that helps us explore 91 what an official GitHub CLI tool can look like with a fundamentally different design. While both 92 tools bring GitHub to the terminal, `hub` behaves as a proxy to `git`, and `gh` is a standalone 93 tool. Check out our [more detailed explanation][gh-vs-hub] to learn more. 94 95 [manual]: https://cli.github.com/manual/ 96 [Homebrew]: https://brew.sh 97 [MacPorts]: https://www.macports.org 98 [winget]: https://github.com/microsoft/winget-cli 99 [scoop]: https://scoop.sh 100 [Chocolatey]: https://chocolatey.org 101 [Conda]: https://docs.conda.io/en/latest/ 102 [releases page]: https://github.com/cli/cli/releases/latest 103 [hub]: https://github.com/github/hub 104 [contributing]: ./.github/CONTRIBUTING.md 105 [gh-vs-hub]: ./docs/gh-vs-hub.md 106 [build from source]: ./docs/source.md