| name | coderabbit-hello-world |
| description | Create a minimal working CodeRabbit configuration and trigger your first AI review.
Use when starting with CodeRabbit, testing your setup,
or learning basic .coderabbit.yaml patterns.
Trigger with phrases like "coderabbit hello world", "coderabbit example",
"coderabbit quick start", "first coderabbit review".
|
| allowed-tools | Read, Write, Edit, Bash(gh:*), Bash(git:*) |
| version | 1.11.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
| tags | ["saas","coderabbit","quickstart","testing"] |
| compatibility | Designed for Claude Code, also compatible with Codex and OpenClaw |
CodeRabbit Hello World
Overview
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)
- A repository with at least one branch
Instructions
Step 1: Create Minimal Configuration
language: "en-US"
reviews:
profile: "assertive"
high_level_summary: true
auto_review:
enabled: true
drafts: false
chat:
auto_reply: true
Step 2: Add Path-Specific Instructions
reviews:
profile: "assertive"
high_level_summary: true
auto_review:
enabled: true
drafts: false
path_instructions:
- path: "src/**/*.ts"
instructions: "Check for proper TypeScript types. Flag any use of `any`."
- path: "**/*.test.*"
instructions: "Verify edge cases are covered. Check async handling."