Flags & Experiments
Getting started
Install the SDK, configure once, ship a flag — under five minutes.
▶
Flags & Experiments in 5 minutes
~5 minutes · no card required01 · INSTALL
Add the SDK and CLI
One package, server + browser. The CLI logs in via your browser — no env tokens.
$npm i @shipeasy/sdk && npm i -g @shipeasy/cli
02 · LOGIN
Authenticate
Opens your browser, mints an admin SDK key, stores it in ~/.config/shipeasy/.
$shipeasy login
03 · WIRE
Configure once, use everywhere
Gates, configs, experiments, and killswitches all share this single apiKey.
$// app/layout.tsx
import { shipeasy } from '@shipeasy/sdk/server';
await shipeasy({ apiKey: process.env.NEXT_PUBLIC_SHIPEASY_CLIENT_KEY! });
04 · SHIP
Create your first gate
Changes you make are visible to your SDK worldwide in under a second.
$shipeasy gate create checkout-v2 --rollout 5
05 · USE
Gate code in your app
Sub-millisecond evaluation. No per-request network call from your code.
$import { gate } from '@shipeasy/sdk/server';
if (await gate('checkout-v2', { userId })) {
return renderCheckoutV2();
}
Where to next
Pick the right toolWhich primitive?
Decision tree mapping "I want to do X" to gate vs config vs killswitch vs experiment.
Read →Deep diveGates — boolean flagsTargeting rules, rollout percentages, hashing, sticky bucketing.
Read →Deep diveExperiments — A/B testsUniverses, holdouts, metrics, and how daily statistical analysis works.
Read →ReferenceCLI commandsEvery gate / config / experiment / killswitch verb the CLI exposes.
Read →