Command Line Interface Reference

GitHub | Documentation | ConfigCat

This is a reference for the ConfigCat CLI. It allows you to interact with the ConfigCat Management API via the command line. It supports most functionality found on the ConfigCat Dashboard. You can manage ConfigCat resources like Feature Flags, Targeting / Percentage rules, Products, Configs, Environments, and more.

Options

Option Description
--verbose, -v, /v Print detailed execution information
--version Show version information
-h, /h, --help, -?, /? Show help and usage information

Commands

This is the complete list of the available commands provided by the CLI.

configcat setup

Command Description
configcat setup Setup the CLI with Public Management API host and credentials.
You can get your credentials from here: https://app.configcat.com/my-account/public-api-credentials

configcat ls

Command Description
configcat ls List all Product, Config, and Environment IDs

configcat product

Command Description
configcat product Manage Products
configcat product ls List all Products that belongs to the configured user
configcat product create Create a new Product in a specified Organization identified by the --organization-id option
configcat product rm Remove a Product identified by the --product-id option
configcat product update Update a Product identified by the --product-id option

configcat config

Command Description
configcat config Manage Configs
configcat config ls List all Configs that belongs to the configured user
configcat config create Create a new Config in a specified Product identified by the --product-id option
configcat config rm Remove a Config identified by the --config-id option
configcat config update Update a Config identified by the --config-id option

configcat environment

Command Description
configcat environment Manage Environments
configcat environment ls List all Environments that belongs to the configured user
configcat environment create Create a new Environment in a specified Product identified by the --product-id option
configcat environment rm Remove an Environment identified by the --environment-id option
configcat environment update Update environment

configcat tag

Command Description
configcat tag Manage Tags
configcat tag ls List all Tags that belongs to the configured user
configcat tag create Create a new Tag in a specified Product identified by the --product-id option
configcat tag rm Remove a Tag identified by the --tag-id option
configcat tag update Update a Tag identified by the --tag-id option

configcat flag

Command Description
configcat flag Manage Feature Flags & Settings
configcat flag ls List all Feature Flags & Settings that belongs to the configured user
configcat flag create Create a new Feature Flag or Setting in a specified Config identified by the --config-id option
configcat flag rm Remove a Feature Flag or Setting identified by the --flag-id option
configcat flag update Update a Feature Flag or Setting identified by the --flag-id option
configcat flag attach Attach Tag(s) to a Feature Flag or Setting
configcat flag detach Detach Tag(s) from a Feature Flag or Setting
configcat flag value Show, and update Feature Flag or Setting values in different Environments
configcat flag value show Show Feature Flag or Setting values, targeting, and percentage rules for each environment
configcat flag value update Update the value of a Feature Flag or Setting
configcat flag targeting Manage targeting rules
configcat flag targeting create Create new targeting rule
configcat flag targeting update Update targeting rule
configcat flag targeting rm Delete targeting rule
configcat flag targeting move Move a targeting rule into a different position
configcat flag percentage Manage percentage rules
configcat flag percentage update Update percentage rules
configcat flag percentage clear Delete all percentage rules

configcat sdk-key

Command Description
configcat sdk-key List SDK Keys

configcat scan

Command Description
configcat scan Scans files for Feature Flag or Setting usages