Skip to content

Commit cef28e1

Browse files
docs: add beta installation instructions to README (#1576)
Add a collapsible "Installing the Beta" section covering Homebrew, cURL, Scoop, Powershell, Go, and manual install for the beta build.
1 parent 85f45a7 commit cef28e1

1 file changed

Lines changed: 87 additions & 0 deletions

File tree

README.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,93 @@ go install github.com/auth0/auth0-cli/cmd/auth0@latest
126126
> [!TIP]
127127
> Autocompletion instructions for supported platforms available by running `auth0 completion -h`
128128
129+
### Installing the Beta
130+
131+
<details>
132+
<summary>Want to try pre-release features? Install the beta build here.</summary>
133+
134+
<br>
135+
136+
> [!WARNING]
137+
> This is a **beta release** of the Auth0 CLI and is not yet generally available. Features and behavior may change before the final release.
138+
139+
> [!WARNING]
140+
> The beta release does not fully support the interactive **device authorization** login flow (`auth0 login` as a user). We recommend authenticating with **machine-to-machine (M2M)** client credentials while using the beta. See [Authenticating to Your Tenant](#authenticating-to-your-tenant) for details.
141+
142+
#### Linux and macOS
143+
144+
Install via [Homebrew](https://brew.sh/):
145+
146+
```bash
147+
brew tap auth0/auth0-cli && brew install auth0-beta
148+
```
149+
150+
> [!NOTE]
151+
> The `auth0-beta` formula installs the beta build as the `auth0` binary. Run it with `auth0` once installed.
152+
153+
Install via [cURL](https://curl.se/):
154+
155+
1. Download the binary. It will be placed in `./auth0`:
156+
```bash
157+
curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/beta/install.sh | sh -s -- -b .
158+
```
159+
2. Optionally, if you want to be able to run the binary from any directory, make sure you move it to a place in your $PATH:
160+
```bash
161+
sudo mv ./auth0 /usr/local/bin
162+
```
163+
164+
#### Windows
165+
166+
Install via [Scoop](https://scoop.sh/):
167+
168+
```bash
169+
scoop bucket add auth0 https://github.com/auth0/scoop-auth0-cli.git
170+
scoop install auth0-beta
171+
```
172+
173+
> [!NOTE]
174+
> The `auth0-beta` manifest installs the beta build as the `auth0` binary. Run it with `auth0` once installed.
175+
176+
Install via [Powershell](https://learn.microsoft.com/en-us/powershell/):
177+
178+
1. Fetch the latest beta release information with the following commands:
179+
```powershell
180+
$latestRelease = (Invoke-RestMethod -Uri "https://api.github.com/repos/auth0/auth0-cli/releases") | Where-Object { $_.prerelease -eq $true } | Select-Object -First 1
181+
$latestVersion = $latestRelease.tag_name
182+
$version = $latestVersion -replace "^v"
183+
```
184+
2. Download the binary to the current folder:
185+
```powershell
186+
Invoke-WebRequest -Uri "https://github.com/auth0/auth0-cli/releases/download/${latestVersion}/auth0-cli_${version}_Windows_x86_64.zip" -OutFile ".\auth0.zip"
187+
Expand-Archive ".\auth0.zip" .\
188+
```
189+
190+
#### Go
191+
192+
Install via [Go](https://go.dev/):
193+
194+
```bash
195+
# Make sure your $GOPATH/bin is exported on your $PATH
196+
# to be able to run the binary from any directory.
197+
198+
# Latest beta code (tip of the beta branch):
199+
go install github.com/auth0/auth0-cli/cmd/auth0@beta
200+
201+
# Or a specific published beta release (reproducible):
202+
# See https://github.com/auth0/auth0-cli/releases for available tags.
203+
go install github.com/auth0/auth0-cli/cmd/auth0@v1.33.0-beta.0
204+
```
205+
206+
> [!NOTE]
207+
> Do not use `@latest` for the beta. Go's `@latest` skips pre-release versions, so it always resolves to the stable release instead of a beta.
208+
209+
#### Manual
210+
211+
1. Download the appropriate binary for your environment from the [releases page](https://github.com/auth0/auth0-cli/releases) — select the most recent pre-release.
212+
2. Follow the same extraction and `PATH`/`HOME` setup steps described in the [Manual](#manual) installation section above.
213+
214+
</details>
215+
129216
## Authenticating to Your Tenant
130217
131218
Authenticating to your Auth0 tenant is required for most functions of the CLI. It can be initiated by running:

0 commit comments

Comments
 (0)