Skip to content

Installation

Local Review is a Node.js app that runs on your own machine. It needs Node.js 22 or later and git, and supports macOS and Linux. Windows is untested: it may work, but nothing is promised.

No install step; npx fetches it on first use:

Terminal window
npx local-review # serve the UI + API on http://localhost:5622
npx local-review init my-feature # create a project to review

npx local-review@latest makes sure you’re on the newest release. That’s the quick way to try it; to keep it running in the background, install it and make it a service.

Terminal window
npm i -g local-review
local-review # the same commands, without npx

Every command and flag: CLI.

Installed globally, Local Review can run in the background as a service that starts at login and is restarted if it exits: a launchd LaunchAgent on macOS, a systemd user unit on Linux.

Terminal window
local-review service install # run it at every login (after npm i -g local-review)

Stop any local-review you started in a terminal first: the service needs its port. It won’t install a service from npx’s cache, which npm can delete at any time. More: Run it as a service.

Terminal window
local-review update # the latest from npm; restarts the service onto it

It asks first, waits while Local Review is busy, and puts the old version back if the new one doesn’t start. More: Updating. With npx, npx local-review@latest fetches the newest release. Updating never touches your data (below).

It serves on http://localhost:5622, bound to 127.0.0.1 only. If that port is in use, it says so and exits: pick another with --port <n> or PORT=<n>:

Terminal window
npx local-review --port 5050

To work on Local Review itself:

Terminal window
git clone https://github.com/edspencer/local-review.git
cd local-review
npm install
npm start # build what's stale, then run the compiled CLI (npm start -- --port 5050)
npm run lr -- plan my-feature # any local-review command, from source

npm run dev runs Vite with hot reload. The rest (tests, the build, conventions) is in Contributing.

Whichever way you run it, your projects and reviews live in ~/.local-review/, never in the package or the repos you review, so upgrading or reinstalling never touches them. See Where your data lives.