Docs/Quickstart
// GETTING STARTED

Quickstart

The fastest path from zero to your first shipped pull request. You'll connect a GitHub repo, pick how much oversight you want, hand Leroy a piece of work, then review and merge the PR it opens. Leroy is invite-only beta — sign in with your Leroy account to begin.

01 Connect your repos

Leroy needs somewhere to open pull requests. Onboarding walks you through it: install the Leroy GitHub App, then choose which repositories Leroy can work in.

  1. Install the Leroy GitHub App and grant it access to your repos.
  2. Pick the repositories Leroy can work in — start with one to a few; add the rest from Settings → Repos anytime.
  3. If you connect more than one repo, Leroy reads each one — code, manifests, README, structure — to learn what it is and what it's for, then shows you a short summary to review and edit. That understanding is what lets Leroy send each piece of work to the right repo. A single reposkips this step — there's nothing to route.
i
Multi-repo? The review step is the important one. Those repo descriptions are how Leroy tells your codebases apart — so it routes work to the right one and can answer questions across the whole multi-repo setup. Tighten them and everything downstream gets sharper.

02 Set your oversight

Decide how much Leroy does on its own. Oversight is controlled by three policy gates — picking up work, starting to code, and shipping the PR — and you can start from a preset.

i
Start on Balanced.Leroy picks up and plans work on its own, then waits for your review before merging the PR. It's the default, and a good place to build trust before loosening (Autonomous) or tightening (Cautious).

03 Give Leroy something to do

A unit of work is a ticket — one bug, change, or request. It usually ships as a single pull request (a change spanning several repos opens one per repo). You can create one yourself, or let a connected tool feed one in:

  1. File a ticket in the app (or from your editor over MCP) describing the bug or change.
  2. Let Sentry feed one — a flagged error can become a ticket automatically.
  3. Let Linear feed one — a labeled issue can flow in as a ticket.

Once Leroy owns the ticket, it triages, plans, and starts coding — pausing at whichever gates you set to ask. You can follow along on the board and in the ticket detail.

04 Review and merge the PR

When the work is ready, the ticket moves to In reviewand shows up in your inbox. You can read the plan, the diff, and Leroy's own review of its change. On Balanced, the PR waits for your sign-off.

Review wherever you already work — Leroy meets you there:

  1. In Leroy — read the diff on the ticket, reply to ask for a change, or approve to merge.
  2. On the GitHub PR — leave a review or comment as you normally would; Leroy picks it up and revises.
  3. In Linear — comment on the linked issue; it syncs back to the ticket.

Request a change from any of them and Leroy revises and pushes an update; approve and the PR merges. However it merges — Accept & ship in Leroy or merged on GitHub — the ticket is marked Shipped, and if it came from a connected source like Sentry or Linear, that issue is updated to match. Use whatever workflow fits your team.

i
Want it hands-off? Switch the ship gate to Auto (or use the Autonomous preset) and Leroy merges once its checks pass — hard stops still apply. See Policy gates.