Check your code before you share it — and get answers in plain English.
pr-review looks at your changes and tells you if anything needs fixing before you commit or open a pull request. No AI setup required to get started.
Open a terminal in this folder and run:
pip install -e .Windows tip: If
pr-reviewisn't found, usepython -m pr_reviewinstead (e.g.python -m pr_review quick).
pr-review setupThis walks you through a short checklist and can turn on automatic checks before each commit.
pr-review quickRun this before committing. That's the main command most people need.
Not sure what to run? Use this:
| I want to… | Run this |
|---|---|
| Check what I'm about to commit | pr-review quick |
| Check everything on my branch | pr-review check |
| See a menu and pick an option | pr-review |
| Check a GitHub pull request | pr-review pr 42 (replace 42 with your PR number) |
| Set up for the first time | pr-review setup |
Not sure? Just run pr-review and choose from the menu.
pr-review sorts findings into three levels:
| Label | What it means | Do I need to act? |
|---|---|---|
| Must fix | Something risky or clearly wrong | Yes — fix before sharing |
| Should fix | Worth addressing, but not blocking | Recommended |
| Note | FYI — leftover TODO, style hint, etc. | Optional |
Every run ends with a Next step telling you what to do.
When something needs attention:
Checking your changes (3 files)...
What changed
- Adds a login page and form validation
- Updates the database connection code
Should fix — In login.py (line 24): Missing error handling if login fails
Note — In login.py (line 31): TODO marker left in new code
Found 1 should-fix item(s) — nothing blocking, but worth addressing.
Next step: Fix the should-fix items, then run pr-review again.
When everything looks good:
Looks good! No issues found. You are ready to share.
Next step: Share your changes when you are ready.
No. pr-review works out of the box with fast built-in checks — no accounts, no API keys, no extra installs.
AI review is an optional extra for deeper feedback. If you want it, ask a developer to set up Ollama (free, runs on your computer). Details are in docs/TECHNICAL.md.
During pr-review setup, you can enable checks that run automatically every time you commit. Think of it as a safety net — if something slips through, the commit is blocked until you fix it.
To turn this on later:
pr-review setup| Message | What to do |
|---|---|
| "This folder is not a code project" | Open your project folder in the terminal, then try again |
| "No changes to check" | Make and save a change first, or stage it with git |
| "AI review skipped" | Normal if AI isn't set up — built-in checks still ran |
| Command not found | Try python -m pr_review quick instead |
Still stuck? Share the message with a developer, or see docs/TECHNICAL.md.
Configuration, custom rules, CI integration, and architecture docs:
MIT