npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

growthbook

v0.2.3

Published

The GrowthBook command-line interface (CLI) for working with the GrowthBook A/B testing, feature flagging, and experimentation platform

Downloads

27,124

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

bryce-fitzsimonsbryce-fitzsimonsjdornjdorn

Keywords

growthbook

Readme

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

USAGE
  $ growthbook auth

growthbook auth login

Configure your API key with the GrowthBook SDK with your project

USAGE
  $ growthbook auth login

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 <value>]

FLAGS
  -p, --profile=<value>  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 <value>] [-p <value>]

ARGUMENTS
  ID  Datasource ID

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>] [--limit <value>] [--offset <value>] [--project <value>]

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

ARGUMENTS
  ID  Dimension ID

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>] [--limit <value>] [--offset <value>] [--dataSourceId <value>]

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

ARGUMENTS
  ID  Experiment ID

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>] [--limit <value>] [--offset <value>] [--project <value>]
    [--datasource <value>] [--experiment <value>]

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

ARGUMENTS
  EXPERIMENTID  ID of the experiment

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

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 <value>] [-p <value>] [-o <value>] [-f <value>]

FLAGS
  -f, --filename=<value>    Output filename for the generated types. If not provided, the filename app-features.ts will
                            be used.
  -o, --output=<value>      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=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
                            https://api.growthbook.io)

DESCRIPTION
  Generate TypeScript types for all your features

growthbook features get FEATUREKEY

Get a feature by key

USAGE
  $ growthbook features get FEATUREKEY [-u <value>] [-p <value>]

ARGUMENTS
  FEATUREKEY  Feature key

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>] [--limit <value>] [--offset <value>] [--project <value>]

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
                            https://api.growthbook.io)
  --limit=<value>           [default: 100] Limit for pagination
  --offset=<value>          Offset for pagination
  --project=<value>         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 <value> -n true|false|on|off|1|0 [-u <value>] [-p <value>] [-r <value>]

ARGUMENTS
  FEATUREKEY  Feature key to toggle

FLAGS
  -e, --environment=<value>  (required) Environment that you would like to toggle
  -n, --enabled=<option>     (required) Enabled state of the feature
                             <options: true|false|on|off|1|0>
  -p, --profile=<value>      Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -r, --reason=<value>       The reason for toggling it on
  -u, --apiBaseUrl=<value>   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 <value>] [-p <value>] [-f <value>] [-o <value>]

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

FLAGS
  -f, --filePath=<value>    Path to input file
  -o, --output=<value>      Path to output file, e.g. created-resource.json
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>]

ARGUMENTS
  METRICID  Metric ID

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>] [--limit <value>] [--offset <value>] [--project <value>]

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

ARGUMENTS
  PROJECTID  Project ID

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>] [--limit <value>] [--offset <value>]

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
                            https://api.growthbook.io)
  --limit=<value>           [default: 100] Limit for pagination
  --offset=<value>          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 <value>] [-p <value>] [-f <value>] [-o <value>]

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=<value>    Path to input file
  -o, --output=<value>      Path to output file, e.g. created-resource.json
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>]

ARGUMENTS
  ID  Saved Group ID

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>]

ARGUMENTS
  ID  Saved Group ID

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>] [--limit <value>] [--offset <value>]

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  Your GrowthBook instance base URL (e.g. http://localhost:3100, default:
                            https://api.growthbook.io)
  --limit=<value>           [default: 100] Limit for pagination
  --offset=<value>          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 <value> [-u <value>] [-p <value>] [-f <value>] [-o <value>]

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

FLAGS
  -f, --filePath=<value>    Path to input file
  -i, --id=<value>          (required) Saved group ID to update
  -o, --output=<value>      Path to output file, e.g. created-resource.json
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>]

ARGUMENTS
  ID  SDK connection ID

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>] [--limit <value>] [--offset <value>] [--projectId <value>]

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

ARGUMENTS
  ID  Segment ID

FLAGS
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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 <value>] [-p <value>] [--limit <value>] [--offset <value>] [--dataSourceId <value>]

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

ARGUMENTS
  ID  Visual Changeset ID

FLAGS
  -e, --includeExperiment=<option>  Include the associated experiment in payload
                                    <options: 0|1>
  -p, --profile=<value>             Optional profile (for projects that use multiple GrowthBook instances) default:
                                    default)
  -u, --apiBaseUrl=<value>          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 <value> [-u <value>] [-p <value>]

FLAGS
  -e, --experiment=<value>  (required) Filter by experiment
  -p, --profile=<value>     Optional profile (for projects that use multiple GrowthBook instances) default: default)
  -u, --apiBaseUrl=<value>  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