Skip to main content

​
Before you start

  • Node.js 22.13 or newer. Check with node --version. If you’re on an older version, the installer will tell you.
  • A project to work in. Rivet recognizes Next.js, Vite, Create React App, Remix, SvelteKit, and plain HTML. No project yet? That’s fine too — Rivet can start from zero.

​
1. Install the CLI

Keep the @latest tag — it makes sure npm gives you the current release rather than an older one. If you’d rather not install globally, npx -y rivet-design@latest … works for every command.

​
2. Sign in

This opens a sign-in page in your browser and finishes on its own. If your agent ever hits an “authentication required” error, this same command is the fix.

​
3. Connect your coding agent

rivet install with no arguments sets up every agent it finds on your machine. Or set up one at a time:
Add to CursorOr install from the terminal:
Restart Cursor, open a project, and say “Open Rivet” in a new chat.
You can add --mcp to any of these (for example rivet install claude --mcp) to register Rivet’s MCP server for that agent too. Without it, agents run rivet commands directly — install pre-approves them, so you won’t get permission prompts for every command.

​
What install changes

For each agent, rivet install writes a short usage guide (so the agent knows how to drive Rivet), pre-approves rivet commands (so you aren’t asked to allow each one), and, with --mcp, registers the MCP server. The files it touches: After upgrading Rivet, run rivet update to refresh these. To remove Rivet from an agent, run rivet uninstall <name>, or rivet uninstall all.

​
Next

Your first designs

Generate your first set of variants from your agent.