Docs · Quickstart

Your first plan in six steps.

Install Corvi, add a model key, point it at a repo, and generate a reviewed, code-grounded plan — in the app or from the CLI.

Install

Corvi is a native macOS app (Apple silicon & Intel, macOS 15+). Download the zip, unzip it, and drag Corvi.app to /Applications.

The beta is signed but not yet notarized, so the first launch needs an extra step: right-click (or Control-click) Corvi.app → Open, then Open again in the dialog. Only the first launch.

Add a model key

Corvi runs the model on your own key — nothing is proxied through us. Open Settings → Providers and paste an Anthropic, OpenAI, or OpenRouter key. Keys are stored in the macOS Keychain.

Want zero cloud? Point Corvi at a local Ollama model and it plans fully on-device, embeddings included.

Open a workspace

Point Corvi at a repository. Everything it reads passes through the workspace broker: reads are scoped to the root you chose, secrets are redacted in-file, and nothing leaves the machine unless you opt in. Link more than one repo when the work spans services.

Describe the change

Pick a plan type — feature, bugfix, refactor, migration — and write a sentence or two, the way you would to a colleague. Concrete beats complete: name the behaviour you want and anything you already know about where it lives. Retrieval finds the rest.

Generate

Hit Generate. One model drafts the plan while reading your code, an independent model reviews it, and a third reconciles the result into one plan — files cited, decisions made, tests first. A deep plan takes a few minutes. For a grounded sketch in under a minute, use ⚡ Quick; upgrade it to the full pipeline in one click.

The plan opens in a live-preview Markdown editor — your text is never overwritten while output streams in. When you're happy, export it or write it into the repo as .corvi/<slug>/ for your agent or CI to pick up.

Or do it from the terminal

The app bundles the corvi CLI — same engine, same keys. Generate a reviewed plan and export it:

corvi run --workspace . \
  --prompt "Add rate limiting to the API gateway" \
  --review --synthesize --export ./plan

--quick returns the sub-minute sketch; --export writes plan.md, TODO.md, and a machine-readable sidecar your tooling can consume. Add the CLI to your PATH from the bundled binary:

ln -s /Applications/Corvi.app/Contents/Resources/corvi /usr/local/bin/corvi

See the Run headless guide for CI, resume, and budgets, and the CLI reference for every command and flag.

Next steps

NextThe planning model