STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #1638 from cli/readme-updates

Browse source 
Update README.md
This commit is contained in:
Amanda Pinsker 2020-09-16 13:08:32 -04:00 • committed by GitHub
commit 51d6bcb4f1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

78
README.md
View file

@ -1,38 +1,24 @@
# 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.
`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](https://user-images.githubusercontent.com/98482/84171218-327e7a80-aa40-11ea-8cd1-5177fc2d0e72.png)
## 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.
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
Read the [official docs][] for usage and more information.
## 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 gist [create, list, view, edit]`
- `gh auth [login, logout, refresh, status]`
- `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][gh-vs-hub] to learn more.
<!-- this anchor is linked to from elsewhere, so avoid renaming it -->
@ -44,31 +30,17 @@ tool. Check out our [more detailed explanation][gh-vs-hub] to learn more.
#### Homebrew
Install:
```bash
brew install gh
```
Upgrade:
```bash
brew upgrade gh
```
|Install:|Upgrade:|
|---|---|
|`brew install gh`|`brew upgrade gh`|
#### MacPorts
Install:
|Install:|Upgrade:|
|---|---|
|`sudo port install gh`|`sudo port selfupdate && sudo port upgrade gh`|
```bash
sudo port install gh
```
Upgrade:
```bash
sudo port selfupdate && sudo port upgrade gh
```
### Linux
@ -95,17 +67,10 @@ scoop update gh
#### Chocolatey
Install:
|Install:|Upgrade:|
|---|---|
|`choco install gh`|`choco upgrade gh`|
```powershell
choco install gh
```
Upgrade:
```powershell
choco upgrade gh
```
#### Signed MSI
@ -119,6 +84,13 @@ Download packaged binaries from the [releases page][].
See here on how to [build GitHub CLI from source][build 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][gh-vs-hub] to learn more.
[official docs]: https://cli.github.com/manual
[scoop]: https://scoop.sh