vercel rolling-release
Use the vercel rolling-release command (also available as vercel rr) 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]Using vercel rolling-release with a specific command
to manage rolling releases.
Configure rolling release settings for a project.
vercel rolling-release configure --enable --advancement-type=manual-approval --stage=10 --stage=50Using the vercel rolling-release configure command to
set up a rolling release with manual approval stages of 10%, 50%, and 100%.
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 --dpl=dpl_abcUsing the vercel rolling-release start command to
begin a rolling release for a deployment (where "dpl_abc" is the deployment ID or URL).
Options:
| Option | Type | Required | Description |
|---|---|---|---|
--dpl | String | Yes | The deployment ID or URL to target |
--yes | Boolean | No | Skip confirmation prompt |
Examples:
vercel rr start --dpl=dpl_123abc456def
vercel rr start --dpl=https://my-project-abc123.vercel.app
vercel rr start --dpl=dpl_123 --yesApprove the current stage of an active rolling release.
vercel rolling-release approve --dpl=dpl_abc --currentStageIndex=0Using the vercel rolling-release approve command to
approve the current stage and advance to the next stage.
Abort an active rolling release.
vercel rolling-release abort --dpl=dpl_abcUsing the vercel rolling-release abort command to
stop an active rolling release.
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 --dpl=dpl_abcUsing the vercel rolling-release complete command to
finish a rolling release and fully promote the deployment.
Fetch details about a rolling release.
vercel rolling-release fetchUsing the vercel rolling-release fetch command to get
information about the current rolling release.
These are options that only apply to the vercel rolling-release command.
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 configure --enable --advancement-type=automatic --stage=10,5mEnable a rolling release that ramps from 10% for 5 minutes and then to 100%.
The --disable option turns off rolling releases for the project. Prefer it over the legacy --cfg='disable' form, which the CLI still accepts for backwards compatibility.
vercel rolling-release configure --disableDisable rolling releases for the project.
The --advancement-type option controls how stages advance. It accepts automatic or manual-approval. Required when --enable is set.
vercel rolling-release configure --enable --advancement-type=automatic --stage=10,5m
vercel rolling-release configure --enable --advancement-type=manual-approval --stage=10Use automatic for time-based advancement, or manual-approval to require
approval between stages.
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 (only valid with --advancement-type=automatic) is a duration like 5m. A final 100% stage is added automatically.
vercel rolling-release configure --enable --advancement-type=automatic --stage=10,5m --stage=50,10mConfigure stages of 10% for 5 minutes, then 50% for 10 minutes, then 100%.
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, --disable, --advancement-type, and --stage for everyday configuration.
vercel rolling-release configure --cfg='{"enabled":true, "advancementType":"automatic", "stages":[{"targetPercentage":10,"duration":5},{"targetPercentage":100}]}'Using the --cfg option with raw JSON.
As a legacy shortcut, --cfg='disable' is also accepted and disables rolling releases. Prefer --disable for new usage.
vercel rolling-release configure --cfg='disable'Legacy form for disabling rolling releases. Equivalent to --disable.
The --dpl option specifies the deployment ID or URL for rolling release operations.
vercel rolling-release start --dpl=https://example.vercel.appUsing the vercel rolling-release start command with a
deployment URL.
The --currentStageIndex option specifies the current stage index when approving a rolling release stage.
vercel rolling-release approve --currentStageIndex=0 --dpl=dpl_123Using the vercel rolling-release approve command with
a specific stage index.
vercel rolling-release configure --enable --advancement-type=automatic --stage=10,5mThis configures a rolling release that starts at 10% traffic, automatically advances after 5 minutes, and then goes to 100%.
vercel rolling-release configure --enable --advancement-type=manual-approval --stage=10This configures a rolling release that starts at 10% traffic and requires manual approval to advance to 100%.
vercel rolling-release configure --enable --advancement-type=manual-approval --stage=10 --stage=50This configures a rolling release with three stages: 10%, 50%, and 100% traffic, each requiring manual approval.
vercel rolling-release configure --disableThis 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--team--token--version
For more information on global options and their usage, refer to the options section.
Was this helpful?
