Command-line interface for the GrowthBook REST API.

The recommended way to install is via npm, which installs a small launcher that downloads the prebuilt binary for your platform:

npm i -g growthbook

Prefer a standalone binary with no Node.js dependency? An install script, go install, and prebuilt downloads are covered under CLI Installation below.

This CLI follows semantic versioning: breaking changes ship only in a major release and are called out in the changelog. Additive changes (new commands, flags, or response fields) are minor releases; fixes are patch releases. We recommend pinning to a version you have tested.

The CLI checks for a newer release at most once a day and prints a one-line notice to stderr (never stdout) when one is available and compatible with your server. Disable it with --no-update-check or GBCLI_NO_UPDATE_CHECK=1; it is also off automatically in CI and non-interactive shells.

Each command group targets the newest version of its API endpoint — e.g. features is the latest (v2) feature API. When a command is superseded, the previous version stays available under a version suffix (e.g. features-v1), deprecated and printing a one-line notice to stderr. When a newer API version lands, the base group advances to it and the prior version becomes the next -vN.

Because the bare command then returns the newer version's response shape, re-pointing a base command is a breaking change: it ships as a major release with the change called out in the changelog — so you can pin the prior major or move to the explicit -vN command on your own schedule.

GrowthBook REST API: A command-line interface for GrowthBook — manage feature flags, experiments, metrics, and more from your terminal.

Endpoints are versioned by path prefix: /v1 (stable) and /v2 (improved shapes). Each command group targets the newest version of its endpoint; superseded versions remain available under a -vN suffix.

Authenticate with a Secret Key or Personal Access Token via --bearer-auth (or the GBCLI_BEARER_AUTH environment variable). Run growthbook configure to store credentials, or growthbook whoami to check the active configuration.

• growthbook
  • Installation
  • Versioning and stability
  • CLI Installation
  • Shell Completion
  • CLI Example Usage
  • Authentication
  • Profiles
  • Generating TypeScript types
  • Available Commands
  • Request Body Input
  • Server Selection
  • Output Formats
  • Pagination
  • Error Handling
  • Diagnostics
• Development
  • Maturity
  • Contributions

curl -fsSL https://raw.githubusercontent.com/growthbook/cli/main/scripts/install.sh | bash

iwr -useb https://raw.githubusercontent.com/growthbook/cli/main/scripts/install.ps1 | iex

Alternatively, install directly via Go:

go install github.com/growthbook/cli/v2/cmd/growthbook@latest

Download pre-built binaries for your platform from the releases page.

Shell completions are available for Bash, Zsh, Fish, and PowerShell.

# Add to ~/.bashrc:
source <(growthbook completion bash)

# Or install permanently:
growthbook completion bash > /etc/bash_completion.d/growthbook

# Add to ~/.zshrc:
source <(growthbook completion zsh)

# Or install permanently:
growthbook completion zsh > "${fpath[1]}/_growthbook"

growthbook completion fish | source

# Or install permanently:
growthbook completion fish > ~/.config/fish/completions/growthbook.fish

growthbook completion powershell | Out-String | Invoke-Expression

growthbook get-SDK-payload --bearer-auth 'Bearer test_token' --key '<key>'

Authentication credentials can be configured in four ways (in order of priority):

Pass credentials directly as flags to any command:

growthbook --bearer-auth <value> --username <value> --password <value> <command> [arguments]

Set credentials via environment variables:

Credentials are stored securely in your operating system's keychain when you run:

growthbook configure

Secret credentials (tokens, API keys, passwords) are automatically stored in:

• macOS: Keychain
• Linux: GNOME Keyring / KWallet (via D-Bus Secret Service)
• Windows: Windows Credential Locker

If no keychain is available (e.g., in CI environments), credentials fall back to the config file.

Run the interactive configure command to store non-secret settings:

growthbook configure

Configuration is stored in ~/.config/growthbook/config.yaml.

Profiles let you switch between GrowthBook environments (e.g. cloud, staging, self-hosted), each with its own server URL and API key. Keys are stored in your OS keychain, not in plaintext config.

