Create a minimal working CodeRabbit example.
Use when starting a new CodeRabbit integration, testing your setup,
or learning basic CodeRabbit API patterns.
Trigger with phrases like "coderabbit hello world", "coderabbit example",
"coderabbit quick start", "simple coderabbit code".
Minimal working example demonstrating CodeRabbit AI code review. CodeRabbit reviews PRs automatically via a GitHub/GitLab App -- no SDK or API calls needed. You configure behavior through a .coderabbit.yaml file and interact via PR comments.
Prerequisites
CodeRabbit GitHub App installed (see coderabbit-install-auth)
Once CodeRabbit posts its review (typically 2-5 minutes), you can interact:
# In a PR comment, use these commands:
@coderabbitai summary # Get a walkthrough of all changes
@coderabbitai full review # Re-run a complete review from scratch
@coderabbitai resolve # Mark all CodeRabbit comments as resolved
@coderabbitai help # List all available commands
# Reply to any CodeRabbit comment to have a conversation about the feedback
# CodeRabbit will respond with context-aware explanations
Step 5: Try the CLI for Local Reviews (Optional)
set -euo pipefail
# Review staged changes before committing
git add -A
cr review
# Review with interactive mode for back-and-forth discussion
cr review --interactive
# Review specific files
cr review src/index.ts src/utils.ts
What CodeRabbit Posts on Your PR
Walkthrough comment: High-level summary of all changes with a file-by-file breakdown
Sequence diagram: Visual control flow of the changes (if enabled)
Line-level comments: Specific suggestions on individual code lines
Review status: Approved or changes-requested based on severity of findings
Output
.coderabbit.yaml committed to repository root
First AI review posted on a test PR within 2-5 minutes