shipd

Overview

shipd is a feature-flag service. You define flags (toggles, switches, gates) in TypeScript, review them in PRs, and evaluate them in-process in microseconds. Your app never waits on us for a flag check. We use the same SDK on app.useshipd.com — rules-editor and audit-log are shipd flags.

Quickstart

Define new-checkout, push it, evaluate it.

Define flags in code

shipd.config.ts + shipd push.

Evaluate in your app

createClient, isEnabled, getVariant.

CLI reference

login, pull, diff, push, types gen.

What you get

shipd.config.ts

import { defineFlags } from "shipdit/config";

export default defineFlags({
  "new-checkout": {
    type: "boolean",
    default: false,
    description: "Redesigned checkout flow",
    tags: ["checkout"],
  },
  "search-variant": {
    type: "variant",
    variants: ["control", "semantic", "hybrid"] as const,
    default: "control",
  },
});

app.ts

import { createClient } from "shipdit";
import type { FlagDefinitions } from "./generated/flags";

const shipd = createClient<FlagDefinitions>({
  sdkKey: process.env.SHIPD_SDK_KEY!,
  endpoint: "https://edge.useshipd.com",
  defaults: { "new-checkout": false, "search-variant": "control" },
});

await shipd.ready();

if (shipd.isEnabled("new-checkout", { userId: "usr_8f2k19" })) {
  return renderNewCheckout();
}

Feature flags, toggles, switches, gates — same thing

A flag is a named value your app reads at runtime: on/off, a variant, a number, or JSON. Teams also call them toggles, switches, or gates. Variant flags are experiments / A/B tests. This site uses flag.

Config as code, not a dashboard-only tool

The source of truth for definitions is shipd.config.ts. shipd push applies it. The dashboard is for targeting rules, rollouts, and debugging — not a second source of flag keys.

Local evaluation

The SDK downloads a snapshot (the evaluation payload) and checks flags in memory. If the edge is down, you get your defaults. See Local evaluation.

Paths through the docs

If you want to…	Go here
Get a flag evaluating	Quickstart
Author flags in a repo	Define flags in code
Wire the SDK	Evaluate flags
Target users / identify	Target users
Look up a command or option	CLI · SDK · Config

Getting started

Guides

How-to

Concepts

Reference

Overview

Quickstart

Define flags in code

Evaluate in your app

CLI reference

What you get

Paths through the docs

​Overview

Quickstart

Define flags in code

Evaluate in your app

CLI reference

​What you get

​Paths through the docs

Overview

What you get

Paths through the docs