Control and manage code reviews
This page is about issuing direct commands to CodeRabbit during code reviews.For a general overview of performing code reviews with CodeRabbit, seeReview pull requests.
You can control CodeRabbit's behavior with a specific pull request by mentioning theusername of its bot,@coderabbitai, alongside keywords in comments or the pullrequest description, as specified by the next sections of this page.
For a complete CodeRabbit command reference, seeCode review command reference.
Control automatic code reviews
By default, CodeRabbit automatically reviews every new pull request created inyour repository. It updates its review with comments whenever the pull request has new commitspushed to it.
The following sections show you how to tell CodeRabbit to modify this behavior witha specific pull request, such as pausing reviews, or resolving open comments.
For more information about permanently configuring the behavior of CodeRabbit onyour repository, seeAdd a configuration file.
Pause and resume automatic code reviews
You can tell CodeRabbit to pause its automatic reviews of a pull request. Ifyou do, then you can still manually request CodeRabbit to review changes usingthe commands listed onCode review command reference.
To pause automated reviews of a pull request, post the following comment to thepull request:
@coderabbitai pause
To resume automated reviews after pausing them, post the following comment to thepull request:
@coderabbitai resume
Disable automatic code reviews
To disable automatic code reviews for a pull request, add the following lineanywhere in the pull request description:
@coderabbitai ignore
As long as that text remains in the description, CodeRabbit will notautomatically review any commits associated with that pull request.You can stillchat with CodeRabbit and issue other commands in the pullrequest comments.
To enable automatic reviews on that pull request, delete "@coderabbitai ignore"from the pull request description. CodeRabbit commences automatic reviews starting withthe next commit made to the branch under review.
Manually request code reviews
You can ask CodeRabbit to perform a code review at any time. This can be usefulwhen you have paused automated code reviews. Manually requested reviews havetwo types:
Afull review disregards any comments that CodeRabbit has already madeon this pull request, and generates a complete review of the entire pull request.
Anincremental review takes all comments that CodeRabbit has made since its most recent full review into consideration, and generates a review of only the new changes.
To manually request a full review, post the following comment to thepull request:
@coderabbitai full review
To manually request an incremental review, post the following comment to thepull request:
@coderabbitai review
Resolve comments
To have CodeRabbit mark all of its previous comments as resolved, post the following comment to thepull request:
@coderabbitai resolve
Update information about the pull request
The commands in this section request CodeRabbit to generate and post updated informationabout the pull request itself.
Update the summary text
To have CodeRabbit update the generated summary of the branch’s proposed changesto the pull request’s description, post the following comment:
@coderabbitai summary
CodeRabbit updates the summary text to the description under the heading"Summary by CodeRabbit".
Diagram the pull request history
To have CodeRabbit post a comment that contains a sequence diagram which visualizes thehistory of the pull request under review, post the following comment:
@coderabbitai generate sequence diagram
Get information about CodeRabbit
The commands in this section request CodeRabbit to display its own configurationor documentation.
Display current configuration
To have CodeRabbit post a comment listing out its current configurationwith your repository, post the following comment to thepull request:
@coderabbitai configuration
Display a quick-reference guide
To have CodeRabbit post a comment to the pull request with a quick-referenceguide to its own commands and other features, post the following comment to thepull request:
@coderabbitai help