Auth0 CLI (Experimental)
auth0
is the command line to supercharge your development workflow.
Note: This CLI is currently in an experimental state and is not supported by Auth0. It has not had a complete security review, and we do not recommend using it to interact with production tenants.
Build, test, and manage your integration with Auth0 directly from your terminal.
Installation
macOS
Homebrew
brew install auth0/auth0-cli/auth0
Manually
- Download the Darwin binary from the latest release: https://github.com/auth0/auth0-cli/releases/latest/
- Extract
- Run
./auth0
- 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
Windows
Manually
- Download the Windows binary from the latest release: https://github.com/auth0/auth0-cli/releases/latest/
- Extract
- Run
auth0.exe
Linux
Manually
- Download the Linux binary from the latest release: https://github.com/auth0/auth0-cli/releases/latest/
- Extract
$ tar -xf auth0-cli_{dowloaded version here}_Linux_x86_64.tar.gz
- Run
./auth0
- 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:
auth0 [command]
# For any help, run --help after a specific command, e.g.:
auth0 [command] --help
Onboarding Journey
Following these instructions will give you a sense of what's possible with the
Auth0 CLI. To start, you will have to login:
Login
auth0 login
Creating your application
If you haven't created an application yet, you may do so by running the
following command:
auth0 apps create
A screen similar to the following will be presented after successful app creation:
$ auth0 apps create
Name: My Awesome App
Description: Test app
Type: Regular Web Application
Callback URLs: http://localhost:3000
Allowed Logout URLs: http://localhost:3000
=== travel0.auth0.com application created
CLIENT ID wmVzrZkGhKgglMRMvpauORCulBkQ5qeI
NAME My Awesome App
DESCRIPTION Test app
TYPE regular web application
CLIENT SECRET kaS2NR5nk2PcGuITQ8JoKnpVnc5ky1TuKgsb6iTA08ec8XqizqkDupKhEIcsFiNM
CALLBACKS http://localhost:3000
ALLOWED LOGOUT URLS http://localhost:3000
ALLOWED ORIGINS
ALLOWED WEB ORIGINS
TOKEN ENDPOINT AUTH
GRANTS implicit, authorization_code, refresh_token, client_credentials
▸ Quickstarts: https://auth0.com/docs/quickstart/webapp
▸ Hint: Test this app's login box with 'auth0 test login wmVzrZkGhKgglMRMvpauORCulBkQ5qeI'
▸ Hint: You might wanna try 'auth0 quickstarts download wmVzrZkGhKgglMRMvpauORCulBkQ5qeI'
As you might observe, the next thing to do would likely be to try logging in
using the client ID.
Testing the login flow
Whether or not you've created the application using the CLI or the management
dashboard, you'll be able to test logging in using a specific application.
If you have the client ID, you may pass it as an argument,
otherwise a prompt will be presented:
auth0 test login
Tailing your logs
Once you have a few logins in place, you might wanna tail your logs. This is
done by running the following command:
auth0 logs tail
After running that, one might see the following output:
Success Login 9 minutes ago Username-Password-Authentic... my awesome app
If there are errors encountered, such as the following example, you may run it
with the --debug
flag as follows:
auth0 logs tail --debug
The full raw data will be displayed below every error:
Failed Login hello 7 minutes ago N/A my awesome app
id: "90020210306002808976000921438552554184272624146777636962"
logid: "90020210306002808976000921438552554184272624146777636962"
date: 2021-03-06T00:28:04.91Z
type: f
clientid: vXAtoaFdhlmtWjpIrjb9AUnrGEAOH2MM
clientname: my awesome app
ip: 1.2.3.4
description: hello
locationinfo: {}
details:
body:
action: default
password: '*****'
state: QXV0aDAgaXMgaGlyaW5nISBhdXRoMC5jb20vY2FyZWVycyAK
username: j.doe@gmail.com
connection: Username-Password-Authentication
error:
message: hello
oauthError: access_denied
type: oauth-authorization
qs: {}
session_id: QXV0aDAgaXMgaGlyaW5nISBhdXRoMC5jb20vY2FyZWVycyAK
userid: auth0|QXV0aDAgaXMgaGlyaW5nISBhdXRoMC5jb20vY2FyZWVycyAK
Contributing
Please check the contributing guidelines.
Author
Auth0