Rivets
Documentation

Quickstart

This guide takes you from a new account to a merged pull request. You need a machine that can run a worker, with Claude Code or Codex installed and signed in, and a GitHub repository you can install an app on.

1. Sign in and set up your organization

How you start depends on whether you are creating an organization or joining one.

Create an organization

  1. Open app.rivets.dev and create an account with your email and a password.
  2. On Create your organization, enter a name and your claim token, then choose Create org.
  3. On Invite members, choose Create invite link to invite teammates, or Skip for now. You can invite people later from Settings › Members.

Join an organization

Open the invite link you received, sign in or create an account, and choose Accept invite.

2. Connect a repository

Organization owners connect repositories.

  1. On Home, choose Connect repository.
  2. Choose Connect GitHub and install the Rivets GitHub App on your GitHub account or organization. Grant it the repositories you want Rivets to work on.
  3. Back in Rivets, pick a repository and choose Add repository.

See GitHub for the permissions the app requests and why.

3. Add a worker

A worker is the machine where agents run. Pick one of these.

Use the Mac app

Install the Mac app from downloads.frontier.sh/rivets/Rivets-latest.dmg and sign in. It includes a worker, so your Mac can take tasks right away. Adjust it under Settings › This Mac.

Use the CLI

  1. Download the standalone worker from downloads.frontier.sh/rivets/worker.
  2. Run rivets doctor to check prerequisites.
  3. In Rivets, open Settings › Workers, choose Add worker, enter a name and a cluster, and choose Register worker.
  4. Copy the command Rivets shows and run it on the machine. Paste the one-time token when prompted:
rivets worker connect --token-stdin
  1. Optionally, install it as a background service so it survives logouts and reboots:
rivets worker install

The worker appears as online in Settings › Workers. See Connect a worker for details.

4. Create a task

  1. Choose New task, or press ⌘N.
  2. Pick the repository.
  3. Describe what you want the agent to do. Attach files if they help.
  4. Optionally, use Start from to begin from a pull request, a branch, or a Linear issue instead of the default branch.
  5. Choose the agent and model, the reasoning effort, and the worker cluster. Auto picks the best available worker.
  6. Choose Create.

Rivets names the task and its branch, provisions a worktree on the worker, and starts the agent. See Creating tasks.

5. Watch and steer

The transcript streams as the agent works. The Changes tab in the inspector follows each edit live. To redirect the agent, type in the composer and send. By default your message interrupts the current turn and is picked up straight away. Teammates with access can watch and steer the same task. See Steering and multiplayer.

6. Open a pull request and merge

  1. Open the Checks tab in the inspector.
  2. Choose Create PR. Rivets writes any missing title, description, and commit message, then commits, pushes, and opens the pull request.
  3. Follow the check runs and reviews in Checks. Use Fix on an unresolved review thread to send it to the agent.
  4. When checks pass, choose Merge.

By default, Rivets archives the task once its pull request is merged. See Pull requests and merging.

Next steps

Type to search the docs.