Getting Started

Quick Start

This walkthrough takes you from “installed” to a complete review loop in a few minutes. It uses the terminal app, but every concept maps directly onto the desktop app — see Desktop Overview for its equivalents.

1. Open a diff

From inside any git repository, run:

er

er opens on the branch diff — everything that differs between your current branch and its base. The base branch is detected automatically from your upstream tracking branch, falling back to main, master, develop, then dev. You did not have to specify it.

You will see a file list on the left and the diff beside it. The context panel on the right starts closed — press p to cycle it open (file detail, AI summary, PR overview, agent log). The top bar shows the available diff modes and any detected pull request; the bottom bar shows key hints.

2. Move around

Everything is keyboard-driven. The essentials:

KeysMove
k / jNext / previous file
n / NNext / previous hunk
↓ / ↑Next / previous line within hunks
d / uScroll down / up
/Search files by name

The full map is on the Keybinding Reference page.

3. Switch diff modes

Press a number key to change what you are looking at:

# 1  branch diff (vs base)     3  staged changes
# 2  unstaged changes          4  commit history

The numbers are positions, not fixed labels: a tab that knows its pull request slots PR Diff in after Staged, and a guided tour adds one after History. Merge conflicts appears only while a merge is in progress, and hidden / ignored files only when you have [watched] paths configured.

See Diff Modes for what each one shows and when to reach for it.

4. Track your progress

As you finish a file, mark it reviewed:

If a file's diff changes underneath you (because watch mode picked up an edit), its reviewed mark clears automatically so you never miss new changes.

5. Leave notes

er has three kinds of inline annotations:

KeyTypeGoes to
qPrivate question (yellow)Stays local; read by your AI tools
q, then Ctrl+tPrivate note (yellow, 📝)Stays local; an instruction to hand to an agent
cGitHub comment (cyan)Syncs to a pull request

Each anchors to the current line; Shift+↓/↑ extends a line selection, which the copy hub (y) uses as its scope. While composing, Ctrl+t cycles the draft type — question → note → comment. Read more in Comments & Questions.

6. Add AI analysis (optional)

This is where er earns its name. The quickest way is the built-in AI Hub: press a to open it (Cmd+K → AI in the desktop app) and run a review. er spawns your AI tool for you — Claude Code by default, if the claude CLI is on your PATH — so you do not need a second terminal.

  1. Press a and choose Review work (called Run review in the desktop app). Per-file risk levels, inline findings, and a checklist appear as the agent writes them; toggle the findings layer with A and cycle the side panel with p.
  2. Leave questions with q, then use the Hub's Answer questions action (TUI only — in the desktop app, questions are managed in the Notes panel) to have the AI respond inline.
  3. Re-open the Hub any time to re-run the review or launch a single expert, the professor, or a fast triage.

The Hub can drive Codex, Cursor, or another tool too — see AI Review → the AI Hub for how to configure providers, and AI Hub Actions for the full catalog of actions — review, specialized/expert review, triage, professor — and what each one writes.

7. Watch it stay live

Watch mode is on by default. Leave er open while your AI assistant edits code: every save, stage, and commit refreshes the diff within a fraction of a second. The ● WATCHING indicator in the top bar shows it is active; toggle it with w.

8. Quit

Press Ctrl+q to exit. Your reviewed marks, comments, and questions are persisted, so you can pick the review back up exactly where you left off.

✦

Next: read How er Works to understand the model behind all of this, or skip to GitHub & Pull Requests if you are reviewing a PR.