# Create or update a profile (the key comes from --bearer-auth, stored in the keychain)
growthbook profiles set staging --server-url https://gb.staging.example.com/api --bearer-auth secret_xxx

growthbook profiles use staging      # make it the active profile
growthbook profiles list             # show configured profiles
growthbook profiles remove staging   # delete one

Select a profile for a single command with --profile <name>, or set GBCLI_PROFILE in your environment. (Upgrading from the legacy CLI? An existing ~/.growthbook/config.toml is imported into profiles automatically on first run — see MIGRATION.md.)

generate-types fetches all of your features and writes a TypeScript AppFeatures definition, giving you type-safe feature keys and values in the GrowthBook SDK:

growthbook generate-types                                   # → ./growthbook-types/app-features.ts
growthbook generate-types --output ./src/types --filename growthbook.ts
growthbook generate-types --project prj_123                 # limit to one project

• get-SDK-payload - Get a SDK payload
• copy-transform

• ~~list~~ - Get all features ⚠️ Deprecated
• ~~create~~ - Create a single feature ⚠️ Deprecated
• ~~get~~ - Get a single feature ⚠️ Deprecated
• ~~update~~ - Partially update a feature ⚠️ Deprecated
• ~~delete~~ - Deletes a single feature ⚠️ Deprecated
• ~~toggle~~ - Toggle a feature in one or more environments ⚠️ Deprecated
• ~~revert~~ - Revert a feature to a specific revision ⚠️ Deprecated
• ~~get-feature-keys~~ - Get list of feature keys ⚠️ Deprecated
• ~~get-feature-stale~~ - Get stale status for one or more features ⚠️ Deprecated

• ~~list-revisions~~ - List feature revisions ⚠️ Deprecated
• ~~list-for-feature~~ - List revisions for a feature ⚠️ Deprecated
• ~~create~~ - Create a draft revision ⚠️ Deprecated
• ~~get-feature-revision-latest~~ - Get the most recent active draft revision ⚠️ Deprecated
• ~~get-feature-revision~~ - Get a single feature revision ⚠️ Deprecated
• ~~put-feature-revision-metadata~~ - Update revision metadata (comment, title, feature metadata) ⚠️ Deprecated
• ~~put-feature-revision-default-value~~ - Set the default value in a draft revision ⚠️ Deprecated
• ~~put-feature-revision-prerequisites~~ - Set feature-level prerequisites in a draft revision ⚠️ Deprecated
• ~~put-feature-revision-holdout~~ - Set holdout in a draft revision ⚠️ Deprecated
• ~~put-feature-revision-archive~~ - Set archived state in a draft revision ⚠️ Deprecated
• ~~post-feature-revision-toggle~~ - Toggle an environment on/off in a draft revision ⚠️ Deprecated
• ~~post-feature-revision-rule-add~~ - Add a rule to a draft revision ⚠️ Deprecated
• ~~put-feature-revision-rule~~ - Update a rule in a draft revision ⚠️ Deprecated
• ~~delete-feature-revision-rule~~ - Delete a rule from a draft revision ⚠️ Deprecated
• ~~post-feature-revision-rules-reorder~~ - Reorder rules in an environment ⚠️ Deprecated
• ~~put-feature-revision-rule-ramp-schedule~~ - Set ramp schedule for a rule ⚠️ Deprecated
• ~~delete-feature-revision-rule-ramp-schedule~~ - Remove ramp schedule from a rule ⚠️ Deprecated
• ~~post-feature-revision-request-review~~ - Request review for a draft revision ⚠️ Deprecated
• ~~post-feature-revision-submit-review~~ - Submit a review on a draft revision ⚠️ Deprecated
• ~~get-feature-revision-merge-status~~ - Get merge status for a draft revision ⚠️ Deprecated
• ~~post-feature-revision-rebase~~ - Rebase a draft revision onto the current live version ⚠️ Deprecated
• ~~post-feature-revision-publish~~ - Publish a draft revision ⚠️ Deprecated
• ~~post-feature-revision-discard~~ - Discard a draft revision ⚠️ Deprecated
• ~~post-feature-revision-revert~~ - Revert the feature to a prior revision ⚠️ Deprecated

