### Setup Auth0 for Next.js Quickstart

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_quickstarts_setup.md

Use this command to set up Auth0 for a Next.js server-side application. It creates an Auth0 application and generates a .env file.

```bash
auth0 quickstarts setup --type nextjs
```

--------------------------------

### Setup Auth0 for Fastify Quickstart

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_quickstarts_setup.md

Use this command to set up Auth0 for a Fastify web application. It creates an Auth0 application and generates a .env file.

```bash
auth0 quickstarts setup --type fastify
```

--------------------------------

### Setup Auth0 with Custom Name and Port

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_quickstarts_setup.md

Customize the Auth0 application name and port when setting up for Vite or Next.js quickstarts.

```bash
auth0 quickstarts setup --type vite --name "My App"
```

```bash
auth0 quickstarts setup --type nextjs --port 8080
```

```bash
auth0 qs setup --type fastify -n "My App" -p 3000
```

--------------------------------

### Setup Auth0 for Vite Quickstart

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_quickstarts_setup.md

Use this command to set up Auth0 for a Vite-based client-side SPA. It creates an Auth0 application and generates a .env file.

```bash
auth0 quickstarts setup --type vite
```

--------------------------------

### Auth0 CLI API Examples

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_api.md

Examples demonstrating various ways to use the auth0 api command, including GET, POST with data, DELETE, and piping data.

```bash
auth0 api get "tenants/settings"
```

```bash
auth0 api "stats/daily" -q "from=20221101" -q "to=20221118"
```

```bash
auth0 api delete "actions/actions/<action-id>" --force
```

```bash
auth0 api clients --data "{\"name\":\"ssoTest\",\"app_type\":\"sso_integration\"}"
```

```bash
cat data.json | auth0 api post clients
```

--------------------------------

### List Auth0 Quickstarts

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_quickstarts_list.md

Use this command to list all available Auth0 Quickstarts. Aliases include 'ls' and 'qs'.

```bash
auth0 quickstarts list
```

```bash
auth0 quickstarts ls
```

```bash
auth0 qs list
```

```bash
auth0 qs ls
```

--------------------------------

### Auth0 CLI Setup Flags

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_quickstarts_setup.md

These flags control the output format and customization options for the `auth0 quickstarts setup` command.

```bash
auth0 quickstarts setup [flags]
```

```bash
--json          Output in json format.
```

```bash
-n, --name string   Name of the Auth0 application (default: 'My App' for vite, nextjs and fastify, 'JHipster' for jhipster-rwa)
```

```bash
-p, --port int      Port number for the application (default: 5173 for vite, 3000 for nextjs/fastify, 8080 for jhipster-rwa)
```

```bash
-t, --type string   Type of quickstart (vite, nextjs, fastify, jhipster-rwa)
```

--------------------------------

### Download Auth0 Quickstart Applications

Source: https://context7.com/auth0/auth0-cli/llms.txt

Downloads sample applications for various platforms. Use 'list' to see available quickstart types.

```bash
# Download a quickstart for a specific app type
auth0 quickstarts download <app-id>
```

```bash
# List available quickstart types
auth0 quickstarts list
```

--------------------------------

### Setup Auth0 for JHipster RWA Quickstart

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_quickstarts_setup.md

Use this command to set up Auth0 for a JHipster regular web application. It creates an Auth0 application and generates a .env file.

```bash
auth0 quickstarts setup --type jhipster-rwa
```

--------------------------------

### Download Quickstart Sample Application

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_quickstarts_download.md

Use this command to download a Quickstart sample application. You can specify an application ID and a tech stack. The `--force` flag can be used to skip confirmation.

```bash
auth0 quickstarts download [flags]
```

```bash
auth0 quickstarts download <app-id>
```

```bash
auth0 quickstarts download <app-id> --stack <stack>
```

```bash
auth0 qs download <app-id> -s <stack>
```

```bash
auth0 qs download <app-id> -s "Next.js"
```

```bash
auth0 qs download <app-id> -s "Next.js" --force
```

--------------------------------

### List Auth0 Quickstarts with Formatted Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_quickstarts_list.md

Specify the output format for the list of Auth0 Quickstarts using flags like --json, --json-compact, or --csv.

```bash
auth0 qs ls --json
```

```bash
auth0 qs ls --json-compact
```

```bash
auth0 qs ls --csv
```

--------------------------------

### Install Auth0 CLI via Go

Source: https://context7.com/auth0/auth0-cli/llms.txt

Installs the Auth0 CLI using the Go package manager.

```bash
go install github.com/auth0/auth0-cli/cmd/auth0@latest
```

--------------------------------

### Quickstart Download Flags

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_quickstarts_download.md

These flags modify the behavior of the `auth0 quickstarts download` command. The `--stack` flag specifies the tech/language of the Quickstart, and `--force` skips confirmation.

```bash
--force          Skip confirmation.
```

```bash
-s, --stack string   Tech/language of the Quickstart sample to download. You can use the 'auth0 quickstarts list' command to see all available tech stacks.
```

--------------------------------

### Auth0 CLI Completion Examples

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_completion.md

Provides examples of how to generate completions for different shells using the `auth0 completion` command.

