Local reviewer
The local reviewer works without an account, server or network. Use it in pre-commit hooks, coding agents and simple CI jobs.
Install the CLI
Install CodeJackRabbit with npm. Node.js 20 or newer and Git are required.
npm install -g https://cli.codejackrabbit.com/0.2.0/codejackrabbit-0.2.0.tgz
cjr --version
cjr doctor
For a one-off run without a global install, use npx -y --package https://cli.codejackrabbit.com/0.2.0/codejackrabbit-0.2.0.tgz cjr review --local --include-untracked.
npm creates both cjr and codejackrabbit commands. If a freshly opened terminal does not see cjr, check npm config get prefix. On Windows, cjr.cmd --version can be used when PowerShell blocks npm's PowerShell shim.
Typical workflows
Interactive review before a commit:
codejackrabbit review --local --include-untracked
codejackrabbit review findings
Severity gate:
codejackrabbit review --local --fail-on major
Agent workflow:
codejackrabbit review --local --agent
codejackrabbit pullrequest 0 --show-prompts
PowerShell hook example:
codejackrabbit review --local --uncommitted --fail-on critical
if ($LASTEXITCODE -ne 0) { exit 1 }
Local versus server
Both modes use the same output format and repository configuration. Local mode never sends code over the network. Connected mode adds shared history, usage limits and cloud tasks.
Update or uninstall
npm install -g https://cli.codejackrabbit.com/0.2.0/codejackrabbit-0.2.0.tgz
npm uninstall -g codejackrabbit
Troubleshooting
- Not a Git repository: run the command inside a work tree, or use
--changelistfor a Perforce workspace. - No changes selected: the working tree is clean or the selected base has no diff. Review committed work with
--base <branch>or--base HEAD~1. - Run
codejackrabbit doctorfor Node, Git, configuration and installed-tool diagnostics.