Skip to content
This repository has been archived by the owner on Jun 21, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mislav authored Jan 28, 2020
1 parent dcb436e commit a795f60
Showing 1 changed file with 3 additions and 75 deletions.
78 changes: 3 additions & 75 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Public releases for GitHub CLI
This is a Homebrew tap repository that provides the `gh` formula for GitHub CLI.

## Install for macOS
### Homebrew
Expand All @@ -11,78 +11,6 @@ To upgrade:
brew upgrade gh
```

### Manual install
1. Download the `*_macOS_amd64.tar.gz` file from the [releases page](https://github.com/github/homebrew-gh/releases/latest)
2. `tar -xf gh_*_macOS_amd64.tar.gz`
3. Copy the uncompressed `gh` somewhere to your PATH (e.g. `cp gh_*_macOS_amd64/bin/gh /usr/local/bin/`)
## Other platforms

## Install for Windows
1. Download the `*.msi` installer from the [releases page](https://github.com/github/homebrew-gh/releases/latest)
2. Run the installer

### Uninstall from Windows
1. Search for "remove programs" in the start menu
2. Choose “Add or remove programs”
3. Find “GitHub CLI” on the list
4. Click on it and choose “Uninstall”

## Install for Linux
### Debian/Ubuntu Linux

1. `sudo apt install git` if you don't already have git
2. Download the `.deb` file from the [releases page](https://github.com/github/homebrew-gh/releases/latest)
3. `sudo dpkg -i gh_*_linux_amd64.deb` install the downloaded file

_(Uninstall with `sudo apt remove gh`)_

### Fedora/Centos Linux

1. Download the `.rpm` file from the [releases page](https://github.com/github/homebrew-gh/releases/latest)
2. `sudo yum localinstall gh_*_linux_amd64.rpm` install the downloaded file

_(Uninstall with `sudo yum remove gh`)_

### Other Linux

1. Download the `*_linux_amd64.tar.gz` file from the [releases page](https://github.com/github/homebrew-gh/releases/latest)
2. `tar -xf gh_*_linux_amd64.tar.gz`
3. Copy the uncompressed `gh` somewhere to your PATH (e.g. `sudo cp gh_*_linux_amd64/bin/gh /usr/local/bin/`)

_(Uninstall with `rm`)_

## Usage
```console
$ gh help
Work with GitHub from your terminal

Usage:
gh [command]

Available Commands:
help Help about any command
issue Work with issues
pr Work with pull requests

Flags:
-h, --help Help for gh
-R, --repo string Select GitHub repository

Use "gh [command] --help" for more information about a command.
```

Thank you for trying out GitHub CLI! 🌟

### Development version (restricted access)

You can get access to features that are not yet in the stable release by
building the development version:

```
brew install github/gh/gh --HEAD
```

To upgrade it:

```
brew upgrade gh --fetch-HEAD
```
See <https://github.com/cli/cli#installation>

0 comments on commit a795f60

Please sign in to comment.