```bash
auth0 completion bash
auth0 completion zsh
auth0 completion fish
auth0 completion powershell
```

--------------------------------

### Create HTTP Log Stream (Example with Compact JSON Output)

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_logs_streams_create_http.md

Example of creating an HTTP log stream with specific configurations and requesting compact JSON output.

```bash
auth0 logs streams create http -n mylogstream -e "https://example.com/webhook/logs" -t "application/json" -f "JSONLINES" -a "AKIAXXXXXXXXXXXXXXXX" --json-compact
```

--------------------------------

### Install Auth0 CLI with Go

Source: https://github.com/auth0/auth0-cli/blob/main/README.md

Install the Auth0 CLI using the Go toolchain. Ensure your $GOPATH/bin directory is exported to your $PATH for global command execution.

```bash
# 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
```

--------------------------------

### Create HTTP Log Stream (Example with JSON Output)

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_logs_streams_create_http.md

Example of creating an HTTP log stream with specific configurations and requesting JSON output.

```bash
auth0 logs streams create http -n mylogstream -e "https://example.com/webhook/logs" -t "application/json" -f "JSONLINES" -a "AKIAXXXXXXXXXXXXXXXX" --json
```

--------------------------------

### Show Welcome Email Template

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_email_templates_show.md

This is an example of showing a specific email template named 'welcome'.

```bash
auth0 email templates show welcome
```

--------------------------------

### JSON Output for auth0 test login

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_test_login.md

This example shows how to get the output in JSON format, which is useful for scripting and automation. It uses shorthand flags for brevity.

```bash
auth0 test login <client-id> -c <connection-name> -a <api-identifier|api-audience> -d <domain> -s <scope1,scope2> --json
```

--------------------------------

### Install Auth0 CLI via Scoop on Windows

Source: https://github.com/auth0/auth0-cli/blob/main/docs/index.md

Use these commands to install the Auth0 CLI on Windows using Scoop.

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

--------------------------------

### Auth0 CLI Examples for EventGrid Log Stream Creation

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_logs_streams_create_eventgrid.md

These examples demonstrate various ways to create an Azure Event Grid log stream using the Auth0 CLI, from basic to fully configured with filters and PII settings. Use these as a reference for constructing your own commands.

```bash
auth0 logs streams create eventgrid
```

```bash
auth0 logs streams create eventgrid --name <name>
```

```bash
auth0 logs streams create eventgrid --name <name> --azure-id <azure-id>
```

```bash
auth0 logs streams create eventgrid --name <name> --azure-id <azure-id> --azure-region <azure-region>
```

```bash
auth0 logs streams create eventgrid --name <name> --azure-id <azure-id> --azure-region <azure-region> --azure-group <azure-group>
```

```bash
auth0 logs streams create eventgrid --name <name> --azure-id <azure-id> --azure-region <azure-region> --azure-group <azure-group> --filters '[{"type":"category","name":"auth.login.fail"},{"type":"category","name":"auth.signup.fail"}]'
```

```bash
auth0 logs streams create eventgrid --name <name> --azure-id <azure-id> --azure-region <azure-region> --azure-group <azure-group> --pii-config  '{"log_fields": ["first_name", "last_name"], "method": "hash", "algorithm": "xxhash"}'
```

```bash
auth0 logs streams create eventgrid -n <name> -i <azure-id> -r <azure-region> -g <azure-group>
```

```bash
auth0 logs streams create eventgrid -n mylogstream -i "b69a6835-57c7-4d53-b0d5-1c6ae580b6d5" -r northeurope -g "azure-logs-rg" --json
```

```bash
auth0 logs streams create eventgrid -n mylogstream -i "b69a6835-57c7-4d53-b0d5-1c6ae580b6d5" -r northeurope -g "azure-logs-rg" --json-compact
```

--------------------------------

### Initiate Auth0 CLI Login

Source: https://github.com/auth0/auth0-cli/blob/main/README.md

Run this command to start the authentication process for your Auth0 tenant. This is required for most CLI operations.

```bash
auth0 login
```

--------------------------------

### Create Sumo Log Stream (Interactive)

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_logs_streams_create_sumo.md

Use this command to interactively create a Sumo Logic log stream. No arguments are required for interactive setup.

```bash
auth0 logs streams create sumo
```

--------------------------------

### Install Auth0 CLI with Scoop on Windows

Source: https://github.com/auth0/auth0-cli/blob/main/README.md

Add the Auth0 CLI scoop bucket and install the CLI. This is a convenient way to manage CLI tools on Windows.

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

--------------------------------

### Install Fish Completion for All Sessions

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_completion.md

To load Fish completions for each session, run this command once to save the output of `auth0 completion fish` to the `auth0.fish` file in the `~/.config/fish/completions/` directory.

```fish
$ auth0 completion fish > ~/.config/fish/completions/auth0.fish
```

--------------------------------

### Install Auth0 CLI via cURL

Source: https://context7.com/auth0/auth0-cli/llms.txt

Installs the Auth0 CLI using a cURL script. Ensure to move the binary to a directory in your system's PATH.

