Skip to content

Commit

Permalink
Add CLI options with explanations (#766)
Browse files Browse the repository at this point in the history
* Add CLI options with explanations

Also switched `-c` to `--config_file` to give the long form of the options in the example `a0deploy export`.

Mostly the description is copied from `args.ts` with some additional explantion

* Update README.md

Co-authored-by: Will Vedder <willvedd@gmail.com>

* Addressing PR feedback

---------

Co-authored-by: Will Vedder <willvedd@gmail.com>
Co-authored-by: Will Vedder <will.vedder@okta.com>
  • Loading branch information
3 people authored May 24, 2023
1 parent fe6248f commit 473d27b
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

---
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/using-as-cli.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/using-as-node-module.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 473d27b

Please sign in to comment.