vercel rolling-release

Use the vercel rolling-release command to manage your project's rolling releases. Rolling releases allow you to gradually roll out new deployments to a small fraction of your users before promoting them to everyone.

Vercel offers Rolling Releases on Pro and Enterprise. Pro teams can use Rolling Releases for one project. See Rolling Releases for limits and setup details.

vercel rolling-release [command]

Update rolling release settings for a project.

vercel rolling-release update --enable --advancement-type=manual-approval --stage=10 --stage=50

Start a rolling release for a specific deployment. This command calls POST /v1/projects/{idOrName}/rolling-release/start. The start endpoint is idempotent. See Starting and completing via the API.

vercel rolling-release start --deployment=dpl_abc

Options:

Examples:

vercel rolling-release start --deployment=dpl_123abc456def
vercel rolling-release start --deployment=https://my-project-abc123.vercel.app
vercel rolling-release start --deployment=dpl_123 --yes

Approve the current stage of an active rolling release.

vercel rolling-release approve --deployment=dpl_abc --currentStageIndex=0

Abort an active rolling release. This command rolls back to the deployment that you pass to --deployment. Pass the ID or URL of the previous production deployment, not the deployment that is rolling out:

vercel rolling-release abort --deployment=dpl_previous

Complete an active rolling release, promoting the deployment to 100% of traffic. This command calls POST /v1/projects/{idOrName}/rolling-release/complete. See Starting and completing via the API for CI/CD usage.

vercel rolling-release complete --deployment=dpl_abc

Inspect details about a rolling release.

fetch remains a supported alias, but prints a deprecation warning. Use inspect for new commands.

vercel rolling-release inspect

These are options that only apply to the vercel rolling-release command.

The --project option sets which project to manage, by name or ID. Without it, vercel rolling-release uses the project linked to your current directory. Pass --project to manage a different project, or to run a subcommand from a directory that isn't linked. Every subcommand accepts it, for example inspect:

vercel rolling-release inspect --project my-app

The --enable option turns on rolling releases for the project. Combine it with --advancement-type and one or more --stage flags to define how traffic shifts.

vercel rolling-release update --enable --advancement-type=automatic --stage=10,5m

To turn rolling releases off for the project, use --no-enable:

vercel rolling-release update --no-enable

The --advancement-type option controls how stages advance. It accepts automatic or manual-approval. Required when --enable is set.

vercel rolling-release update --enable --advancement-type=automatic --stage=10,5m
vercel rolling-release update --enable --advancement-type=manual-approval --stage=10

The --stage option adds a release stage. Repeat it to add multiple stages. The format is PERCENTAGE[,DURATION], where PERCENTAGE is between 1 and 99 and DURATION (required with --advancement-type=automatic, not allowed with --advancement-type=manual-approval) is a duration like 5m. A final 100% stage is added automatically.

vercel rolling-release update --enable --advancement-type=automatic --stage=10,5m --stage=50,10m

The --cfg option accepts a raw JSON configuration string. It takes priority over the other configuration flags and is kept for advanced and backwards-compatible use. Prefer --enable, --no-enable, --advancement-type, and --stage for everyday configuration.

vercel rolling-release update --cfg='{"enabled":true, "advancementType":"automatic", "stages":[{"targetPercentage":10,"duration":5},{"targetPercentage":100}]}'

As a legacy shortcut, --cfg='disable' is also accepted and disables rolling releases. Prefer --no-enable for new usage.

vercel rolling-release update --cfg='disable'

The --deployment option specifies the deployment ID or URL for rolling release operations.

vercel rolling-release start --deployment=https://example.vercel.app

The --currentStageIndex option specifies the current stage index when approving a rolling release stage.

vercel rolling-release approve --currentStageIndex=0 --deployment=dpl_123

vercel rolling-release update --enable --advancement-type=automatic --stage=10,5m

This configures a rolling release that starts at 10% traffic, automatically advances after 5 minutes, and then goes to 100%.

vercel rolling-release update --enable --advancement-type=manual-approval --stage=10

This configures a rolling release that starts at 10% traffic and requires manual approval to advance to 100%.

vercel rolling-release update --enable --advancement-type=manual-approval --stage=10 --stage=50

This configures a rolling release with three stages: 10%, 50%, and 100% traffic, each requiring manual approval.

vercel rolling-release update --no-enable

This disables rolling releases for the project.

The following global options can be passed when using the vercel rolling-release command:

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

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