From 718bf7bf14d03bf3b7f83d5c8485022fd40e79da Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:00:43 -0500 Subject: [PATCH 1/9] Updating README --- README.md | 243 +++++++++++++++--------------------------------------- 1 file changed, 65 insertions(+), 178 deletions(-) diff --git a/README.md b/README.md index cb9ebdbd9..e853d9b51 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,36 @@ -# Auth0 CLI (Experimental) +
+

Auth0 CLI

-`auth0` is the command line to supercharge your development workflow. +[![Release](https://img.shields.io/github/v/release/auth0/auth0-cli?include_prereleases&style=flat-square)](https://github.com/auth0/auth0-cli/releases) [![Build Status](https://img.shields.io/github/actions/workflow/status/auth0/auth0-cli/go.yml?branch=v1)](https://github.com/auth0/auth0-cli/actions?query=branch%3Amain) [![Go Report Card](https://goreportcard.com/badge/github.com/auth0/auth0-cli?style=flat-square)](https://goreportcard.com/report/github.com/auth0/auth0-cli) [![License](https://img.shields.io/github/license/auth0/auth0-cli.svg?style=flat-square)](https://github.com/auth0/auth0-cli/blob/main/LICENSE) -> Note: This CLI is an experimental release, and is built on a best-efforts basis by some Auth0 developers in their available innovation time. It is open-source licensed and free to use, and is not covered by any Auth0 Terms of Service or Agreements. If you have issues with this CLI you can engage with the project's developer community through the repository GitHub Issues list, or contribute fixes and enhancements of your own via a Pull Request. +
-Build, test, troubleshoot and manage your integration with **[Auth0](http://auth0.com/)** directly from your **terminal**. +# Auth0 CLI + +Build, manage and test your [Auth0](http://auth0.com/) integrations from the command line. ![demo](./demo.gif) --- +## Highlights + +- **πŸ§ͺ Test your universal login flow:** Emulate your end users' login experience by running `auth0 test login`. +- **πŸ” Troubleshoot in real-time:** Inspect the events of your Auth0 integration as they happen with the `auth0 logs tail` command +- **πŸ” Simplify repetitive tasks:** Create, update, list and delete your Auth0 resources directly from the terminal. + +--- + ## Table of Contents -- [Features](#features) - [Installation](#installation) -- [Usage](#usage) +- [Authentication](#authentication) +- [Available Commands](#available-commands) - [Customization](#customization) - [Anonymous Analytics](#anonymous-analytics) -- [Contributing](#contributing) -- [Author](#author) --- -## Features - -### πŸ§ͺ Test the login flow at any time - -You can easily test out the Universal Login box of your Auth0 application by running `auth0 test login`. This initiates a login flow in your browser. Once you complete the process, the Auth0 CLI will display your profile information and credentials. - -### ⚑️ Get up and running quickly - -You can also download a QuickStart sample application that’s already configured for your Auth0 application with `auth0 quickstarts download`. Just install the dependencies, and the sample application will be ready to run. Use it as an example integration to help set up Auth0 in your own application. - -### πŸ” Find issues faster - -If you encounter difficulties setting up your integration, use the Auth0 CLI to tail your tenant’s logs for a smoother troubleshooting experience. `auth0 logs tail` will let you inspect the authentication events as they happen. You can easily filter the events from a single Auth0 application with `--filter "client_id:"` and use `--debug` to get the raw error details. - -### πŸ” Simplify repetitive tasks - -With the Auth0 CLI, you can: - -- Manage your Auth0 applications, rules, and APIs right from the terminal. -- Create, update, and delete resources interactively. -- List all your resources or inspect them individually. - ## Installation ### macOS @@ -94,7 +81,7 @@ go install github.com/auth0/auth0-cli/cmd/auth0@latest ## Authentication -Authenticating to your tenant is required for most functions of the CLI. It can be initiated by running: +Authenticating to your Auth0 tenant is required for most functions of the CLI. It can be initiated by running: ```bash auth0 login @@ -108,167 +95,67 @@ There are two ways to authenticate: > **Warning** > Authenticating as a user is not supported for **private cloud** tenants. Instead, those users should authenticate with client credentials. -## Usage - -After installation, you should have the `auth0` command available: - -```bash -auth0 [command] - -# For any help, run --help after a specific command, e.g.: -auth0 [command] --help -``` - -- [auth0 actions](https://auth0.github.io/auth0-cli/auth0_actions.html) - Manage resources for actions -- [auth0 apis](https://auth0.github.io/auth0-cli/auth0_apis.html) - Manage resources for APIs -- [auth0 apps](https://auth0.github.io/auth0-cli/auth0_apps.html) - Manage resources for applications -- [auth0 attack-protection](https://auth0.github.io/auth0-cli/auth0_attack_protection.html) - Manage attack protection settings -- [auth0 branding](https://auth0.github.io/auth0-cli/auth0_branding.html) - Manage branding options -- [auth0 completion](https://auth0.github.io/auth0-cli/auth0_completion.html) - Setup autocomplete features for this CLI on your terminal -- [auth0 ips](https://auth0.github.io/auth0-cli/auth0_ips.html) - Manage blocked IP addresses -- [auth0 login](https://auth0.github.io/auth0-cli/auth0_login.html) - Authenticate the Auth0 CLI -- [auth0 logout](https://auth0.github.io/auth0-cli/auth0_logout.html) - Log out of a tenant's session -- [auth0 logs](https://auth0.github.io/auth0-cli/auth0_logs.html) - View tenant logs -- [auth0 orgs](https://auth0.github.io/auth0-cli/auth0_orgs.html) - Manage resources for organizations -- [auth0 quickstarts](https://auth0.github.io/auth0-cli/auth0_quickstarts.html) - Quickstart support for getting bootstrapped -- [auth0 roles](https://auth0.github.io/auth0-cli/auth0_roles.html) - Manage resources for roles -- [auth0 rules](https://auth0.github.io/auth0-cli/auth0_rules.html) - Manage resources for rules -- [auth0 tenants](https://auth0.github.io/auth0-cli/auth0_tenants.html) - Manage configured tenants -- [auth0 test](https://auth0.github.io/auth0-cli/auth0_test.html) - Try your Universal Login box or get a token -- [auth0 users](https://auth0.github.io/auth0-cli/auth0_users.html) - Manage resources for users - -### Creating an application - -If you haven't created an application yet, you may do so by running the -following command: - -```bash -auth0 apps create -``` - -A screen similar to the following will be presented after successful app creation: - -```bash -$ auth0 apps create - Name: My Awesome App - Description: Test app - Type: Regular Web Application - Callback URLs: http://localhost:3000 - Allowed Logout URLs: http://localhost:3000 - -=== travel0.auth0.com application created - - CLIENT ID wmVzrZkGhKgglMRMvpauORCulBkQ5qeI - NAME My Awesome App - DESCRIPTION Test app - TYPE regular web application - CLIENT SECRET kaS2NR5nk2PcGuITQ8JoKnpVnc5ky1TuKgsb6iTA08ec8XqizqkDupKhEIcsFiNM - CALLBACKS http://localhost:3000 - ALLOWED LOGOUT URLS http://localhost:3000 - ALLOWED ORIGINS - ALLOWED WEB ORIGINS - TOKEN ENDPOINT AUTH - GRANTS implicit, authorization_code, refresh_token, client_credentials - - β–Έ Quickstarts: https://auth0.com/docs/quickstart/webapp - β–Έ Hint: Test this app's login box with 'auth0 test login wmVzrZkGhKgglMRMvpauORCulBkQ5qeI' - β–Έ Hint: You might wanna try 'auth0 quickstarts download wmVzrZkGhKgglMRMvpauORCulBkQ5qeI' -``` - -As you might observe, the next thing to do would likely be to try logging in -using the client ID. - -### Test the login flow - -Whether or not you've created the application using the CLI or the management -dashboard, you'll be able to test logging in using a specific application. - -If you have the client ID, you may pass it as an argument, -otherwise a prompt will be presented: - -```bash -auth0 test login -``` - -### Tail your logs - -Once you have a few logins in place, you might want to tail your logs. This is -done by running the following command: - -```bash -auth0 logs tail -``` - -After running that, one might see the following output: +## Available Commands + +- [auth0 actions](auth0_actions.md) - Manage resources for actions +- [auth0 api](auth0_api.md) - Makes an authenticated HTTP request to the Auth0 Management API +- [auth0 apis](auth0_apis.md) - Manage resources for APIs +- [auth0 apps](auth0_apps.md) - Manage resources for applications +- [auth0 completion](auth0_completion.md) - Setup autocomplete features for this CLI on your terminal +- [auth0 domains](auth0_domains.md) - Manage custom domains +- [auth0 email](auth0_email.md) - Manage email settings +- [auth0 ips](auth0_ips.md) - Manage blocked IP addresses +- [auth0 login](auth0_login.md) - Authenticate the Auth0 CLI +- [auth0 logout](auth0_logout.md) - Log out of a tenant's session +- [auth0 logs](auth0_logs.md) - View tenant logs +- [auth0 orgs](auth0_orgs.md) - Manage resources for organizations +- [auth0 protection](auth0_protection.md) - Manage resources for attack protection +- [auth0 quickstarts](auth0_quickstarts.md) - Quickstart support for getting bootstrapped +- [auth0 roles](auth0_roles.md) - Manage resources for roles +- [auth0 rules](auth0_rules.md) - Manage resources for rules +- [auth0 tenants](auth0_tenants.md) - Manage configured tenants +- [auth0 test](auth0_test.md) - Try your Universal Login box or get a token +- [auth0 universal-login](auth0_universal-login.md) - Manage the Universal Login experience +- [auth0 users](auth0_users.md) - Manage resources for users -``` -Success Login 9 minutes ago Username-Password-Authentic... my awesome app -``` - -If there are errors encountered, such as the following example, you may run it -with the `--debug` flag as follows: - -```bash -auth0 logs tail --debug -``` +## Customization -The full raw data will be displayed below every error: +To change the text editor used for editing templates, rules, and actions, +set the environment variable `EDITOR` to your preferred editor. Example: -``` -Failed Login hello 7 minutes ago N/A my awesome app - - id: "90020210306002808976000921438552554184272624146777636962" - logid: "90020210306002808976000921438552554184272624146777636962" - date: 2021-03-06T00:28:04.91Z - type: f - clientid: vXAtoaFdhlmtWjpIrjb9AUnrGEAOH2MM - clientname: my awesome app - ip: 1.2.3.4 - description: hello - locationinfo: {} - details: - body: - action: default - password: '*****' - state: QXV0aDAgaXMgaGlyaW5nISBhdXRoMC5jb20vY2FyZWVycyAK - username: j.doe@gmail.com - connection: Username-Password-Authentication - error: - message: hello - oauthError: access_denied - type: oauth-authorization - qs: {} - session_id: QXV0aDAgaXMgaGlyaW5nISBhdXRoMC5jb20vY2FyZWVycyAK - userid: auth0|QXV0aDAgaXMgaGlyaW5nISBhdXRoMC5jb20vY2FyZWVycyAK +```shell +export EDITOR="code -w" +# or +export EDITOR="nano" ``` -## Customization +## Anonymized Analytics Disclosure -To change the text editor used for editing templates, rules, and actions, -set the environment variable `EDITOR` to your preferred editor: +Anonymized data points are collected during the use of this CLI. This data includes the CLI version, operating system, timestamp, and other technical details that do not personally identify you. -`export EDITOR="code -w"` +Auth0 uses this data to better understand the usage of this tool to prioritize the features, enhancements and fixes that matter most to our users. -`export EDITOR="nano"` +To **opt-out** of this collection, set the `AUTH0_CLI_ANALYTICS` environment variable to `false`. -## Anonymous Analytics +## Issue Reporting -By default, the CLI tracks some anonymous usage events. This helps us understand how the CLI is being used, so we can continue to improve it. You can opt-out by setting the environment variable `AUTH0_CLI_ANALYTICS` to `false`. +For general support or usage questions, use the [Auth0 Community](https://community.auth0.com/tag/deploy-cli) forums or raise a [support ticket](https://support.auth0.com/). Only [raise an issue](https://github.com/auth0/auth0-deploy-cli/issues) if you have found a bug or want to request a feature. -### Data sent +**Do not report security vulnerabilities on the public GitHub issue tracker.** The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues. -Every event tracked sends the following data along with the event name: +## What is Auth0? -- The CLI version. -- The OS name: as determined by the value of `GOOS`, e.g. `windows`. -- The processor architecture: as determined by the value of `GOARCH`, e.g. `amd64`. -- The install ID: an anonymous UUID that is stored in the CLI's config file. -- A timestamp. +Auth0 helps you to: -## Contributing +- Add authentication with [multiple sources](https://auth0.com/docs/authenticate/identity-providers), either social identity providers such as **Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce** (amongst others), or enterprise identity systems like **Windows Azure AD, Google Apps, Active Directory, ADFS, or any SAML identity provider**. +- Add authentication through more traditional **[username/password databases](https://auth0.com/docs/authenticate/database-connections/custom-db)**. +- Add support for **[linking different user accounts](https://auth0.com/docs/manage-users/user-accounts/user-account-linking)** with the same user. +- Support for generating signed [JSON Web Tokens](https://auth0.com/docs/secure/tokens/json-web-tokens) to call your APIs and **flow the user identity** securely. +- Analytics of how, when, and where users are logging in. +- Pull data from other sources and add it to the user profile through [JavaScript Actions](https://auth0.com/docs/customize/actions). -Please check the [contributing guidelines](CONTRIBUTING.md). +**Why Auth0?** Because you should save time, be happy, and focus on what really matters: building your product. -## Author +## License -[Auth0](https://auth0.com) +This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more information. From c4d4adeec383820f9aa38f6f47865c5736033fee Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:13:05 -0500 Subject: [PATCH 2/9] Targeting main branch before we forget to change back --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e853d9b51..727b1f087 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

Auth0 CLI

-[![Release](https://img.shields.io/github/v/release/auth0/auth0-cli?include_prereleases&style=flat-square)](https://github.com/auth0/auth0-cli/releases) [![Build Status](https://img.shields.io/github/actions/workflow/status/auth0/auth0-cli/go.yml?branch=v1)](https://github.com/auth0/auth0-cli/actions?query=branch%3Amain) [![Go Report Card](https://goreportcard.com/badge/github.com/auth0/auth0-cli?style=flat-square)](https://goreportcard.com/report/github.com/auth0/auth0-cli) [![License](https://img.shields.io/github/license/auth0/auth0-cli.svg?style=flat-square)](https://github.com/auth0/auth0-cli/blob/main/LICENSE) +[![Release](https://img.shields.io/github/v/release/auth0/auth0-cli?include_prereleases&style=flat-square)](https://github.com/auth0/auth0-cli/releases) [![Build Status](https://img.shields.io/github/actions/workflow/status/auth0/auth0-cli/go.yml?branch=main)](https://github.com/auth0/auth0-cli/actions?query=branch%3Amain) [![Go Report Card](https://goreportcard.com/badge/github.com/auth0/auth0-cli?style=flat-square)](https://goreportcard.com/report/github.com/auth0/auth0-cli) [![License](https://img.shields.io/github/license/auth0/auth0-cli.svg?style=flat-square)](https://github.com/auth0/auth0-cli/blob/main/LICENSE)
@@ -56,7 +56,7 @@ Install via [cURL](https://curl.se/): ```bash # Binary will be downloaded to "./auth0". -curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/v1/install.sh | sh -s -- -b . +curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | sh -s -- -b . ``` ### Manual From ddcf1168ac5ee1f83a182439fb51876f78cb0280 Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:17:02 -0500 Subject: [PATCH 3/9] Fixing link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 727b1f087..4c5a3b3f4 100644 --- a/README.md +++ b/README.md @@ -139,7 +139,7 @@ To **opt-out** of this collection, set the `AUTH0_CLI_ANALYTICS` environment var ## Issue Reporting -For general support or usage questions, use the [Auth0 Community](https://community.auth0.com/tag/deploy-cli) forums or raise a [support ticket](https://support.auth0.com/). Only [raise an issue](https://github.com/auth0/auth0-deploy-cli/issues) if you have found a bug or want to request a feature. +For general support or usage questions, use the [Auth0 Community](https://community.auth0.com/) forums or raise a [support ticket](https://support.auth0.com/). Only [raise an issue](https://github.com/auth0/auth0-cli/issues) if you have found a bug or want to request a feature. **Do not report security vulnerabilities on the public GitHub issue tracker.** The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues. From 48f27e34bfbb21d33f35f5d1c9b50fde0e2756b9 Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:24:30 -0500 Subject: [PATCH 4/9] Removing redundant header, removing line breaks --- README.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/README.md b/README.md index 4c5a3b3f4..c67f4dc07 100644 --- a/README.md +++ b/README.md @@ -5,22 +5,16 @@ -# Auth0 CLI - Build, manage and test your [Auth0](http://auth0.com/) integrations from the command line. ![demo](./demo.gif) ---- - ## Highlights - **πŸ§ͺ Test your universal login flow:** Emulate your end users' login experience by running `auth0 test login`. - **πŸ” Troubleshoot in real-time:** Inspect the events of your Auth0 integration as they happen with the `auth0 logs tail` command - **πŸ” Simplify repetitive tasks:** Create, update, list and delete your Auth0 resources directly from the terminal. ---- - ## Table of Contents - [Installation](#installation) @@ -29,8 +23,6 @@ Build, manage and test your [Auth0](http://auth0.com/) integrations from the com - [Customization](#customization) - [Anonymous Analytics](#anonymous-analytics) ---- - ## Installation ### macOS From 4a001408c31b65008940fad50b332a425e076c93 Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:25:33 -0500 Subject: [PATCH 5/9] Fixing documentation links --- README.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index c67f4dc07..5c1759599 100644 --- a/README.md +++ b/README.md @@ -89,26 +89,26 @@ There are two ways to authenticate: ## Available Commands -- [auth0 actions](auth0_actions.md) - Manage resources for actions -- [auth0 api](auth0_api.md) - Makes an authenticated HTTP request to the Auth0 Management API -- [auth0 apis](auth0_apis.md) - Manage resources for APIs -- [auth0 apps](auth0_apps.md) - Manage resources for applications -- [auth0 completion](auth0_completion.md) - Setup autocomplete features for this CLI on your terminal -- [auth0 domains](auth0_domains.md) - Manage custom domains -- [auth0 email](auth0_email.md) - Manage email settings -- [auth0 ips](auth0_ips.md) - Manage blocked IP addresses -- [auth0 login](auth0_login.md) - Authenticate the Auth0 CLI -- [auth0 logout](auth0_logout.md) - Log out of a tenant's session -- [auth0 logs](auth0_logs.md) - View tenant logs -- [auth0 orgs](auth0_orgs.md) - Manage resources for organizations -- [auth0 protection](auth0_protection.md) - Manage resources for attack protection -- [auth0 quickstarts](auth0_quickstarts.md) - Quickstart support for getting bootstrapped -- [auth0 roles](auth0_roles.md) - Manage resources for roles -- [auth0 rules](auth0_rules.md) - Manage resources for rules -- [auth0 tenants](auth0_tenants.md) - Manage configured tenants -- [auth0 test](auth0_test.md) - Try your Universal Login box or get a token -- [auth0 universal-login](auth0_universal-login.md) - Manage the Universal Login experience -- [auth0 users](auth0_users.md) - Manage resources for users +- [auth0 actions](https://auth0.github.io/auth0-cli/auth0_actions.html) - Manage resources for actions +- [auth0 api](https://auth0.github.io/auth0-cli/auth0_api.html) - Makes an authenticated HTTP request to the Auth0 Management API +- [auth0 apis](https://auth0.github.io/auth0-cli/auth0_apis.html) - Manage resources for APIs +- [auth0 apps](https://auth0.github.io/auth0-cli/auth0_apps.html) - Manage resources for applications +- [auth0 completion](https://auth0.github.io/auth0-cli/auth0_completion.html) - Setup autocomplete features for this CLI on your terminal +- [auth0 domains](https://auth0.github.io/auth0-cli/auth0_domains.html) - Manage custom domains +- [auth0 email](https://auth0.github.io/auth0-cli/auth0_email.html) - Manage email settings +- [auth0 ips](https://auth0.github.io/auth0-cli/auth0_ips.html) - Manage blocked IP addresses +- [auth0 login](https://auth0.github.io/auth0-cli/auth0_login.html) - Authenticate the Auth0 CLI +- [auth0 logout](https://auth0.github.io/auth0-cli/auth0_logout.html) - Log out of a tenant's session +- [auth0 logs](https://auth0.github.io/auth0-cli/auth0_logs.html) - View tenant logs +- [auth0 orgs](https://auth0.github.io/auth0-cli/auth0_orgs.html) - Manage resources for organizations +- [auth0 protection](https://auth0.github.io/auth0-cli/auth0_protection.html) - Manage resources for attack protection +- [auth0 quickstarts](https://auth0.github.io/auth0-cli/auth0_quickstarts.html) - Quickstart support for getting bootstrapped +- [auth0 roles](https://auth0.github.io/auth0-cli/auth0_roles.html) - Manage resources for roles +- [auth0 rules](https://auth0.github.io/auth0-cli/auth0_rules.html) - Manage resources for rules +- [auth0 tenants](https://auth0.github.io/auth0-cli/auth0_tenants.html) - Manage configured tenants +- [auth0 test](https://auth0.github.io/auth0-cli/auth0_test.html) - Try your Universal Login box or get a token +- [auth0 universal-login](https://auth0.github.io/auth0-cli/auth0_universal-login.html) - Manage the Universal Login experience +- [auth0 users](https://auth0.github.io/auth0-cli/auth0_users.html) - Manage resources for users ## Customization From 54611177c2c0b7ca6e9e895aa4d80998a0e620db Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:40:00 -0500 Subject: [PATCH 6/9] Adding period --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c1759599..a166e6ce3 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Build, manage and test your [Auth0](http://auth0.com/) integrations from the com ## Highlights - **πŸ§ͺ Test your universal login flow:** Emulate your end users' login experience by running `auth0 test login`. -- **πŸ” Troubleshoot in real-time:** Inspect the events of your Auth0 integration as they happen with the `auth0 logs tail` command +- **πŸ” Troubleshoot in real-time:** Inspect the events of your Auth0 integration as they happen with the `auth0 logs tail` command. - **πŸ” Simplify repetitive tasks:** Create, update, list and delete your Auth0 resources directly from the terminal. ## Table of Contents From e03002e22972268080eabbdbe533fdad51f0a2d4 Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:42:41 -0500 Subject: [PATCH 7/9] Updating catchphrase --- .goreleaser.yml | 61 ++++++++++++++++++++++---------------------- docs/_config.yml | 5 ++-- internal/cli/root.go | 2 +- 3 files changed, 33 insertions(+), 35 deletions(-) diff --git a/.goreleaser.yml b/.goreleaser.yml index f69cbccdf..016089a9f 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -1,17 +1,17 @@ # Documentation at http://goreleaser.com builds: -- main: ./cmd/auth0 - env: - - CGO_ENABLED=0 - goarch: - - amd64 - - arm64 - goos: - - darwin - - linux - - windows - binary: auth0 - ldflags: + - main: ./cmd/auth0 + env: + - CGO_ENABLED=0 + goarch: + - amd64 + - arm64 + goos: + - darwin + - linux + - windows + binary: auth0 + ldflags: - -X 'github.com/auth0/auth0-cli/internal/buildinfo.Version={{.Version}}' - -X 'github.com/auth0/auth0-cli/internal/buildinfo.Revision={{.Commit}}' - -X 'github.com/auth0/auth0-cli/internal/buildinfo.BuildUser=goreleaser' @@ -40,8 +40,7 @@ changelog: - "^docs:" - "^test:" brews: - - - name: auth0 + - name: auth0 tap: owner: auth0 name: homebrew-auth0-cli @@ -49,27 +48,27 @@ brews: name: auth0 email: support@auth0.com homepage: https://auth0.github.io/auth0-cli - description: Auth0 command-line tool to supercharge your developer workflow + description: Build, manage and test your Auth0 integrations from the command line license: MIT skip_upload: auto install: | - bin.install "auth0" + bin.install "auth0" - (bash_completion/"auth0").write `#{bin}/auth0 completion bash` - (fish_completion/"auth0.fish").write `#{bin}/auth0 completion fish` - (zsh_completion/"_auth0").write `#{bin}/auth0 completion zsh` + (bash_completion/"auth0").write `#{bin}/auth0 completion bash` + (fish_completion/"auth0.fish").write `#{bin}/auth0 completion fish` + (zsh_completion/"_auth0").write `#{bin}/auth0 completion zsh` caveats: "Thanks for installing the Auth0 CLI" scoop: + name: auth0 + bucket: + owner: auth0 + name: scoop-auth0-cli + commit_author: name: auth0 - bucket: - owner: auth0 - name: scoop-auth0-cli - commit_author: - name: auth0 - email: support@auth0.com - commit_msg_template: "Scoop manifest update for {{ .ProjectName }} version {{ .Tag }}" - homepage: https://auth0.github.io/auth0-cli - description: Auth0 command-line tool to supercharge your developer workflow - license: MIT - skip_upload: auto - post_install: ["Write-Host 'Thanks for installing the Auth0 CLI'"] + email: support@auth0.com + commit_msg_template: "Scoop manifest update for {{ .ProjectName }} version {{ .Tag }}" + homepage: https://auth0.github.io/auth0-cli + description: Build, manage and test your Auth0 integrations from the command line + license: MIT + skip_upload: auto + post_install: ["Write-Host 'Thanks for installing the Auth0 CLI'"] diff --git a/docs/_config.yml b/docs/_config.yml index 2a057ad1c..268e798b3 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -3,15 +3,14 @@ title: Auth0 CLI description: >- - auth0 is the command line to supercharge your development workflow. + Build, manage and test your Auth0 integrations from the command line. baseurl: "/auth0-cli" url: "" # the base hostname & protocol for your site, e.g. http://example.com twitter_username: auth0 -github_username: auth0 +github_username: auth0 # Build settings theme: minima header_pages: - about.markdown - diff --git a/internal/cli/root.go b/internal/cli/root.go index f3df231fb..d637526f7 100644 --- a/internal/cli/root.go +++ b/internal/cli/root.go @@ -17,7 +17,7 @@ import ( "github.com/auth0/auth0-cli/internal/instrumentation" ) -const rootShort = "Supercharge your development workflow." +const rootShort = "Build, manage and test your Auth0 integrations from the command line." // Execute is the primary entrypoint of the CLI app. func Execute() { From b1ad7ff1f1cfac680683317aa4fab4a379cb7f3e Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Tue, 20 Dec 2022 07:32:07 -0500 Subject: [PATCH 8/9] Regenerating docs --- docs/auth0_actions.md | 2 +- docs/auth0_api.md | 2 +- docs/auth0_apis.md | 2 +- docs/auth0_apps.md | 2 +- docs/auth0_completion.md | 2 +- docs/auth0_domains.md | 2 +- docs/auth0_email.md | 2 +- docs/auth0_ips.md | 2 +- docs/auth0_login.md | 2 +- docs/auth0_logout.md | 2 +- docs/auth0_logs.md | 2 +- docs/auth0_orgs.md | 2 +- docs/auth0_protection.md | 2 +- docs/auth0_quickstarts.md | 2 +- docs/auth0_roles.md | 2 +- docs/auth0_rules.md | 2 +- docs/auth0_tenants.md | 2 +- docs/auth0_test.md | 2 +- docs/auth0_universal-login.md | 2 +- docs/auth0_users.md | 2 +- 20 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/auth0_actions.md b/docs/auth0_actions.md index 4a071dc39..0635a3ab7 100644 --- a/docs/auth0_actions.md +++ b/docs/auth0_actions.md @@ -26,7 +26,7 @@ Manage resources for actions. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 actions create](auth0_actions_create.md) - Create a new action * [auth0 actions delete](auth0_actions_delete.md) - Delete an action * [auth0 actions deploy](auth0_actions_deploy.md) - Deploy an action diff --git a/docs/auth0_api.md b/docs/auth0_api.md index e1b86c3ce..c5ba5da7e 100644 --- a/docs/auth0_api.md +++ b/docs/auth0_api.md @@ -52,5 +52,5 @@ cat data.json | auth0 api post clients ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. diff --git a/docs/auth0_apis.md b/docs/auth0_apis.md index 704c3f7de..1559cff39 100644 --- a/docs/auth0_apis.md +++ b/docs/auth0_apis.md @@ -26,7 +26,7 @@ Manage resources for APIs. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 apis create](auth0_apis_create.md) - Create a new API * [auth0 apis delete](auth0_apis_delete.md) - Delete an API * [auth0 apis list](auth0_apis_list.md) - List your APIs diff --git a/docs/auth0_apps.md b/docs/auth0_apps.md index d22ccbcc0..fe9c3771e 100644 --- a/docs/auth0_apps.md +++ b/docs/auth0_apps.md @@ -26,7 +26,7 @@ Manage resources for applications. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 apps create](auth0_apps_create.md) - Create a new application * [auth0 apps delete](auth0_apps_delete.md) - Delete an application * [auth0 apps list](auth0_apps_list.md) - List your applications diff --git a/docs/auth0_completion.md b/docs/auth0_completion.md index 483d985f1..39753dd78 100644 --- a/docs/auth0_completion.md +++ b/docs/auth0_completion.md @@ -70,5 +70,5 @@ auth0 completion ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. diff --git a/docs/auth0_domains.md b/docs/auth0_domains.md index fff6186ad..4630e987d 100644 --- a/docs/auth0_domains.md +++ b/docs/auth0_domains.md @@ -26,7 +26,7 @@ Manage custom domains. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 domains create](auth0_domains_create.md) - Create a custom domain * [auth0 domains delete](auth0_domains_delete.md) - Delete a custom domain * [auth0 domains list](auth0_domains_list.md) - List your custom domains diff --git a/docs/auth0_email.md b/docs/auth0_email.md index d92edc06c..f8dbfbaea 100644 --- a/docs/auth0_email.md +++ b/docs/auth0_email.md @@ -26,6 +26,6 @@ Manage email settings. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 email templates](auth0_email_templates.md) - Manage custom email templates diff --git a/docs/auth0_ips.md b/docs/auth0_ips.md index 7a5573542..0705a9573 100644 --- a/docs/auth0_ips.md +++ b/docs/auth0_ips.md @@ -26,7 +26,7 @@ Manage blocked IP addresses. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 ips check](auth0_ips_check.md) - Check IP address * [auth0 ips unblock](auth0_ips_unblock.md) - Unblock IP address diff --git a/docs/auth0_login.md b/docs/auth0_login.md index ae16295eb..ad73450fd 100644 --- a/docs/auth0_login.md +++ b/docs/auth0_login.md @@ -44,5 +44,5 @@ auth0 login --scopes "read:client_grants,create:client_grants" ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. diff --git a/docs/auth0_logout.md b/docs/auth0_logout.md index 236694e65..91be74245 100644 --- a/docs/auth0_logout.md +++ b/docs/auth0_logout.md @@ -36,5 +36,5 @@ auth0 logout ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. diff --git a/docs/auth0_logs.md b/docs/auth0_logs.md index 6c3dc4c76..119108a69 100644 --- a/docs/auth0_logs.md +++ b/docs/auth0_logs.md @@ -26,7 +26,7 @@ View tenant logs. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 logs list](auth0_logs_list.md) - Show the application logs * [auth0 logs streams](auth0_logs_streams.md) - Manage resources for log streams * [auth0 logs tail](auth0_logs_tail.md) - Tail the tenant logs diff --git a/docs/auth0_orgs.md b/docs/auth0_orgs.md index e428363c5..890849142 100644 --- a/docs/auth0_orgs.md +++ b/docs/auth0_orgs.md @@ -26,7 +26,7 @@ Manage resources for organizations. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 orgs create](auth0_orgs_create.md) - Create a new organization * [auth0 orgs delete](auth0_orgs_delete.md) - Delete an organization * [auth0 orgs list](auth0_orgs_list.md) - List your organizations diff --git a/docs/auth0_protection.md b/docs/auth0_protection.md index 85ccb8f97..baad260ec 100644 --- a/docs/auth0_protection.md +++ b/docs/auth0_protection.md @@ -26,7 +26,7 @@ Manage resources for attack protection. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 protection breached-password-detection](auth0_protection_breached-password-detection.md) - Manage breached password detection settings * [auth0 protection brute-force-protection](auth0_protection_brute-force-protection.md) - Manage brute force protection settings * [auth0 protection suspicious-ip-throttling](auth0_protection_suspicious-ip-throttling.md) - Manage suspicious ip throttling settings diff --git a/docs/auth0_quickstarts.md b/docs/auth0_quickstarts.md index b88195a4e..23344fb3b 100644 --- a/docs/auth0_quickstarts.md +++ b/docs/auth0_quickstarts.md @@ -26,7 +26,7 @@ Step-by-step guides to quickly integrate Auth0 into your application. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 quickstarts download](auth0_quickstarts_download.md) - Download a Quickstart sample app for a specific tech stack * [auth0 quickstarts list](auth0_quickstarts_list.md) - List the available Quickstarts diff --git a/docs/auth0_roles.md b/docs/auth0_roles.md index e15340c3b..a58bc87fa 100644 --- a/docs/auth0_roles.md +++ b/docs/auth0_roles.md @@ -26,7 +26,7 @@ Manage resources for roles. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 roles create](auth0_roles_create.md) - Create a new role * [auth0 roles delete](auth0_roles_delete.md) - Delete a role * [auth0 roles list](auth0_roles_list.md) - List your roles diff --git a/docs/auth0_rules.md b/docs/auth0_rules.md index bce10afbe..d40eb4f54 100644 --- a/docs/auth0_rules.md +++ b/docs/auth0_rules.md @@ -26,7 +26,7 @@ Manage resources for rules. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 rules create](auth0_rules_create.md) - Create a new rule * [auth0 rules delete](auth0_rules_delete.md) - Delete a rule * [auth0 rules disable](auth0_rules_disable.md) - Disable a rule diff --git a/docs/auth0_tenants.md b/docs/auth0_tenants.md index af330cb4e..e35e015dc 100644 --- a/docs/auth0_tenants.md +++ b/docs/auth0_tenants.md @@ -26,7 +26,7 @@ Manage configured tenants. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 tenants list](auth0_tenants_list.md) - List your tenants * [auth0 tenants open](auth0_tenants_open.md) - Open tenant settings page in the Auth0 Dashboard * [auth0 tenants use](auth0_tenants_use.md) - Set the active tenant diff --git a/docs/auth0_test.md b/docs/auth0_test.md index 49f93072f..d995264ca 100644 --- a/docs/auth0_test.md +++ b/docs/auth0_test.md @@ -26,7 +26,7 @@ Try your Universal Login box or get a token. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 test login](auth0_test_login.md) - Try out your Universal Login box * [auth0 test token](auth0_test_token.md) - Fetch a token for the given application and API diff --git a/docs/auth0_universal-login.md b/docs/auth0_universal-login.md index bb8a97b02..42bc846bc 100644 --- a/docs/auth0_universal-login.md +++ b/docs/auth0_universal-login.md @@ -26,7 +26,7 @@ Manage a consistent, branded Universal Login experience that can handle all of y ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 universal-login prompts](auth0_universal-login_prompts.md) - Manage custom text for prompts * [auth0 universal-login show](auth0_universal-login_show.md) - Display the custom branding settings for Universal Login * [auth0 universal-login templates](auth0_universal-login_templates.md) - Manage custom Universal Login templates diff --git a/docs/auth0_users.md b/docs/auth0_users.md index 62c6e5c8a..ca9202f2c 100644 --- a/docs/auth0_users.md +++ b/docs/auth0_users.md @@ -26,7 +26,7 @@ Manage resources for users. ### SEE ALSO -* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. * [auth0 users blocks](auth0_users_blocks.md) - Manage brute-force protection user blocks * [auth0 users create](auth0_users_create.md) - Create a new user * [auth0 users delete](auth0_users_delete.md) - Delete a user From 8d90ca081c8bf76f7533561d89ade88fbc3d87e7 Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Tue, 20 Dec 2022 07:33:19 -0500 Subject: [PATCH 9/9] Regenerating docs --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index f18de95d3..aee38fc24 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,7 +3,7 @@ layout: home --- ## auth0 -Supercharge your development workflow. +Build, manage and test your Auth0 integrations from the command line. ### Options