Repository navigation
Releases: edspencer/local-review
Release list
v0.4.0
Minor Changes
- #26
853927fThanks @edspencer! - Click an image in a PR description, stack note, the project intro, a comment or an editor's preview to see it in a
viewer over the page, fitted to the window. Click it again to see it at full size and scroll or drag around it;
← / → step through the other images in the same block, and Esc closes it. An image inside a link still opens its
link, unless the link is to the image itself.
v0.3.0
Minor Changes
-
#23
6af921aThanks @edspencer! - A first-run welcome page, and one-click example projects:- With no projects, the UI now shows a welcome page instead of a bare "No projects yet": what Local Review is, how to
create your first project (or a prompt to hand that to your coding agent), and links to the docs. - Add the example projects (on that page, at the bottom of the project switcher, or
local-review examples)
creates "Orchard", a made-up app reviewed across four repos, in about a second and with no network: stacked PRs,
review threads with an agent's replies, and a fully merged stack to click around. They're marked Example. - Remove examples hides them again and deletes nothing: each example's
project.yamlis renamed to a.bak, and
adding them again brings them back as you left them. A project of your own is never touched.
- With no projects, the UI now shows a welcome page instead of a bare "No projects yet": what Local Review is, how to
v0.2.0
Minor Changes
-
#20
205a9a4Thanks @edspencer! - Images in PR descriptions, stack notes and the project intro. Paste, drop or attach an image in any of their editors,
or add one withlocal-review asset add <project> <file>, which prints the markdown ().
Images live in the project'sassets/folder, named by their content, and are never replaced or deleted; snapshots
hard-link them instead of copying them. PNG, JPEG, GIF, WebP and SVG up to 5 MB, checked by their contents, and served
withnosniffand a Content Security Policy that stops an SVG running script. GitHub can't show a local image, so
local-review planwarns about each one, and puts its URL in the body instead once you record where it's published
withlocal-review asset url <project> <name> <url>. -
#10
89ddc0bThanks @edspencer! - Breaking: the default port is now 5622, not 5000. macOS uses port 5000 for AirPlay, so Local Review now serves on
http://localhost:5622. If you have bookmarks, scripts or agent prompts that saylocalhost:5000, update them, or keep
the old port withlocal-review --port 5000(orPORT=5000).Local Review is now an installable npm package. Run it with
npx local-review, or install it once with
npm i -g local-reviewand runlocal-review. It has four commands:local-review [serve] [--port <n>]serves the UI (the default command).local-review init <project>creates a project from a commented example.local-review plan <project>prints the read-only materialization plan.local-review guideprints the guide for coding agents.
The package ships compiled JavaScript and a prebuilt UI, so it no longer needs
tsxor a build step at run time, and
it installs only its runtime dependencies. It needs Node.js 22 or later.The guide for agents using Local Review on your repos moved from
AGENTS.mdtoAGENT-GUIDE.md, and
local-review guideprints it, so an agent can read it without a checkout.AGENTS.mdnow holds the conventions
for contributing to Local Review itself.There's a new logo and favicon.
Patch Changes
-
#18
eab708fThanks @edspencer! - Display fixes:- A PR title or description written into a prs file that matches the commit message (ignoring whitespace) no longer
shows as "edited", andlocal-review planno longer says "(edited)" for it. The file itself isn't changed. - Tabs in code in the Conversation tab (code blocks in comments and descriptions, and the code under inline
threads) are now as wide as in the Files changed diff, instead of 8 columns. - A repo whose PRs have all merged is labelled merged on the project homepage and in the stack picture, as it
already was in the sidebar, instead of with its base branch (for exampleorigin/main). - Paths under your home directory are shown as
~/…, for example~/.local-review/projects/…. The API still returns
absolute paths, and now always does: they used to be relative to Local Review's own directory when your data was
inside it.GET /api/projectsalso returnshome, the home directory the UI shortens paths against.
- A PR title or description written into a prs file that matches the commit message (ignoring whitespace) no longer
-
#19
45e5b6fThanks @edspencer! - The documentation now lives at https://local-review.edspencer.net, and the README is a short introduction that links
to it. The "No projects yet" page links to the docs' Quickstart andproject.yamlreference, and the example
project.yamlandlocal-review guidepoint at the docs too. The agent guide's "Importing a historical stack" section
now covers how stacks merged with ghstack, Sapling, Graphite and GitHub's own stacks look on GitHub.