diff --git a/README.md b/README.md index 6b07d00b2..5a19f287c 100644 --- a/README.md +++ b/README.md @@ -69,8 +69,9 @@ Install and upgrade: ### Other platforms -Install a prebuilt binary from the [releases page][] or source compile by running `make` from the -project directory. +Install a prebuilt binary from the [releases page][] + +### [Build from source](/source.md) [docs]: https://cli.github.io/cli/gh diff --git a/source.md b/source.md new file mode 100644 index 000000000..da27f29fe --- /dev/null +++ b/source.md @@ -0,0 +1,31 @@ +# Installation from source + +1. Clone cli into `~/.githubcli` +``` +$ git clone https://github.com/cli/cli.git ~/.githubcli +``` + +2. Compile +``` +$ cd ~/.githubcli && make +``` + +3. Add `~/.githubcli/bin` to your $PATH for access to the gh command-line utility. + + * For **bash**: + ~~~ bash + $ echo 'export PATH="$HOME/.githubcli/bin:$PATH"' >> ~/.bash_profile + ~~~ + + * For **Zsh**: + ~~~ zsh + $ echo 'export PATH="$HOME/.githubcli/bin:$PATH"' >> ~/.zshrc + ~~~ + + * For **Fish shell**: + ~~~ fish + $ set -Ux fish_user_paths $HOME/.githubcli/bin $fish_user_paths + ~~~ + +4. Restart your shell so that PATH changes take effect. +