• list - Get all features
• create - Create a single feature
• get - Get a single feature
• update - Partially update a feature
• delete - Deletes a single feature
• toggle - Toggle a feature in one or more environments
• revert - Revert a feature to a specific revision
• get-feature-keys - Get list of feature keys
• get-feature-stale - Get stale status for one or more features

• list-revisions - List revisions across all features
• list-for-feature - List revisions for a feature
• create - Create a draft revision
• latest - Get the most recent active draft revision
• get - Get a single feature revision
• diff - Diff a revision against another revision
• set-metadata - Update revision metadata
• set-default-value - Set the default value in a draft revision
• set-prerequisites - Set feature-level prerequisites in a draft revision
• set-holdout - Set holdout in a draft revision
• archive - Set archived state in a draft revision
• toggle - Toggle an environment on/off in a draft revision
• add-rule - Add a rule to a draft revision
• update-rule - Update a rule in a draft revision
• delete-rule - Delete a rule from a draft revision
• reorder-rules - Reorder rules in the revision
• set-rule-ramp-schedule - Set ramp schedule for a rule
• delete-rule-ramp-schedule - Remove ramp schedule from a rule
• request-review - Request review for a draft revision
• schedule-publish - Schedule (or cancel) a deferred publish for a draft revision
• submit-review - Submit a review on a draft revision
• recall-review - Recall a review request (revert to draft)
• undo-review - Undo a reviewer's own review verdict
• log - List the activity log for a revision
• add-log-comment - Edit the comment text of an owned log entry
• delete-log-entry - Delete an owned revision Comment entry
• merge-status - Get merge status for a draft revision
• rebase-preview - Preview a rebase without applying it
• rebase - Rebase a draft revision onto the current live version
• publish - Publish a draft revision
• discard - Discard a draft revision
• reopen - Reopen a discarded revision as a draft
• revert - Revert the feature to a prior revision

• list - Get the organization's archetypes
• create - Create a single archetype
• get - Get a single archetype
• update - Update a single archetype
• delete - Deletes a single archetype

• list - Get all experiments
• create - Create a single experiment
• list-results - Get latest results for many experiments
• get - Get a single experiment
• update - Update a single experiment
• get-start-checklist - Get an experiment pre-launch checklist status
• results - Get results for an experiment
• start - Start/Stage an experiment
• complete-start-checklist - Mark manual pre-launch checklist items complete
• stop - Stop an experiment
• set-schedule - Set an experiment's schedule and shipping automation
• modify-temporary-rollout - Modify temporary rollout status for a stopped experiment
• create-snapshot - Create Experiment Snapshot
• upload-variation-screenshot - Upload a variation screenshot
• delete-variation-screenshot - Delete a variation screenshot
• list-names - Get a list of experiments with names and ids
• post-comment - Post a comment on an experiment

• create-snapshot - Create Experiment Snapshot
• get-experiment - Get an experiment snapshot status

• list - Get all visual changesets
• create - Create a visual changeset for an experiment
• get - Get a single visual changeset
• update - Update a visual changeset
• add-visual-change - Create a visual change for a visual changeset
• update-visual-change - Update a visual change for a visual changeset

• get-current-weights - Get current Contextual Bandit leaf weights and latest event
• list-snapshots - List Contextual Bandit snapshots
• get-snapshot - Get a single Contextual Bandit snapshot
• list-events - List Contextual Bandit weight-update events
• get-event - Get a single Contextual Bandit weight-update event
• get-results - Get latest Contextual Bandit results
• list-linked-features - Get features linked to a Contextual Bandit
• add-linked-feature - Link a feature to a Contextual Bandit
• update-linked-feature - Replace a Contextual Bandit's rule on a linked feature
• delete-linked-feature - Unlink a feature from a Contextual Bandit
• get - Get a single contextualBandit
• update - Update a single contextualBandit
• create - Create a single contextualBandit
• list - Get all contextualBandits
• start - Start a Contextual Bandit
• stop - Stop a Contextual Bandit
• refresh - Trigger a Contextual Bandit snapshot refresh
• cancel - Cancel a running Contextual Bandit snapshot refresh

