growthbook
Version:
The GrowthBook command-line interface (CLI) for working with the GrowthBook A/B testing, feature flagging, and experimentation platform
1,335 lines • 40.1 kB
JSON
{
"version": "0.2.4",
"commands": {
"auth": {
"id": "auth",
"description": "",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [],
"flags": {},
"args": {}
},
"auth:login": {
"id": "auth:login",
"description": "Configure your API key with the GrowthBook SDK with your project",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [],
"flags": {},
"args": {}
},
"auth:logout": {
"id": "auth:logout",
"description": "Removes GrowthBook API key configurations",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [],
"flags": {
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances or organizations) (default: all profiles)",
"required": false,
"multiple": false
}
},
"args": {}
},
"datasources:get": {
"id": "datasources:get",
"description": "Get a single datasource by ID",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
}
},
"args": {
"id": {
"name": "id",
"description": "Datasource ID",
"required": true
}
}
},
"datasources:list": {
"id": "datasources:list",
"description": "Get all data sources",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"limit": {
"name": "limit",
"type": "option",
"description": "Limit for pagination",
"required": false,
"multiple": false,
"default": 100
},
"offset": {
"name": "offset",
"type": "option",
"description": "Offset for pagination",
"required": false,
"multiple": false,
"default": 0
},
"project": {
"name": "project",
"type": "option",
"description": "Project ID filter",
"required": false,
"multiple": false
}
},
"args": {}
},
"dimensions:get": {
"id": "dimensions:get",
"description": "Get a single dimension used during experiment analysis",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
}
},
"args": {
"id": {
"name": "id",
"description": "Dimension ID",
"required": true
}
}
},
"dimensions:list": {
"id": "dimensions:list",
"description": "Get all dimensions used during experiment analysis",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"limit": {
"name": "limit",
"type": "option",
"description": "Limit for pagination",
"required": false,
"multiple": false,
"default": 100
},
"offset": {
"name": "offset",
"type": "option",
"description": "Offset for pagination",
"required": false,
"multiple": false,
"default": 0
},
"dataSourceId": {
"name": "dataSourceId",
"type": "option",
"description": "Data source ID to filter by",
"required": false,
"multiple": false
}
},
"args": {}
},
"experiments:get": {
"id": "experiments:get",
"description": "Get a single experiment by ID",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
}
},
"args": {
"id": {
"name": "id",
"description": "Experiment ID",
"required": true
}
}
},
"experiments:list": {
"id": "experiments:list",
"description": "Get all experiments",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"limit": {
"name": "limit",
"type": "option",
"description": "Limit for pagination",
"required": false,
"multiple": false,
"default": 100
},
"offset": {
"name": "offset",
"type": "option",
"description": "Offset for pagination",
"required": false,
"multiple": false,
"default": 0
},
"project": {
"name": "project",
"type": "option",
"description": "Project ID filter",
"required": false,
"multiple": false
},
"datasource": {
"name": "datasource",
"type": "option",
"description": "Datasource ID filter",
"required": false,
"multiple": false
},
"experiment": {
"name": "experiment",
"type": "option",
"description": "Filter the returned list by the experiment tracking key (id)",
"required": false,
"multiple": false
}
},
"args": {}
},
"experiments:results": {
"id": "experiments:results",
"description": "Get results for an experiment with optional phase and dimension filtering",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"dimension": {
"name": "dimension",
"type": "option",
"required": false,
"multiple": false
},
"phase": {
"name": "phase",
"type": "option",
"required": false,
"multiple": false
}
},
"args": {
"experimentId": {
"name": "experimentId",
"description": "ID of the experiment",
"required": true
}
}
},
"features:generate-types": {
"id": "features:generate-types",
"description": "Generate TypeScript types for all your features",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"output": {
"name": "output",
"type": "option",
"char": "o",
"description": "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.",
"required": false,
"multiple": false
},
"filename": {
"name": "filename",
"type": "option",
"char": "f",
"description": "Output filename for the generated types. If not provided, the filename app-features.ts will be used.",
"required": false,
"multiple": false
},
"project": {
"name": "project",
"type": "option",
"description": "Project ID filter",
"required": false,
"multiple": false
}
},
"args": {}
},
"features:get": {
"id": "features:get",
"description": "Get a feature by key",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
}
},
"args": {
"featureKey": {
"name": "featureKey",
"description": "Feature key",
"required": true
}
}
},
"features:list": {
"id": "features:list",
"description": "Get all features",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"limit": {
"name": "limit",
"type": "option",
"description": "Limit for pagination",
"required": false,
"multiple": false,
"default": 100
},
"offset": {
"name": "offset",
"type": "option",
"description": "Offset for pagination",
"required": false,
"multiple": false,
"default": 0
},
"project": {
"name": "project",
"type": "option",
"description": "Project ID filter",
"required": false,
"multiple": false
}
},
"args": {}
},
"features:toggle": {
"id": "features:toggle",
"description": "Toggle a feature on or off for a specific environment",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"environment": {
"name": "environment",
"type": "option",
"char": "e",
"description": "Environment that you would like to toggle",
"required": true,
"multiple": false
},
"enabled": {
"name": "enabled",
"type": "option",
"char": "n",
"description": "Enabled state of the feature",
"required": true,
"multiple": false,
"options": [
"true",
"false",
"on",
"off",
"1",
"0"
]
},
"reason": {
"name": "reason",
"type": "option",
"char": "r",
"description": "The reason for toggling it on",
"required": false,
"multiple": false
}
},
"args": {
"featureKey": {
"name": "featureKey",
"description": "Feature key to toggle",
"required": true
}
}
},
"metrics:create": {
"id": "metrics:create",
"description": "Create a metric from file or standard in",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"cat my-metric.json | <%= config.bin %> <%= command.id %>",
"<%= config.bin %> <%= command.id %> --filePath my-metric.json"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"filePath": {
"name": "filePath",
"type": "option",
"char": "f",
"description": "Path to input file",
"required": false,
"multiple": false
},
"output": {
"name": "output",
"type": "option",
"char": "o",
"description": "Path to output file, e.g. created-resource.json",
"required": false,
"multiple": false
}
},
"args": {
"input": {
"name": "input",
"description": "JSON payload of the metric to be created. Docs: https://docs.growthbook.io/api/#tag/metrics/operation/postMetric",
"required": false
}
}
},
"metrics:get": {
"id": "metrics:get",
"description": "Get a single metric by ID",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
}
},
"args": {
"metricId": {
"name": "metricId",
"description": "Metric ID",
"required": true
}
}
},
"metrics:list": {
"id": "metrics:list",
"description": "List all metrics",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"limit": {
"name": "limit",
"type": "option",
"description": "Limit for pagination",
"required": false,
"multiple": false,
"default": 100
},
"offset": {
"name": "offset",
"type": "option",
"description": "Offset for pagination",
"required": false,
"multiple": false,
"default": 0
},
"project": {
"name": "project",
"type": "option",
"description": "Project ID filter",
"required": false,
"multiple": false
}
},
"args": {}
},
"projects:get": {
"id": "projects:get",
"description": "Get a single project by ID",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
}
},
"args": {
"projectId": {
"name": "projectId",
"description": "Project ID",
"required": true
}
}
},
"projects:list": {
"id": "projects:list",
"description": "List all projects",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"limit": {
"name": "limit",
"type": "option",
"description": "Limit for pagination",
"required": false,
"multiple": false,
"default": 100
},
"offset": {
"name": "offset",
"type": "option",
"description": "Offset for pagination",
"required": false,
"multiple": false,
"default": 0
}
},
"args": {}
},
"savedgroups:create": {
"id": "savedgroups:create",
"description": "Create a saved group",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>",
"<%= config.bin %> <%= command.id %> --filePath input.json"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"filePath": {
"name": "filePath",
"type": "option",
"char": "f",
"description": "Path to input file",
"required": false,
"multiple": false
},
"output": {
"name": "output",
"type": "option",
"char": "o",
"description": "Path to output file, e.g. created-resource.json",
"required": false,
"multiple": false
}
},
"args": {
"input": {
"name": "input",
"description": "JSON payload of the saved group to be created. Docs: https://docs.growthbook.io/api/#tag/saved-groups/operation/postSavedGroup",
"required": false
}
}
},
"savedgroups:delete": {
"id": "savedgroups:delete",
"description": "Delete a saved group",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
}
},
"args": {
"id": {
"name": "id",
"description": "Saved Group ID",
"required": true
}
}
},
"savedgroups:get": {
"id": "savedgroups:get",
"description": "Get a single saved group by ID",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
}
},
"args": {
"id": {
"name": "id",
"description": "Saved Group ID",
"required": true
}
}
},
"savedgroups:list": {
"id": "savedgroups:list",
"description": "Defined sets of attribute values which can be used with feature rules for targeting features at particular users.",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"limit": {
"name": "limit",
"type": "option",
"description": "Limit for pagination",
"required": false,
"multiple": false,
"default": 100
},
"offset": {
"name": "offset",
"type": "option",
"description": "Offset for pagination",
"required": false,
"multiple": false,
"default": 0
}
},
"args": {}
},
"savedgroups:update": {
"id": "savedgroups:update",
"description": "Update an existing saved group.",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>",
"<%= config.bin %> <%= command.id %> --filePath input.json"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"filePath": {
"name": "filePath",
"type": "option",
"char": "f",
"description": "Path to input file",
"required": false,
"multiple": false
},
"output": {
"name": "output",
"type": "option",
"char": "o",
"description": "Path to output file, e.g. created-resource.json",
"required": false,
"multiple": false
},
"id": {
"name": "id",
"type": "option",
"char": "i",
"description": "Saved group ID to update",
"required": true,
"multiple": false
}
},
"args": {
"input": {
"name": "input",
"description": "JSON payload of the update payload. Docs: https://docs.growthbook.io/api/#tag/saved-groups/operation/updateSavedGroup",
"required": false
}
}
},
"sdkconnections:get": {
"id": "sdkconnections:get",
"description": "Client keys and settings for connecting SDKs to a GrowthBook instance",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
}
},
"args": {
"id": {
"name": "id",
"description": "SDK connection ID",
"required": true
}
}
},
"sdkconnections:list": {
"id": "sdkconnections:list",
"description": "Client keys and settings for connecting SDKs to a GrowthBook instance",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"limit": {
"name": "limit",
"type": "option",
"description": "Limit for pagination",
"required": false,
"multiple": false,
"default": 100
},
"offset": {
"name": "offset",
"type": "option",
"description": "Offset for pagination",
"required": false,
"multiple": false,
"default": 0
},
"projectId": {
"name": "projectId",
"type": "option",
"description": "Project ID to filter by",
"required": false,
"multiple": false
}
},
"args": {}
},
"segments:get": {
"id": "segments:get",
"description": "Get a single segment used during experiment analysis",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
}
},
"args": {
"id": {
"name": "id",
"description": "Segment ID",
"required": true
}
}
},
"segments:list": {
"id": "segments:list",
"description": "Get all segments used during experiment analysis",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"limit": {
"name": "limit",
"type": "option",
"description": "Limit for pagination",
"required": false,
"multiple": false,
"default": 100
},
"offset": {
"name": "offset",
"type": "option",
"description": "Offset for pagination",
"required": false,
"multiple": false,
"default": 0
},
"dataSourceId": {
"name": "dataSourceId",
"type": "option",
"description": "Data source ID to filter by",
"required": false,
"multiple": false
}
},
"args": {}
},
"vcs:get": {
"id": "vcs:get",
"description": "Get a Visual Changeset created in the visual editor",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"includeExperiment": {
"name": "includeExperiment",
"type": "option",
"char": "e",
"description": "Include the associated experiment in payload",
"required": false,
"multiple": false,
"options": [
"0",
"1"
],
"default": 0
}
},
"args": {
"id": {
"name": "id",
"description": "Visual Changeset ID",
"required": true
}
}
},
"vcs:list": {
"id": "vcs:list",
"description": "List Visual Changesets created in the visual editor",
"strict": true,
"pluginName": "growthbook",
"pluginAlias": "growthbook",
"pluginType": "core",
"aliases": [],
"examples": [
"<%= config.bin %> <%= command.id %>"
],
"flags": {
"apiBaseUrl": {
"name": "apiBaseUrl",
"type": "option",
"char": "u",
"description": "Your GrowthBook instance base URL (e.g. http://localhost:3100, default: https://api.growthbook.io)",
"required": false,
"multiple": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Optional profile (for projects that use multiple GrowthBook instances) default: default)",
"required": false,
"multiple": false
},
"experiment": {
"name": "experiment",
"type": "option",
"char": "e",
"description": "Filter by experiment",
"required": true,
"multiple": false
}
},
"args": {}
}
}
}