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
description: Learn about CodeRabbit Pro's agentic chat system
5
+
sidebar_position: 8
6
+
---
7
+
8
+
# Agentic Chat
9
+
10
+
```mdx-code-block
11
+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
12
+
13
+
<ProPlanNotice />
14
+
```
15
+
16
+
CodeRabbit Chat is a powerful pull-request-specific assistant designed to streamline your development workflow. You can interact directly in pull request review comments and pull request comments to ask questions, have CodeRabbit rewrite code, or generate new code.
17
+
18
+
## Invocation
19
+
20
+
To invoke CodeRabbit Chat, simply comment on a pull request using the handle `@coderabbitai` without any explicit command (so without the [explicit CodeRabbit commands](./commands.md)) in plain natural language.
21
+
22
+
The permission flow for the chat is the same as the deterministic CodeRabbit commands.
23
+
24
+
Upon being invoked, CodeRabbit processes your request and responds with the necessary assistance. This assistance may entail generating scripts, updating issue tracking systems, offering detailed code suggestions, or even submitting an entire pull request (with your consent).
25
+
26
+
## Features
27
+
28
+
### Script Writing
29
+
30
+
CodeRabbit Chat can automatically generate scripts in various programming languages (mainly shell scripting) to answer questions about your codebase. If incorrect or non-running or non-germane shell scripts are created, CodeRabbit goes and tries again, and the whole script iteration process will be displayed to you in an Analysis Flow.
31
+
32
+
### Web Search
33
+
34
+
CodeRabbit Chat integrates real-time web search capabilities, enabling it to fetch up-to-date information to support its responses. The CodeRabbit Chat response will indicate this if it decides to search the web to answer your query.
35
+
36
+
Set `enabled` to false within `web_search` within `knowledge_base` within the config in order to turn this off.
37
+
38
+
### Jira and Linear Integration
39
+
40
+
CodeRabbit Chat can deal with existing issue tracking system integrations in order to integrate with your existing issues. For details on setting up issue tracking integrations, see our [Issue Integrations](../integrations/issue-integrations.md) guide and [Issue Creation](./issue-creation.md) guide.
41
+
42
+
### Learnings Integration
43
+
44
+
CodeRabbit Chat can insert and delete Learnings from your Learnings database. Simply ask it to do so in plain natural language.
45
+
46
+
### Single Step Code Generation
47
+
48
+
For rapid prototyping and quick fixes, CodeRabbit Chat is capable of generating code snippets in a single step.
49
+
50
+
### Multi-Step Agentic Flow with Planning
51
+
52
+
When facing complex coding challenges, CodeRabbit Chat supports multi-step agentic flows that involve detailed planning and execution. Once the multi-step workflow is complete, CodeRabbit can automatically issue a pull request for the changes so you can consent to the code changes or edit them.
53
+
54
+
CodeRabbit cannot perform further modifications to opened pull requests. From there, it's your turn to checkout the branch and improve it to satisfaction. We believe that this workflow provides a significant headstart to implementing code.
55
+
56
+
Multi-step agentic flows are currently only available on Github. Multi-step agentic flows are an early access product currently.
57
+
58
+
### Configuration Changes
59
+
60
+
CodeRabbit is also capable of managing its own configuration settings upon request. This self-management allows the assistant to dynamically adapt to changing project requirements. By simplifying configuration updates, CodeRabbit helps users quickly adjust to new workflows or requirements without interrupting the development process.
61
+
62
+
### Help and Feedback
63
+
64
+
Need help? Join our community on [Discord](https://discord.gg/coderabbit) or contact our support team.
Copy file name to clipboardExpand all lines: docs/guides/custom-reports.md
+87-28
Original file line number
Diff line number
Diff line change
@@ -71,6 +71,8 @@ Your custom reports can access the following PR information that you can referen
71
71
72
72
#### Pull Request Status
73
73
74
+
Contained within the `<pr_details>` tag.
75
+
74
76
-`Merged`: boolean (true/false) - Whether the PR has been merged
75
77
-`Draft`: boolean (true/false) - Whether the PR is in draft state
76
78
-`State`: string ("open"/"closed") - Current state of the PR
@@ -79,6 +81,8 @@ Your custom reports can access the following PR information that you can referen
79
81
80
82
#### Basic Information
81
83
84
+
Contained within the `<pr_details>` tag.
85
+
82
86
-`Pull request number`: number - The PR's identifier
83
87
-`Title`: string - PR title
84
88
-`URL`: string - Link to the PR
@@ -88,40 +92,95 @@ Your custom reports can access the following PR information that you can referen
88
92
-`Closed at`: datetime (if applicable) - When the PR was closed
89
93
-`Source branch`: string - Source branch name
90
94
-`Target branch`: string - Target branch name
91
-
92
-
#### Additional Context
93
-
94
95
-`Labels`: array of strings - All labels applied to the PR
95
96
-`Reviewers`: array of strings - Assigned reviewers' usernames
96
-
-`Description`: markdown - Full PR description
97
-
-`Summary`: string - AI-generated summary of changes
98
-
-`Comments`: array of objects
99
-
-`username`: string - Comment author
100
-
-`body`: markdown - Comment content
97
+
98
+
#### Summarized PR Details
99
+
100
+
-`<pr_description>`: string - Contains the body of your pull request (aka the PR description at the top of the PR page).
101
+
-`<file_changes_summary>`: string - Contains a file by file summary of the changes made in the PR in markdown format. This summary is generated by CodeRabbit AI durring the PR review process. This includes several sections for each file that was changed:
102
+
-`filename`: string - The name of the file that was changed.
103
+
-`AI-generated summary of changes`: markdown - An overall summary of the changes made in the file.
104
+
-`Alterations to the declarations of exported or public entities`: markdown - A more specific breakdown of the changes made to the file such as exactly what was added, removed, or modified.
105
+
106
+
#### Comments
107
+
108
+
-`<pr_comments>`: array of comment objects - Contains all the comments made on the PR.
109
+
-`<comment>`: object - Each indidvidual comment is wrapped in this tag and is an object with the following properties:
110
+
-`<comment_author_username>`: string - The username of the comment author.
111
+
-`<comment_created_at>`: datetime - The date and time the comment was created.
112
+
-`<comment_updated_at>`: datetime - The date and time the comment was last updated.
113
+
-`<comment_body>`: markdown - The content of the comment.
101
114
102
115
Here's an example prompt that uses these data points:
103
116
104
117
```text
105
-
Generate a summary with the following format for each PR:
106
-
107
-
## [PR Title](URL)
108
-
**Status**: {Use these symbols based on state}
109
-
- 🔀 if Merged is true
110
-
- 📝 if Draft is true
111
-
- 💬 if State is "open"
112
-
- 🔒 if State is "closed" and not merged
113
-
Add ⚠️ if Is stale is true
114
-
115
-
**Author**: {Author name}
116
-
**Created**: {Created at}
117
-
**Labels**: {Labels joined by commas}
118
-
**Reviewers**: {Reviewers joined by commas}
119
-
120
-
### Summary
121
-
{Summary limited to 50 words}
122
-
123
-
### Recent Activity
124
-
{List last 3 comments with username and content}
118
+
Use the <overall_instructions> to guide the content of the summary. Use the format shown in <example> but do not include or refer the example's content in the final summary/report.
119
+
120
+
<overall_instructions>
121
+
Generate a summary of each pull request in the following bullet point format:
122
+
123
+
- PR Link: Provide a hyperlink to the pull request from the 'URL:' value
124
+
- Title: Provide the value of the 'Title:' field
125
+
- PR State: Provide the state of the PR based on the following conditions:
126
+
- If 'Merged: true' set 'PR State: 🔀 Merged'
127
+
- Else If 'Draft: true' set 'PR State: 📝 Draft'
128
+
- Else If 'State: open' or 'State: active' set 'PR State: 💬 Open'
129
+
- Else If 'State: closed' and 'Merged: false' set 'PR State: 🔒 Closed'
130
+
- Else set 'PR State: ❓ Unknown'
131
+
- If the PR is stale, add '⚠️ Stale' at the end of the PR State.
132
+
- Mergeable (if PR State if not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable'.
133
+
- Summary: In under 50 words provide a short summary of the PR.
134
+
- Comments: In under 50 words provide a short summary of all comments found within <pr_comments>, including each comments author username from <comment_author_username>. If there are no comments available, output 'No comments'.
description: Learn how to create issues directly through CodeRabbit
5
+
sidebar_position: 9
6
+
---
7
+
8
+
```mdx-code-block
9
+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
10
+
11
+
<ProPlanNotice />
12
+
```
13
+
14
+
CodeRabbit provides seamless issue creation capabilities across multiple platforms including GitHub, GitLab, Jira, and Linear. You can create issues directly from pull request discussions or through the agentic chat interface.
15
+
16
+
## Creating Issues Through Agentic Chat
17
+
18
+
Using CodeRabbit's chat functions, you can create issues naturally through conversations in comments or comment threads. Simply mention `@coderabbitai` and ask to create an issue.
When using CodeRabbit's [agentic chat](./agent_chat.md), CodeRabbit will help you format and create the issue with appropriate details based on your description and desired issue platform.
23
+
24
+
25
+
26
+
## Supported Platforms
27
+
28
+
### GitHub Issues
29
+
30
+
CodeRabbit can create GitHub issues directly in your repository. The integration works automatically without additional setup.
31
+
32
+
### GitLab Issues
33
+
34
+
Similar to GitHub, GitLab issue creation is supported out of the box.
35
+
36
+
### Jira
37
+
38
+
To create Jira issues, ensure you have [configured the Jira integration](../integrations/issue-integrations.md#jira) first.
39
+
40
+
### Linear
41
+
42
+
Make sure you have [set up the Linear integration](../integrations/issue-integrations.md#linear) to create Linear issues.
43
+
44
+
## Tips for Issue Creation
45
+
46
+
- Use natural language when creating issues through agentic chat
47
+
- Include code snippets when relevant
48
+
- Specify assignees if known
49
+
- Set appropriate priorities
50
+
- Add deadlines or milestones if applicable
51
+
52
+
For more detailed information about issue tracking integrations, see our [Issue Integrations](../integrations/issue-integrations.md) guide.
Copy file name to clipboardExpand all lines: docs/integrations/issue-integrations.md
+5-1
Original file line number
Diff line number
Diff line change
@@ -37,13 +37,15 @@ To link a Jira Issue, you can add the Jira Issue into the PR description as show
37
37
Closes CR-5
38
38
```
39
39
40
+
You can also create new Jira issues directly through CodeRabbit. See our [Issue Creation guide](../guides/issue-creation.md#jira) for details.
41
+
40
42
## Linear {#Linear}
41
43
42
44
```mdx-code-block
43
45
<ProPlanNotice />
44
46
```
45
47
46
-
With CodeRabbit, you can easily link your pull requests with Linear. It makes your life simpler by automatically creating Linear issues with all the code context, keeping your issues and pull requests in sync both ways. Plus, it lets you generate issues straight from pull requests, track how you’re hitting your goals, and even turn code review feedback into actionable tasks in Linear.
48
+
With CodeRabbit, you can easily link your pull requests with Linear. It makes your life simpler by automatically creating Linear issues with all the code context, keeping your issues and pull requests in sync both ways. Plus, it lets you generate issues straight from pull requests, track how you're hitting your goals, and even turn code review feedback into actionable tasks in Linear.
47
49
48
50
### CodeRabbit App
49
51
@@ -67,6 +69,8 @@ To link a Linear Issue, you can add the Linear Issue via the team key and issue
67
69
Closes ENG-123
68
70
```
69
71
72
+
You can also create new Linear issues directly through CodeRabbit. Learn more in our [Issue Creation guide](../guides/issue-creation.md#linear).
Copy file name to clipboardExpand all lines: static/schema/schema.v2.json
+16-1
Original file line number
Diff line number
Diff line change
@@ -112,6 +112,11 @@
112
112
"default": true,
113
113
"description": "Enable free tier features for users not on a paid plan."
114
114
},
115
+
"auto_resolve_threads": {
116
+
"type": "boolean",
117
+
"default": true,
118
+
"description": "Automatically resolve threads when code changes address the feedback. When disabled, metrics are still tracked but threads won't be marked as resolved."
119
+
},
115
120
"reviews": {
116
121
"type": "object",
117
122
"properties": {
@@ -211,6 +216,11 @@
211
216
"default": true,
212
217
"description": "Suggest reviewers based on the changes in the pull request in the walkthrough."
213
218
},
219
+
"auto_assign_reviewers": {
220
+
"type": "boolean",
221
+
"default": false,
222
+
"description": "Automatically assign suggested reviewers to the pull request"
223
+
},
214
224
"poem": {
215
225
"type": "boolean",
216
226
"default": true,
@@ -566,7 +576,7 @@
566
576
"enabled": {
567
577
"type": "boolean",
568
578
"default": true,
569
-
"description": "Enable golangci-lint | golangci-lint is a fast linters runner for Go. | Enable golangci-lint integration. | v1.62.2"
579
+
"description": "Enable golangci-lint | golangci-lint is a fast linters runner for Go. | Enable golangci-lint integration. | v1.64.8"
570
580
},
571
581
"config_file": {
572
582
"type": "string",
@@ -776,6 +786,11 @@
776
786
"default": true,
777
787
"description": "Enable the bot to reply automatically without requiring the user to tag it."
778
788
},
789
+
"create_issues": {
790
+
"type": "boolean",
791
+
"default": true,
792
+
"description": "Enable Issue creation by CodeRabbit from PR comments."
0 commit comments