Skip to main content
CodePeelCodePeelDocumentation
Back

Get Started

Getting StartedFeaturesTeamsBilling

Integrations

VS Code ExtensionMCP Server@codepeel Chat

Configuration

.codepeel.ymlPre-merge ChecksLearnings

Automation

Auto-TestAuto-Fix

Reference

SecurityFAQ

Getting Started

Get your first AI code review in under 2 minutes. Install the GitHub App, open a PR, and CodePeel reviews it automatically.

Setup

1. Create your account

Sign up at codepeel.com with your GitHub account. No credit card required — free tier includes 30 reviews per month.

2. Install the GitHub App

After signing up, click Connect in the dashboard or go directly to Install CodePeel. Select the repositories you want reviewed.

3. Open a pull request

That's it. Open (or push to) any PR in a connected repository and CodePeel will automatically review it within 30-60 seconds.

Not using GitHub? Pick a different entry point

CodePeel works without the GitHub App — same review engine, same quota, different distribution:

  • VS Code Extension — Review code in your editor before pushing. Works with any Git repo (GitHub, GitLab, Bitbucket, self-hosted). Sign in once, run from the sidebar.
  • MCP Server — Add review_code, fix_code, and ask_codepeel to Claude Code, Cline, Roo, Cursor, or Kiro. Your AI agent reviews its own output as it writes.

All three use the same cpk_ API token from Settings → API Tokens. The free tier (30 reviews/month) works for every entry point.

What you'll see

When a review completes, CodePeel posts directly on your PR:

  • PR Walkthrough — A summary comment explaining what the PR does, with an optional Mermaid sequence diagram for complex changes.
  • Inline comments — Specific issues pinned to the exact lines that need attention, with severity badges (Critical, High, Medium, Low), explanations, and suggested fixes.
  • Commit status — A green ✓ or red ✗ check in the PR's status area (configurable via Pre-merge Checks).

What's next

Once you're receiving reviews, explore these to get more value:

  • Configuration — Add a .codepeel.yml to customize review behavior, ignore paths, and add team rules.
  • Learnings — Teach CodePeel your conventions with @codepeel learn: commands in PR comments.
  • MCP Server — Get reviews inside your AI coding agent (Claude, Kiro, Cursor, Cline).
  • VS Code Extension — Review code directly in your editor before pushing.
  • Teams — Share installations with your team. Each member is billed for their own PRs.
  • Chat — Ask CodePeel questions about findings with @codepeel mentions in PR comments.

Chat commands

You can interact with CodePeel directly in any PR comment:

CommandWhat it does
@codepeelAsk a question about the PR or a finding
@codepeel learn: <rule>Save a team convention for future reviews
@codepeel ignore: <pattern>Suppress a false positive permanently

Troubleshooting

Reviews not appearing?

  • Verify the GitHub App is installed on the repository (GitHub Settings → Applications)
  • Check that the PR targets a branch CodePeel monitors (default: main, master)
  • PRs with "WIP" or "[skip review]" in the title are skipped by default

Slow reviews?

Large PRs (500+ lines changed) take longer because the full review runs through multiple analysis stages. Consider smaller PRs for faster feedback.

Need help?

← All docsCodePeel