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
Hi! Thanks for your interest in contributing to the GitHub CLI!
8
10
9
11
We accept pull requests for bug fixes and features where we've discussed the approach in an issue and given the go-ahead for a community member to work on it. We'd also love to hear about ideas for new features as issues.
10
12
11
13
Please do:
12
14
15
+
* check existing issues to verify that the [bug][bug issues] or [feature request][feature request issues] has not already been submitted
13
16
* open an issue if things aren't working as expected
14
17
* open an issue to propose a significant change
15
18
* open a pull request to fix a bug
@@ -24,7 +27,7 @@ Please avoid:
24
27
25
28
Prerequisites:
26
29
- Go 1.13+ for building the binary
27
-
- Go 1.14+ for running the test suite
30
+
- Go 1.15+ for running the test suite
28
31
29
32
Build with: `make` or `go build -o bin/gh ./cmd/gh`
Copy file name to clipboardExpand all lines: README.md
+14-54Lines changed: 14 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,32 +9,29 @@ the terminal next to where you are already working with `git` and your code.
9
9
10
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.
11
11
12
-
## We need your feedback
12
+
## We want your feedback
13
13
14
-
GitHub CLI is currently in its early development stages, and we're hoping to get feedback from people using it.
15
-
16
-
If you've installed and used `gh`, we'd love for you to take a short survey here (no more than five minutes): https://forms.gle/umxd3h31c7aMQFKG7
17
-
18
-
And if you spot bugs or have features that you'd really like to see in `gh`, please check out the [contributing page][]
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][].
19
15
20
16
## Usage
21
17
22
18
-`gh pr [status, list, view, checkout, create]`
23
19
-`gh issue [status, list, view, create]`
24
20
-`gh repo [view, create, clone, fork]`
21
+
-`gh auth [login, logout, refresh, status]`
25
22
-`gh config [get, set]`
26
23
-`gh help`
27
24
28
25
## Documentation
29
26
30
-
Read the [official docs](https://cli.github.com/manual/) for more information.
27
+
Read the [official docs][] for more information.
31
28
32
29
## Comparison with hub
33
30
34
31
For many years, [hub][] was the unofficial GitHub CLI tool. `gh` is a new project that helps us explore
35
32
what an official GitHub CLI tool can look like with a fundamentally different design. While both
36
33
tools bring GitHub to the terminal, `hub` behaves as a proxy to `git`, and `gh` is a standalone
37
-
tool. Check out our [more detailed explanation](/docs/gh-vs-hub.md) to learn more.
34
+
tool. Check out our [more detailed explanation][gh-vs-hub] to learn more.
38
35
39
36
40
37
<!-- this anchor is linked to from elsewhere, so avoid renaming it -->
@@ -72,6 +69,10 @@ Upgrade:
72
69
sudo port selfupdate && sudo port upgrade gh
73
70
```
74
71
72
+
### Linux
73
+
74
+
See [Linux installation docs](/docs/install_linux.md).
75
+
75
76
### Windows
76
77
77
78
`gh` is available via [scoop][], [Chocolatey][], and as downloadable MSI.
@@ -109,61 +110,20 @@ choco upgrade gh
109
110
110
111
MSI installers are available for download on the [releases page][].
111
112
112
-
### Debian/Ubuntu Linux
113
-
114
-
Install and upgrade:
115
-
116
-
1. Download the `.deb` file from the [releases page][];
117
-
2. Install the downloaded file: `sudo apt install ./gh_*_linux_amd64.deb`
118
-
119
-
### Fedora Linux
120
-
121
-
Install and upgrade:
122
-
123
-
1. Download the `.rpm` file from the [releases page][];
124
-
2. Install the downloaded file: `sudo dnf install gh_*_linux_amd64.rpm`
125
-
126
-
### Centos Linux
127
-
128
-
Install and upgrade:
129
-
130
-
1. Download the `.rpm` file from the [releases page][];
131
-
2. Install the downloaded file: `sudo yum localinstall gh_*_linux_amd64.rpm`
132
-
133
-
### openSUSE/SUSE Linux
134
-
135
-
Install and upgrade:
136
-
137
-
1. Download the `.rpm` file from the [releases page][];
138
-
2. Install the downloaded file: `sudo zypper in gh_*_linux_amd64.rpm`
139
-
140
-
### Arch Linux
141
-
142
-
Arch Linux users can install from the [community repo](https://www.archlinux.org/packages/community/x86_64/github-cli/):
143
-
144
-
```bash
145
-
pacman -S github-cli
146
-
```
147
-
148
-
### Android
149
-
150
-
Android users can install via Termux:
151
-
152
-
```bash
153
-
pkg install gh
154
-
```
155
-
156
113
### Other platforms
157
114
158
115
Download packaged binaries from the [releases page][].
159
116
160
117
### Build from source
161
118
162
-
See here on how to [build GitHub CLI from source](/docs/source.md).
119
+
See here on how to [build GitHub CLI from source][build from source].
0 commit comments