Skip to content

Commit 022a5b9

Browse files
duedares-rvjduedares-rvj
committed
Added docs and lint
1 parent 9d1bc90 commit 022a5b9

32 files changed

Lines changed: 1558 additions & 0 deletions

‎docs/auth0_experiments.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
layout: default
3+
has_toc: false
4+
has_children: true
5+
---
6+
# auth0 experiments
7+
8+
Experiments run A/B tests by tying a feature flag, its variations, and traffic allocations together.
9+
10+
Typical workflow:
11+
1. Create a feature flag and its variations
12+
2. Optionally create segments for targeted allocation
13+
3. Create an experiment
14+
4. Validate it
15+
5. Start it
16+
17+
## Commands
18+
19+
- [auth0 experiments archive](auth0_experiments_archive.md) - Archive an experiment
20+
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
21+
- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
22+
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
23+
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
24+
- [auth0 experiments pause](auth0_experiments_pause.md) - Pause an experiment
25+
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
26+
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
27+
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
28+
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment
29+

‎docs/auth0_experiments_archive.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: default
3+
parent: auth0 experiments
4+
has_toc: false
5+
---
6+
# auth0 experiments archive
7+
8+
Archive a completed experiment.
9+
10+
## Usage
11+
```
12+
auth0 experiments archive [flags]
13+
```
14+
15+
## Examples
16+
17+
```
18+
auth0 experiments archive
19+
auth0 experiments archive <experiment-id>
20+
```
21+
22+
23+
24+
25+
## Inherited Flags
26+
27+
```
28+
--debug Enable debug mode.
29+
--no-color Disable colors.
30+
--no-input Disable interactivity.
31+
--tenant string Specific tenant to use.
32+
```
33+
34+
35+
## Related Commands
36+
37+
- [auth0 experiments archive](auth0_experiments_archive.md) - Archive an experiment
38+
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
39+
- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
40+
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
41+
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
42+
- [auth0 experiments pause](auth0_experiments_pause.md) - Pause an experiment
43+
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
44+
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
45+
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
46+
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment
47+
48+

‎docs/auth0_experiments_complete.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: default
3+
parent: auth0 experiments
4+
has_toc: false
5+
---
6+
# auth0 experiments complete
7+
8+
Mark an experiment as completed. It can then be archived.
9+
10+
## Usage
11+
```
12+
auth0 experiments complete [flags]
13+
```
14+
15+
## Examples
16+
17+
```
18+
auth0 experiments complete
19+
auth0 experiments complete <experiment-id>
20+
```
21+
22+
23+
24+
25+
## Inherited Flags
26+
27+
```
28+
--debug Enable debug mode.
29+
--no-color Disable colors.
30+
--no-input Disable interactivity.
31+
--tenant string Specific tenant to use.
32+
```
33+
34+
35+
## Related Commands
36+
37+
- [auth0 experiments archive](auth0_experiments_archive.md) - Archive an experiment
38+
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
39+
- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
40+
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
41+
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
42+
- [auth0 experiments pause](auth0_experiments_pause.md) - Pause an experiment
43+
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
44+
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
45+
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
46+
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment
47+
48+

‎docs/auth0_experiments_create.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
layout: default
3+
parent: auth0 experiments
4+
has_toc: false
5+
---
6+
# auth0 experiments create
7+
8+
Create a new experiment.
9+
10+
To create interactively, use `auth0 experiments create` with no flags.
11+
12+
To create non-interactively, supply all required flags.
13+
14+
## Usage
15+
```
16+
auth0 experiments create [flags]
17+
```
18+
19+
## Examples
20+
21+
```
22+
auth0 experiments create
23+
auth0 experiments create --name "button-color" --feature-flag-id ff_abc --authentication-flow login --allocation-strategy percentage --allocations '[{"variation_id":"vid_1","weight":0.5,"is_control":true},{"variation_id":"vid_2","weight":0.5,"is_control":false}]'
24+
```
25+
26+
27+
## Flags
28+
29+
```
30+
-s, --allocation-strategy string Allocation strategy: percentage or segment.
31+
-A, --allocations string Allocations as JSON array. Example: '[{"variation_id":"vid","weight":1.0,"is_control":true}]'
32+
-a, --authentication-flow string Authentication flow this experiment applies to (e.g. login, signup).
33+
-d, --description string Description of the experiment.
34+
-f, --feature-flag-id string ID of the feature flag to experiment on.
35+
--json Output in json format.
36+
--json-compact Output in compact json format.
37+
-n, --name string Name of the experiment.
38+
```
39+
40+
41+
## Inherited Flags
42+
43+
```
44+
--debug Enable debug mode.
45+
--no-color Disable colors.
46+
--no-input Disable interactivity.
47+
--tenant string Specific tenant to use.
48+
```
49+
50+
51+
## Related Commands
52+
53+
- [auth0 experiments archive](auth0_experiments_archive.md) - Archive an experiment
54+
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
55+
- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
56+
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
57+
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
58+
- [auth0 experiments pause](auth0_experiments_pause.md) - Pause an experiment
59+
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
60+
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
61+
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
62+
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment
63+
64+

