vercel flags

The vercel flags command manages Vercel Flags for a project directly from the command line. You can create, list, inspect, enable, disable, archive, and delete feature flags, as well as manage SDK keys.

vercel flags list

vercel flags add [slug]

vercel flags inspect [flag]

vercel flags enable [flag]

vercel flags disable [flag]

vercel flags archive [flag]

vercel flags rm [flag]

Boolean flags are created by default. You can specify a different kind and an optional description:

vercel flags add my-feature --kind string --description "My feature flag"

When you create a flag, default variants are generated based on the kind:

All three environments (production, preview, and development) start as paused.

The enable and disable commands control whether a boolean flag evaluates rules in a given environment. If you don't provide the --environment option, you'll be prompted to select one interactively.

vercel flags enable my-feature --environment production

vercel flags disable my-feature -e production --variant off

A flag must be archived before it can be deleted. Archived flags stop evaluating and can be restored from the dashboard.

vercel flags archive my-feature --yes

vercel flags rm my-feature --yes

The vercel flags sdk-keys subcommand manages SDK keys for your project. SDK keys authenticate your application when evaluating flags. You can create keys for different environments and key types.

vercel flags sdk-keys ls

vercel flags sdk-keys add --type server --environment production

vercel flags sdk-keys rm [hash-key]

When you create an SDK key, the output includes:

• Hash key: A truncated identifier shown in the key list
• SDK key: The full key value, shown only at creation time
• Connection string: A flags: URI containing all configuration needed to connect to Vercel Flags

If you don't provide the --environment option, you'll be prompted to select one interactively.

These are options that only apply to the vercel flags command.

The --state option, shorthand -s, filters the list of flags by state when using vercel flags list. Valid values are active and archived. Defaults to active.

vercel flags ls --state archived

The --kind option, shorthand -k, specifies the type of a new flag when using vercel flags add. Valid values are boolean, string, and number. Defaults to boolean.

vercel flags add my-feature --kind string

The --description option, shorthand -d, sets a description for a new flag when using vercel flags add.

vercel flags add my-feature --description "Controls the new onboarding flow"

The --environment option, shorthand -e, specifies the target environment for vercel flags enable, vercel flags disable, and vercel flags sdk-keys add. Valid values are production, preview, and development.

vercel flags enable my-feature --environment production

The --variant option, shorthand -v, specifies the variant ID to serve when disabling a flag with vercel flags disable.

vercel flags disable my-feature -e production --variant off

The --type option specifies the type of SDK key when using vercel flags sdk-keys add.

vercel flags sdk-keys add --type server --environment production

The --label option, shorthand -l, sets an optional label for an SDK key when using vercel flags sdk-keys add.

vercel flags sdk-keys add --type server -e production --label "Production Server Key"

The --yes option, shorthand -y, skips the confirmation prompt when archiving or deleting a flag, or when deleting an SDK key.

vercel flags archive my-feature --yes

The following global options can be passed when using the vercel flags command:

• --cwd
• --debug
• --global-config
• --help
• --local-config
• --no-color
• --scope
• --token

For more information on global options and their usage, refer to the options section.