GrowthBook CLI

A CLI tool for helping developers work with the GrowthBook open-source platform for feature flags and A/B tests.

See the official GrowthBook CLI documentation for more information.

Commands

* growthbook auth
* growthbook auth login
* growthbook auth logout
* growthbook datasources get ID
* growthbook datasources list
* growthbook dimensions get ID
* growthbook dimensions list
* growthbook experiments get ID
* growthbook experiments list
* growthbook experiments results EXPERIMENTID
* growthbook features generate-types
* growthbook features get FEATUREKEY
* growthbook features list
* growthbook features toggle FEATUREKEY
* [growthbook help [COMMANDS]](#growthbook-help-commands)
* [growthbook metrics create [INPUT]](#growthbook-metrics-create-input)
* growthbook metrics get METRICID
* growthbook metrics list
* growthbook projects get PROJECTID
* growthbook projects list
* [growthbook savedgroups create [INPUT]](#growthbook-savedgroups-create-input)
* growthbook savedgroups delete ID
* growthbook savedgroups get ID
* growthbook savedgroups list
* [growthbook savedgroups update [INPUT]](#growthbook-savedgroups-update-input)
* growthbook sdkconnections get ID
* growthbook sdkconnections list
* growthbook segments get ID
* growthbook segments list
* growthbook vcs get ID
* growthbook vcs list

growthbook auth

``
USAGE
$ growthbook auth
`

growthbook auth login

Configure your API key with the GrowthBook SDK with your project

`
USAGE
$ growthbook auth login [-u ] [-p ] [-k ]

FLAGS
-k, --apiKey= Your GrowthBook secret API Key
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Configure your API key with the GrowthBook SDK with your project
`

growthbook auth logout

Removes GrowthBook API key configurations

`
USAGE
$ growthbook auth logout [-p ]

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances or organizations)
(default: all profiles)

DESCRIPTION
Removes GrowthBook API key configurations
`

growthbook datasources get ID

Get a single datasource by ID

`
USAGE
$ growthbook datasources get ID [-u ] [-p ]

ARGUMENTS
ID Datasource ID

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Get a single datasource by ID

EXAMPLES
$ growthbook datasources get
`

growthbook datasources list

Get all data sources

`
USAGE
$ growthbook datasources list [-u ] [-p ] [--limit ] [--offset ] [--project ]

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)
--limit= [default: 100] Limit for pagination
--offset= Offset for pagination
--project= Project ID filter

DESCRIPTION
Get all data sources

EXAMPLES
$ growthbook datasources list
`

growthbook dimensions get ID

Get a single dimension used during experiment analysis

`
USAGE
$ growthbook dimensions get ID [-u ] [-p ]

ARGUMENTS
ID Dimension ID

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Get a single dimension used during experiment analysis

EXAMPLES
$ growthbook dimensions get
`

growthbook dimensions list

Get all dimensions used during experiment analysis

`
USAGE
$ growthbook dimensions list [-u ] [-p ] [--limit ] [--offset ] [--dataSourceId ]

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)
--dataSourceId= Data source ID to filter by
--limit= [default: 100] Limit for pagination
--offset= Offset for pagination

DESCRIPTION
Get all dimensions used during experiment analysis

EXAMPLES
$ growthbook dimensions list
`

growthbook experiments get ID

Get a single experiment by ID

`
USAGE
$ growthbook experiments get ID [-u ] [-p ]

ARGUMENTS
ID Experiment ID

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Get a single experiment by ID

EXAMPLES
$ growthbook experiments get
`

growthbook experiments list

Get all experiments

`
USAGE
$ growthbook experiments list [-u ] [-p ] [--limit ] [--offset ] [--project ]
[--datasource ] [--experiment ]

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)
--datasource= Datasource ID filter
--experiment= Filter the returned list by the experiment tracking key (id)
--limit= [default: 100] Limit for pagination
--offset= Offset for pagination
--project= Project ID filter

DESCRIPTION
Get all experiments

EXAMPLES
$ growthbook experiments list
`

growthbook experiments results EXPERIMENTID

Get results for an experiment with optional phase and dimension filtering

`
USAGE
$ growthbook experiments results EXPERIMENTID [-u ] [-p ] [--dimension ] [--phase ]

ARGUMENTS
EXPERIMENTID ID of the experiment

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)
--dimension=
--phase=

