Docs
How to install the runner and connect GitHub. Read this in order, then open the repo docs for depth.
Install
Install the runner
The runner is the program on your machine that reads pull requests and calls the model.
Install uv first, then run the install script from the public repository.
The script checks a checksum before it copies files. If the checksum fails, the install stops.
curl -fsSL https://raw.githubusercontent.com/the-niresh/plug-and-play-reviewer/main/scripts/install-reviewer.sh | sh
reviewer --help
GitHub connect
Connect GitHub
Run setup with your hosted origin. The terminal UI walks you through GitHub App approval.
Pick the repositories the App may read. Without GitHub, no review can start.
reviewer setup --hosted-origin https://plug-and-play-reviewer.vercel.app
reviewer doctor
reviewer start
Bring your own key
Add your model key
A model key is an API key from OpenAI, Anthropic, or another provider you choose.
Setup collects it with hidden input. Keys stay in your OS keychain, or in a local file if no keychain exists.
A model key never goes to the hosted database.
reviewer setup --hosted-origin https://plug-and-play-reviewer.vercel.app
reviewer status
agent plugin
Use it from another agent
The same review is available through MCP, a JSON CLI, ACP, and A2A.
One core backs all four surfaces. A parity test keeps them aligned.
reviewer agent-json review --owner OWNER --repository REPO --pull-request N
reviewer agent-json findings --review-id ID
reviewer agent-json remediation-prompts --review-id ID