Create a boolean flag

Overview

In this guide you add a boolean flag, new-checkout, in TypeScript or Go, push it, branch on it in code, and turn it on from the dashboard. You need the shipd CLI signed in (shipd login) and an SDK client. See the Quickstart if you have neither.

Steps

Define the flag

// shipd.config.ts
import { defineFlags } from "shipdit/config";

export default defineFlags({
  "new-checkout": {
    type: "boolean",
    default: false,
    description: "Redesigned checkout flow",
    tags: ["checkout"],
  },
});

// Entries inside config.ShipdConfig (import github.com/alasti-company/useshipd.com/sdks/go/config).
"new-checkout": {Type: "boolean", Default: false,
    Description: "Redesigned checkout flow", Tags: []string{"checkout"}},

For Go, add definitions to Config in shipd.config.go, then run shipd push. See Define flags in code for the complete file.

Push it

shipd push --project web-app --env production

The flag is created in every environment of the project. In the environment you push to, it is enabled and its Fallthrough serves the default (false). Push also regenerates TypeScript types or Go accessors according to your project settings.

Evaluate it

// src/checkout.ts
import { shipd } from "./lib/shipd";

export function renderCheckout(userId: string) {
  if (shipd.isEnabled("new-checkout", { userId })) {
    return renderNewCheckout();
  }
  return renderLegacyCheckout();
}

// checkout.go
if client.IsEnabled("new-checkout", shipd.EvaluationContext{UserID: userID}) {
    return renderNewCheckout()
}
return renderLegacyCheckout()

In React:

src/components/checkout.tsx

const on = useFlag("new-checkout");

Pass "new-checkout": false in the client’s defaults so the flag stays off before the first snapshot arrives. See isEnabled.

Turn it on

In the dashboard, open the project, click new-checkout, and select the environment. Then either:

set Fallthrough to true to turn it on for everyone, or
click Add rule to turn it on for some users (by attribute or by percentage).

Click Save environment. Running SDK clients pick up the change on their next snapshot refresh.

shipd push sets Fallthrough in the target environment back to the config default when they differ. After you change Fallthrough in the dashboard, update default in your flag definitions (or run shipd pull) so the next push doesn’t revert it. See Push, pull, and diff.

Create it without a config file

shipd flags create --key new-checkout --type boolean --description "Redesigned checkout flow"

Prefer defineFlags and shipd push so the repository stays the source of truth. See CLI reference.

Flags

Config as code

Operations

Enterprise

Migrate to shipd

Create a boolean flag

Overview

Steps

Create it without a config file

Next

​Overview

​Steps

​Create it without a config file

​Next

Overview

Steps

Create it without a config file

Next