• list - Get all metrics
• create - Create a single metric
• get - Get a single metric
• update - Update a metric
• delete - Deletes a metric
• list-experiments - Get results for all experiments that use a metric

• get - Get metric usage across experiments

• list - Get all segments
• create - Create a single segment
• get - Get a single segment
• update - Update a single segment
• delete - Deletes a single segment

• list - Get all dimensions
• create - Create a single dimension
• get - Get a single dimension
• update - Update a single dimension
• delete - Deletes a single dimension

• list - Get all projects
• create - Create a single project
• get - Get a single project
• update - Edit a single project
• delete - Deletes a single project

• list - Get the organization's environments
• create - Create a new environment
• update - Update an environment
• delete - Deletes a single environment

• list - Get the organization's attributes
• create - Create a new attribute
• update - Update an attribute
• delete - Deletes a single attribute

• list - Get all sdk connections
• create - Create a single sdk connection
• get - Get a single sdk connection
• update - Update a single sdk connection
• delete - Deletes a single SDK connection
• lookup-SDK-connection-by-key - Find a single sdk connection by its key

• list - Get all data sources
• get - Get a single data source
• get-information-schema - Get a Data Source's Information Schema
• search-warehouse-tables - Search warehouse tables
• get-warehouse-table-schema - Get warehouse table schemas
• preview-warehouse-column-values - Preview distinct column values
• run-sql-query - Execute a read-only SQL query
• get-information-schema-table - Get a single Information Schema Table by id

• list - Get all saved group
• create - Create a single saved group
• get - Get a single saved group
• update - Partially update a single saved group
• delete - Deletes a single saved group
• archive - Archive a single saved group
• unarchive - Unarchive a single saved group
• get-saved-group-references - Get features, experiments, and saved groups that reference this saved group

• list - List saved-group revisions across the organization
• list-for-saved-group - List revisions for a saved group
• create - Create a draft revision
• latest - Get the most recent active draft revision
• get - Get a single saved group revision
• set-metadata - Update saved group metadata in a draft revision
• set-condition - Update the condition of a condition saved group draft revision
• set-values - Replace the values list in a list saved group draft revision
• archive - Stage an archive/unarchive in a draft revision
• add-items - Append items to a list saved group draft revision
• remove-items - Remove items from a list saved group draft revision
• request-review - Request review for a draft revision
• submit-review - Submit a review on a draft revision
• recall-review - Recall a review request
• reopen - Reopen a discarded revision
• schedule-publish - Schedule (or cancel) a deferred publish
• undo-review - Retract your own review verdict
• merge-status - Get merge status for a draft revision
• rebase - Rebase a draft revision onto the current live saved group
• publish - Publish a draft revision
• discard - Discard a draft revision
• revert - Revert the saved group to a prior revision

• list - Get all constants
• create - Create a single constant
• get-references - Get features and constants that reference this constant
• get - Get a single constant
• update - Partially update a single constant
• delete - Delete a single constant
• archive - Archive a single constant
• unarchive - Unarchive a single constant

• list - List constant revisions across the organization
• list-for-constant - List revisions for a constant
• create - Create a draft revision
• latest - Get the most recent active draft revision
• get - Get a single constant revision
• set-metadata - Update constant metadata in a draft revision
• set-value - Update the value of a constant draft revision
• archive - Stage an archive/unarchive in a draft revision
• request-review - Request review for a draft revision
• submit-review - Submit a review on a draft revision
• recall-review - Recall a review request
• reopen - Reopen a discarded revision
• schedule-publish - Schedule (or cancel) a deferred publish
• undo-review - Retract your own review verdict
• merge-status - Get merge status for a draft revision
• rebase - Rebase a draft revision onto the current live constant
• publish - Publish a draft revision
• discard - Discard a draft revision
• revert - Revert the constant to a prior revision

