Skip to main content

CodeRabbit Commands

Control your code reviews directly from pull request comments using CodeRabbit's command system. Each command starts with @coderabbitai followed by the specific action you want to take.

Review Control Commands

Managing Reviews

CommandDescriptionUse Case
@coderabbitai reviewTriggers an incremental review of new changesWhen automatic reviews are disabled or you want to manually trigger a review
@coderabbitai full reviewPerforms a complete review of all files from scratchWhen you want to get fresh insights on the entire PR
@coderabbitai summaryRegenerates the PR summaryWhen you want an updated overview after making changes

Review Flow Control

CommandDescriptionUse Case
@coderabbitai pauseTemporarily stops reviews on the PRWhen you're making multiple rapid changes
@coderabbitai resumeRestarts reviews after a pauseWhen you're ready for CodeRabbit to review again
@coderabbitai ignorePermanently disables reviews for this PRWhen you want to handle the review process manually

Comment Management

CommandDescriptionUse Case
@coderabbitai resolveResolves all CodeRabbit review commentsWhen you've addressed all feedback and want to clean up

Documentation Commands

CommandDescriptionUse Case
@coderabbitai generate docstringsGenerates docstrings for functions in the PRWhen you need automatic documentation for your code
@coderabbitai configurationShows current CodeRabbit settingsWhen you need to check or export your configuration

Help & Support

CommandDescriptionUse Case
@coderabbitai helpDisplays available commands and usage infoWhen you need guidance on using CodeRabbit

Best Practices

Review Workflow

  • Start with @coderabbitai review for checking new changes
  • Use @coderabbitai full review when major changes require a fresh perspective
  • Generate summaries after significant updates using @coderabbitai summary

Managing Large Changes

  • Use @coderabbitai pause before making multiple commits
  • Resume reviews with @coderabbitai resume when ready
  • Consider @coderabbitai full review after substantial changes

Documentation Flow

  • Run @coderabbitai generate docstrings after finalizing function implementations
  • Learn more about docstring generation

Tips

  • Commands are case-insensitive (@coderabbitai REVIEW works the same as @coderabbitai review)
  • Commands can be issued by anyone with write access to the repository
  • Multiple commands can be used in sequence as needed
  • Use @coderabbitai configuration to export your settings before making changes

Command Response Time

  • Most commands (pause, resume, ignore) take effect immediately
  • Review commands typically complete within a few minutes, depending on PR size
  • Docstring generation time varies based on the number of functions

Troubleshooting

If a command doesn't seem to work:

  1. Check that you have the necessary repository permissions
  2. Verify the command syntax
  3. Look for any response from CodeRabbit in the PR comments
  4. Use @coderabbitai help for command guidance

Need help? Join our community on Discord or contact our support team.