github.com/ungtb10d/cli/v2@v2.0.0-20221110210412-98537dd9d6a1/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  For [installation options see below](#installation), for usage instructions [see the manual][manual].
    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][], [Spack][], 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  #### Spack
    45  
    46  | Install:           | Upgrade:                                 |
    47  | ------------------ | ---------------------------------------- |
    48  | `spack install gh` | `spack uninstall gh && spack install gh` |
    49  
    50  ### Linux & BSD
    51  
    52  `gh` is available via:
    53  - [our Debian and RPM repositories](./docs/install_linux.md);
    54  - community-maintained repositories in various Linux distros;
    55  - OS-agnostic package managers such as [Homebrew](#homebrew), [Conda](#conda), and [Spack](#spack); and
    56  - our [releases page][] as precompiled binaries.
    57  
    58  For more information, see [Linux & BSD installation](./docs/install_linux.md).
    59  
    60  ### Windows
    61  
    62  `gh` is available via [WinGet][], [scoop][], [Chocolatey][], [Conda](#conda), and as downloadable MSI.
    63  
    64  #### WinGet
    65  
    66  | Install:            | Upgrade:            |
    67  | ------------------- | --------------------|
    68  | `winget install --id GitHub.cli` | `winget upgrade --id GitHub.cli` |
    69  
    70  #### scoop
    71  
    72  | Install:           | Upgrade:           |
    73  | ------------------ | ------------------ |
    74  | `scoop install gh` | `scoop update gh`  |
    75  
    76  #### Chocolatey
    77  
    78  | Install:           | Upgrade:           |
    79  | ------------------ | ------------------ |
    80  | `choco install gh` | `choco upgrade gh` |
    81  
    82  #### Signed MSI
    83  
    84  MSI installers are available for download on the [releases page][].
    85  
    86  ### GitHub Actions
    87  
    88  GitHub CLI comes pre-installed in all [GitHub-Hosted Runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners).
    89  
    90  ### Other platforms
    91  
    92  Download packaged binaries from the [releases page][].
    93  
    94  ### Build from source
    95  
    96  See here on how to [build GitHub CLI from source][build from source].
    97  
    98  ## Comparison with hub
    99  
   100  For many years, [hub][] was the unofficial GitHub CLI tool. `gh` is a new project that helps us explore
   101  what an official GitHub CLI tool can look like with a fundamentally different design. While both
   102  tools bring GitHub to the terminal, `hub` behaves as a proxy to `git`, and `gh` is a standalone
   103  tool. Check out our [more detailed explanation][gh-vs-hub] to learn more.
   104  
   105  [manual]: https://cli.github.com/manual/
   106  [Homebrew]: https://brew.sh
   107  [MacPorts]: https://www.macports.org
   108  [winget]: https://github.com/microsoft/winget-cli
   109  [scoop]: https://scoop.sh
   110  [Chocolatey]: https://chocolatey.org
   111  [Conda]: https://docs.conda.io/en/latest/
   112  [Spack]: https://spack.io
   113  [releases page]: https://github.com/ungtb10d/cli/releases/latest
   114  [hub]: https://github.com/github/hub
   115  [contributing]: ./.github/CONTRIBUTING.md
   116  [gh-vs-hub]: ./docs/gh-vs-hub.md
   117  [build from source]: ./docs/source.md