• list - Get all configs
• create - Create a single config
• get-references - Get features and configs that reference this config
• get-key-usage - Get the feature rules and default values implementing each key
• get-lineage - Get the full lineage (family tree) for a config
• verify-schema - Verify a config's schema against a source (drift check)
• get-schema - Export a config's schema
• get - Get a single config
• update - Partially update a single config
• delete - Delete a single config
• archive - Archive a single config
• unarchive - Unarchive a single config
• lock - Lock a config at its current published revision
• unlock - Unlock a config

• list - List config revisions across the organization
• list-for-config - List revisions for a config
• create - Create a draft revision
• latest - Get the most recent active draft revision
• get - Get a single config revision
• set-metadata - Update config metadata in a draft revision
• set-value - Update the value of a config draft revision
• set-property - Set one property of a config draft revision's value
• delete-property - Remove one property from a config draft revision's value
• set-schema - Update or import the schema of a config draft revision
• set-projection - Set (or update) a config's per-source render projection on a draft
• delete-projection - Remove a config's per-source render projection on a draft
• archive - Stage an archive/unarchive in a draft revision
• request-review - Request review for a draft revision
• submit-review - Submit a review on a draft revision
• undo-review - Retract your own review verdict
• recall-review - Recall a review request
• reopen - Reopen a discarded revision
• schedule-publish - Schedule (or cancel) a deferred publish
• merge-status - Get merge status for a draft revision
• rebase - Rebase a draft revision onto the current live config
• publish - Publish a draft revision
• discard - Discard a draft revision
• revert - Revert the config to a prior revision

• publish-revisions - Atomically publish revisions across multiple entities

• list - Get all custom hooks
• create - Create a single custom hook
• test - Dry-run hook code in the sandbox
• get - Get a single custom hook
• update - Partially update a single custom hook
• delete - Delete a single custom hook
• list-history - List a custom hook's version history
• revert - Revert a custom hook to a previous version

• list - Get all organizations (only for super admins on multi-org Enterprise Plan only)
• create - Create a single organization (only for super admins on multi-org Enterprise Plan only)
• update - Edit a single organization (only for super admins on multi-org Enterprise Plan only)

• list - Get all fact tables
• create - Create a single fact table
• get - Get a single fact table
• update - Update a single fact table
• delete - Deletes a single fact table
• list-filters - Get all filters for a fact table
• create-filter - Create a single fact table filter
• get-filter - Get a single fact filter
• update-filter - Update a single fact table filter
• delete-filter - Deletes a single fact table filter
• create-virtual-column - Create a virtual (computed) column on a fact table
• update-virtual-column - Update a virtual (computed) column on a fact table
• delete-virtual-column - Delete a virtual (computed) column from a fact table
• get-aggregated - Get the materialization status of a fact table's shared daily aggregated tables
• refresh-aggregated - Force a refresh or full restate of a fact table's shared daily aggregated tables
• list-aggregated-table-runs - List aggregated table runs
• get-aggregated-table-run - Get a single aggregated table run
• bulk-import - Bulk import fact tables, filters, and metrics

• list - Get all fact metrics
• create - Create a single fact metric
• get - Get a single fact metric
• update - Update a single fact metric
• delete - Deletes a single fact metric
• create-analysis - Create a fact metric analysis

• submit - Submit list of code references
• list - Get list of all code references for the current organization
• get-for-feature - Get list of code references for a single feature id

• list - Get all organization members
• update-member-role - Update a member's global role (including any enviroment restrictions, if applicable). Can also update a member's project roles if your plan supports it.
• delete - Removes a single user from an organization

• get-query - Get a single query

• get - Get organization settings
• set-approvals - Replace the approval requirements for feature flags, configs and constants, and for saved groups. Each family is replaced wholesale when supplied; omit one to leave it unchanged.

• get-version - Get the GrowthBook server version and build info

