@coderabbitai ignore to skip it.
Before you start
- Write each command alone on its line, with flags allowed. Extra text such as
review pleasestops CodeRabbit from recognizing it, and a command inside a fenced code block doesnât count. - Know which settings a pull request canât change. See Enforce settings teams canât change.
Run one review with different settings
Post a comment with the command on its own line, followed by a fencedyaml block. CodeRabbit validates the block against the V2 schema and applies it to that review only.
@coderabbitai full review --with-config. It works whether or not automatic reviews are on, and it counts toward the review rate limit. Nothing in the committed configuration changes.
The block canât change merge or security risk instructions, allow_author_approval, or approval risk limits and overrides. To add knowledge_base.linked_repositories, you need write access to the pull requestâs repository and read access to each added repository. Cross-repository entries in knowledge_base.code_guidelines.filePatterns are rejected.
Add settings in the pull request description
Put the line@coderabbitai configuration override in the description, immediately followed by a fenced yaml block. You can add several blocks. Unlike a --with-config block, a description block always merges with inheritance: true onto the base configuration.
A block with any other key is rejected as a whole: none of its settings apply, and the pull request shows an error. Path instructions for paths that are already configured are skipped. File patterns add to the configured ones. A description block canât change approval policy.
Preview a configuration change not yet merged
To try a configuration change before it merges, comment@coderabbitai review --preview-config on the draft pull request that contains it. CodeRabbit runs an isolated full review with the pull request headâs configuration and labels it non-authoritative. It doesnât update the pull requestâs review state, and automatic approvals stay off. You need write access, the pull request must come from your repository, and the configuration must parse. The command is listed for GitHub and GitHub Enterprise Server.
Skip or pause one pull request
@coderabbitai pause and @coderabbitai resume comments pause and resume the review stream. For how the description keyword interacts with manual reviews and other skip rules, see Skip one pull request.
Force a review that configuration skips
@coderabbitai full review runs even when configuration skips the pull request, for example for drafts, ignored authors or disabled automatic reviews. It canât override a locked conversation, a bot author without a seat, or a pull request with no reviewable files.
Check the result
After the review posts, expand Run configuration in Review info, or post@coderabbitai configuration. See Check which configuration a review used.
Whatâs next
Validate and test a change
Try a configuration change before it reaches your team.
Control when reviews run
Set which pull requests CodeRabbit reviews automatically.
Review commands
See every
@coderabbitai command.