‎docs/auth0_experiments_delete.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
layout: default
3+
parent: auth0 experiments
4+
has_toc: false
5+
---
6+
# auth0 experiments delete
7+
8+
Delete an experiment.
9+
10+
Active experiments must be paused or completed before deleting.
11+
12+
To delete non-interactively, supply the experiment ID and use `--force` to skip confirmation.
13+
14+
## Usage
15+
```
16+
auth0 experiments delete [flags]
17+
```
18+
19+
## Examples
20+
21+
```
22+
auth0 experiments delete
23+
auth0 experiments delete <experiment-id>
24+
auth0 experiments delete <experiment-id> --force
25+
```
26+
27+
28+
## Flags
29+
30+
```
31+
--force Skip confirmation.
32+
```
33+
34+
35+
## Inherited Flags
36+
37+
```
38+
--debug Enable debug mode.
39+
--no-color Disable colors.
40+
--no-input Disable interactivity.
41+
--tenant string Specific tenant to use.
42+
```
43+
44+
45+
## Related Commands
46+
47+
- [auth0 experiments archive](auth0_experiments_archive.md) - Archive an experiment
48+
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
49+
- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
50+
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
51+
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
52+
- [auth0 experiments pause](auth0_experiments_pause.md) - Pause an experiment
53+
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
54+
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
55+
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
56+
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment
57+
58+

‎docs/auth0_experiments_list.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
layout: default
3+
parent: auth0 experiments
4+
has_toc: false
5+
---
6+
# auth0 experiments list
7+
8+
List all experiments. To create one, run: `auth0 experiments create`.
9+
10+
## Usage
11+
```
12+
auth0 experiments list [flags]
13+
```
14+
15+
## Examples
16+
17+
```
18+
auth0 experiments list
19+
auth0 experiments ls
20+
auth0 experiments list --json
21+
auth0 experiments list --status active
22+
auth0 experiments list --feature-flag-id <id>
23+
```
24+
25+
26+
## Flags
27+
28+
```
29+
--authentication-flow string Filter by authentication flow.
30+
--csv Output in csv format.
31+
--feature-flag-id string Filter by feature flag ID.
32+
--json Output in json format.
33+
--json-compact Output in compact json format.
34+
--status string Filter by status (draft, active, paused, completed, archived).
35+
```
36+
37+
38+
## Inherited Flags
39+
40+
```
41+
--debug Enable debug mode.
42+
--no-color Disable colors.
43+
--no-input Disable interactivity.
44+
--tenant string Specific tenant to use.
45+
```
46+
47+
48+
## Related Commands
49+
50+
- [auth0 experiments archive](auth0_experiments_archive.md) - Archive an experiment
51+
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
52+
- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
53+
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
54+
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
55+
- [auth0 experiments pause](auth0_experiments_pause.md) - Pause an experiment
56+
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
57+
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
58+
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
59+
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment
60+
61+

‎docs/auth0_experiments_pause.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: default
3+
parent: auth0 experiments
4+
has_toc: false
5+
---
6+
# auth0 experiments pause
7+
8+
Pause a running experiment. It can be resumed with `auth0 experiments start`.
9+
10+
## Usage
11+
```
12+
auth0 experiments pause [flags]
13+
```
14+
15+
## Examples
16+
17+
```
18+
auth0 experiments pause
19+
auth0 experiments pause <experiment-id>
20+
```
21+
22+
23+
24+
25+
## Inherited Flags
26+
27+
```
28+
--debug Enable debug mode.
29+
--no-color Disable colors.
30+
--no-input Disable interactivity.
31+
--tenant string Specific tenant to use.
32+
```
33+
34+
35+
## Related Commands
36+
37+
- [auth0 experiments archive](auth0_experiments_archive.md) - Archive an experiment
38+
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
39+
- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
40+
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
41+
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
42+
- [auth0 experiments pause](auth0_experiments_pause.md) - Pause an experiment
43+
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
44+
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
45+
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
46+
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment
47+
48+

0 commit comments

Comments
 (0)