• list - Get all rampSchedules
• create - Create a ramp schedule
• start - Start a ramp schedule
• pause - Pause a ramp schedule
• resume - Resume a paused ramp schedule
• rollback - Roll back a ramp schedule
• restart - Restart a terminal ramp schedule
• jump - Jump to a specific step
• complete - Complete a ramp schedule immediately
• approve-step - Approve the pending approval gate
• add-target - Add a target rule to a ramp schedule
• eject-target - Remove a target rule from a ramp schedule
• api-advance - Advance to the next step, overriding any holds
• get-ramp-schedule-status - Get ramp schedule status summary
• set-monitoring-mode - Set ramp monitoring mode
• set-auto-update - Toggle automatic monitoring updates
• update-ramp-schedule-monitoring - Update ramp monitoring configuration
• update-ramp-schedule-lockdown - Update ramp lockdown configuration
• update-ramp-schedule-steps - Update ramp schedule steps
• refresh-monitoring - Trigger a manual monitoring update
• get - Get a single rampSchedule
• delete - Delete a single rampSchedule
• update - Update a single rampSchedule

• list - Get all reports
• create - Create a new report
• get - Get a single report
• refresh - Refresh a report by re-running its analysis
• set-metadata - Update report metadata (title, description, visibility)
• set-settings - Update report analysis settings

• list - Get all namespaces
• create - Create a namespace
• get - Get a single namespace
• update - Update a namespace
• delete - Delete a namespace
• get-memberships - Get namespace membership
• rotate-seed - Rotate namespace seed

• get - Get a single dashboard
• delete - Delete a single dashboard
• update - Update a single dashboard
• create - Create a single dashboard
• list - Get all dashboards
• list-for-experiment - Get all dashboards for an experiment

• get - Get a single contextualBanditQuery
• delete - Delete a single contextualBanditQuery
• update - Update a single contextualBanditQuery
• create - Create a single contextualBanditQuery
• list - Get all contextualBanditQueries

• create - Create a single customField
• list - Get all custom fields
• delete - Delete a single customField
• get - Get a single customField
• update - Update a single customField

• get - Get a single metricGroup
• delete - Delete a single metricGroup
• update - Update a single metricGroup
• create - Create a single metricGroup
• list - Get all metricGroups

• get - Get a single team
• update - Update a single team
• delete - Delete a single team
• create - Create a single team
• list - Get all teams
• add-team-members - Add members to team
• remove-team-member - Remove members from team

• get - Get a single experimentTemplate
• delete - Delete a single experimentTemplate
• update - Update a single experimentTemplate
• create - Create a single experimentTemplate
• list - Get all experimentTemplates
• bulk-import - Bulk create or update experiment templates

• run-metric - Create a Metric based visualization
• run-fact-table - Run a Fact Table based visualization
• run-data-source - Create a Data Source based visualization
• run-sql - Create a SQL based visualization
• run-funnel - Run a Funnel based visualization
• search - Search Product Analytics resources
• get-columns - List columns available to a Product Analytics exploration
• get-column-values - Fetch values for Product Analytics string columns
• get - Get a Product Analytics exploration

• get - Get a single rampScheduleTemplate
• delete - Delete a single rampScheduleTemplate
• update - Update a single rampScheduleTemplate
• create - Create a single rampScheduleTemplate
• list - Get all rampScheduleTemplates

• get - Get a single learning
• delete - Delete a single learning
• update - Update a single learning
• create - Create a single learning
• list - Get all learnings
• search - Search saved Learnings by meaning rather than keyword

• get - Get a single holdout
• update - Update a single holdout
• create - Create a single holdout
• list - Get all holdouts
• start - Start the Holdout's Active Period
• start-analysis - Start the Holdout's Analysis Period
• stop - Stop a Holdout

• create - Create a single autoRun
• list - Get all autoRuns
• get - Get a single autoRun
• update - Update a single autoRun
• append-artifact - Record something an auto run created

Operations that accept a request body support three input methods, with a clear priority chain:

growthbook <command> --name "Jane" --age 30

Provide the entire request body as a JSON string:

growthbook <command> --body '{"name": "John", "age": 30}'

Individual flags override --body values:

# Result: {name: "Jane", age: 30}
growthbook <command> --body '{"name": "John", "age": 30}' --name "Jane"

Pipe JSON into any command that accepts a request body:

echo '{"name": "John", "age": 30}' | growthbook <command>

Individual flags override stdin values:

