The ConfigCat Command Line Interface 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.
See the command reference documentation for more information about each available command.
ConfigCat is a feature flag and configuration management service that lets you separate releases from deployments. You can turn your features ON/OFF using ConfigCat Dashboard even after they are deployed. ConfigCat lets you target specific groups of users based on region, email or any other custom user attribute.
ConfigCat is a hosted feature flag service. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.
The following instructions will guide you through the first steps to start using this tool.
You can install the CLI on multiple operating systems using the following methods.
Homebrew (macOS / Linux)
Install the CLI with Homebrew from ConfigCat's tap by executing the following command:
brew tap configcat/tap
brew install configcatSnap (Linux)
Install the CLI with Snapcraft by executing the following command:
sudo snap install configcatScoop (Windows)
Install the CLI with Scoop from ConfigCat's bucket by executing the following command:
scoop bucket add configcat https://github.com/configcat/scoop-configcat
scoop install configcatChocolatey (Windows)
Install the CLI with Chocolatey by executing the following command:
choco install configcatDocker
The CLI can be executed from a Docker image.
docker pull configcat/cliAn 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" | bashBy 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 bashThe script accepts the following input parameters:
| Parameter | Description | Default value |
|---|---|---|
-d, --dir |
The directory where the CLI should be installed. | /usr/local/bin |
-v, --version |
The desired version to install. | latest |
-a, --arch |
The 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 to support 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/installInstall a different version:
curl -fsSL "https://raw.githubusercontent.com/configcat/cli/main/scripts/install.sh" | bash -s -- -v=1.4.2Install with custom architecture:
curl -fsSL "https://raw.githubusercontent.com/configcat/cli/main/scripts/install.sh" | bash -s -- -a=armStandalone executables
You can download the executables directly from GitHub Releases for your desired platform.
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.
Besides the configuration command above, the CLI can read your credentials from the following environment variables.
| Name | Description |
|---|---|
CONFIGCAT_API_HOST |
The Management API host. (default: api.configcat.com) |
CONFIGCAT_API_USER |
The Management API basic authentication username. |
CONFIGCAT_API_PASS |
The Management API basic authentication password. |
When any of these environment variables are set, the CLI will use them over the local values set by the
configcat setupcommand.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent