<img src="https://devin.ai/assets/deepwiki-badge.png" alt="Ask questions about auth0-deploy-cli on DeepWiki" height="20"/
The Auth0 Deploy CLI is a tool that helps you manage your Auth0 tenant configuration. It integrates into your development workflows as a standalone CLI or as a node module.
Supported resource types: actions, branding, client grants, clients (applications), connections, databases, custom domains, email templates, emails, grants, guardian, hook secrets, log streams, organizations, pages, prompts, resource servers (APIs), roles, tenant settings, themes, forms, flows, self-service profiles, network ACLs.
🎢 Highlights • 📚 Documentation • 🚀 Getting Started • 📝 Feedback • 💬 Discussions
---
Highlights
- Multi-Environment Oriented: Designed to help you test your applications' Auth0 integrations from feature branch all the way to production.
- Keyword Replacement: Shared resource configurations across all environments with dynamic keyword replacement.
- Versatile: Integrate into your CI/CD workflows either as a CLI or as a Node module.
Documentation
- Using as a CLI
- Using as a Node Module
- Authenticating with Tenant
- Configuring the Deploy CLI
- Keyword Replacement
- Incorporating Into Multi-environment Workflows
- Excluding Resources From Management
- Resource-specific Documentation
- Available Resource Formats
- Terraform Provider
- How to Contribute
Getting Started
This guide will help you to a working implementation of the Deploy CLI tool used as a standalone CLI. There are three main steps before the Deploy CLI can be run:
- Create a Dedicated Auth0 Application
- Configure the Deploy CLI
- Calling the Deploy CLI
Warning This tool can be destructive to your Auth0 tenant. It is recommended to be familiar with the AUTH0ALLOWDELETE configuration and to test on development tenants prior to using in production.
Prerequisites
- Node version 20(v20.19.0) or greater
- Auth0 Tenant
Install the Deploy CLI
To run as a standalone command-line tool: