@coderabbitai. This page lists where to post each command, which platforms and plans support it, and what it needs to run.
@coderabbitai is the handle on most installations. On some platforms the handle depends on how the CodeRabbit account was created. If CodeRabbit’s comments in your pull request come from a different account name, start commands with that handle instead.How commands work
Most commands go in a pull request comment. Some also work, or only work, as a reply in one of CodeRabbit’s review threads. Each command below says where it goes.- Handles: start a command with
@coderabbitaior@coderabbit. If CodeRabbit is installed with a different service-account handle on your platform, use that handle. - Case: commands are case-insensitive, so
@CodeRabbitAI Full Reviewworks. - One per comment: CodeRabbit runs one command from each comment. Post each command in its own comment.
- Position: a command must start a line, written as plain text. CodeRabbit ignores commands inside code blocks.
- Whole-comment commands: some commands run only when they are the entire comment, with no other text before or after them. The Post in line of each command says when this applies.
- Chat: anything else you write after the handle is a chat message, which CodeRabbit answers as a question or request. See Chat.
Quick reference
Platform availability
✓ means every hosting option of the platform, Cloud means the cloud-hosted service only, Self-managed means the self-managed service only, a list of platform names means only the listed hosting options, and — means not available.Run and pause reviews
Start a review on demand, or pause and resume automatic reviews on one pull request.review
Reviews the commits pushed since CodeRabbit’s last review of the pull request.
- Post in: A pull request comment (the command must be alone on its line, optionally followed by its flags)
Lets this review use usage credits after your organization’s included reviews are used up, when the usage-based add-on is set to On demand.
Applies the fenced
yaml code block that follows the command as configuration for this review only. Adding repositories to knowledge_base.linked_repositories this way needs write access to this repository and read access to each added repository.Runs an isolated full review with the unmerged CodeRabbit configuration from this draft pull request’s branch. The comment must be exactly
@coderabbitai review --preview-config, the pull request must be a draft from a branch in the same repository, and you need write access. Available on GitHub and GitHub Enterprise Server. The results don’t change the pull request’s review state.Use usage credits for this review
Preview the configuration changes in this draft pull request
Change one setting for this review and keep the rest of your configuration
- Works whether or not automatic reviews are enabled for the repository.
- Other text on the same line, such as
@coderabbitai review please, stops CodeRabbit from recognizing the command. - A command inside a fenced code block doesn’t count.
--preview-configworks only when the whole comment is exactly@coderabbitai review --preview-config. It isn’t accepted with other flags or text, or onfull review.- A review started by a command counts toward your review rate limit.
- To change settings for one review, add
--with-configand put a fenced YAML block right after the command. The settings apply to that review only and change nothing in your committed configuration. - Settings the block leaves out use their defaults for that review, not your repository’s configuration, unless the block sets
inheritance: true. Global overrides still apply. @coderabbitai full review --with-configworks the same way.- The block can’t add guideline sources from another repository (
repository:pathentries inknowledge_base.code_guidelines.filePatterns). Configure those in the repository or organization settings instead.
full review
Reviews every file in the pull request again from scratch.
- Post in: A pull request comment (the command must be alone on its line, optionally followed by its flags)
Lets this review use usage credits after your organization’s included reviews are used up, when the usage-based add-on is set to On demand.
Applies the fenced
yaml code block that follows the command as configuration for this review only. Adding repositories to knowledge_base.linked_repositories this way needs write access to this repository and read access to each added repository.Use usage credits for this review
Change one setting for this review and keep the rest of your configuration
- Other text on the same line, such as
@coderabbitai full review please, stops CodeRabbit from recognizing the command. - A review started by a command counts toward your review rate limit.
- To change settings for this review only, add
--with-configand put a fenced YAML block right after the command. Settings the block leaves out use their defaults for that review, not your repository’s configuration, unless the block setsinheritance: true. Global overrides still apply.
pause
Stops automatic reviews on the pull request until you resume them.
- Post in: A pull request comment (the whole comment must be the command)
- Also accepted:
ignore - Posted as a comment,
@coderabbitai ignorealso pauses reviews. In the pull request description, it stops automatic reviews instead; see Ignore keyword in the description.
resume
Restarts automatic reviews on a paused pull request.
- Post in: A pull request comment (the whole comment must be the command)
- CodeRabbit also starts an incremental review of the commits pushed while reviews were paused.
verify
|
Tests the reviewed pull request in an isolated browser environment.
- Post in: A reply in a CodeRabbit review thread
Test the reviewed pull request in an isolated browser environment.
Tell CodeRabbit what to test.
- Text you type after
verifyis passed to CodeRabbit as instructions for the test run. - In a top-level pull request comment, the command is accepted but CodeRabbit doesn’t start a test run.
Resolve and approve
Close CodeRabbit’s review threads and ask for its approval.resolve
Resolves all of CodeRabbit’s review threads on the pull request.
- Post in: A pull request comment or a reply in a review thread (the whole comment must be the command)
- Pull request authors: can post it as a pull request comment on their own pull requests only when
reviews.auto_approvals.allow_author_approvalis enabled; a reply in a review thread works either way - Posted as a reply in a CodeRabbit review thread, it resolves only that thread.
- A top-level
resolvecloses every CodeRabbit thread, so address the feedback first. - When Automatic Approvals is on, a top-level
resolvecan also approve the pull request, asapprovedoes, within the same approval risk limits.
approve
Resolves CodeRabbit’s review threads and, when Automatic Approvals is enabled, can approve the pull request.
- Post in: A pull request comment (the whole comment must be the command)
- Pull request authors: can use it on their own pull requests only when
reviews.auto_approvals.allow_author_approvalis enabled - Post it as a new top-level pull request comment. CodeRabbit doesn’t accept it as a reply in a review thread.
- With Automatic Approvals off, CodeRabbit resolves its threads but doesn’t approve, and replies that approval is disabled.
- It doesn’t bypass approval risk limits or an override that turns approval off. CodeRabbit resolves its threads and replies with the reason it withheld approval.
- On the Free plan, CodeRabbit resolves its threads but doesn’t approve.
Track findings in review threads
Have CodeRabbit keep checking a reviewer’s comment against new commits until the code addresses it.track
|
Tracks a reviewer’s comment in a review thread as a finding that CodeRabbit checks against later commits until the code addresses it.
- Post in: A reply in a CodeRabbit review thread (the command must be alone on its line, optionally followed by its flags)
- Reply to a review thread that a person started on code in a file. A thread that CodeRabbit started already uses the standard resolution workflow, and CodeRabbit replies with that explanation.
- A thread without a file location can’t be tracked, and CodeRabbit replies with that reason.
- A line number isn’t required, so threads on a line and threads on a whole file both work.
- CodeRabbit confirms in the thread that it is tracking the finding. On each later review of the pull request, it checks the new commits against the original comment and replies in the thread with a link to the pull request once the code satisfies it.
- CodeRabbit checks up to 20 tracked findings per review.
- Self-hosted CodeRabbit doesn’t support tracked findings. CodeRabbit replies that tracked review issues aren’t available for the repository.
fixed
|
Asks CodeRabbit to check the latest commits against a tracked review finding and report whether it is fixed.
- Post in: A reply in a CodeRabbit review thread (the command must be alone on its line, optionally followed by its flags)
- Reply in a review thread that you tracked with
track. In a thread that isn’t tracked, CodeRabbit asks you to runtrackfirst. - If the code satisfies the original comment, CodeRabbit replies with a link to the pull request that fixed it. Otherwise it replies that the finding isn’t fixed yet and explains why, and the finding stays tracked.
- If nothing has changed since the last check, CodeRabbit repeats the previous result instead of checking again.
- Self-hosted CodeRabbit doesn’t support tracked findings. CodeRabbit replies that tracked review issues aren’t available for the repository.
Fix the pull request
Have CodeRabbit change the pull request branch to fix review findings, failing CI checks, and merge conflicts.fix comments
|
Fixes unresolved CodeRabbit review findings and commits the fixes to the pull request branch.
- Post in: A pull request comment or a reply in a review thread
- Also accepted:
fix-comments,fix - Also accepted with
stacked pr:autofix,auto-fix,auto fix - Requires: write access to the repository;
reviews.finishing_touches.autofix.enabledenabled (on by default)
Commits the fixes to a new branch and opens a stacked pull request against the current branch, instead of committing to the current branch.
Deliver the fixes as a stacked pull request
- Posted as a reply in a review thread, it fixes that thread’s finding, whoever posted it. Posted in the pull request conversation, it fixes every unresolved CodeRabbit review thread.
- On GitHub, you can also select the Fix comments checkbox in CodeRabbit’s review comment.
- On GitHub, Fix comments doesn’t run on an open pull request from a fork, whether you post the command or select the checkbox. Push the branch to the upstream repository and run it from there.
@coderabbitai autofix stacked prruns Fix comments once and delivers the fixes as a stacked pull request. Withoutstacked pr,@coderabbitai autofixturns on Autofix, which keeps fixing the pull request automatically.
fix-ci
|
Investigates failing CI checks and delivers the fixes as a stacked pull request or a commit.
- Post in: A pull request comment
- Also accepted:
fix ci,fixci - Requires: write access to the repository;
reviews.finishing_touches.fix_ci.enabledenabled (on by default)
Commit the fixes to the current branch
commitworks with every spelling, for example@coderabbitai fix ci commit.
resolve merge conflict
|
Resolves merge conflicts with the base branch and commits the resolution to the pull request branch.
- Post in: A pull request comment
- Also accepted:
fix merge conflict - Requires: write access to the repository;
reviews.finishing_touches.resolve_merge_conflict.enabledenabled (on by default)
autofix
|
Turns on Autofix, which keeps fixing CodeRabbit findings and failing required CI checks, and resolves merge conflicts, on the pull request.
- Post in: A pull request comment (the whole comment must be the command)
- Also accepted:
autopilot,auto-fix,auto fix - Requires: write access to the repository
Turns Autofix off for this pull request. Putting
stop first, as in @coderabbitai stop autofix, also works.Restarts Autofix after it pauses, once you have resolved the blocker. Putting
resume first, as in @coderabbitai resume autofix, also works.Turn Autofix off
Resume Autofix after a pause
- CodeRabbit replies with a link to the coding task that runs Autofix.
stopandresumework with every spelling of the command.- A leading
pleaseand a trailing.or!are ignored. - Plain-language requests such as
@coderabbitai take this PR to completionalso turn Autofix on. - On GitHub, you can also select the Autofix checkbox in CodeRabbit’s walkthrough comment.
- Normal billing checks apply to the follow-up work Autofix starts.
local commit
Commits the changes that CodeRabbit proposed in a comment to the pull request branch.
- Post in: A reply to the CodeRabbit comment that proposed the change
- Requires: write access to the repository
- Reply to the CodeRabbit comment that contains the proposal. CodeRabbit commits its most recent proposal from that conversation or thread.
Generate code
Run Finishing Touches that add or change code in the pull request.generate unit tests
|
Generates unit tests for the code changed in the pull request.
- Post in: A pull request comment
- Requires: write access to the repository;
reviews.finishing_touches.unit_tests.enabledenabled (on by default) - On GitHub, you can also check Generate unit tests in the CodeRabbit walkthrough.
simplify
|
Reviews the changed code for reuse, quality, and efficiency, then applies targeted simplifications.
- Post in: A pull request comment
- Requires: write access to the repository;
reviews.finishing_touches.simplify.enabledenabled (off by default) - On GitHub, you can also check Simplify code in the CodeRabbit walkthrough.
run <recipe name>
|
Runs one of your custom Finishing Touch recipes on the pull request.
- Post in: A pull request comment
- Requires: write access to the repository
The name of a recipe defined under
reviews.finishing_touches.custom. Quote names that contain spaces.Run the recipe named Tighten types
- Define recipes under
reviews.finishing_touches.custom, up to your plan’s limit. - On GitHub, each enabled recipe also appears as a checkbox in the walkthrough’s Finishing Touches section.
evaluate custom finishing touch
|
Tries out finishing touch instructions on the pull request without saving them as a recipe.
- Post in: A pull request comment
- Requires: write access to the repository
What the finishing touch should change, in plain language. Quote text that contains spaces.
- CodeRabbit delivers the result as a stacked pull request.
Generate summaries, diagrams, and plans
Have CodeRabbit write about the pull request instead of changing its code.summary
Regenerates the pull request summary.
- Post in: A pull request comment (the whole comment must be the command)
- In the pull request description,
@coderabbitai summaryis a placeholder instead; see summary placeholder.
generate sequence diagram
Posts a sequence diagram of the pull request’s changes as a comment.
- Post in: A pull request comment
- It needs CodeRabbit’s summary on the pull request. If there isn’t one yet, run a review first.
plan
Generates a Coding Plan for an issue, or on GitHub for a pull request and its linked issue.
- Post in: A pull request comment (the whole comment must be the command)
- Requires:
issue_enrichment.planning.enabledenabled (on by default) - Comment it on an issue in GitHub, GitLab, Azure Boards, Jira, or Linear to plan that issue; see Issue Planner.
/create_issue
|
Creates one issue in the repository from a merge request comment, using your linked GitLab account.
- Post in: A pull request comment
What the issue should track. CodeRabbit writes the issue from this text and the merge request context.
- Type the command at the start of the comment, followed by a space, a line break or nothing.
- CodeRabbit creates the issue with your linked GitLab account. If that account can’t create issues in the repository, CodeRabbit doesn’t create one.
- CodeRabbit creates the issue only for the comment as you posted it. If the comment is edited or removed before the issue is created, no issue is created.
Pre-merge checks and post-merge actions
Run, override, and try out pre-merge checks, and choose which post-merge actions run.run pre-merge checks
|
Runs the configured pre-merge checks on the pull request again.
- Post in: A pull request comment
ignore pre-merge checks
|
Overrides failing pre-merge checks so they don’t block CodeRabbit’s approval.
- Post in: A pull request comment
- When
reviews.pre_merge_checks.override_requested_reviewers_onlyis enabled, only reviewers of the pull request can use it, not its author.
evaluate custom pre-merge check
|
Runs a custom pre-merge check on the pull request without adding it to your configuration.
- Post in: A pull request comment
skip post-merge actions
|
Clears the Post-Merge Actions checkboxes so those actions don’t run when the pull request merges.
- Post in: A pull request comment
- Also accepted:
skip post merge actions,post-merge skip,post merge skip
Skips only the action with this exact name. Repeat it to skip several actions. Without
--name, every action is skipped.Skip only these actions
- It applies only to this pull request. Action names must match exactly.
View and generate configuration
See the configuration CodeRabbit uses for the repository and turn it into a file.configuration
Shows the resolved CodeRabbit configuration for the repository, with comments that say where each setting comes from.
- Post in: A pull request comment (the whole comment must be the command)
generate configuration
Opens a pull request that adds the resolved configuration as .coderabbit.yaml, or shows the configuration when the file already exists.
- Post in: A pull request comment (the whole comment must be the command)
- Requires: write access to the repository
- Where CodeRabbit can’t open pull requests, it shows the configuration instead.
- On Bitbucket Data Center, CodeRabbit can’t verify write access, so it doesn’t open the pull request. It still shows the configuration when
.coderabbit.yamlalready exists.
emit path instructions
Opens a pull request that adds CodeRabbit’s recent path instruction suggestions to .coderabbit.yaml.
- Post in: A pull request comment
- Also accepted:
emit path-instructions - Requires: write access to the repository
- CodeRabbit uses suggestions from the past 7 days, adds only paths that don’t have instructions yet, and keeps the rest of the file as it is.
- When there are no recent agent-generated suggestions, CodeRabbit generates new ones first.
- Generating new suggestions needs an active subscription.
Get information
Look up the available commands, your review allowance, and the repository’s own terms.help
Lists the commands you can use on this pull request.
- Post in: A pull request comment (the whole comment must be the command)
- The list depends on the repository’s platform, plan, and settings, so it shows only commands that can run here.
rate limit
Shows whether another review is available now and, if not, when to try again.
- Post in: A pull request comment
- Also accepted:
rate-limit,limits,quota - Post it as a top-level pull request comment. Checking doesn’t use a review.
generate project vocabulary
Lists up to 50 terms that are specific to the repository, such as product names, domain concepts, and abbreviations.
- Post in: A pull request comment
- Also accepted:
generate vocabulary,generate project vocab - The reply is a Markdown list of the terms.
- Needs an active subscription; free accounts can’t use it.
If a command doesn’t respond
If CodeRabbit doesn’t react to a command, or answers it as a chat message, check the following:- Where you posted it. Post the command where its entry says: a pull request comment or a reply in a CodeRabbit review thread. For example,
approvedoesn’t work as a review-thread reply. - Extra text. A whole-comment command must be the entire comment. Remove any other text before or after it, and post other requests in a separate comment.
- Formatting. Write the command as plain text at the start of a line. CodeRabbit doesn’t run commands inside code blocks or wrapped in backticks.
- Platform. Check the command’s platform badges. Some commands work only on some Git platforms, or only on CodeRabbit Cloud.
- Plan. Check the command’s plan badge. Some commands need the Essentials or Team plan.
- Settings. Some commands run only when a setting is enabled, such as
reviews.finishing_touches.simplify.enabled, which is off by default. Post@coderabbitai configurationto see the settings that apply to the repository. - Write access. Commands that change the branch or open a pull request need write access to the repository.
- GitHub organization membership. In a repository owned by a GitHub organization, when
chat.allow_non_org_membersisfalse, CodeRabbit responds only to members of that organization. - What’s available here. Post
@coderabbitai helpto list the commands available on this pull request right now. The list reflects the repository’s platform, plan, and settings.
What’s next
Configuration reference
Look up the settings that turn commands and features on or off for a repository.
Finishing Touches
See the actions CodeRabbit can take on a pull request after the review.
Path-based review instructions
Tell CodeRabbit how to review specific files and directories.