r3 logo

r3: Review. Revise. Resolve.

npm version license: MIT platforms: macOS, Linux live demo

r3_cc r3_web

▶ Try the live demo — the full UI, running entirely in your browser.

r3 is a review tool for the diffs and docs produced by your coding agents, running locally with a web interface. You leave feedback pinned to the exact line or quote it's about, and track each comment to resolution. r3 fills a gap that chat boxes can’t. Say your agent writes a long planning document and you want to fix a handful of issues. In chat, you have to copy and paste each passage, explain your feedback, and then keep track of what has or hasn’t been addressed across multiple turns. r3 replaces that linear, unstructured stream with a workflow modeled on the code review tools you already know—built specifically for you and your agents, and running entirely locally.
## Workflow r3 offers a tight, copy-paste-free review loop between you and an agent. ```mermaid sequenceDiagram participant A as Agent participant S as r3 server participant U as You (browser) A->>S: [1] `r3 create` — opens a review, shares the URL loop until you Approve or Abandon A->>S: [2] `r3 watch` (blocks for feedback) U->>S: [3] leave feedback + Submit S-->>A: `r3 watch` prints your feedback to stdout and exits A->>S: [4] `r3 reply` by feedback id S-->>U: [5] web UI updates live end ``` 1. The agent starts a review with **`r3 create`** and shares the URL. 2. The agent runs **`r3 watch `**, which registers as a live watcher and waits for feedback. 3. You leave feedback anchored to the exact lines it's about, then click **Submit**. `watch` prints your feedback to stdout that's captured by the agent. 4. The agent works each item and **replies by feedback id** (`r3 reply -m "what I changed"`), saying what it changed, or the reasoning for why it didn't. 5. Every reply lands on the web UI through live updates. The agent `watch`es again until you **Approve** or **Abandon** the review. ## Quick start r3 is driven by your coding agent, so the quickest start is to point your agent at it. Drop this into your agent's instructions file (`AGENTS.md`, `CLAUDE.md`, or your tool's equivalent), or just try it out by pasting it into a new session: ```md This project uses r3 for review. Run it with whichever of these you have: `npx @hyperlogue/r3@latest`, `bunx @hyperlogue/r3@latest`, or `nix run github:hyperlogue/r3 --`. `r3 guide` will show how to use it. ``` Then just ask: "put your changes up for review." Your agent runs `npx @hyperlogue/r3@latest create …`, shares the URL, and waits while you leave feedback in the browser. The launcher lazily starts the web server on localhost and opens the review. One **web server** spans all your repos on a stable port (default 8791). The first call spawns it automatically, so there's nothing to start by hand; `r3 start | stop | status | restart` manage it explicitly. Open http://127.0.0.1:8791/ to see every project's reviews in one tab. No config needed: reviews live in one global sqlite at `$XDG_STATE_HOME/r3/r3.sqlite` keyed by a **projects registry** (so worktrees of one clone are one project and copies stay separate), and the web server announces itself in `$XDG_RUNTIME_DIR/r3/daemon.json` so the CLI finds it with zero config. Run the CLI from any git repo, and it tells the web server which project/worktree the call targets. You rarely type the commands yourself — you ask your agent, and it runs the right `r3 create`: ```text "Put your working changes up for review." → diff review of the working tree "Open a review of the plan doc so I can comment on it." → files review of that file, watched live as the agent keeps editing "Let me review the diff between main and this branch." → diff review of the range "Start a review with a scratch folder and put your draft design doc there." → adhoc scratch review with no git source ``` To install `r3` permanently — a persistent command instead of `npx`/`bunx` each time — add `-g`: ```sh npm install -g @hyperlogue/r3 # or: bun add -g @hyperlogue/r3 ``` Then run `r3 …` from anywhere. ## Reviews Every review is one of two kinds: - A **files review** is a live view of a set of files as they are right now. r3 watches them and re-renders on every change, so it fits work in progress: a design doc your agent is still writing, or a few source files you want to read together. - A **diff review** is a frozen record of a change: a commit, a branch range, your working tree, or any diff. It doesn't move once captured, and follow-up work lands as new rounds you can compare against. Feedback anchors to a **quote**, not a line number: in a files review your notes follow the code as it's edited; in a diff review the rounds are immutable, so nothing drifts. ## Remote access If you work on a remote dev server, r3 listens on loopback there, and you reach its web UI from your local device through a tunnel. Set one up however you like: an SSH forward (`ssh -L 8791:localhost:8791 devbox`), `tailscale serve`, or a Cloudflare tunnel. **Never** bind `0.0.0.0`. **Exposing r3 beyond loopback turns on an optional login gate.** It's pure security hardening — **on by default whenever r3 is exposed** (a non-loopback bind, a non-loopback `R3_PUBLIC_URL`, or a non-loopback `R3_ALLOWED_HOSTS`), and **off on a plain `localhost:8791`** so the default setup needs no login at all. Over an SSH forward you browse `localhost`, so nothing changes. When it's on, create a token on the host and paste it into the browser once: the browser posts that **login token** to the daemon to mint an HttpOnly session cookie, and from then on holds only the cookie. (The login token is a scoped, revocable credential; the daemon's own per-user API token — the CLI's credential — is never handed to a browser when exposed.) Force it either way with `R3_REQUIRE_LOGIN=1|0`. > **Behind your own reverse proxy, set `R3_REQUIRE_LOGIN=1`.** r3 decides whether > to require a login from its own bind + advertised host — it can't see that > through a proxy that rewrites the `Host` header to `127.0.0.1` (nginx's default > `proxy_pass`), which reads as loopback-only and hands the browser the per-user > token. Setting `R3_PUBLIC_URL` to the public name fixes it too; `tailscale serve` > forwards the real host, so it's already covered. ```sh # on the host: r3 config set publicUrl https://myhost.tailnet.ts.net # allows that Host + requires login r3 restart # config.json is read below env tailscale serve --bg 8791 # -> https://myhost.tailnet.ts.net/ r3 auth create-token --label laptop # prints the token once — paste it in the browser ``` `r3 config set` **persists** these settings to `$XDG_CONFIG_HOME/r3/config.json`, so a restart — or a daemon lazily re-spawned by any CLI call from a shell that never exported the env vars — keeps serving remotely instead of silently dropping to loopback-only. (`export R3_PUBLIC_URL=…` still works for a one-off run; it just isn't remembered.) The store is a flat map — names `bind`, `port`, `publicUrl`, `allowedHosts` (comma list), `requireLogin`: `r3 config show` dumps the JSON, `r3 config get ` prints one value, `r3 config unset ` reverts one. `r3 auth list-tokens` / `r3 auth revoke-token | --all` manage tokens (revoking kills its sessions immediately). Settings: `R3_PORT` (default 8791), `R3_BIND` (default `127.0.0.1`), `R3_ALLOWED_HOSTS` (comma-separated exact Host names, never `*`; a non-loopback name here also marks r3 exposed), `R3_PUBLIC_URL` (a non-loopback host is auto-allowed **and** marks r3 exposed, so this alone covers the common single-name `tailscale serve` case), `R3_REQUIRE_LOGIN` (`1`/`0` to force the login requirement on or off explicitly). Each resolves **env → `config.json` (via `r3 config set`) → default**, so env overrides the persisted file for a single run.