From 4a5037d95d598619a0d9babfe2b4e63c337c08f3 Mon Sep 17 00:00:00 2001 From: "Jorge L. Fatta" Date: Fri, 26 Mar 2021 19:58:27 -0300 Subject: [PATCH] docs: update install instructions (#195) * docs: update install instructions * Update README.md * Update README.md Co-authored-by: Rita Zerrizuela * Update README.md Co-authored-by: Rita Zerrizuela --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3ac0d3c97..ee2a51802 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,9 @@ brew install auth0/auth0-cli/auth0 #### Manually -1. Download the binaries from: https://github.com/auth0/auth0-cli/releases/latest/ +1. Download the _Darwin_ binaries from the latest release: 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. Run `./auth0` 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"` @@ -31,6 +31,25 @@ brew install auth0/auth0-cli/auth0 > see more completion options: `auth0 completion -h` +### Windows + +#### Manually + +1. Download the _Windows_ binaries from the latest release: https://github.com/auth0/auth0-cli/releases/latest/ +1. Extract +1. Run `auth0.exe` + +### Linux + +#### Manually + +1. Download the _Linux_ binaries from the latest release: https://github.com/auth0/auth0-cli/releases/latest/ +1. Extract `$ tar -xf auth0-cli_{dowloaded version here}_Linux_x86_64.tar.gz` +1. Run `./auth0` +1. Setup CLI commands completion for your terminal: + - `sudo ./auth0 completion bash > /etc/bash_completion.d/auth0` +> see more completion options: `auth0 completion -h` + ## Usage After installation, you should have the `auth0` command available: