stagereview
v0.1.6
Published
Chapter-style code review against your local git branch.
Downloads
11,294
Maintainers
Readme
Install
npm install -g stagereviewThen add the skill to your agent:
npx skills add ReviewStage/stage-cliRequirements
- Node.js 20 or newer
- A Git repository to review
- An AI agent that supports skills
- GitHub CLI (
gh) installed and authenticated when reviewing GitHub pull requests
Stage runs locally and opens its review UI in your browser. It does not upload your source code.
Uninstall
npx skills remove ReviewStage/stage-cli
npm uninstall -g stagereviewUsage
In your AI agent, run:
/stage-chaptersThis organizes your local changes into reviewable chapters and opens a browser UI. Everything happens on your machine.
Stage groups related changes into chapters, adds a prologue and risk context, and provides a file-by-file review surface with inline comments. The UI also supports full-file previews, image diffs, syntax themes, typography settings, continuous chapter review, and keyboard navigation.
Options
| Flag | Description |
|------|-------------|
| --base <ref> | Base ref to diff against (default: auto-detect main/master) |
| --compare <ref> | Compare ref to diff against --base |
| --ref <mode> | Diff scope: work (staged + unstaged + untracked), staged, or unstaged (default: auto-detect) |
| --pr <number-or-url> | Review a GitHub pull request by number or URL (requires gh) |
| --instructions <text> | One-off instructions for chapter generation (up to 1000 characters; prep command) |
Examples:
# Review only staged changes
/stage-chapters --ref staged
# Diff against a specific branch
/stage-chapters --base feature-a
# Compare two branches
/stage-chapters main feature
/stage-chapters main..feature
/stage-chapters --base main --compare feature
# Review a teammate's PR by number or URL
/stage-chapters --pr 123
/stage-chapters --pr https://github.com/owner/repo/pull/123Review a GitHub pull request
With gh authenticated and a GitHub origin remote configured, use --pr to review a pull
request without checking out its branch. Stage loads the PR's changes and exposes its review
timeline, comments, labels, viewed-file state, merge status, and stacked-PR navigation when
available. GitHub actions such as submitting comments, marking files viewed, and merging remain
subject to your GitHub permissions.
Additional instructions
Use .stageinstructions in the repository root for persistent review guidance, such as project
conventions or areas that deserve extra attention. For a one-off request, pass
--instructions to stagereview prep:
echo "Pay special attention to backward compatibility." > .stageinstructions
stagereview prep --instructions "Focus on changes to the public API."Both sources are included in the chapter-generation prompt; the one-off instructions apply only to that run.
.stageignore
Add a .stageignore file to your repo root to exclude files from the diff analysis. Uses .gitignore-style patterns, one per line:
# Build artifacts
build/**
dist/**
# Generated code
*.generated.ts
# But keep this one
!dist/important.jsIgnored files still appear in the "Other changes" chapter so nothing is silently hidden. Comments (#), blank lines, and negation patterns (!) are supported — last matching pattern wins.
