View Source ConfigCat SDK for Elixir

ConfigCat SDK for Elixir provides easy integration for your application to ConfigCat.

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.

Elixir CI Coverage Status Last Updated

Getting Started

1. Add configcat to your list of dependencies in mix.exs:

def deps do
    {:configcat, "~> 4.0.1"}

2. Go to the <a href="" target="_blank">ConfigCat Dashboard</a> to get your SDK Key:


3. Add ConfigCat to your application Supervisor tree:

def start(_type, _args) do
  children = [
    {ConfigCat, [sdk_key: "YOUR SDK KEY"]},

  opts = [strategy: :one_for_one, name: MyApp.Supervisor]
  Supervisor.start_link(children, opts)

4. Get your setting value:

isMyAwesomeFeatureEnabled = ConfigCat.get_value("isMyAwesomeFeatureEnabled", false)
if isMyAwesomeFeatureEnabled do

Getting user specific setting values with Targeting

Using this feature, you will be able to get different setting values for different users in your application by passing a ConfigCat.User object to the ConfigCat.get_value/3 function.

Read more about Targeting here.


isMyAwesomeFeatureEnabled = ConfigCat.get_value("isMyAwesomeFeatureEnabled", false, user)
if isMyAwesomeFeatureEnabled do

Sample/Demo apps

Polling Modes

The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache then all requests are served from there. Read more about Polling Modes and how to use them at ConfigCat Docs.

Need help?


Contributions are welcome. For more info please read the Contribution Guideline.

About ConfigCat