diff --git a/README.md b/README.md index 1a6e3dc68..3bf921e08 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,19 @@ Stripe CLI, etc. - For actions, delivering a CLI experience would be far ideal than having developers write code in the browser. -## Setup instructions +## Installation +### macOS +1. Download the binaries from: https://github.com/auth0/auth0-cli/releases/latest/ +1. Extract +1. Move `auth0` to `/usr/local/bin/auth0`, e.g.: `mv ~/Desktop/auth0 /usr/local/bin` +1. Setup CLI commands completion for your terminal: + - (**bash**) `auth0 completion bash > /usr/local/etc/bash_completion.d/auth0` + - (**zsh**) `auth0 completion zsh > "${fpath[1]}/_auth0"` + - (**fish**) `auth0 completion fish | source` + +> see more completion options: `auth0 completion -h` + +## Dev Setup instructions 1. [Setup go](https://golang.org/doc/install) 2. Clone this repo: `git clone git@github.com:auth0/auth0-cli`