Quick Start

Get from zero to evaluating flags in your app.

Create a Project and Environment

Log into the Flipswitch dashboard
Create a Project (e.g., "My App")
Create an Environment (e.g., "Development")

Each environment is isolated - flags can have different values per environment.

Create Your First Flag

Navigate to Flags in your project
Click Create Flag
Enter a key: dark-mode
Select Boolean type
Set default value to false

Your flag exists but is disabled. Toggle it on to return true.

Get Your API Key

Each environment automatically gets an API key when created. Find it in the Environments tab:

Click on your environment
Copy the token from the API Key section

Keep your API key secure. If compromised, use Rotate Key to generate a new one. The old key stays valid for 24 hours during rotation.

Install the SDK

npm install @flipswitch-io/web-provider @openfeature/web-sdk

npm install @flipswitch-io/server-provider @openfeature/server-sdk

<dependency>
    <groupId>io.flipswitch</groupId>
    <artifactId>flipswitch-sdk</artifactId>
</dependency>

pip install flipswitch-sdk openfeature-sdk

go get github.com/flipswitch-io/go-sdk
go get github.com/open-feature/go-sdk

Evaluate Flags

import { FlipswitchWebProvider } from '@flipswitch-io/web-provider';
import { OpenFeature } from '@openfeature/web-sdk';

const provider = new FlipswitchWebProvider({
  apiKey: 'YOUR_API_KEY'
});

await OpenFeature.setProviderAndWait(provider);
const client = OpenFeature.getClient();

const darkMode = await client.getBooleanValue('dark-mode', false);
console.log(`Dark mode: ${darkMode}`);

import { FlipswitchServerProvider } from '@flipswitch-io/server-provider';
import { OpenFeature } from '@openfeature/server-sdk';

const provider = new FlipswitchServerProvider({
  apiKey: 'YOUR_API_KEY'
});

await OpenFeature.setProviderAndWait(provider);
const client = OpenFeature.getClient();

const darkMode = await client.getBooleanValue('dark-mode', false, {
  targetingKey: 'user-123',
});
console.log(`Dark mode: ${darkMode}`);

import io.flipswitch.FlipswitchProvider;
import dev.openfeature.sdk.OpenFeatureAPI;
import dev.openfeature.sdk.Client;

FlipswitchProvider provider = FlipswitchProvider.builder("YOUR_API_KEY").build();

OpenFeatureAPI api = OpenFeatureAPI.getInstance();
api.setProviderAndWait(provider);

Client client = api.getClient();
boolean darkMode = client.getBooleanValue("dark-mode", false);
System.out.println("Dark mode: " + darkMode);

from flipswitch import FlipswitchProvider
from openfeature import api

provider = FlipswitchProvider(api_key="YOUR_API_KEY")
api.set_provider(provider)

client = api.get_client()
dark_mode = client.get_boolean_value("dark-mode", False)
print(f"Dark mode: {dark_mode}")

import (
    "github.com/open-feature/go-sdk/openfeature"
    flipswitch "github.com/flipswitch-io/go-sdk"
)

provider, _ := flipswitch.NewProvider("YOUR_API_KEY")
defer provider.Shutdown()
provider.Init(openfeature.EvaluationContext{})

openfeature.SetProvider(provider)
client := openfeature.NewClient("my-app")

darkMode, _ := client.BooleanValue(ctx, "dark-mode", false, openfeature.EvaluationContext{})

Test Real-Time Updates

Run your application
Toggle the flag in the dashboard
Watch your app update instantly

The SDK maintains an SSE connection and receives flag changes in real-time.

Next Steps

Core Concepts - Understand targeting, segments, and rollouts
SDK Documentation - Deep dive into your language's SDK
Targeting Guide - Set up targeting rules