All commands must be used with the
@coderabbitai mention in PR comments or
descriptions to trigger CodeRabbit’s response.Review control commands
These commands control CodeRabbit’s automatic review behavior for your pull request.Manual review triggers
@coderabbitai review
@coderabbitai review
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
@coderabbitai full review
@coderabbitai full review
Description: Performs a complete review of all files from scratchUsage: Post as a comment in your pull requestWhen to use:
- You want fresh insights on the entire PR
- Previous reviews may have missed something
- You’ve made significant changes affecting the overall logic
Review flow control
@coderabbitai pause
@coderabbitai pause
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
@coderabbitai resume
@coderabbitai resume
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
@coderabbitai ignore
@coderabbitai ignore
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
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
@coderabbitai summary
@coderabbitai summary
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:
- Add
@coderabbitai summaryanywhere in your PR description - When CodeRabbit generates a summary, it replaces this placeholder instead of appending to the end
- You can customize this placeholder using the
reviews.high_level_summary_placeholderconfiguration option
- 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
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.@coderabbitai generate docstrings
@coderabbitai generate docstrings
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
This feature must be enabled in your CodeRabbit configuration under
reviews.finishing_touches.docstrings.enabled.@coderabbitai generate unit tests
@coderabbitai generate unit tests
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
This feature must be enabled in your CodeRabbit configuration under
reviews.finishing_touches.unit_tests.enabled.@coderabbitai generate sequence diagram
@coderabbitai generate sequence diagram
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
Comment management
@coderabbitai resolve
@coderabbitai resolve
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
This will resolve ALL CodeRabbit comments. Make sure you’ve actually addressed the feedback before using this command.
Information and configuration
@coderabbitai configuration
@coderabbitai 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
@coderabbitai help
@coderabbitai help
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
Agentic chat commands
Agentic chat allows CodeRabbit to make actual code changes to your repository.
Use with caution.
Command reference table
For quick reference, here’s a summary of all available commands:| Command | Type | Description | Location |
|---|---|---|---|
@coderabbitai review | Review | Incremental review of new changes | PR comment |
@coderabbitai full review | Review | Complete review from scratch | PR comment |
@coderabbitai pause | Control | Temporarily stop reviews | PR comment |
@coderabbitai resume | Control | Restart reviews after pause | PR comment |
@coderabbitai ignore | Control | Permanently disable reviews | PR description |
@coderabbitai summary | Content | Regenerate PR summary | PR comment |
@coderabbitai generate docstrings | Content | Generate function documentation | PR comment |
@coderabbitai generate unit tests | Content | Generate test cases | PR comment |
@coderabbitai generate sequence diagram | Content | Create visual diagram | PR comment |
@coderabbitai resolve | Management | Resolve all CR comments | PR comment |
@coderabbitai configuration | Info | Show current settings | PR comment |
@coderabbitai help | Info | Show command reference | PR comment |
Related configuration
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