-
Notifications
You must be signed in to change notification settings - Fork 32
Added content for developer tools #395
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
brth31
wants to merge
2
commits into
main
Choose a base branch
from
cdt-tab
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| --- | ||
| description: Learn about the Auth0 CLI and how to use it for tenant management. | ||
| 'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png | ||
| 'og:title': Auth0 CLI | ||
| 'og:url': https://auth0.com/docs/ | ||
| permalink: auth0-cli | ||
| title: Auth0 CLI | ||
| 'twitter:description': Learn about the Auth0 CLI and how to use it for tenant management. | ||
| 'twitter:title': Auth0 CLI | ||
| --- | ||
|
|
||
| <Callout icon="📚"> | ||
| For complete CLI command reference and detailed usage information, see the [Auth0 CLI Reference Documentation](https://auth0.github.io/auth0-cli/). | ||
| </Callout> | ||
|
|
||
| <Card title="Before you start"> | ||
|
|
||
| Set up an [Auth0 Tenant](https://manage.auth0.com/). | ||
|
|
||
| </Card> | ||
|
|
||
| The Auth0 CLI is a command-line tool that provides direct access to the Auth0 Management API, enabling you to manage your Auth0 tenant from your terminal. It's designed for interactive use during development and can be integrated into scripts for automation. | ||
|
|
||
| ## Key Features | ||
|
|
||
| * **Interactive Management**: Quickly create, update, and manage Auth0 resources from the command line | ||
| * **Authentication Support**: Multiple authentication methods including user login and machine-to-machine credentials | ||
| * **Resource Management**: Full CRUD operations for applications, APIs, connections, users, and more | ||
| * **Cross-Platform**: Available for macOS, Linux, and Windows | ||
| * **JSON Output**: Machine-readable output for scripting and automation | ||
|
|
||
| ## Installation | ||
|
|
||
| ### macOS | ||
|
|
||
| Using Homebrew: | ||
|
|
||
| ```bash lines | ||
| brew tap auth0/auth0-cli | ||
| brew install auth0 | ||
| ``` | ||
|
|
||
| ### Linux | ||
|
|
||
| ```bash lines | ||
| curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | sh -s -- -b /usr/local/bin | ||
| ``` | ||
|
|
||
| ### Windows | ||
|
|
||
| Using Scoop: | ||
|
|
||
| ```powershell lines | ||
| scoop bucket add auth0 https://github.com/auth0/scoop-auth0-cli.git | ||
| scoop install auth0 | ||
| ``` | ||
|
|
||
| Or download the latest release from the [GitHub releases page](https://github.com/auth0/auth0-cli/releases). | ||
|
|
||
| ## Authentication | ||
|
|
||
| Before using the Auth0 CLI, you need to authenticate: | ||
|
|
||
| ```bash lines | ||
| auth0 login | ||
| ``` | ||
|
|
||
| This will open a browser window for you to log in to your Auth0 account. You can also authenticate using a machine-to-machine application: | ||
|
|
||
| ```bash lines | ||
| auth0 login --domain <your-domain> --client-id <client-id> --client-secret <client-secret> | ||
| ``` | ||
|
|
||
| ## Common Commands | ||
|
|
||
| ### Manage Applications | ||
|
|
||
| ```bash lines | ||
| # List all applications | ||
| auth0 apps list | ||
|
|
||
| # Create a new application | ||
| auth0 apps create --name "My App" --type spa | ||
|
|
||
| # Show application details | ||
| auth0 apps show <app-id> | ||
|
|
||
| # Update an application | ||
| auth0 apps update <app-id> --callbacks "http://localhost:3000/callback" | ||
|
|
||
| # Delete an application | ||
| auth0 apps delete <app-id> | ||
| ``` | ||
|
|
||
| ### Manage APIs | ||
|
|
||
| ```bash lines | ||
| # List all APIs | ||
| auth0 apis list | ||
|
|
||
| # Create a new API | ||
| auth0 apis create --name "My API" --identifier "https://my-api.example.com" | ||
|
|
||
| # Show API details | ||
| auth0 apis show <api-id> | ||
| ``` | ||
|
|
||
| ### Manage Users | ||
|
|
||
| ```bash lines | ||
| # List users | ||
| auth0 users list | ||
|
|
||
| # Create a user | ||
| auth0 users create --email "[email protected]" --connection "Username-Password-Authentication" | ||
|
|
||
| # Show user details | ||
| auth0 users show <user-id> | ||
|
|
||
| # Update a user | ||
| auth0 users update <user-id> --email "[email protected]" | ||
| ``` | ||
|
|
||
| ### Manage Tenant Settings | ||
|
|
||
| ```bash lines | ||
| # Show current tenant | ||
| auth0 tenants list | ||
|
|
||
| # Update tenant settings | ||
| auth0 tenants update | ||
| ``` | ||
|
|
||
| ## Using in Scripts | ||
|
|
||
| The Auth0 CLI supports JSON output for easy parsing in scripts: | ||
|
|
||
| ```bash lines | ||
| # Get application details as JSON | ||
| auth0 apps show <app-id> --json | ||
|
|
||
| # Create an app and capture the output | ||
| auth0 apps create --name "My App" --type spa --json > app-details.json | ||
| ``` | ||
|
|
||
| ## Use Cases | ||
|
|
||
| The Auth0 CLI is ideal for: | ||
|
|
||
| * **Development Workflows**: Quickly set up and configure Auth0 resources during development | ||
| * **Testing**: Create test applications and users for automated testing | ||
| * **Debugging**: Inspect and modify Auth0 configuration in real-time | ||
| * **Scripting**: Automate repetitive tasks with shell scripts | ||
| * **CI/CD Integration**: Integrate Auth0 configuration into your deployment pipelines | ||
|
|
||
| ## Comparison with Other Tools | ||
|
|
||
| ### Auth0 CLI vs Deploy CLI | ||
|
|
||
| * **Auth0 CLI**: Interactive, command-by-command resource management. Best for development and ad-hoc tasks. | ||
| * **Deploy CLI**: Declarative, configuration-file-based tenant management. Best for managing entire tenant configurations across environments. | ||
|
|
||
| ### Auth0 CLI vs Terraform Provider | ||
|
|
||
| * **Auth0 CLI**: Imperative commands for immediate changes. No state management. | ||
| * **Terraform Provider**: Declarative infrastructure-as-code with state tracking. Best for production infrastructure management. | ||
|
|
||
| ## Documentation and Support | ||
|
|
||
| For complete documentation, command reference, and examples, visit: | ||
|
|
||
| * [Auth0 CLI GitHub Repository](https://github.com/auth0/auth0-cli) | ||
| * [Auth0 CLI Documentation](https://auth0.github.io/auth0-cli/) | ||
|
|
||
| ## Next Steps | ||
|
|
||
| <Columns cols={3}> | ||
| <Card title="Deploy CLI" href="/docs/deploy-monitor/deploy-cli-tool" icon="rocket"> | ||
| Learn about managing tenant configuration with the Deploy CLI | ||
| </Card> | ||
| <Card title="Terraform Provider" href="/docs/deploy-monitor/auth0-terraform-provider" icon="code"> | ||
| Explore infrastructure-as-code with Terraform | ||
| </Card> | ||
| <Card title="Management API" href="/docs/api/management/v2" icon="code-branch"> | ||
| Access the Auth0 Management API directly | ||
| </Card> | ||
| </Columns> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pending. We need to discuss criteria for adding content to the top menu as well as check with the author about Design.