Skip to content

Commit 51d6bcb

Browse files
author
Amanda Pinsker
authored
Merge pull request cli#1638 from cli/readme-updates
Update README.md
2 parents b2e36a0 + 2570f13 commit 51d6bcb

File tree

1 file changed

+22
-50
lines changed

1 file changed

+22
-50
lines changed

README.md

Lines changed: 22 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,24 @@
11
# GitHub CLI
22

3-
`gh` is GitHub on the command line, and it's now available in beta. It brings pull requests, issues, and other GitHub concepts to
4-
the terminal next to where you are already working with `git` and your code.
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.
54

65
![screenshot of gh pr status](https://user-images.githubusercontent.com/98482/84171218-327e7a80-aa40-11ea-8cd1-5177fc2d0e72.png)
76

87
## Availability
98

10-
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.
9+
GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on macOS, Windows, and Linux.
1110

12-
## We want your feedback
1311

14-
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][].
12+
## Documentation
1513

16-
## Usage
14+
Read the [official docs][] for usage and more information.
1715

18-
- `gh pr [status, list, view, checkout, create]`
19-
- `gh issue [status, list, view, create]`
20-
- `gh repo [view, create, clone, fork]`
21-
- `gh gist [create, list, view, edit]`
22-
- `gh auth [login, logout, refresh, status]`
23-
- `gh config [get, set]`
24-
- `gh help`
2516

26-
## Documentation
2717

28-
Read the [official docs][] for more information.
18+
## We want your feedback
2919

30-
## Comparison with hub
20+
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][].
3121

32-
For many years, [hub][] was the unofficial GitHub CLI tool. `gh` is a new project that helps us explore
33-
what an official GitHub CLI tool can look like with a fundamentally different design. While both
34-
tools bring GitHub to the terminal, `hub` behaves as a proxy to `git`, and `gh` is a standalone
35-
tool. Check out our [more detailed explanation][gh-vs-hub] to learn more.
3622

3723

3824
<!-- 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.
4430

4531
#### Homebrew
4632

47-
Install:
48-
49-
```bash
50-
brew install gh
51-
```
52-
53-
Upgrade:
54-
55-
```bash
56-
brew upgrade gh
57-
```
33+
|Install:|Upgrade:|
34+
|---|---|
35+
|`brew install gh`|`brew upgrade gh`|
5836

5937
#### MacPorts
6038

61-
Install:
62-
63-
```bash
64-
sudo port install gh
65-
```
39+
|Install:|Upgrade:|
40+
|---|---|
41+
|`sudo port install gh`|`sudo port selfupdate && sudo port upgrade gh`|
6642

67-
Upgrade:
6843

69-
```bash
70-
sudo port selfupdate && sudo port upgrade gh
71-
```
7244

7345
### Linux
7446

@@ -95,17 +67,10 @@ scoop update gh
9567

9668
#### Chocolatey
9769

98-
Install:
99-
100-
```powershell
101-
choco install gh
102-
```
70+
|Install:|Upgrade:|
71+
|---|---|
72+
|`choco install gh`|`choco upgrade gh`|
10373

104-
Upgrade:
105-
106-
```powershell
107-
choco upgrade gh
108-
```
10974

11075
#### Signed MSI
11176

@@ -119,6 +84,13 @@ Download packaged binaries from the [releases page][].
11984

12085
See here on how to [build GitHub CLI from source][build from source].
12186

87+
## Comparison with hub
88+
89+
For many years, [hub][] was the unofficial GitHub CLI tool. `gh` is a new project that helps us explore
90+
what an official GitHub CLI tool can look like with a fundamentally different design. While both
91+
tools bring GitHub to the terminal, `hub` behaves as a proxy to `git`, and `gh` is a standalone
92+
tool. Check out our [more detailed explanation][gh-vs-hub] to learn more.
93+
12294

12395
[official docs]: https://cli.github.com/manual
12496
[scoop]: https://scoop.sh

0 commit comments

Comments
 (0)