```bash
curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | sh -s -- -b .
sudo mv ./auth0 /usr/local/bin
```

--------------------------------

### Compact JSON Output for auth0 test login

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_test_login.md

This example demonstrates how to obtain a more compact JSON output, reducing verbosity for easier parsing in certain scenarios.

```bash
auth0 test login <client-id> -c <connection-name> -a <api-identifier|api-audience> -d <domain> -s <scope1,scope2> --json-compact
```

--------------------------------

### Install Auth0 CLI via Powershell on Windows

Source: https://github.com/auth0/auth0-cli/blob/main/docs/index.md

This script installs the Auth0 CLI on Windows using Powershell. It fetches the latest release, downloads the binary, extracts it, and adds it to the system's PATH.

```powershell
#fetch latest release information
$apiUrl = "https://api.github.com/repos/auth0/auth0-cli/releases/latest"
$latestRelease = Invoke-RestMethod -Uri $apiUrl
$latestVersion = $latestRelease.tag_name
$version = $latestVersion -replace "^v"
# Download the binary to the current folder
Invoke-WebRequest "https://github.com/auth0/auth0-cli/releases/download/${latestVersion}/auth0-cli_${version}_Windows_x86_64.zip" -OutFile ".\auth0.zip"
Expand-Archive ".\auth0.zip" .\
# To be able to run the binary from any directory, make sure you add it to your '$PATH'
[System.Environment]::SetEnvironmentVariable('PATH', $Env:PATH + ";${pwd}")
```

--------------------------------

### Initialize and Develop Advanced Custom Universal Login (ACUL) Projects

Source: https://context7.com/auth0/auth0-cli/llms.txt

Commands to initialize an ACUL project and start a local development server. This is the starting point for building custom login experiences.

```bash
# Initialize an ACUL project
auth0 acul init
```

```bash
# Start a local development server for ACUL
auth0 acul dev
```

--------------------------------

### Create Invitation with Inviter Name and Invitee Email

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_orgs_invitations_create.md

Specify the inviter's name and the invitee's email address for a more detailed invitation setup.

```bash
auth0 orgs invs create --org-id <org-id> --inviter-name "Inviter Name" --invitee-email "invitee@example.com"
```

--------------------------------

### auth0 test login with Multiple Custom Parameters and JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_test_login.md

This example shows how to pass multiple custom parameters to the login URL and receive the output in JSON format. Note the syntax for multiple `-p` flags.

```bash
auth0 test login <client-id> -c <connection-name> -a <api-identifier|api-audience> -d <domain> -o <org-id> -s <scope1,scope2> -p "foo=bar" -p "bazz=buzz" --json
```

--------------------------------

### Create Splunk Log Stream (Example with JSON Output)

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_logs_streams_create_splunk.md

Example of creating a Splunk log stream with specific parameters and requesting output in JSON format. The `--json-compact` flag provides a more condensed JSON output.

```bash
auth0 log streams create splunk -n mylogstream -d "demo.splunk.com" -t "12a34ab5-c6d7-8901-23ef-456b7c89d0c1" -p "8088" -s false --json
```

```bash
auth0 log streams create splunk -n mylogstream -d "demo.splunk.com" -t "12a34ab5-c6d7-8901-23ef-456b7c89d0c1" -p "8088" -s false --json-compact
```

--------------------------------

### Create Invitation with Organization ID

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_orgs_invitations_create.md

Provide the organization ID to create an invitation. This is a minimal non-interactive setup.

```bash
auth0 orgs invs create --org-id <org-id>
```

--------------------------------

### Create Invitation with Short Flags and Connection ID

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_orgs_invitations_create.md

Utilize short flags for inviter name and invitee email, along with connection ID and invitation TTL, for a comprehensive invitation setup.

```bash
auth0 orgs invs create --org-id <org-id> -n "Inviter Name" -e "invitee@example.com" --client-id "client_id" --connection-id "connection_id" -t 86400
```

--------------------------------

### Install Bash Completion for All Sessions (Linux)

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_completion.md

To have Bash completions available in all future sessions on Linux, redirect the output of `auth0 completion bash` to a file in `/etc/bash_completion.d/`.

```bash
# On Linux:
$ auth0 completion bash > /etc/bash_completion.d/auth0
```

--------------------------------

### Search Query Syntax Example

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_users_search.md

Demonstrates the flexible Lucene query syntax for searching users. Supports OR, AND, and wildcard matching for email addresses.

```bash
auth0 users search -q email:"user123@*.com" OR (user_id:"user-id-123" AND name:"Bob")
```

--------------------------------

### Auth0 CLI Examples: Search Users by Email

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_users_search-by-email.md

Demonstrates various ways to use the `auth0 users search-by-email` command. The `-p` flag allows toggling between a list of users and viewing a user in detail.

```bash
auth0 users search-by-email
```

```bash
auth0 users search-by-email <user-email>,
```

```bash
auth0 users search-by-email <user-email> -p
```

--------------------------------

### Create Sumo Log Stream (Non-Interactive)

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_logs_streams_create_sumo.md

Supply the log stream name and other information through flags for non-interactive creation. This allows for automated or scripted stream setup.

```bash
auth0 logs streams create sumo --name <name>
```

