You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Split the current chat commands page into three pages: a reference page,
a troubleshooting guide, and a best practices guide.
Replace the chat commands page with two task-orience how-to guides,
one about controlling code reviews, and one about generating improvements.
Add a new overview page for the code review process.
@@ -3,92 +3,152 @@ title: Control and manage code reviews
3
3
description: Learn how to control CodeRabbit using commands in pull request comments
4
4
---
5
5
6
-
# CodeRabbit Commands
6
+
This page is about issuing direct commands to CodeRabbit during code reviews.
7
+
For a general overview of performing code reviews with CodeRabbit, see [Review pull requests](/guides/code-review-overview).
7
8
8
-
> 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.
9
+
You can control CodeRabbit's behavior with a specific pull request by mentioning the
10
+
username of its bot, `@coderabbitai`, alongside keywords in comments or the pull
11
+
request description, as specified by the next sections of this page.
9
12
10
-
## Review Control Commands
13
+
For a complete CodeRabbit command reference, see [Code review command reference](/reference/review-commands).
|`@coderabbitai review`| Triggers an incremental review of new changes | When automatic reviews are disabled or you want to manually trigger a review |
17
-
|`@coderabbitai full review`| Performs a complete review of all files from scratch | When you want to get fresh insights on the entire PR |
18
-
|`@coderabbitai summary`| Regenerates the PR summary | When you want an updated overview after making changes |
17
+
By default, CodeRabbit automatically reviews every new pull request created in
18
+
your repository. It updates its review with comments whenever the pull request has new commits
19
+
pushed to it.
19
20
20
-
### Review Flow Control
21
+
The following sections show you how to tell CodeRabbit to modify this behavior with
22
+
a specific pull request, such as pausing reviews, or resolving open comments.
|`@coderabbitai help`| Displays available commands and usage info | When you need guidance on using CodeRabbit |
49
+
To disable automatic code reviews for a pull request, add the following line
50
+
anywhere in the pull request description:
52
51
53
-
## Best Practices
52
+
```text
53
+
@coderabbitai ignore
54
+
```
54
55
55
-
### Review Workflow
56
+
As long as that text remains in the description, CodeRabbit will not
57
+
automatically review any commits associated with that pull request.
58
+
You can still [chat with CodeRabbit](/guides/agent_chat) and issue other commands in the pull
59
+
request comments.
56
60
57
-
- Start with `@coderabbitai review` for checking new changes
58
-
- Use `@coderabbitai full review` when major changes require a fresh perspective
59
-
- Generate summaries after significant updates using `@coderabbitai summary`
61
+
To enable automatic reviews on that pull request, delete "`@coderabbitai ignore`"
62
+
from the pull request description. CodeRabbit commences automatic reviews starting with
63
+
the next commit made to the branch under review.
60
64
61
-
### Managing Large Changes
65
+
##Manually request code reviews {#request}
62
66
63
-
- Use `@coderabbitai pause` before making multiple commits
64
-
- Resume reviews with `@coderabbitai resume` when ready
65
-
- Consider `@coderabbitai full review` after substantial changes
67
+
You can ask CodeRabbit to perform a code review at any time. This can be useful
68
+
when you have paused automated code reviews. Manually requested reviews have
69
+
two types:
66
70
67
-
### Documentation Flow
71
+
- A _full review_ disregards any comments that CodeRabbit has already made
72
+
on this pull request, and generates a complete review of the entire pull request.
68
73
69
-
- Run `@coderabbitai generate docstrings` after finalizing function implementations
70
-
- Learn more about [docstring generation](/finishing-touches/docstrings)
74
+
- An _incremental 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.
71
75
72
-
## Tips
76
+
To manually request a full review, post the following comment to the
77
+
pull request:
73
78
74
-
- Commands are case-insensitive (`@coderabbitai REVIEW` works the same as `@coderabbitai review`)
75
-
- Commands can be issued by anyone with write access to the repository
76
-
- Multiple commands can be used in sequence as needed
77
-
- Use `@coderabbitai configuration` to export your settings before making changes
79
+
```text
80
+
@coderabbitai full review
81
+
```
78
82
79
-
## Command Response Time
83
+
To manually request an incremental review, post the following comment to the
84
+
pull request:
80
85
81
-
- Most commands (pause, resume, ignore) take effect immediately
82
-
- Review commands typically complete within a few minutes, depending on PR size
83
-
- Docstring generation time varies based on the number of functions
86
+
```text
87
+
@coderabbitai review
88
+
```
84
89
85
-
## Troubleshooting
90
+
## Resolve comments {#resolve}
86
91
87
-
If a command doesn't seem to work:
92
+
To have CodeRabbit mark all of its previous comments as resolved, post the following comment to the
93
+
pull request:
88
94
89
-
1. Check that you have the necessary repository permissions
90
-
2. Verify the command syntax
91
-
3. Look for any response from CodeRabbit in the PR comments
92
-
4. Use `@coderabbitai help` for command guidance
95
+
```text
96
+
@coderabbitai resolve
97
+
```
93
98
94
-
Need help? Join our community on [Discord](https://discord.gg/coderabbit) or contact our support team.
99
+
## Update information about the pull request {#update}
100
+
101
+
The commands in this section request CodeRabbit to generate and post updated information
102
+
about the pull request itself.
103
+
104
+
### Update the summary text {#summary}
105
+
106
+
To have CodeRabbit update the generated summary of the branch’s proposed changes
107
+
to the pull request’s description, post the following comment:
108
+
109
+
```text
110
+
@coderabbitai summary
111
+
```
112
+
113
+
CodeRabbit updates the summary text to the description under the heading
114
+
"Summary by CodeRabbit".
115
+
116
+
### Diagram the pull request history {#diagram}
117
+
118
+
To have CodeRabbit post a comment that contains a sequence diagram which visualizes the
119
+
history of the pull request under review, post the following comment:
120
+
121
+
```text
122
+
@coderabbitai generate sequence diagram
123
+
```
124
+
125
+
## Get information about CodeRabbit {#info}
126
+
127
+
The commands in this section request CodeRabbit to display its own configuration
128
+
or documentation.
129
+
130
+
### Display current configuration {#config}
131
+
132
+
To have CodeRabbit post a comment listing out its current configuration
133
+
with your repository, post the following comment to the
134
+
pull request:
135
+
136
+
```text
137
+
@coderabbitai configuration
138
+
```
139
+
140
+
### Display a quick-reference guide {#help}
141
+
142
+
To have CodeRabbit post a comment to the pull request with a quick-reference
143
+
guide to its own commands and other features, post the following comment to the
|`@coderabbitai review`| Triggers an incremental review of new changes | When automatic reviews are disabled or you want to manually trigger a review |
13
+
|`@coderabbitai full review`| Performs a complete review of all files from scratch | When you want to get fresh insights on the entire PR |
14
+
|`@coderabbitai summary`| Regenerates the PR summary | When you want an updated overview after making changes |
0 commit comments