Skip to main content

Command Line Interface

The ConfigCat Command Line Interface (CLI) allows you to interact with the Public 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.

configcat  This is the Command Line Tool of ConfigCat.  ConfigCat is a hosted feature flag service: https://configcat.com  For more information, see the documentation here: https://configcat.com/docs/advanced/cli
Usage:  configcat [options] [command]
Options:  -v, --verbose   Print detailed execution information  --version       Show version information  -?, -h, --help  Show help and usage information
Commands:  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  ls                   List all Product, Config, and Environment IDs  p, product           Manage Products  c, config            Manage Configs  e, environment       Manage Environments  t, tag               Manage Tags  f, flag, s, setting  Manage Feature Flags & Settings  k, sdk-key           List SDK Keys  scan <directory>     Scans files for Feature Flag or Setting usages
Use "configcat [command] -?" for more information about a command.

Reference#

See the command reference documentation for more information about each available command.

Getting Started#

The following instructions will guide you through the first steps to start using this tool.

Installation#

You can install the CLI on multiple operating systems using the following sources.

Homebrew (macOS / Linux)

Install the CLI from ConfigCat tap with Homebrew by executing the following command:

brew tap configcat/tapbrew install configcat
Snap (Linux)

Install the CLI from Snapcraft by executing the following command:

sudo snap install configcat
Scoop (Windows)

Install the CLI from ConfigCat bucket with Scoop by executing the following command:

scoop bucket add configcat https://github.com/configcat/scoop-configcatscoop install configcat
Chocolatey (Windows)

Install the CLI from Chocolatey by executing the following command:

choco install configcat
Docker

The CLI can be executed from a Docker image.

docker pull configcat/cli

An example of how to scan a repository for feature flag & setting references with the docker image.

docker run --rm \    --env CONFIGCAT_API_HOST=<API-HOST> \    --env CONFIGCAT_API_USER=<API-USER> \    --env CONFIGCAT_API_PASS=<API-PASSWORD> \    -v /path/to/repository:/repository \  configcat/cli scan "/repository" --print --config-id <CONFIG-ID>
Install Script

On Unix platforms, you can install the CLI by executing an install script.

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

By default, the script downloads the OS specific artifact from the latest GitHub Release with curl and moves it into the /usr/local/bin directory.

It might happen, that you don't have permissions to write into /usr/local/bin, then you should execute the install script with sudo.

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

The script accepts the following input parameters:

ParameterDescriptionDefault value
-d, --dirThe directory where the CLI should be installed./usr/local/bin
-v, --versionThe desired version to install.latest
-a, --archThe desired architecture to install.x64

The possible architecture values for Linux: x64, musl-x64, arm, arm64.

For macOS, the architecture is fixed to x64, but we plan the support of Apple silicon in the future.

Script usage examples:

Custom installation directory:

curl -fsSL "https://raw.githubusercontent.com/configcat/cli/main/scripts/install.sh" | bash -s -- -d=/path/to/install

Install a different version:

curl -fsSL "https://raw.githubusercontent.com/configcat/cli/main/scripts/install.sh" | bash -s -- -v=1.4.2

Install with custom architecture:

curl -fsSL "https://raw.githubusercontent.com/configcat/cli/main/scripts/install.sh" | bash -s -- -a=arm
Standalone executables

You can download the executables directly from GitHub Releases for your desired platform.

Configuration#

After a successful installation, the CLI must be configured with your ConfigCat Management API credentials.

You can do this by using the configcat setup command.

interactive

Environment Variables#

Besides the configuration command above, the CLI can read your credentials from the following environment variables.

NameDescription
CONFIGCAT_API_HOSTThe Management API host. (default: api.configcat.com)
CONFIGCAT_API_USERThe Management API basic authentication username.
CONFIGCAT_API_PASSThe Management API basic authentication password.
caution

When any of these environment variables are set, the CLI will use them over the local values set by the configcat setup command.

Modes#

The CLI supports both interactive and argument driven execution. When no arguments provided for a command and user input is enabled (stdout is not redirected), the CLI automatically activates interactive mode.

Interactive#

interactive

With Arguments#

The same operation with command arguments would look like this:

configcat flag create \--config-id <config-id> \ --name "My awesome feature" \--hint "This is my awesome feature" \--key my_awesome_feature--type boolean \--tag-ids <tag-id-1> <tag-id-2> \
info

Each create command writes the newly created resource's ID to the standard output, that you can save for further operations.

info

You can change the output format of several command's result to JSON with the --json option, like: configcat flag ls --json. See more about these commands in the command reference documentation.

Examples#

Here are a few examples showing the true power of the CLI.

Create a Feature Flag#

The following example shows how you can create a Feature Flag in a specific Config via command line.

create-flag

Value update#

The following example shows how you can update the value of a Feature Flag in a specific Environment via command line.

flag-value-update

Add targeting rules#

The following example shows how you can add targeting rules to a Feature Flag via command line.

flag-targeting-add

Add percentage rules#

The following example shows how you can set percentage rules on a Feature Flag via command line.

flag-percentage-add

Scan for code references#

The following example shows how you can scan a codebase for Feature Flag or Setting usages. The scanner command searches for every Feature Flag / Setting key defined within the given Config.

flag-percentage-add

The scan command respects all include/exclude patterns listed inside .gitignore and .ignore files within the given directory.

In addition, you can create an extra .ccignore file with patterns that the scanner must include/exclude.

Each pattern must follow the gitignore pattern format.