Review your PR stacks before you create them.
以下摘录自该仓库的 README(片段) · 在 GitHub 读完整 README →
Local Review is a GitHub-style pull-request UI for the **stack of commits on your machine**, before any of it is
pushed. Every commit is shown as its own PR, grouped into the stacks you mean to open. You review them like PRs, your
coding agent reads your comments and replies in the same place, and when a stack is right, the agent publishes it as
GitHub stacked PRs.
- **Every commit is a PR**, with a Conversation tab, a Files changed tab, a Stack tab and a readiness badge, grouped
into colour-coded PR stacks, across one repo or several.
- **Every effort in view.** The root page shows each project as a card with a thumbnail of its stacks, and work that
builds on other work is linked to it, in order.
- **Your agent answers in the review.** Comments are plain YAML files that any coding agent can read and reply to; the
replies show up in your browser live, and threads follow their code through amends and rebases.
- **Publish when it's ready.** local-review plan prints each PR's branch, base, title and body, and your agent opens
the stack as GitHub native stacked PRs. It
works in front of any stacking tool.
- **Safe to point at your work.** It never modifies your repos, never talks to GitHub, never deletes your review, and
only listens on localhost.
One review round trip, on the fictional demo project the docs use.
Quickstart
Needs Node.js 22 or later and git, on macOS or Linux. To look around first, run npx local-review and click **Add
the example projects**: a made-up app reviewed across four repos.
Edit project.yaml to point at your repo, branch and stacks:
Then open **http://localhost:5622**. Edits are picked up live. The full walk-through is the
Quickstart.
> **Upgrading from before 0.2.0?** The default port was 5000; it's now 5622 (macOS uses 5000 for AirPlay). Update
> bookmarks and agent prompts, or run npx local-review --port 5000.
For agents
To have your coding agent set up a project, point it at the running server's llms.txt:
It has the rules, the recipe, the commented project.yaml example and this machine's data directory and projects
(llms.txt; the docs site has a copy at
https://local-review.edspencer.net/llms.txt). Then
prints the guide for coding agents driving Local Review from the repo they work on: the data model, how to answer
review threads, fix a commit mid-stack, tag branches, publish stacked PRs and record merges. It's
AGENT-GUIDE.md in this repo, and on the docs site.
To hand a reviewed project to your agent, paste the
hand-off prompt.
Documentation
**https://local-review.edspencer.net**
- **Getting started:** Quickstart ·
Installation
- **Concepts:** Projects & repos ·
PR stacks ·
Readiness ·
Landed PRs ·
Follow-on stacks ·
Linked projects ·
Following rebases
- **Using it:** A tour of the UI ·
Reviewing & comments ·
Stack pictures ·
Keyboard shortcuts
- **Reference:** CLI ·
project.yaml ·
Comment files ·