DESCRIPTION
Get results for an experiment with optional phase and dimension filtering

EXAMPLES
$ growthbook experiments results
`

growthbook features generate-types

Generate TypeScript types for all your features

`
USAGE
$ growthbook features generate-types [-u ] [-p ] [-o ] [-f ] [--project ]

FLAGS
-f, --filename= Output filename for the generated types. If not provided, the filename app-features.ts will
be used.
-o, --output= Output path for the app-features.ts file. All directories in this path should exist. If not
provided, the directory ./growthbook-types will be created in the current working directory.
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)
--project= Project ID filter

DESCRIPTION
Generate TypeScript types for all your features
`

growthbook features get FEATUREKEY

Get a feature by key

`
USAGE
$ growthbook features get FEATUREKEY [-u ] [-p ]

ARGUMENTS
FEATUREKEY Feature key

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Get a feature by key

EXAMPLES
$ growthbook features get
`

growthbook features list

Get all features

`
USAGE
$ growthbook features list [-u ] [-p ] [--limit ] [--offset ] [--project ]

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)
--limit= [default: 100] Limit for pagination
--offset= Offset for pagination
--project= Project ID filter

DESCRIPTION
Get all features

EXAMPLES
$ growthbook features list
`

growthbook features toggle FEATUREKEY

Toggle a feature on or off for a specific environment

`
USAGE
$ growthbook features toggle FEATUREKEY -e -n true|false|on|off|1|0 [-u ] [-p ] [-r ]

ARGUMENTS
FEATUREKEY Feature key to toggle

FLAGS
-e, --environment= (required) Environment that you would like to toggle
-n, --enabled= (required) Enabled state of the feature

-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-r, --reason= The reason for toggling it on
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Toggle a feature on or off for a specific environment

EXAMPLES
$ growthbook features toggle
`

growthbook help [COMMANDS]

Display help for growthbook.

`
USAGE
$ growthbook help [COMMANDS] [-n]

ARGUMENTS
COMMANDS Command to show help for.

FLAGS
-n, --nested-commands Include all nested commands in the output.

DESCRIPTION
Display help for growthbook.
`

growthbook metrics create [INPUT]

Create a metric from file or standard in

`
USAGE
$ growthbook metrics create [INPUT] [-u ] [-p ] [-f ] [-o ]

ARGUMENTS
INPUT JSON payload of the metric to be created. Docs:
https://docs.growthbook.io/api/#tag/metrics/operation/postMetric

FLAGS
-f, --filePath= Path to input file
-o, --output= Path to output file, e.g. created-resource.json
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Create a metric from file or standard in

EXAMPLES
cat my-metric.json | growthbook metrics create

$ growthbook metrics create --filePath my-metric.json
`

growthbook metrics get METRICID

Get a single metric by ID

`
USAGE
$ growthbook metrics get METRICID [-u ] [-p ]

ARGUMENTS
METRICID Metric ID

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Get a single metric by ID

EXAMPLES
$ growthbook metrics get
`

growthbook metrics list

List all metrics

`
USAGE
$ growthbook metrics list [-u ] [-p ] [--limit ] [--offset ] [--project ]

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)
--limit= [default: 100] Limit for pagination
--offset= Offset for pagination
--project= Project ID filter

DESCRIPTION
List all metrics

EXAMPLES
$ growthbook metrics list
`

growthbook projects get PROJECTID

Get a single project by ID

`
USAGE
$ growthbook projects get PROJECTID [-u ] [-p ]

ARGUMENTS
PROJECTID Project ID

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Get a single project by ID

EXAMPLES
$ growthbook projects get
`

growthbook projects list

List all projects

`
USAGE
$ growthbook projects list [-u ] [-p ] [--limit ] [--offset ]

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)
--limit= [default: 100] Limit for pagination
--offset= Offset for pagination

DESCRIPTION
List all projects

EXAMPLES
$ growthbook projects list
`

growthbook savedgroups create [INPUT]

Create a saved group

`
USAGE
$ growthbook savedgroups create [INPUT] [-u ] [-p ] [-f ] [-o ]

ARGUMENTS
INPUT JSON payload of the saved group to be created. Docs:
https://docs.growthbook.io/api/#tag/saved-groups/operation/postSavedGroup

