Getting started
Install the SDK, configure once, ship a flag — under five minutes.
▶
Flags & Configs 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
Feature flags, configs, and killswitches all share this single apiKey.
$// app/layout.tsx
import { configure } from '@shipeasy/sdk/server';
configure({
apiKey: process.env.SHIPEASY_SERVER_KEY ?? '',
attributes: (u) => ({ user_id: u.id, plan: u.plan }),
});
04 · SHIP
Create your first feature flag
Changes you make are visible to your SDK worldwide in under a second.
$shipeasy release flags create checkout-v2 --rollout-percent 5
05 · USE
Put a feature flag around code in your app
Sub-millisecond evaluation. No per-request network call from your code.
$import { Client } from '@shipeasy/sdk/server';
const flags = new Client(currentUser);
if (flags.getFlag('checkout-v2')) {
return renderCheckoutV2();
}
Where to next
Pick the right toolWhich primitive?
Decision tree mapping "I want to do X" to feature flag vs config vs killswitch.
Read →Deep diveFeature flags — boolean flagsTargeting rules, rollout percentages, hashing, sticky bucketing.
Read →Deep diveConfigs — typed valuesSchema-validated strings, numbers and JSON, with per-environment drafts.
Read →ReferenceCLI commandsEvery feature flag / config / killswitch verb the CLI exposes.
Read →Related