auth0-cli

README

Auth0 CLI

---

Build, manage and test your Auth0 integrations from the command line.

🎢 Highlights

• 🧪 Test your universal login flow: Emulate your end users' login experience by running auth0 test login.
• 🔍 Troubleshoot in real-time: Inspect the events of your Auth0 integration as they happen with the auth0 logs tail command.
• 🔁 Simplify repetitive tasks: Create, update, list and delete your Auth0 resources directly from the terminal.

📜 Table of Contents

• Installation
• Authenticating to Your Tenant
• Available Commands
• Customization
• Anonymous Analytics

🪛 Installation

macOS

Install via Homebrew:

brew tap auth0/auth0-cli && brew install auth0

Windows

Install via Scoop:

scoop bucket add auth0 https://github.com/auth0/scoop-auth0-cli.git
scoop install auth0

Linux

Install via cURL:

# Binary will be downloaded to "./auth0".
curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | sh -s -- -b .

# To be able to run the binary from any directory
# make sure you move it to a place in your $PATH
# sudo mv ./auth0 /usr/local/bin

Go

Install via Go:

# Make sure your $GOPATH/bin is exported on your $PATH
# to be able to run the binary from any directory.
go install github.com/auth0/auth0-cli/cmd/auth0@latest

Manual

1. Download the appropriate binary for your environment from the latest release
2. Extract the archive
   • macOS: $ tar -xf auth0-cli_{version}_Darwin_{architecture}.tar.gz
   • Linux: $ tar -xf auth0-cli_{version}_Linux_{architecture}.tar.gz
   • Windows: Extract auth0-cli_{version}_Windows_{architecture}.zip using your preferred method of choice
3. Run ./auth0

Note Autocompletion instructions for supported platforms available by running auth0 completion -h

🔐 Authenticating to Your Tenant

Authenticating to your Auth0 tenant is required for most functions of the CLI. It can be initiated by running:

auth0 login

There are two ways to authenticate:

• As a user - Recommended when invoking on a personal machine or other interactive environment. Facilitated by device authorization flow.
• As a machine - Recommended when running on a server or non-interactive environments (ex: CI). Facilitated by client credentials flow. Flags available for bypassing interactive shell.

Warning Authenticating as a user is not supported for private cloud tenants. Instead, those users should authenticate with client credentials.

💻 Available Commands

• auth0 actions - Manage resources for actions
• auth0 api - Makes an authenticated HTTP request to the Auth0 Management API
• auth0 apis - Manage resources for APIs
• auth0 apps - Manage resources for applications
• auth0 completion - Setup autocomplete features for this CLI on your terminal
• auth0 domains - Manage custom domains
• auth0 email - Manage email settings
• auth0 login - Authenticate the Auth0 CLI
• auth0 logout - Log out of a tenant's session
• auth0 logs - View tenant logs
• auth0 orgs - Manage resources for organizations
• auth0 protection - Manage resources for attack protection
• auth0 quickstarts - Quickstart support for getting bootstrapped
• auth0 roles - Manage resources for roles
• auth0 rules - Manage resources for rules
• auth0 tenants - Manage configured tenants
• auth0 test - Try your Universal Login box or get a token
• auth0 universal-login - Manage the Universal Login experience
• auth0 users - Manage resources for users

🖌️ Customization

To change the text editor used for editing templates, rules, and actions, set the environment variable EDITOR to your preferred editor. Example:

export EDITOR="code -w"
# or
export EDITOR="nano"

📊 Anonymized Analytics Disclosure

Anonymized data points are collected during the use of this CLI. This data includes the CLI version, operating system, timestamp, and other technical details that do not personally identify you.

Auth0 uses this data to better understand the usage of this tool to prioritize the features, enhancements and fixes that matter most to our users.

To opt-out of this collection, set the AUTH0_CLI_ANALYTICS environment variable to false.

🙇 Feedback

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

• Auth0's general contribution guidelines
• Auth0's code of conduct guidelines
• This repo's contribution guide

Raise an issue

To provide feedback or report a bug, please raise an issue on our issue tracker.

Vulnerability Reporting

Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

---

Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?

This project is licensed under the MIT license. See the LICENSE file for more info.