|
1 | | ---- |
2 | | -title:CodeRabbit Commands |
3 | | -sidebar_label:CodeRabbit Commands |
4 | | -description: |
5 | | -CodeRabbit offers various commands that can be invoked as PR comments to |
6 | | -control the review process. |
7 | | -sidebar_position:4 |
8 | | ---- |
9 | | - |
10 | | -The following commands are available (invoked as PR comments): |
11 | | - |
12 | | --`@coderabbitai pause` to pause the reviews on a PR. |
13 | | --`@coderabbitai resume` to resume the paused reviews. |
14 | | --`@coderabbitai ignore` to ignore the reviews on a PR. |
15 | | --`@coderabbitai review` to trigger an incremental review. This is useful when |
16 | | - automatic reviews are disabled for the repository. |
17 | | --`@coderabbitai full review` to do a full review from scratch and review all |
18 | | - the files again. |
19 | | --`@coderabbitai summary` to regenerate the summary of the PR. |
20 | | --`@coderabbitai resolve` resolve all the CodeRabbit review comments. |
21 | | --`@coderabbitai configuration` to show the current CodeRabbit configuration for |
22 | | - the repository. |
23 | | --`@coderabbitai help` to get help. |
24 | | --`@coderabbitai generate docstrings` to generate docstrings for functions in the PR. Learn more about[docstrings generation](/finishing-touches/docstrings). |
| 1 | +#CodeRabbit Commands |
| 2 | + |
| 3 | +>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. |
| 4 | +
|
| 5 | +##Review Control Commands |
| 6 | + |
| 7 | +###Managing Reviews |
| 8 | + |
| 9 | +| Command| Description| Use Case| |
| 10 | +| ---------------------------| ----------------------------------------------------| ----------------------------------------------------------------------------| |
| 11 | +|`@coderabbitai review`| Triggers an incremental review of new changes| When automatic reviews are disabled or you want to manually trigger a review| |
| 12 | +|`@coderabbitai full review`| Performs a complete review of all files from scratch| When you want to get fresh insights on the entire PR| |
| 13 | +|`@coderabbitai summary`| Regenerates the PR summary| When you want an updated overview after making changes| |
| 14 | + |
| 15 | +###Review Flow Control |
| 16 | + |
| 17 | +| Command| Description| Use Case| |
| 18 | +| ----------------------| ----------------------------------------| ---------------------------------------------------| |
| 19 | +|`@coderabbitai pause`| Temporarily stops reviews on the PR| When you're making multiple rapid changes| |
| 20 | +|`@coderabbitai resume`| Restarts reviews after a pause| When you're ready for CodeRabbit to review again| |
| 21 | +|`@coderabbitai ignore`| Permanently disables reviews for this PR| When you want to handle the review process manually| |
| 22 | + |
| 23 | +###Comment Management |
| 24 | + |
| 25 | +| Command| Description| Use Case| |
| 26 | +| -----------------------| ---------------------------------------| -------------------------------------------------------| |
| 27 | +|`@coderabbitai resolve`| Resolves all CodeRabbit review comments| When you've addressed all feedback and want to clean up| |
| 28 | + |
| 29 | +###Documentation Commands |
| 30 | + |
| 31 | +| Command| Description| Use Case| |
| 32 | +| -----------------------------------| --------------------------------------------| ---------------------------------------------------| |
| 33 | +|`@coderabbitai generate docstrings`| Generates docstrings for functions in the PR| When you need automatic documentation for your code| |
| 34 | +|`@coderabbitai configuration`| Shows current CodeRabbit settings| When you need to check or export your configuration| |
| 35 | + |
| 36 | +###Help & Support |
| 37 | + |
| 38 | +| Command| Description| Use Case| |
| 39 | +| --------------------| ------------------------------------------| ------------------------------------------| |
| 40 | +|`@coderabbitai help`| Displays available commands and usage info| When you need guidance on using CodeRabbit| |
| 41 | + |
| 42 | +##Best Practices |
| 43 | + |
| 44 | +###Review Workflow |
| 45 | + |
| 46 | +- Start with`@coderabbitai review` for checking new changes |
| 47 | +- Use`@coderabbitai full review` when major changes require a fresh perspective |
| 48 | +- Generate summaries after significant updates using`@coderabbitai summary` |
| 49 | + |
| 50 | +###Managing Large Changes |
| 51 | + |
| 52 | +- Use`@coderabbitai pause` before making multiple commits |
| 53 | +- Resume reviews with`@coderabbitai resume` when ready |
| 54 | +- Consider`@coderabbitai full review` after substantial changes |
| 55 | + |
| 56 | +###Documentation Flow |
| 57 | + |
| 58 | +- Run`@coderabbitai generate docstrings` after finalizing function implementations |
| 59 | +- Learn more about[docstring generation](/finishing-touches/docstrings) |
| 60 | + |
| 61 | +##Tips |
| 62 | + |
| 63 | +- Commands are case-insensitive (`@coderabbitai REVIEW` works the same as`@coderabbitai review`) |
| 64 | +- Commands can be issued by anyone with write access to the repository |
| 65 | +- Multiple commands can be used in sequence as needed |
| 66 | +- Use`@coderabbitai configuration` to export your settings before making changes |
| 67 | + |
| 68 | +##Command Response Time |
| 69 | + |
| 70 | +- Most commands (pause, resume, ignore) take effect immediately |
| 71 | +- Review commands typically complete within a few minutes, depending on PR size |
| 72 | +- Docstring generation time varies based on the number of functions |
| 73 | + |
| 74 | +##Troubleshooting |
| 75 | + |
| 76 | +If a command doesn't seem to work: |
| 77 | + |
| 78 | +1. Check that you have the necessary repository permissions |
| 79 | +2. Verify the command syntax |
| 80 | +3. Look for any response from CodeRabbit in the PR comments |
| 81 | +4. Use`@coderabbitai help` for command guidance |
| 82 | + |
| 83 | +Need help? Join our community on[Discord](https://discord.gg/coderabbit) or contact our support team. |