Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt

Use this file to discover all available pages before exploring further.

Examples on this page use @coderabbitai. If CodeRabbit is installed with a different service-account handle on your platform, use that handle instead in PR comments and PR descriptions.

​
Review control commands

These commands control CodeRabbit’s automatic review behavior for your pull request.

​
Manual review triggers

@coderabbitai review does incremental review (new changes), not a full review. Use @coderabbitai full review when you want a complete pass over the entire pull request.
Description: Triggers an incremental review of new changes onlyUsage: Post as a comment in your pull requestWhen to use:
  • Automatic reviews are disabled
  • You want to manually request a review of recent changes
  • You’ve made updates and want focused feedback on new code
  • A full review already ran and you only want feedback on what changed since then (new commits)
Example:
@coderabbitai review
Description: Performs a complete review of all files from scratchUsage: Post as a comment in your pull requestWhen to use:
  • You want fresh view on the entire PR
  • Previous reviews may have missed something
  • You’ve made significant changes affecting the overall logic
  • A PR was moved from draft to open and you want the first complete review now
Example:
@coderabbitai full review

​
Review flow control

Description: Temporarily stops automatic reviews on the PRUsage: Post as a comment in your pull requestWhen to use:
  • Making multiple rapid changes
  • Want to avoid review spam during development
  • Need time to complete your implementation
Example:
@coderabbitai pause
Description: Restarts automatic reviews after a pauseUsage: Post as a comment in your pull requestWhen to use:
  • Ready for CodeRabbit to review again
  • Completed your changes and want feedback
Example:
@coderabbitai resume
Description: Permanently disables automatic reviews for this PRUsage: Add anywhere in the pull request descriptionWhen to use:
  • Want to handle the review process manually
  • PR contains sensitive or experimental code
  • Working on a hotfix that needs immediate deployment
Example:
@coderabbitai ignore
This command must be placed in the PR description, not in comments. To re-enable reviews, remove this text from the description.

​
Content generation commands

These commands help generate and update PR content and documentation.

​
Summary and documentation

Note: This is not a command - it’s a placeholder that you put in your PR description.Description: A placeholder in your PR description that gets replaced with CodeRabbit’s high-level summary of the changesHow it works:
  1. Add @coderabbitai summary anywhere in your PR description
  2. When CodeRabbit generates a summary, it replaces this placeholder instead of appending to the end
  3. You can customize this placeholder using the reviews.high_level_summary_placeholder configuration option
Usage: Place directly in your PR description (not as a comment)When to use:
  • You want the summary in a specific location in your description
  • You want to control where the summary appears instead of it being appended at the end
Example PR description:
## Overview
This PR implements the new user authentication flow.

@coderabbitai summary

## Testing
- [ ] Unit tests pass
- [ ] Integration tests pass
You can change this placeholder to anything you like using the reviews.high_level_summary_placeholder configuration option. See the configuration reference for more details.
Description: Generates docstrings for functions and classes in the PRUsage: Post as a comment in your pull requestWhen to use:
  • Code lacks proper documentation
  • Want consistent docstring formatting
  • Need to improve code documentation quickly
Example:
@coderabbitai generate docstrings
This feature must be enabled in your CodeRabbit configuration under reviews.finishing_touches.docstrings.enabled.
Description: Generates unit tests for the code in the PRUsage: Post as a comment in your pull requestWhen to use:
  • Code lacks test coverage
  • Want to quickly scaffold test cases
  • Need examples of how to test your functions
Example:
@coderabbitai generate unit tests
This feature must be enabled in your CodeRabbit configuration under reviews.finishing_touches.unit_tests.enabled.
Description: Automatically applies fixes for unresolved CodeRabbit review findings on GitHub pull requests and GitLab merge requests. Fixes can be committed directly to the current branch or to a new branch, based on your preference. For full details, see Finishing Touches / Autofix.When to use: You want CodeRabbit to automatically implement review fixesUsage:Post as a comment in your pull request
Commit changes directly to the current branch
@coderabbitai autofix
Commit changes to a new branch and open a stacked pull request against the current branch
@coderabbitai autofix stacked pr
The aliases auto-fix and auto fix are also supported.
Supported on GitHub and GitLab. The interactive Autofix checkboxes are available on supported GitHub pull-request flows only.
No configuration required. Enabled by default for Pro and Enterprise plan users.
If the pull request has merge conflicts, Autofix stops before making changes. The reply will suggest @coderabbitai resolve merge conflict as the next step. See Resolve merge conflicts for details.
Description: Creates a sequence diagram visualizing the PR’s history and changesUsage: Post as a comment in your pull requestWhen to use:
  • Want to visualize complex interactions
  • Need to understand the flow of changes
  • Documentation requires visual aids
Example:
@coderabbitai generate sequence diagram

​
Comment management

Description: Marks all CodeRabbit review comments as resolvedUsage: Post as a comment in your pull requestWhen to use:
  • Addressed all CodeRabbit feedback
  • Want to clean up resolved issues
  • Ready to merge and need clean comment state
Example:
@coderabbitai resolve
This will resolve ALL CodeRabbit comments. Make sure you’ve actually addressed the feedback before using this command.

​
Information and configuration

Description: Displays current CodeRabbit configuration settingsUsage: Post as a comment in your pull requestWhen to use:
  • Need to check current settings
  • Troubleshooting configuration issues
  • Want to export or share your configuration
Example:
@coderabbitai configuration
Description: Creates a PR that adds the current resolved configuration as .coderabbit.yaml (or shows it if already present).Usage: Post as a comment in your pull requestWhen to use:
  • Want to export current settings to a file
  • Share configuration with team members
  • Create a baseline configuration for the repository
Example:
@coderabbitai generate configuration
Description: Shows a quick reference guide of available commandsUsage: Post as a comment in your pull requestWhen to use:
  • Need a quick reminder of available commands
  • Want to see command syntax
  • Sharing CodeRabbit capabilities with team members
Example:
@coderabbitai help

​
Command reference table

For quick reference, here’s a summary of all available commands:
CommandTypeDescriptionLocation
@coderabbitai reviewReviewIncremental review of new changesPR comment
@coderabbitai full reviewReviewComplete review from scratchPR comment
@coderabbitai pauseControlTemporarily stop reviewsPR comment
@coderabbitai resumeControlRestart reviews after pausePR comment
@coderabbitai ignoreControlPermanently disable reviewsPR description
@coderabbitai summaryContentRegenerate PR summaryPR comment
@coderabbitai generate docstringsContentGenerate function documentationPR comment
@coderabbitai generate unit testsContentGenerate test casesPR comment
@coderabbitai autofixContentAuto-apply review fixesReview comment
@coderabbitai autofix stacked prContentAuto-fix via stacked pull requestReview comment
@coderabbitai generate sequence diagramContentCreate visual diagramPR comment
@coderabbitai resolveManagementResolve all CR commentsPR comment
@coderabbitai configurationInfoShow current settingsPR comment
@coderabbitai generate configurationInfoCreate/export configuration filePR comment
@coderabbitai helpInfoShow command referencePR comment
Many of these commands are affected by your CodeRabbit configuration. Key configuration options include:
  • Automatic reviews: reviews.auto_review.enabled
  • Docstring generation: reviews.finishing_touches.docstrings.enabled
  • Unit test generation: reviews.finishing_touches.unit_tests.enabled
  • High-level summaries: reviews.high_level_summary
  • Sequence diagrams: reviews.sequence_diagrams
For complete configuration options, see Configuration Reference.