Quickstart

Create an account and a workspaceCopy Anchor Link

Open toggld.io/start and sign up with GitHub or an email link.

Onboarding creates your first workspace. A workspace holds your flags, environments, segments, and credentials. It starts with two environments: Development and Production. Each environment has its own flag values and rules.

Onboarding can also create a first flag for you. This guide creates a separate flag so that you can follow each step.

Create a flagCopy Anchor Link

1. In your workspace, open Flags and select New flag.
2. Under Basics, set Name to New checkout. The Key becomes new-checkout. Your code uses the key, and you cannot change it later.
3. Under Type, keep boolean.
4. Under Variants, select set default on the true variant. Keep false as the off variant.
5. Under Environments, turn on Development. Keep Production off.
6. Select Create flag.

The flag now serves true in Development, because it is on and it has no targeting rules. It serves false in Production, because it is off there.

Create a server SDK keyCopy Anchor Link

A server SDK key is a secret key that lets your server evaluate flags in one environment.

1. Open Settings → API Keys.
2. In the Development section, select Create key.
3. Enter a Key name, such as Quickstart.
4. Under Access, keep Server SDK key.
5. Select Create key, then copy the key. It starts with ffk_.

Toggld shows the full key only once. If you lose it, delete the key and create a new one.

Install the SDKCopy Anchor Link

Create a project folder and install @toggld/node. The SDK needs effect as a peer dependency, so install both.

pnpm add @toggld/node effect

Put your key and the API URL in a .env file next to your script:

TOGGLD_SDK_KEY=ffk_YOUR_SECRET_KEY
TOGGLD_API_URL=https://api.toggld.io

Add .env to your .gitignore file so that the key stays out of source control.

Evaluate the flagCopy Anchor Link

Create index.mjs:

import { ToggldClient } from "@toggld/node";

const client = await ToggldClient.create({
  sdkKey: process.env.TOGGLD_SDK_KEY,
  endpoint: process.env.TOGGLD_API_URL,
});

const details = await client.getBooleanDetails("new-checkout", false, {
  targetingKey: "user-123",
});
console.log(details.value, details.reason);

await client.close();

Run it. The --env-file option tells Node.js to load your .env file:

node --env-file=.env index.mjs

You see this output:

true STATIC

STATIC means that the flag is on and no targeting rule matched, so Toggld served the default variant. The second argument, false, is your fallback. The SDK returns it if evaluation fails for any reason, such as a network error or a wrong flag key.

Change the flagCopy Anchor Link

1. In the dashboard, open the new-checkout flag.
2. Select the Development tab.
3. Under Who gets what, turn off the Development switch.
4. Select Save Development.

Run the script again:

node --env-file=.env index.mjs

false DISABLED

DISABLED means that the flag is off in this environment, so Toggld served the off variant.

You can also turn a flag on or off from the Flags list. The switch is in the Serving column, and it saves at once.