# Result: {name: "Jane", age: 30}
echo '{"name": "John", "age": 30}' | growthbook <command> --name "Jane"

This is useful for chaining commands, reading from files, or scripting:

# Read body from a file
growthbook <command> < request.json

# Pipe from another command
curl -s https://example.com/data.json | growthbook <command>

When multiple input methods are used, the priority is:

Use --server <index> to select a server by its zero-based index (default: 0):

growthbook --server <index> <command> [arguments]

Some server URLs contain template variables (e.g., https://{hostname}:{port}/v1). Set these via dedicated flags:

growthbook --domain value <command> [arguments]

Server variable flags are combined with the selected server URL to produce the final endpoint.

Use --server-url to override the server URL entirely, bypassing any named or indexed server selection:

growthbook --server-url https://custom-api.example.com <command> [arguments]

Precedence: --server-url > --server > default

Every command supports a --output-format flag that controls how the response is rendered to stdout.

# Default pretty output
growthbook <command>

# Machine-readable JSON
growthbook <command> --output-format json

# TOON for LLM-friendly compact output
growthbook <command> --output-format toon

# Pipe JSON to jq without using --output-format
growthbook <command> --output-format json | jq '.fieldName'

Use --jq to filter or transform the response inline using a jq expression. This always outputs JSON and overrides --output-format:

# Extract a single field
growthbook <command> --jq '.name'

# Filter an array
growthbook <command> --jq '.items[] | select(.active == true)'

Use --color to control terminal colors:

The NO_COLOR and FORCE_COLOR environment variables are also respected.

When using --all (pagination) or streaming operations, output is written incrementally as items arrive:

Some operations in this CLI support automatic pagination. These operations accept --all to automatically fetch all pages and stream results incrementally.

# Fetch a single page (default behavior)
growthbook <command> --page 1

# Automatically fetch all pages
growthbook <command> --all

Use --max-pages to cap the number of pages fetched:

# Fetch at most 5 pages
growthbook <command> --all --max-pages 5

When using --all, results are streamed as each page is fetched:

# Stream all results as NDJSON
growthbook <command> --all --output-format json

# Pipe to jq for further processing
growthbook <command> --all --output-format json | jq '.fieldName'

# Use the built-in --jq flag
growthbook <command> --all --jq '.fieldName'

Under the hood, --all calls the operation once, then follows the underlying Next() pagination closure to fetch subsequent pages. Results are written to stdout as they arrive rather than buffered in memory, so this works well even with large result sets.

Without --all, paginated operations behave like any other command — pass cursor, page, offset, or limit flags manually and get a single page of results.

The CLI uses standard exit codes to indicate success or failure:

On success, the response data is printed to stdout as JSON. On failure, error details are printed to stderr.

# Capture output and handle errors
growthbook ... > output.json 2> error.log
if [ $? -ne 0 ]; then
  echo "Error occurred, see error.log"
fi

The CLI includes two diagnostic flags available on all commands:

Preview what would be sent without making any network calls:

growthbook <command> --dry-run

Output goes to stderr and includes:

• HTTP method and URL
• Request headers (sensitive values redacted)
• Request body preview (sensitive fields redacted)

The command exits successfully without contacting the API. This is useful for verifying request construction before executing.

Log request and response diagnostics while running normally:

growthbook <command> --debug

Debug output goes to stderr and includes:

• Request method, URL, headers, and body preview
• Response status, headers, and body preview
• Transport errors (if any)

The command still executes normally and produces its regular output on stdout.

If both --dry-run and --debug are set, --dry-run takes precedence and no network calls are made.

Sensitive information is automatically redacted in diagnostic output:

• Headers: Authorization, Cookie, Set-Cookie, X-API-Key, and other security headers show [REDACTED]
• Body: JSON fields named password, secret, token, api_key, client_secret, etc. show [REDACTED]

Diagnostic output should still be treated as potentially sensitive operational data.

This CLI follows semantic versioning and a stable command-versioning convention — see Versioning and stability at the top of this README. We recommend pinning to a version you have tested.

While we value open-source contributions to this CLI, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.