Skip to content
Open
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
29 changes: 29 additions & 0 deletions docs/auth0_experiments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
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 archive](auth0_experiments_archive.md) - Archive an experiment
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
- [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 pause](auth0_experiments_pause.md) - Pause an experiment
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment

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

Archive a completed experiment.

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

## Examples

```
auth0 experiments archive
auth0 experiments archive <experiment-id>
```




## Inherited Flags

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


## Related Commands

- [auth0 experiments archive](auth0_experiments_archive.md) - Archive an experiment
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
- [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 pause](auth0_experiments_pause.md) - Pause an experiment
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment


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

Mark an experiment as completed. It can then be archived.

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

## Examples

```
auth0 experiments complete
auth0 experiments complete <experiment-id>
```




## Inherited Flags

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


## Related Commands

- [auth0 experiments archive](auth0_experiments_archive.md) - Archive an experiment
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
- [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 pause](auth0_experiments_pause.md) - Pause an experiment
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment


64 changes: 64 additions & 0 deletions docs/auth0_experiments_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
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 --allocations '[{"variation_id":"vid_1","weight":0.5,"is_control":true},{"variation_id":"vid_2","weight":0.5,"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; {variation_id, segment_id, is_control} for segment).
-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 archive](auth0_experiments_archive.md) - Archive an experiment
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
- [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 pause](auth0_experiments_pause.md) - Pause an experiment
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
- [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_delete.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 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 archive](auth0_experiments_archive.md) - Archive an experiment
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
- [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 pause](auth0_experiments_pause.md) - Pause an experiment
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment


61 changes: 61 additions & 0 deletions docs/auth0_experiments_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
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 archive](auth0_experiments_archive.md) - Archive an experiment
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
- [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 pause](auth0_experiments_pause.md) - Pause an experiment
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment


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

Pause a running experiment. It can be resumed with `auth0 experiments start`.

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

## Examples

```
auth0 experiments pause
auth0 experiments pause <experiment-id>
```




## Inherited Flags

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


## Related Commands

- [auth0 experiments archive](auth0_experiments_archive.md) - Archive an experiment
- [auth0 experiments complete](auth0_experiments_complete.md) - Complete an experiment
- [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 pause](auth0_experiments_pause.md) - Pause an experiment
- [auth0 experiments show](auth0_experiments_show.md) - Show an experiment
- [auth0 experiments start](auth0_experiments_start.md) - Start an experiment
- [auth0 experiments update](auth0_experiments_update.md) - Update an experiment
- [auth0 experiments validate](auth0_experiments_validate.md) - Validate an experiment


Loading
Loading