Skip to content

Commit e476379

Browse files
committed
build: test cases added, docs updated
1 parent 902aacd commit e476379

2 files changed

Lines changed: 2306 additions & 10 deletions

File tree

docs/auth0_quickstarts_setup-experimental.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@ has_toc: false
55
---
66
# auth0 quickstarts setup-experimental
77

8-
Creates an Auth0 application and generates a .env file with the necessary configuration.
8+
Creates an Auth0 application and/or API and generates a config file with the necessary Auth0 settings.
99

1010
The command will:
1111
1. Check if you are authenticated (and prompt for login if needed)
12-
2. Create an Auth0 application based on the specified type
13-
3. Generate a .env file with the appropriate environment variables
12+
2. Auto-detect your project framework from the current directory
13+
3. Create an Auth0 application and/or API resource server
14+
4. Generate a config file with the appropriate environment variables
1415

15-
Supported types are dynamically loaded from the `QuickstartConfigs` map in the codebase.
16+
Supported frameworks are dynamically loaded from the QuickstartConfigs map.
1617

1718
## Usage
1819
```
@@ -22,18 +23,32 @@ auth0 quickstarts setup-experimental [flags]
2223
## Examples
2324

2425
```
25-
auth0 quickstarts setup-experimental --type spa:react:vite
26-
auth0 quickstarts setup-experimental --type regular:nextjs:none
27-
auth0 quickstarts setup-experimental --type native:react-native:none
26+
auth0 quickstarts setup-experimental
27+
auth0 quickstarts setup-experimental --app --framework react --type spa
28+
auth0 quickstarts setup-experimental --api --identifier https://my-api
29+
auth0 quickstarts setup-experimental --app --api --name "My App"
2830
```
2931

3032

3133
## Flags
3234

3335
```
34-
--name string Name of the Auth0 application
35-
--port int Port number for the application
36-
--type string Type of the quickstart application (e.g., spa:react:vite, regular:nextjs:none)
36+
--api Create an Auth0 API resource server
37+
--app Create an Auth0 application (SPA, regular web, or native)
38+
--audience string Alias for --identifier (unique audience URL for the API)
39+
--build-tool string Build tool used by the project (vite, webpack, cra, none) (default "none")
40+
--callback-url string Override the allowed callback URL for the application
41+
--framework string Framework to configure (e.g., react, nextjs, vue, express)
42+
--identifier string Unique URL identifier for the API (audience), e.g. https://my-api
43+
--logout-url string Override the allowed logout URL for the application
44+
--name string Name of the Auth0 application
45+
--offline-access Allow offline access (enables refresh tokens)
46+
--port int Local port the application runs on (default varies by framework, e.g. 3000, 5173)
47+
--scopes string Comma-separated list of permission scopes for the API
48+
--signing-alg string Token signing algorithm: RS256, PS256, or HS256 (leave blank to be prompted interactively)
49+
--token-lifetime string Access token lifetime in seconds (default: 86400 = 24 hours) (default "86400")
50+
--type string Application type: spa, regular, or native
51+
--web-origin-url string Override the allowed web origin URL for the application
3752
```
3853

3954

0 commit comments

Comments
 (0)