```bash
auth0 logs streams create sumo --name <name> --source <source>
```

```bash
auth0 logs streams create sumo --name <name> --source <source> --filters '[{"type":"category","name":"auth.login.fail"},{"type":"category","name":"auth.signup.fail"}]'
```

```bash
auth0 logs streams create sumo --name <name> --source <source> --pii-config '{"log_fields": ["first_name", "last_name"], "method": "hash", "algorithm": "xxhash"}'
```

```bash
auth0 logs streams create sumo -n <name> -s <source>
```

```bash
auth0 logs streams create sumo -n "mylogstream" -s "demo.sumo.com" --json
```

```bash
auth0 logs streams create sumo -n "mylogstream" -s "demo.sumo.com" --json-compact
```

--------------------------------

### Install Auth0 CLI with Homebrew on macOS/Linux

Source: https://github.com/auth0/auth0-cli/blob/main/README.md

Use this command to install the Auth0 CLI using Homebrew on macOS and Linux systems. Ensure you have Homebrew installed.

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

--------------------------------

### Create Auth0 Application with Name and Description

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_apps_create.md

Provide both the application name and a description using the `--name` and `--description` flags.

```bash
auth0 apps create --name myapp --description <description>
```

--------------------------------

### Shorthand Flags for auth0 test login

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_test_login.md

This example demonstrates the use of shorthand flags for common options like connection name, audience, domain, and scopes. It also includes the `--force` flag to skip confirmation.

```bash
auth0 test login <client-id> -c <connection-name> -a <api-identifier|api-audience> -d <domain> -s <scope1,scope2> --force
```

--------------------------------

### Auth0 CLI Examples for Suspicious IP Check

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_protection_suspicious-ip-throttling_ips_check.md

Examples demonstrating how to check IP addresses against suspicious IP throttling. The second example uses an alias 'ap sit' for 'protection suspicious-ip-throttling'.

```bash
auth0 protection suspicious-ip-throttling ips check
```

```bash
auth0 ap sit ips check <ip>
```

```bash
auth0 ap sit ips check "178.178.178.178"
```

--------------------------------

### Create User with Name, Email, and Connection

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_users_create.md

Provide name, email, and the specific connection for user creation.

```bash
auth0 users create --name "John Doe" --email john@example.com --connection-name "Username-Password-Authentication" --username "example"
```

--------------------------------

### Auth0 Rules Disable Examples

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_rules_disable.md

Provides examples of disabling a rule with and without specific output formats.

```bash
auth0 rules disable
auth0 rules disable <rule-id>
auth0 rules disable <rule-id> --json
auth0 rules disable <rule-id> --json-compact
```

--------------------------------

### Install Zsh Completion for All Sessions

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_completion.md

To load Zsh completions for each session, run this command once to create the `_auth0` completion file in your Zsh's fpath directory. A new shell is required for this to take effect.

```zsh
$ auth0 completion zsh > "${fpath[1]}/_auth0"
```

--------------------------------

### Initialize ACUL project with template and screens

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_acul_init.md

Specify the template framework (e.g., react) and a comma-separated list of screens (e.g., login,signup) to include in the ACUL project.

```bash
auth0 acul init acul-sample-app --template react --screens login,signup
```

```bash
auth0 acul init acul-sample-app -t react -s login,mfa,signup
```

--------------------------------

### Auth0 CLI Event Streams Redeliver Examples

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_event-streams_redeliver.md

These examples demonstrate how to use the `auth0 event-streams redeliver` command. The first example retries all recent failed deliveries interactively. The second specifies a stream ID, prompting for delivery IDs. The third specifies both a stream ID and specific delivery IDs.

```bash
auth0 event-streams redeliver
```

```bash
auth0 event-streams redeliver <stream-id>
```

```bash
auth0 event-streams redeliver <stream-id> evt_abc123,evt_def456
```

--------------------------------

### Create Auth0 Application with Name, Description, and Type

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_apps_create.md

Define the application's type (e.g., native, spa, regular, m2m, resource_server) along with its name and description.

```bash
auth0 apps create --name myapp --description <description> --type [native|spa|regular|m2m|resource_server]
```

--------------------------------

### Create User with Email and 'email' Connection (No Name)

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_users_create.md

Create a user by providing only the email and specifying the 'email' connection.

```bash
auth0 users create -e john@example.com -c "email"
```

--------------------------------

### Auth0 CLI Examples for Email Provider Deletion

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_email_provider_delete.md

Provides examples of how to delete an email provider, including interactive and non-interactive methods using the `--force` flag.

```bash
auth0 provider delete
```

```bash
auth0 email provider rm
```

```bash
auth0 email provider delete --force
```

```bash
auth0 email provider rm --force
```

--------------------------------

### Build and Run Auth0 CLI

Source: https://github.com/auth0/auth0-cli/blob/main/CONTRIBUTING.md

Compile the Auth0 CLI from the source code and execute the help command to verify the build.

```shell
$ make build
$ ./out/auth0 --help
```

--------------------------------

### Auth0 CLI Examples for Event Stream Deletion

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_event-streams_delete.md

