Getting Started
Get your first AI code review in under 5 minutes.
Step 1: Sign Up
Go to codepeel.ai and click Get Started Free. Sign in with your GitHub account — no credit card required.
After signing in, you'll land on the Dashboard. This is your home base for all review activity.
Step 2: Connect Your Repositories
From the dashboard, click Connect in the top-right of the Repositories page (or follow the prompt on the empty dashboard).
This takes you to GitHub's app installation page where you choose which repositories CodePeel can access:
- All repositories — CodePeel reviews every PR automatically
- Selected repositories — pick specific repos to monitor
After installing, your connected repos appear on the Repositories page in the sidebar.
Free tier: Up to 3 repositories. Private repos require Pro or Max.
Step 3: Open a Pull Request
That's it — no more setup needed. CodePeel triggers automatically when:
- A new PR is opened
- A new commit is pushed to an existing PR
Note: Only PRs created after installation are reviewed. Push a new commit to an existing PR to trigger a review on it.
Within 30-60 seconds, CodePeel posts three things on your PR:
1. Inline Comments
Posted directly on the lines that need attention in the Files changed tab on GitHub:
Each comment includes:
- Severity badge — 🔴 Critical, 🟠 Major, 🟡 Minor
- Structured explanation — "What's happening", "Impact", and "Recommendation" sections
- Code suggestion — a one-click "Commit suggestion" button that applies the fix directly
Only high-value findings are posted as inline comments. Lower-severity findings appear in your dashboard to keep PRs clean.
2. Summary Walkthrough
A collapsible comment on the PR conversation tab with:
- Plain-English summary of what the PR does
- Finding counts by category (bugs, security, performance, best practices)
- Review effort rating (1-5) — how complex the PR is to review
- Health score (0-100) — aggregate code quality score
- Sequence diagram for complex logic (when
auto_sequence_diagram: true)
3. Commit Status
A green ✅ or red ❌ status check appears on the PR:
codepeel/premerge— passes/fails based on your pre-merge check rulesCodePeel— shows total finding count
Pre-merge checks are optional. Set them up to block merges when critical issues are found.
Step 4: Review in the Dashboard
Every review is also visible in the CodePeel webapp at codepeel.ai/app:
- All PRs — list of all reviewed PRs with status and finding counts
- PR Detail — full walkthrough, findings with code diffs, one-click fix buttons
- Fix Queue — PRs with unresolved critical/high findings that need attention
The dashboard also gives you access to:
- Knowledge Base — view and manage learned rules per repository
- Pre-merge Checks — configure quality gates
- Settings — review preferences, automation toggles, API tokens
Step 5: Interact with @codepeel
Mention @codepeel in any PR comment to interact with the bot. Full details: @codepeel Chat docs
Available commands:
| Command | What it does | Example |
|---|---|---|
| (just ask) | Ask any question about the code | @codepeel is there a race condition here? |
learn: | Teach a rule for future reviews | @codepeel learn: Always use Zod for validation |
ignore: | Suppress a false positive pattern | @codepeel ignore: console.log in debug.ts is intentional |
resolve | Dismiss a finding (won't re-flag) | Reply @codepeel resolve on any inline comment |
init | Generate .codepeel.yml config PR | @codepeel init |
reset config | Overwrite existing config with defaults | @codepeel reset config |
Tip: Rules saved via
learn:apply to all future reviews in that repository. For version-controlled rules, useexpert_rulesin .codepeel.yml. See Learnings docs for the full guide.
What Gets Reviewed
CodePeel runs four analysis layers in parallel on every PR:
| Layer | What it detects | Speed |
|---|---|---|
| Secret scanning | API keys, tokens, credentials | Instant |
| AI analysis | Bugs, security, performance, best practices | ~10-30s |
| SAST | Static analysis security patterns | ~10-20s |
| Architecture review | Design patterns, coupling, separation of concerns | ~15-25s |
Finding categories:
| Category | Examples |
|---|---|
| Bugs | Logic errors, null references, off-by-one, unhandled promises |
| Security | SQL injection, XSS, hardcoded secrets, path traversal |
| Performance | N+1 queries, memory leaks, unnecessary re-renders |
| Architecture | Design patterns, coupling, separation of concerns |
Want to customize what gets flagged? Use review profiles (
chill,balanced,assertive) or enablesecurityOnlymode.
Pricing
| Plan | Price | Repos | Reviews/month |
|---|---|---|---|
| Free | $0 | 3 public | 50 |
| Pro | $9.99/user/mo | Unlimited | 500 |
| Max | $0.04/review | Unlimited | No limit |
All reviews deduct from your monthly quota regardless of repo visibility.
What's Available Beyond PR Reviews
CodePeel isn't just a PR reviewer. Here's what else you can do:
| Feature | Description | Docs |
|---|---|---|
| VS Code Extension | Review code locally before pushing | Extension docs → |
| MCP Server | Use CodePeel inside AI editors (Kiro, Claude, Cursor) | MCP docs → |
| Auto-Fix PRs | Automatically generate fix PRs for findings | Auto-Fix docs → |
| Auto-Test PRs | Generate unit tests for your changes | Auto-Test docs → |
| Pre-merge Checks | Block merges when quality gates fail | Pre-merge docs → |
| Knowledge Base | Teach CodePeel your team's conventions | Learnings docs → |
| .codepeel.yml | Per-repo configuration (ignore paths, rules, profiles) | Config docs → |
Next Steps
- Configure .codepeel.yml — customize review behavior, ignore paths, add expert rules
- Set up Pre-merge Checks — block merges on critical findings
- Install the VS Code Extension — review code before pushing
- Set up MCP — use CodePeel inside your AI coding agent
- Teach rules via @codepeel — make reviews smarter over time