Quickstart

Deploy your first app

Install the CLI, link a repository and ship it to production. You will end with a live URL, a preview for every branch and a rivetlane.toml you can commit.

  1. 1

    Install the CLI

    Install rivet globally and check the version. Every command in these docs assumes CLI 5.0 or later.

    Terminal
    $ npm install -g @rivetlane/cli$ rivet --version

    Expected output

    rivet/5.0.2 darwin-arm64 node-v20.17.0
  2. 2

    Log in

    Opens your browser to approve the device. The token is stored in your system keychain, never in the project.

    Terminal
    $ rivet login

    Expected output

    → Opening https://rivetlane.dev/device?code=QXRV-7241✓ Logged in as [email protected] (Quillon)
  3. 3

    Link your project

    Run rivet init in the repository root. It detects the framework, creates the project and writes rivetlane.toml.

    ~/code/storefront
    $ rivet init

    Expected output

    ✓ Detected Next.js 15 (pnpm)✓ Created project storefront in Quillon✓ Wrote rivetlane.toml
  4. 4

    Deploy to production

    Builds the current commit and promotes it to your production URL once the build passes.

    ~/code/storefront
    $ rivet deploy --prod

    Expected output

    → Building storefront@a41c9e2 (main)✓ Build completed in 38s✓ Deployed to production  https://storefront.rivetlane.app

  5. You're live

    storefront is serving from 18 regions. Push a branch to get a preview URL, or keep going with one of these.