These examples demonstrate various ways to delete event streams. You can delete interactively, by specifying one or more event IDs, or by using the `--force` flag to skip confirmation.

```bash
auth0 event-streams delete
```

```bash
auth0 event-streams rm
```

```bash
auth0 event-streams delete <event-id>
```

```bash
auth0 event-streams delete <event-id> --force
```

```bash
auth0 event-streams delete <event-id> <event-id2> <event-idn>
```

```bash
auth0 event-streams delete <event-id> <event-id2> <event-idn> --force
```

--------------------------------

### Start ACUL Project in Dev Mode

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_acul_dev.md

Use this command to start the local development server for an ACUL project. Requires the --port flag to specify the server port. Optionally, use --dir to specify the project directory.

```bash
auth0 acul dev --port 55444
```

```bash
auth0 acul dev -p 55444 --dir ./my_project
```

--------------------------------

### Display ACUL Configuration Documentation

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_acul_config_docs.md

Use this command to open the documentation for configuring Advanced Customizations for Universal Login screens.

```bash
auth0 acul config docs [flags]
```

```bash
auth0 acul config docs
```

--------------------------------

### Deploy an action

Source: https://context7.com/auth0/auth0-cli/llms.txt

Make an Auth0 Action live by deploying it. This command requires the action's ID.

```bash
auth0 actions deploy <action-id>
```

--------------------------------

### Set Rendering Settings from a File

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_acul_config_set.md

Configure rendering settings by specifying a JSON file containing the settings. This is useful for managing complex configurations.

```bash
auth0 acul config set <screen-name> --file settings.json
```

```bash
auth0 acul config set signup-id --file settings.json
```

--------------------------------

### Update Role Interactively

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_roles_update.md

Use this command to interactively update a role. No arguments are needed to start the interactive process.

```bash
auth0 roles update
```

--------------------------------

### Create Auth0 Application with Name

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_apps_create.md

Specify the application name using the `--name` flag for non-interactive creation.

```bash
auth0 apps create --name myapp
```

--------------------------------

### Update Auth0 Application

Source: https://context7.com/auth0/auth0-cli/llms.txt

Modifies the settings of an existing Auth0 application. This example updates the application name and callback URLs.

```bash
auth0 apps update <app-id> \
  --name "Updated App Name" \
  --callbacks "https://newurl.com/callback" \
  --json
```

--------------------------------

### Create Auth0 Application with Short Flags and Compact JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_apps_create.md

Similar to the above, but uses `--json-compact` for a more condensed JSON output.

```bash
auth0 apps create -n myapp -d <description> -t [native|spa|regular|m2m|resource_server] -r --json-compact
```

--------------------------------

### List Universal Login Configurations

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_acul_config_list.md

Use this command to list all Universal Login rendering configurations. You can filter the results using various flags.

```bash
auth0 acul config list [flags]
```

--------------------------------

### Update Auth0 Application Interactively

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_apps_update.md

Use this command to interactively update an application. No arguments are needed to start the interactive process.

```bash
auth0 apps update
```

--------------------------------

### Create Auth0 Application with Multiple Metadata Entries

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_apps_create.md

Include multiple metadata key-value pairs by using the `--metadata` flag multiple times.

```bash
auth0 apps create -n myapp -d <description> -t [native|spa|regular|m2m|resource_server] -r --json --metadata "foo=bar" --metadata "bazz=buzz"
```

--------------------------------

### Re-authentication Prompt

Source: https://github.com/auth0/auth0-cli/blob/main/README.md

This is an example of the prompt you will see when your access token expires, allowing you to confirm your default tenant or select a different one.

```text
Continue login with default tenant 'your-tenant.auth0.com'? [y/N]
```

--------------------------------

### Create Phone Provider Interactively

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_phone_provider_create.md

Use this command to create a phone provider interactively. The CLI will prompt for necessary information.

```bash
auth0 phone provider create
```

--------------------------------

### Create SendGrid Email Provider

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_email_provider_create.md

Create a SendGrid email provider using its API key for authentication. This is a basic setup for SendGrid.

```bash
auth0 email provider create --provider sendgrid --credentials='{ "api_key":"TheAPIKey" }'
```

--------------------------------

### Create Custom Domain with Policy

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_domains_create.md

Create a custom domain with a specified TLS policy. Use 'recommended' for optimal security.

```bash
auth0 domains create --domain <domain-name> --policy recommended
```

--------------------------------

### Update Phone Provider Interactively

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_phone_provider_update.md

Run this command without arguments to update the phone provider interactively. This is useful for guided configuration.

```bash
auth0 phone provider update
```

--------------------------------

### Set Default Auth0 Application

Source: https://context7.com/auth0/auth0-cli/llms.txt

Designates a specific Auth0 application as the default for the CLI. This application will be used by commands like quickstarts and tests.

```bash
auth0 apps use <app-id>
```

--------------------------------

### List Auth0 Logs with Options

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_logs_list.md

Lists Auth0 logs with options for number of entries, picker mode, and output format.

```bash
auth0 logs ls -n 250 -p
```

```bash
auth0 logs ls --json
```

```bash
auth0 logs ls --json-compact
```

