Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/auth0_experiments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
layout: default
has_toc: false
has_children: true
---
# auth0 experiments

Experiments run A/B tests by tying a feature flag, its variations, and traffic allocations together.

Typical workflow:
1. Create a feature flag and its variations
2. Optionally create segments for targeted allocation
3. Create an experiment
4. Validate it
5. Start it

## Commands

- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments status](auth0_experiments_status.md) - Change an experiment's status
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment

62 changes: 62 additions & 0 deletions docs/auth0_experiments_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
layout: default
parent: auth0 experiments
has_toc: false
---
# auth0 experiments create

Create a new experiment.

To create interactively, use `auth0 experiments create` with no flags.

To create non-interactively, supply all required flags.

## Usage
```
auth0 experiments create [flags]
```

## Examples

```
auth0 experiments create
auth0 experiments create --name "button-color" --feature-flag-id ff_abc --authentication-flow login --allocation-strategy percentage --assignment-config '{"subject":"device"}' --allocations '[{"variation_id":"vid_1","weight":50,"is_control":true},{"variation_id":"vid_2","weight":50,"is_control":false}]'
```


## Flags

```
-s, --allocation-strategy string Allocation strategy: percentage or segment.
--allocations string JSON array of allocation items ({variation_id, weight, is_control} for percentage, where weight is an integer percentage from 1 to 100; {variation_id, segment_id, is_control} for segment).
--assignment-config string JSON object configuring how users are assigned to variations (e.g. '{"subject":"device"}').
-a, --authentication-flow string Authentication flow this experiment applies to (e.g. login, signup).
-d, --description string Description of the experiment.
-f, --feature-flag-id string ID of the feature flag to experiment on.
--json Output in json format.
--json-compact Output in compact json format.
-n, --name string Name of the experiment.
```


## Inherited Flags

```
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments status](auth0_experiments_status.md) - Change an experiment's status
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment


55 changes: 55 additions & 0 deletions docs/auth0_experiments_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
layout: default
parent: auth0 experiments
has_toc: false
---
# auth0 experiments delete

Delete an experiment.

Active experiments must be paused or completed before deleting.

To delete non-interactively, supply the experiment ID and use `--force` to skip confirmation.

## Usage
```
auth0 experiments delete [flags]
```

## Examples

```
auth0 experiments delete
auth0 experiments delete <experiment-id>
auth0 experiments delete <experiment-id> --force
```


## Flags

```
--force Skip confirmation.
```


## Inherited Flags

```
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments status](auth0_experiments_status.md) - Change an experiment's status
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment


58 changes: 58 additions & 0 deletions docs/auth0_experiments_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
layout: default
parent: auth0 experiments
has_toc: false
---
# auth0 experiments list

List all experiments. To create one, run: `auth0 experiments create`.

## Usage
```
auth0 experiments list [flags]
```

## Examples

```
auth0 experiments list
auth0 experiments ls
auth0 experiments list --json
auth0 experiments list --status active
auth0 experiments list --feature-flag-id <id>
```


## Flags

```
--authentication-flow string Filter by authentication flow.
--csv Output in csv format.
--feature-flag-id string Filter by feature flag ID.
--json Output in json format.
--json-compact Output in compact json format.
--status string Filter by status (draft, active, paused, completed, archived).
```


## Inherited Flags

```
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments status](auth0_experiments_status.md) - Change an experiment's status
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment


52 changes: 52 additions & 0 deletions docs/auth0_experiments_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
layout: default
parent: auth0 experiments
has_toc: false
---
# auth0 experiments show

Display details about an experiment including its allocations and validation status.

## Usage
```
auth0 experiments show [flags]
```

## Examples

```
auth0 experiments show
auth0 experiments show <experiment-id>
auth0 experiments show <experiment-id> --json
```


## Flags

```
--json Output in json format.
--json-compact Output in compact json format.
```


## Inherited Flags

```
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments status](auth0_experiments_status.md) - Change an experiment's status
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment


60 changes: 60 additions & 0 deletions docs/auth0_experiments_status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
layout: default
parent: auth0 experiments
has_toc: false
---
# auth0 experiments status

Transition an experiment to a new lifecycle status: active, paused, completed, or archived.

• active — start (or resume) the experiment; runs full validation before activating
• paused — pause a running experiment; it can be resumed by setting it active again
• completed — mark the experiment as finished; it can then be archived
• archived — archive a completed experiment

To set the status interactively, run `auth0 experiments status` with no arguments.

## Usage
```
auth0 experiments status [flags]
```

## Examples

```
auth0 experiments status
auth0 experiments status <experiment-id>
auth0 experiments status <experiment-id> active
auth0 experiments status <experiment-id> paused
```


## Flags

```
--json Output in json format.
--json-compact Output in compact json format.
```


## Inherited Flags

```
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments status](auth0_experiments_status.md) - Change an experiment's status
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment


62 changes: 62 additions & 0 deletions docs/auth0_experiments_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
layout: default
parent: auth0 experiments
has_toc: false
---
# auth0 experiments update

Update an experiment.

Note: feature flag, authentication flow, and allocation strategy cannot be changed after creation. To change an experiment's status, use `auth0 experiments status`.

To update interactively, use `auth0 experiments update` with no arguments.

## Usage
```
auth0 experiments update [flags]
```

## Examples

```
auth0 experiments update
auth0 experiments update <experiment-id>
auth0 experiments update <experiment-id> --name "new-name"
auth0 experiments update <experiment-id> --assignment-config '{"subject":"device"}'
auth0 experiments update <experiment-id> --allocations '[{"variation_id":"vid","weight":100,"is_control":true}]'
```


## Flags

```
--allocations string JSON array of allocation items ({variation_id, weight, is_control} for percentage, where weight is an integer percentage from 1 to 100; {variation_id, segment_id, is_control} for segment).
--assignment-config string JSON object configuring how users are assigned to variations (e.g. '{"subject":"device"}').
-d, --description string Description of the experiment.
--json Output in json format.
--json-compact Output in compact json format.
-n, --name string Name of the experiment.
```


## Inherited Flags

```
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 experiments create](auth0_experiments_create.md) - Create a new experiment
- [auth0 experiments delete](auth0_experiments_delete.md) - Delete an experiment
- [auth0 experiments list](auth0_experiments_list.md) - List your experiments
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments status](auth0_experiments_status.md) - Change an experiment's status
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment


Loading
Loading