You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-46Lines changed: 18 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,36 +1,22 @@
1
1
# GitHub CLI
2
2
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.
5
4
6
5
7
6
8
7
## Availability
9
8
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 repos hosted on GitHub.com and GitHub Enterprise Server 2.20+. It is available to install on MacOS, Windows, and Linux.
11
10
12
11
## We want your feedback
13
12
14
13
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][].
15
14
16
-
## Usage
17
-
18
-
-`gh pr [status, list, view, checkout, create]`
19
-
-`gh issue [status, list, view, create]`
20
-
-`gh repo [view, create, clone, fork]`
21
-
-`gh config [get, set]`
22
-
-`gh help`
23
15
24
16
## Documentation
25
17
26
18
Read the [official docs][] for more information.
27
19
28
-
## Comparison with hub
29
-
30
-
For many years, [hub][] was the unofficial GitHub CLI tool. `gh` is a new project that helps us explore
31
-
what an official GitHub CLI tool can look like with a fundamentally different design. While both
32
-
tools bring GitHub to the terminal, `hub` behaves as a proxy to `git`, and `gh` is a standalone
33
-
tool. Check out our [more detailed explanation][gh-vs-hub] to learn more.
34
20
35
21
36
22
<!-- this anchor is linked to from elsewhere, so avoid renaming it -->
@@ -42,31 +28,17 @@ tool. Check out our [more detailed explanation][gh-vs-hub] to learn more.
42
28
43
29
#### Homebrew
44
30
45
-
Install:
46
-
47
-
```bash
48
-
brew install gh
49
-
```
50
-
51
-
Upgrade:
52
-
53
-
```bash
54
-
brew upgrade gh
55
-
```
31
+
|Install:|Upgrade:|
32
+
|---|---|
33
+
|`brew install gh`|`brew upgrade gh`|
56
34
57
35
#### MacPorts
58
36
59
-
Install:
60
-
61
-
```bash
62
-
sudo port install gh
63
-
```
37
+
|Install:|Upgrade:|
38
+
|---|---|
39
+
|`sudo port install gh`|`sudo port selfupdate && sudo port upgrade gh`|
64
40
65
-
Upgrade:
66
41
67
-
```bash
68
-
sudo port selfupdate && sudo port upgrade gh
69
-
```
70
42
71
43
### Linux
72
44
@@ -93,17 +65,10 @@ scoop update gh
93
65
94
66
#### Chocolatey
95
67
96
-
Install:
68
+
|Install:|Upgrade:|
69
+
|---|---|
70
+
|`choco install gh`|`choco upgrade gh`|
97
71
98
-
```powershell
99
-
choco install gh
100
-
```
101
-
102
-
Upgrade:
103
-
104
-
```powershell
105
-
choco upgrade gh
106
-
```
107
72
108
73
#### Signed MSI
109
74
@@ -117,6 +82,13 @@ Download packaged binaries from the [releases page][].
117
82
118
83
See here on how to [build GitHub CLI from source][build from source].
119
84
85
+
## Comparison with hub
86
+
87
+
For many years, [hub][] was the unofficial GitHub CLI tool. `gh` is a new project that helps us explore
88
+
what an official GitHub CLI tool can look like with a fundamentally different design. While both
89
+
tools bring GitHub to the terminal, `hub` behaves as a proxy to `git`, and `gh` is a standalone
90
+
tool. Check out our [more detailed explanation][gh-vs-hub] to learn more.
0 commit comments