```bash
auth0 logs ls --csv
```

--------------------------------

### Create API with Name

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_apis_create.md

Create an API by providing only its name.

```bash
auth0 apis create --name myapi
```

--------------------------------

### Create User with Email and 'email' Connection

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_users_create.md

Create a user specifying only the email and using the 'email' connection type.

```bash
auth0 users create -n "John Doe" -e john@example.com -c "email" --json
```

--------------------------------

### Create SparkPost Email Provider

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_email_provider_create.md

Create a SparkPost email provider using its API key. This example shows the basic configuration for SparkPost.

```bash
auth0 email provider create --provider sparkpost --credentials='{ "api_key":"TheAPIKey" }'
```

--------------------------------

### Basic Usage of auth0 test login

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_test_login.md

This is the most basic form of the command. It initiates the Universal Login flow for your tenant.

```bash
auth0 test login
```

--------------------------------

### Enable a Rule with JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_rules_enable.md

To get the output in JSON format, use the `--json` flag. This is useful for scripting or programmatic access.

```bash
auth0 rules enable <rule-id> --json
```

--------------------------------

### Update Auth0 Action Code

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_actions_update.md

Provide the action's code content by piping it from a file. This example also sets the action name and runtime.

```bash
auth0 actions update <action-id> --name myaction --code "$(cat path/to/code.js) --r node18"
```

--------------------------------

### Create User with Flags and Compact JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_users_create.md

Utilize shorthand flags for user details and request output in a compact JSON format.

```bash
auth0 users create -n "John Doe" -e john@example.com -c "Username-Password-Authentication" -u "example" --json-compact
```

--------------------------------

### Create Phone Provider with Compact JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_phone_provider_create.md

This command creates a phone provider and outputs the result in a compact JSON format.

```bash
auth0 phone provider create --json-compact
```

--------------------------------

### Create a Role with Compact JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_roles_create.md

Create a role using shorthand flags for name and description, and request compact JSON output.

```bash
auth0 roles create -n myrole -d "awesome role" --json-compact
```

--------------------------------

### List Auth0 Tenants with JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_tenants_list.md

Use the `--json` flag to get the tenant list in JSON format. This is useful for programmatic access.

```bash
auth0 tenants ls --json
```

--------------------------------

### Install Bash Completion for All Sessions (macOS)

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_completion.md

To have Bash completions available in all future sessions on macOS, redirect the output of `auth0 completion bash` to a file in `/usr/local/etc/bash_completion.d/`.

```bash
# On MacOS:
$ auth0 completion bash > /usr/local/etc/bash_completion.d/auth0
```

--------------------------------

### Create User with Phone Number, SMS Connection, and Compact JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_users_create.md

Create a user using a phone number and SMS connection, with output in compact JSON format.

```bash
auth0 users create -m +916898989898 -c "sms" --json-compact
```

--------------------------------

### Create Custom Domain with Compact JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_domains_create.md

Create a custom domain and output the result in a compact JSON format, reducing verbosity.

```bash
auth0 domains create -d <domain-name> -p recommended -t auth0 -i "cf-connecting-ip" --json-compact
```

--------------------------------

### Show Tenant Settings

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_tenant-settings_show.md

Displays the current tenant settings. Use this command to view your Auth0 tenant's configuration.

```bash
auth0 tenant-settings show 
```

```bash
auth0 tenant-settings show --json
```

```bash
auth0 tenant-settings show --json-compact
```

--------------------------------

### Create a Role with JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_roles_create.md

Create a role using shorthand flags for name and description, and request standard JSON output.

```bash
auth0 roles create -n myrole -d "awesome role" --json
```

--------------------------------

### Show Role Information in JSON Format

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_roles_show.md

To get the role details in JSON format, use the `--json` flag. This is useful for programmatic consumption of the data.

```bash
auth0 roles show <role-id> --json
```

--------------------------------

### Create Custom Domain with Metadata

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_domains_create.md

Add custom metadata to a new domain. The metadata must be provided as a JSON string.

```bash
auth0 domains create --domain <domain-name> --policy recommended --metadata '{"key1":"value1","key2":"value2"}'
```

--------------------------------

### Show Application Information in JSON Format

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_apps_show.md

Retrieve application details in JSON format for programmatic use. Use `--json` for standard JSON output or `--json-compact` for a more condensed format. The `-r` flag can be combined to include secrets.

```bash
auth0 apps show <app-id> -r --json
auth0 apps show <app-id> -r --json-compact
```

--------------------------------

### Show Auth0 Action in JSON format

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_actions_show.md

To get the action details in JSON format, use the `--json` flag. This is useful for programmatic consumption of the data.

```bash
auth0 actions show <action-id> --json
```

--------------------------------

### Authenticate with Client Credentials: v0 vs v1

Source: https://github.com/auth0/auth0-cli/blob/main/MIGRATION_GUIDE.md

The `auth0 tenants add` command for authenticating via client credentials has been consolidated into `auth0 login`. Use the `--domain`, `--client-id`, and `--client-secret` flags for non-interactive authentication.

