Migration guide

Upgrading to v5

CLI 5 brings config schema 5, a single token variable and new dashboard shortcuts. Most projects upgrade in under ten minutes; the steps below are in the order we recommend.

  • CLI5.0.2
  • Config schema5
  • Node.js≥ 20
  • ReleasedOct 8, 2026

  1. 01Update the CLI

    Terminal
    $ npm install -g @rivetlane/cli@5$ rivet --versionrivet/5.0.2 darwin-arm64 node-v20.17.0

  2. 02Migrate rivetlane.toml

    rivet migrate config rewrites the file to schema 5: it adds schema = 5 and renames build.publish to build.output. Comments and ordering are kept.

    Terminal
    $ rivet migrate config --dry-run~ build.publish → build.output+ schema = 5$ rivet migrate config✓ Migrated rivetlane.toml to schema 5

  3. 03Rename the token variable

    Replace RIVET_API_KEY with RIVET_TOKEN in every CI provider and secret store. The value does not change.

  4. 04Review env pull before you run it

    rivet env pull now writes exactly what the development scope contains, so local runs match deploys.

Dashboard shortcuts

The v5 dashboard adds two-key navigation. Press ? anywhere to see this list.

ActionShortcut
Open the command menu⌘K
Go to deploymentsNewGthenD
Go to previewsNewGthenP
Redeploy the current deploymentChanged⇧R
Stream logsNewL
Show all shortcuts?