FLAGS
-f, --filePath= Path to input file
-o, --output= Path to output file, e.g. created-resource.json
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Create a saved group

EXAMPLES
$ growthbook savedgroups create

$ growthbook savedgroups create --filePath input.json
`

growthbook savedgroups delete ID

Delete a saved group

`
USAGE
$ growthbook savedgroups delete ID [-u ] [-p ]

ARGUMENTS
ID Saved Group ID

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Delete a saved group

EXAMPLES
$ growthbook savedgroups delete
`

growthbook savedgroups get ID

Get a single saved group by ID

`
USAGE
$ growthbook savedgroups get ID [-u ] [-p ]

ARGUMENTS
ID Saved Group ID

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Get a single saved group by ID

EXAMPLES
$ growthbook savedgroups get
`

growthbook savedgroups list

Defined sets of attribute values which can be used with feature rules for targeting features at particular users.

`
USAGE
$ growthbook savedgroups list [-u ] [-p ] [--limit ] [--offset ]

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)
--limit= [default: 100] Limit for pagination
--offset= Offset for pagination

DESCRIPTION
Defined sets of attribute values which can be used with feature rules for targeting features at particular users.

EXAMPLES
$ growthbook savedgroups list
`

growthbook savedgroups update [INPUT]

Update an existing saved group.

`
USAGE
$ growthbook savedgroups update [INPUT] -i [-u ] [-p ] [-f ] [-o ]

ARGUMENTS
INPUT JSON payload of the update payload. Docs:
https://docs.growthbook.io/api/#tag/saved-groups/operation/updateSavedGroup

FLAGS
-f, --filePath= Path to input file
-i, --id= (required) Saved group ID to update
-o, --output= Path to output file, e.g. created-resource.json
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Update an existing saved group.

EXAMPLES
$ growthbook savedgroups update

$ growthbook savedgroups update --filePath input.json
`

growthbook sdkconnections get ID

Client keys and settings for connecting SDKs to a GrowthBook instance

`
USAGE
$ growthbook sdkconnections get ID [-u ] [-p ]

ARGUMENTS
ID SDK connection ID

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Client keys and settings for connecting SDKs to a GrowthBook instance

EXAMPLES
$ growthbook sdkconnections get
`

growthbook sdkconnections list

Client keys and settings for connecting SDKs to a GrowthBook instance

`
USAGE
$ growthbook sdkconnections list [-u ] [-p ] [--limit ] [--offset ] [--projectId ]

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)
--limit= [default: 100] Limit for pagination
--offset= Offset for pagination
--projectId= Project ID to filter by

DESCRIPTION
Client keys and settings for connecting SDKs to a GrowthBook instance

EXAMPLES
$ growthbook sdkconnections list
`

growthbook segments get ID

Get a single segment used during experiment analysis

`
USAGE
$ growthbook segments get ID [-u ] [-p ]

ARGUMENTS
ID Segment ID

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Get a single segment used during experiment analysis

EXAMPLES
$ growthbook segments get
`

growthbook segments list

Get all segments used during experiment analysis

`
USAGE
$ growthbook segments list [-u ] [-p ] [--limit ] [--offset ] [--dataSourceId ]

FLAGS
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)
--dataSourceId= Data source ID to filter by
--limit= [default: 100] Limit for pagination
--offset= Offset for pagination

DESCRIPTION
Get all segments used during experiment analysis

EXAMPLES
$ growthbook segments list
`

growthbook vcs get ID

Get a Visual Changeset created in the visual editor

`
USAGE
$ growthbook vcs get ID [-u ] [-p ] [-e 0|1]

ARGUMENTS
ID Visual Changeset ID

FLAGS
-e, --includeExperiment= Include the associated experiment in payload

-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default:
default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
Get a Visual Changeset created in the visual editor

EXAMPLES
$ growthbook vcs get
`

growthbook vcs list

List Visual Changesets created in the visual editor

`
USAGE
$ growthbook vcs list -e [-u ] [-p ]

FLAGS
-e, --experiment= (required) Filter by experiment
-p, --profile= Optional profile (for projects that use multiple GrowthBook instances) default: default)
-u, --apiBaseUrl= Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
https://api.growthbook.io)

DESCRIPTION
List Visual Changesets created in the visual editor

EXAMPLES
$ growthbook vcs list
``