```sh
# Example:
auth0 tenants add travel0.us.auth0.com \
--client-id tUIvAH7g2ykVM4lGriYEQ6BKV3je24Ka \
--client-secret XXXXXXXXXXXXXXXXXXXXXXXXXXXX
```

```sh
# Example:
auth0 login --domain travel0.us.auth0.com \
--client-id tUIvAH7g2ykVM4lGriYEQ6BKV3je24Ka \
--client-secret XXXXXXXXXXXXXXXXXXXXXXXXXXXX
```

--------------------------------

### Update HTTP Log Stream with JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_logs_streams_update_http.md

Update an HTTP log stream and output the result in JSON format. This example uses short flags for brevity.

```bash
auth0 logs streams update http <log-stream-id> -n mylogstream -e "https://example.com/webhook/logs" -t "application/json" -f "JSONLINES" -a "AKIAXXXXXXXXXXXXXXXX" --json
```

--------------------------------

### User Import with Connection Name

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_users_import.md

Imports users into a specified database connection. You will need to start multiple imports if your data exceeds the 500KB file size limit.

```bash
auth0 users import --connection-name "Username-Password-Authentication"
```

--------------------------------

### Create Auth0 Action with Short Flags and Compact JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_actions_create.md

Use short flags for efficiency and obtain the output in a compact JSON format.

```bash
auth0 actions create -n myaction -t post-login -c "$(cat path/to/code.js)" -r node18 -d "lodash=4.0.0" -d "uuid=9.0.0" -s "API_KEY=value" -s "SECRET=value" --json-compact
```

--------------------------------

### Manage ACUL Project Configuration

Source: https://context7.com/auth0/auth0-cli/llms.txt

Commands for getting, generating, listing, and setting ACUL configurations for specific screens. Use these to manage your ACUL project's settings.

```bash
# Get the ACUL configuration for a screen
auth0 acul config get --screen login-id
```

```bash
# Generate default ACUL configuration
auth0 acul config generate
```

```bash
# List all ACUL screen configurations
auth0 acul config list
```

```bash
# Set configuration for a screen
auth0 acul config set --screen login-id
```

```bash
# Open ACUL documentation
auth0 acul config docs
```

```bash
# Add a new screen to your ACUL project
auth0 acul screen add
```

--------------------------------

### Manage Universal Login Templates and Prompts

Source: https://context7.com/auth0/auth0-cli/llms.txt

Commands for managing Universal Login templates and custom text for prompts. Use these to customize the user login experience.

```bash
auth0 ul templates show
auth0 ul templates update
```

```bash
auth0 ul prompts list
auth0 ul prompts text show login --language en
auth0 ul prompts text update login --language en
```

--------------------------------

### Get Rendering Settings for a Specific Screen

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_acul_config_get.md

Use this command to retrieve the current rendering settings for a given Universal Login screen. You can optionally specify a file to save the output.

```bash
auth0 acul config get <screen-name>
```

```bash
auth0 acul config get <screen-name> --file settings.json
```

```bash
auth0 acul config get signup-id
```

```bash
auth0 acul config get login-id -f ./acul_config/login-id.json
```

--------------------------------

### List Auth0 Actions with JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_actions_list.md

To get the list of actions in JSON format, use the `--json` flag. For a more compact JSON output, use `--json-compact`.

```bash
auth0 actions ls --json
```

```bash
auth0 actions ls --json-compact
```

--------------------------------

### Initialize a new ACUL project

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_acul_init.md

Use this command to create a new ACUL project. Specify the application name as the first argument.

```bash
auth0 acul init <app_name>
```

```bash
auth0 acul init acul-sample-app
```

--------------------------------

### Create Auth0 Application Interactively

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_apps_create.md

Run this command without any arguments to create an application interactively. The CLI will prompt you for necessary details.

```bash
auth0 apps create
```

--------------------------------

### Install PowerShell Completion for All Sessions

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_completion.md

To enable PowerShell completions for every new session, redirect the output of `auth0 completion powershell` to `auth0.ps1`. You then need to source this file from your PowerShell profile.

```powershell
PS> auth0 completion powershell > auth0.ps1
```

--------------------------------

### Update Session Transfer Settings

Source: https://context7.com/auth0/auth0-cli/llms.txt

Updates the session transfer settings for an Auth0 application. This example enables token creation, specifies allowed authentication methods, and enforces device binding.

```bash
auth0 apps session-transfer update <app-id> \
  --can-create-token=true \
  --allowed-auth-methods=cookie,query \
  --enforce-device-binding=ip
```

--------------------------------

### Show Universal Login Template

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_universal-login_templates_show.md

Use this command to display the current custom template for the Universal Login experience. It can be run with the full command or its alias.

```bash
auth0 universal-login templates show
```

```bash
auth0 ul templates show
```

--------------------------------

### Update HTTP Log Stream with Compact JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_logs_streams_update_http.md

Update an HTTP log stream and output the result in a compact JSON format. This example uses short flags for brevity.

```bash
auth0 logs streams update http <log-stream-id> -n mylogstream -e "https://example.com/webhook/logs" -t "application/json" -f "JSONLINES" -a "AKIAXXXXXXXXXXXXXXXX" --json-compact
```

--------------------------------

