# flags

> Flags SDK by Vercel - The feature flags toolkit for Next.js and SvelteKit

Latest version **4.3.1** (published 2026-09-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install flags
pnpm add flags
yarn add flags
bun add flags
```

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 4.3.1 |
| Published | 2026-09-09 |
| First published | 2011-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 2 |
| Unpacked size | 546.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 625 |
| Author | Dominik Ferber |
| Maintainers | matheuss, matt.straka, vercel-release-bot, zeit-bot |
| Keywords | feature flags, Next.js, react, toolbar, overrides, SvelteKit |

## Links

- npm: https://www.npmjs.com/package/flags
- Repository: https://github.com/vercel/flags
- Homepage: https://flags-sdk.dev
- Issues: https://github.com/vercel/flags/issues
- npm.io page: https://npm.io/package/flags

## Dependencies (2)

- [jose](https://npm.io/package/jose.md) ^5.10.0
- [@edge-runtime/cookies](https://npm.io/package/@edge-runtime/cookies.md) ^5.0.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 4.3.1 (latest) — 2026-09-09
- 4.3.1-27681ef-20260909081650 (snapshot) — 2026-09-09
- 4.1.0-c84914eb-20250616171721 (canary) — 2025-06-16
- 4.3.1-873d051-20260908100141 — 2026-09-08
- 4.4.0-af502ab-20260904110845 — 2026-09-04
- 4.4.0-b67dc74-20260831122711 — 2026-08-31
- 4.3.0 — 2026-08-04
- 4.2.4 — 2026-07-29
- 4.2.3 — 2026-07-24
- 4.2.2 — 2026-07-24
- 4.2.2-eaa79e2-20260723182108 — 2026-07-23
- 4.2.1 — 2026-07-20
- 4.2.0 — 2026-06-17
- 4.1.1 — 2026-06-16
- 4.1.0 — 2026-06-05
- … 36 more at https://npm.io/package/flags/versions

## README

![hero illustration](./assets/hero-dark.png)

# Flags SDK

The feature flags toolkit for Next.js and SvelteKit.

From the creators of Next.js, the Flags SDK is a free open-source library that gives you the tools you need to use feature flags in Next.js and SvelteKit applications.

- Works with any flag provider, custom setups or no flag provider at all
- Compatible with App Router, Pages Router, and Routing Middleware
- Built for feature flags and experimentation

See [flags-sdk.dev](https://flags-sdk.dev/) for full docs and examples.

> Upgrading from version 3? See the [Upgrade to v4](https://github.com/vercel/flags/blob/main/packages/flags/guides/upgrade-to-v4.md) guide.

## Installation

Install the package using your package manager:

```sh
npm install flags
```

## Setup

Create an environment variable called `FLAGS_SECRET`.

The `FLAGS_SECRET` value must have a specific length (32 random bytes encoded in base64) to work as an encryption key. Create one using node:

```sh
node -e "console.log(crypto.randomBytes(32).toString('base64url'))"
```

Use a separate `FLAGS_SECRET` value for each environment (Development, Preview, Production), and mark the Preview and Production values as Sensitive. Run the generator once per environment to produce distinct values, then store each on Vercel:

```sh
vercel env add FLAGS_SECRET production --sensitive --value <production-secret>
vercel env add FLAGS_SECRET preview --sensitive --value <preview-secret>
vercel env add FLAGS_SECRET development --value <development-secret>
```

This secret is required to use the SDK. It is used to read overrides and to encrypt flag values in case they are sent to the client and should stay secret.

## Usage

Create a file called flags.ts in your project and declare your first feature flag there:

```ts
// app/flags.tsx
import { flag } from "flags/next";

export const exampleFlag = flag<boolean>({
  key: "example-flag",
  decide() {
    return true;
  },
});
```

Call your feature flag in a React Server Component:

```tsx
// app/page.tsx
import { exampleFlag } from "./flags";

export default async function Page() {
  const example = await exampleFlag();
  return <div>{example ? "Flag is on" : "Flag is off"}</div>;
}
```

Feature Flags can also be called in Routing Middleware and API Routes.

## Adapters

The Flags SDK has adapters for popular feature flag providers including LaunchDarkly, Optimizely, and Statsig.

## Documentation

There is a lot more to the Flags SDK than shown in the example above.

See the full documentation and examples on [flags-sdk.dev](https://flags-sdk.dev/).

---
_Source: https://npm.io/package/flags · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._