diff --git a/README.md b/README.md index 3ce047c8d..57fd65e89 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,6 @@ The Auth0 Deploy CLI is a tool that helps you manage your Auth0 tenant configura **Supported resource types:** actions, branding, client grants, clients (applications), connections, custom domains, email templates, emails, grants, guardian, hook secrets, hooks, log streams, migrations, organizations, pages, prompts, resource servers (APIs), roles, rules, rules configs, tenant settings, themes. - 🎢 [Highlights](#highlights) • 📚 [Documentation](#documentation) • 🚀 [Getting Started](#getting-started) • 💬 [Feedback](#feedback) --- @@ -44,7 +43,7 @@ This guide will help you to a working implementation of the Deploy CLI tool used 3. [Calling the Deploy CLI](#calling-the-deploy-cli) > **Warning** -> This tool can be destructive to your Auth0 tenant. +> This tool can be destructive to your Auth0 tenant. > It is recommended to be familiar with the [`AUTH0_ALLOW_DELETE` configuration](docs/configuring-the-deploy-cli.md#auth0allowdelete) and to test on development tenants prior to using in production. ### Prerequisites @@ -76,7 +75,7 @@ In order for the Deploy CLI to call the Management API, a dedicated Auth0 applic c. Click “Authorize” > **Warning** -> The Deploy CLI's own client grant is unconfigurable by itself to [prevent potentially destructive changes](./docs/resource-specific-documentation.md#client-grants). +> The Deploy CLI's own client is unconfigurable by itself to [prevent potentially destructive changes](./docs/resource-specific-documentation.md#client-grants). #### Client Scopes @@ -105,9 +104,11 @@ a0deploy export --format=yaml --output_folder=local Once the process completes, observe the resource configuration files generated in the `local` directory. Then, run the import command, which pushes configuration from the local machine to your Auth0 tenant: ```shell -a0deploy import -c=config.json --input_file local/tenant.yaml +a0deploy import --config_file=config.json --input_file local/tenant.yaml ``` +Refer to [Using as a CLI](./docs/using-as-cli.md) documentation for a comprehensive list of flags and options. + ## Feedback ### Contributing diff --git a/docs/using-as-cli.md b/docs/using-as-cli.md index fb321f106..6b80ba033 100644 --- a/docs/using-as-cli.md +++ b/docs/using-as-cli.md @@ -1,6 +1,6 @@ # Using as a CLI -The Deploy CLI can be used as a standalone command line utility. Doing so provides a simple way to manage your Auth0 tenant configuration in CI/CD workflows. +The Deploy CLI can be used as a standalone command line utility. Doing so provides a simple way to manage your Auth0 tenant configuration in CI/CD workflows. Refer to the [Configuring the Deploy CLI](./configuring-the-deploy-cli.md) documentation for a comprehensive list of configuration settings. ## `export` command diff --git a/docs/using-as-node-module.md b/docs/using-as-node-module.md index 35118801a..4fecf60da 100644 --- a/docs/using-as-node-module.md +++ b/docs/using-as-node-module.md @@ -1,6 +1,6 @@ # Using as a Node Module -The Deploy CLI can not only be used as a standalone CLI, but as a node module. Doing so allows you to manage Auth0 resources within expressive node scripts. +The Deploy CLI can not only be used as a standalone CLI, but as a node module. Doing so allows you to manage Auth0 resources within expressive node scripts. Refer to the [Configuring the Deploy CLI](./configuring-the-deploy-cli.md) documentation for a comprehensive list of configuration settings. ## `dump` function