### Create an enabled rule with name, template, and script

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_rules_create.md

Create a rule with a name, template, and provide the script content from a file.

```bash
auth0 rules create --enabled=true --name "My Rule" --template "Empty rule" --script "$(cat path/to/script.js)"
```

--------------------------------

### Show Session Transfer Settings in JSON Format

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_apps_session-transfer_show.md

To get the session transfer settings in JSON format, append the `--json` flag to the command. This is useful for programmatic access or further processing.

```bash
auth0 apps session-transfer show <app-id> --json
```

--------------------------------

### Create Auth0 Action with Multiple Dependencies and Secrets

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_actions_create.md

Configure an action with multiple npm dependencies and several secrets.

```bash
auth0 actions create --name myaction --trigger post-login --code "$(cat path/to/code.js)" --dependency "lodash=4.0.0" --dependency "uuid=9.0.0" --secret "API_KEY=value" --secret "SECRET=value"
```

--------------------------------

### Create Mandrill Email Provider with Default From Address

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_email_provider_create.md

Create a Mandrill email provider, specifying the default sender address, credentials, and message settings. This example demonstrates setting a default sender.

```bash
auth0 email provider create --provider mandrill --default-from-address='admin@example.com' --credentials='{ "api_key":"TheAPIKey" }' --settings='{ "message": { "view_control_link": true } }'
```

--------------------------------

### Create Organization with Name and Display Name

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_orgs_create.md

Create an organization specifying both its internal name and a user-friendly display name using the `--display` or `-d` flags.

```bash
auth0 orgs create -n myorganization --display "My Organization"
```

--------------------------------

### Show Log Stream with JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_logs_streams_show.md

To get the log stream information in JSON format, use the `--json` flag. For a more compact JSON output, use the `--json-compact` flag.

```bash
auth0 logs streams show <log-stream-id> --json
```

```bash
auth0 logs streams show <log-stream-id> --json-compact
```

--------------------------------

### Create Auth0 Action with Code Content

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_actions_create.md

Provide the action's code directly using a file path. Ensure the runtime is also specified.

```bash
auth0 actions create --name myaction --trigger post-login --code "$(cat path/to/code.js)" --runtime node18
```

--------------------------------

### Create User with Flags and JSON Output

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_users_create.md

Use shorthand flags for user details and request output in JSON format.

```bash
auth0 users create -n "John Doe" -e john@example.com -c "Username-Password-Authentication" -u "example" --json
```

--------------------------------

### Download and Extract Auth0 CLI on Windows

Source: https://github.com/auth0/auth0-cli/blob/main/README.md

Download the Windows x86_64 zip archive for the Auth0 CLI using the latest version information and extract it to the current directory. This is part of the manual installation process.

```powershell
Invoke-WebRequest -Uri "https://github.com/auth0/auth0-cli/releases/download/${latestVersion}/auth0-cli_${version}_Windows_x86_64.zip" -OutFile ".\auth0.zip"
Expand-Archive ".\auth0.zip" .\
```

--------------------------------

### Move Auth0 CLI to System PATH

Source: https://github.com/auth0/auth0-cli/blob/main/README.md

After downloading the binary, move it to /usr/local/bin to make it accessible from any directory. This command requires sudo privileges.

```bash
sudo mv ./auth0 /usr/local/bin
```

--------------------------------

### Create Network ACL with User Agents and JA3 Fingerprints

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_network-acl_create.md

Create a network ACL to block traffic based on user agents and JA3 fingerprints. This example uses shorthand flags for description and priority.

```bash
auth0 network-acl create -d "Block Bots" -p 4 --active true --rule '{"action":{"block":true},"scope":"tenant","match":{"user_agents":["badbot/*","malicious/*"],"ja3_fingerprints":["deadbeef","cafebabe"]}}'
```

--------------------------------

### Set Default Editor on Linux/macOS

Source: https://github.com/auth0/auth0-cli/blob/main/README.md

Set the EDITOR environment variable to change the default text editor for editing templates, rules, and actions. Ensure the command starts the editor and waits for files to be closed.

```shell
# Uses vscode with the --wait flag.
export EDITOR="code --wait"
```

```shell
# Uses sublime text with the --wait flag.
export EDITOR="subl --wait"
```

```shell
# Uses nano, a terminal based editor.
export EDITOR="nano"
```

```shell
# Uses vim, a terminal based editor.
export EDITOR="vim"
```

--------------------------------

### Create Invitation with Invitee Email and Client ID

Source: https://github.com/auth0/auth0-cli/blob/main/docs/auth0_orgs_invitations_create.md

Create an invitation specifying the invitee's email and the client ID, which is used to resolve the application's login initiation endpoint.

```bash
auth0 orgs invs create --org-id <org-id> --invitee-email "invitee@example.com" --client-id "client_id"
```

--------------------------------

### Create an organization

Source: https://context7.com/auth0/auth0-cli/llms.txt

Create a new organization in Auth0. Specify name, display name, logo URL, and accent color.

```bash
auth0 orgs create \
  --name "my-org" \
  --display "My Organization" \
  --logo "https://example.com/logo.png" \
  --accent "#635DFF" \
  --json
```