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
Copy file name to clipboardExpand all lines: docs/changelog.md
+8Lines changed: 8 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,14 @@ description: The latest updates and changes to CodeRabbit.
5
5
sidebar_position: 13
6
6
---
7
7
8
+
### May 30, 2025
9
+
10
+
#### New Static Analysis Tool
11
+
12
+
We're excited to announce that [Pylint](https://github.com/PyCQA/pylint) is now supported on CodeRabbit!
13
+
14
+
-**Pylint**: A widely used static analysis and code quality tool for Python. It checks for errors, enforces a coding standard, and looks for code smells in your Python codebase by analyzing Python files.
Copy file name to clipboardExpand all lines: docs/faq.md
+84-3Lines changed: 84 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,42 @@ import TabItem from '@theme/TabItem';
10
10
11
11
## General Questions {#general-questions}
12
12
13
+
### How to trigger a CodeRabbit Review?
14
+
15
+
Once installed, CodeRabbit automatically triggers a review when a pull request is opened against the main branch of any repository. We automatically detect the name of the primary branch (whether this be master, main, dev, etc). This branch restriction can be customized in your settings.
16
+
17
+
You can also manually trigger a review at any time by commenting on a pull request with one of these commands (see [Commands](/guides/commands.md) for full list):
18
+
19
+
-`@coderabbitai review` - Triggers a standard review
20
+
-`@coderabbitai full review` - Triggers a comprehensive review
21
+
22
+
### How to run a review from my IDE?
23
+
24
+
You can trigger CodeRabbit reviews directly from your IDE using our editor plugins:
25
+
26
+
-[VSCode Extension](./guides/about-vscode.md) - For VSCode, Cursor or Windsurf users
27
+
28
+
These plugins allow you to request reviews without leaving your development environment. See the individual plugin documentation for installation and usage instructions.
29
+
30
+
### How to install CodeRabbit?
31
+
32
+
View step by step instructions depending on your platform:
33
+
34
+
<Tabs>
35
+
<TabItemvalue="github"label="GitHub"default>
36
+
See our [GitHub App installation guide](./platforms/github-com.md) for step-by-step instructions.
37
+
</TabItem>
38
+
<TabItemvalue="gitlab"label="GitLab">
39
+
Follow our [GitLab integration guide](/platforms/gitlab-com.mdx) to get started.
40
+
</TabItem>
41
+
<TabItemvalue="bitbucket"label="Bitbucket">
42
+
Check out the [Bitbucket installation steps](/platforms/bitbucket-cloud.md) for detailed setup.
43
+
</TabItem>
44
+
<TabItemvalue="azure"label="Azure DevOps">
45
+
View our [Azure DevOps setup guide](/platforms/azure-devops.md) for complete installation instructions.
46
+
</TabItem>
47
+
</Tabs>
48
+
13
49
### How accurate is CodeRabbit?
14
50
15
51
> CodeRabbit demonstrates high accuracy in code reviews based on early adoption results. While 100% accuracy isn't guaranteed due to AI's evolving nature, our technology continuously improves through:
@@ -27,6 +63,51 @@ CodeRabbit works with all programming languages, with varying proficiency based
27
63
- Available training data
28
64
- Community usage patterns
29
65
66
+
### Whats the difference between CodeRabbit Code Reviews and CodeRabbit Reports?
67
+
68
+
CodeRabbit offers two distinct features that serve different roles in your development workflow:
69
+
70
+
#### CodeRabbit Code Reviews
71
+
72
+
**Role**: Developer, QA, and Code Reviewer
73
+
**Access Level**: Full code access with comprehensive analysis capabilities
74
+
75
+
**Key Features:**
76
+
77
+
-**Complete Toolchain**: Runs all available analysis tools on your codebase
78
+
-**Static Analysis**: Can execute shell commands and perform deep static analysis against your codebase
79
+
-**Direct Code Access**: Has full access to code in issues and pull requests
80
+
-**Interactive Chat**: Provides chat features for real-time collaboration and questions
81
+
-**Comprehensive Review**: Analyzes code quality, security, performance, and best practices
82
+
-**Actionable Feedback**: Provides specific, line-by-line suggestions and improvements
83
+
-**Comment Interaction**: Engages with users through comments in pull requests and issues for clarifications and discussions
84
+
-**Available in All Tiers**: All features are available across Free, Lite, and Pro plans
85
+
86
+
#### CodeRabbit Reports
87
+
88
+
**Role**: Project Manager and Communication Hub
89
+
**Access Level**: Summary-only access without direct code interaction
90
+
91
+
**Key Features:**
92
+
93
+
-**Summary Generation**: Creates convenient, formatted summaries of all your recent pull requests
94
+
-**Customizable Prompts**: Allows you to select or create your own summarization templates
95
+
-**High-Level Overview**: Focuses on project progress and changes without code details
96
+
-**Comment Analysis**: Reads and summarizes existing comments and discussions
97
+
-**No Code Access**: Operates only on summaries and metadata, not the actual codebase
98
+
-**Communication Tool**: Designed for stakeholders who need updates without technical details
99
+
-**Multi-Channel Delivery**: Sends reports through various communication channels:
100
+
- Email notifications
101
+
- Slack integration
102
+
- Discord webhooks
103
+
- Microsoft Teams updates
104
+
-**Pro Plan Exclusive**: Reports feature is available only in the Pro plan tier
105
+
106
+
**In Summary:**
107
+
108
+
-**Code Reviews** = Technical analysis with full code access for developers
109
+
-**Reports** = High-level summaries with no code access for project management
110
+
30
111
### Data Security
31
112
32
113
<Tabs>
@@ -92,7 +173,7 @@ Email field and click Update to save your changes.
92
173
### Usage and Configuration
93
174
94
175
-**Language Settings**: Configure review language in repository settings
95
-
-**Review Rules**: Customize via [review instructions](/guides/review-instructions)
176
+
-**Review Rules**: Customize via [review instructions](/guides/review-instructions.md)
96
177
-**Branch Selection**: Default branch reviews enabled by default (configurable)
97
178
98
179
### Access & Permissions
@@ -108,7 +189,7 @@ Interact with CodeRabbit by:
108
189
1. Replying directly to CodeRabbit comments
109
190
2. Tagging `@coderabbitai` in PR discussions
110
191
3. Adding review comments for specific lines
111
-
4. Customize via [review instructions](/guides/review-instructions)
192
+
4. Customize via [review instructions](/guides/review-instructions.md)
112
193
113
194
:::tip Collaboration Mode
114
195
When team members are active in PRs, use `@coderabbitai` to engage the bot.
@@ -146,7 +227,7 @@ The following limits enforced _per developer_:
146
227
3. That's it. CodeRabbit will automatically start reviewing your PRs
147
228
148
229
:::tip Need Help?
149
-
Visit our [Support](/getting-started/support) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit).
230
+
Visit our [Support](/getting-started/support.md) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit).
Copy file name to clipboardExpand all lines: docs/guides/custom-reports.md
+4-2Lines changed: 4 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,8 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
11
11
12
12
CodeRabbit Pro allows you to create custom reports tailored to your specific needs using a flexible prompt-based system. This guide will help you understand how to create effective custom reports.
13
13
14
+
For a conceptual overview of reports in CodeRabbit, see [Generate reports](/guides/reports-overview).
15
+
14
16
## Understanding Custom Reports
15
17
16
18
Custom reports allow you to:
@@ -558,6 +560,6 @@ These are the available emojis and the type of change they represent. Do not usi
558
560
559
561
## Related Resources
560
562
561
-
-[Scheduled Reports](./scheduled-reports.md)
562
-
-[On-demand Reports](./ondemand-reports.md)
563
+
-[Schedule reports](/guides/scheduled-reports)
564
+
-[Generate reports on demand](/guides/ondemand-reports)
Copy file name to clipboardExpand all lines: docs/guides/ondemand-reports.md
+8-7Lines changed: 8 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Generate reports
2
+
title: Generate reports on demand
3
3
description: CodeRabbit offers a way to generate on-demand reports using a simple API request
4
4
---
5
5
@@ -12,13 +12,9 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
12
12
13
13
## Overview
14
14
15
-
CodeRabbit's reporting feature helps you track and analyze pull request activity across your repositories. There are two ways to generate reports:
15
+
This page is about using the CodeRabbit API to generate on-demand reports about your organization's usage of CodeRabbit. For a conceptual overview of reports in CodeRabbit, see [Generate reports](/guides/reports-overview).
16
16
17
-
1.**[Scheduled Reports](./scheduled-reports.md)** - Set up automated recurring reports that are delivered on a schedule to your preferred channels (email, Slack, MS Teams). This is the recommended way to keep your team informed about development progress.
18
-
19
-
2.**On-demand Reports** (this guide) - Generate reports programmatically through our API when you need them. This is useful for integration with your own tools and workflows.
20
-
21
-
If you're new to CodeRabbit's reporting features, we recommend starting with [Scheduled Reports](./scheduled-reports.md) to understand the available options and capabilities.
17
+
If you're new to CodeRabbit's reporting features, then we recommend starting with [Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities.
22
18
23
19
## API Access
24
20
@@ -73,3 +69,8 @@ The on-demand report generation endpoints take in inputs as per the schema shown
description: Learn about CodeRabbit's reporting capabilities, including scheduled and on-demand reports, and how to customize them
4
+
sidebar_label: Overview
5
+
---
6
+
7
+
```mdx-code-block
8
+
import ReportSchema from "@site/src/components/ReportSchema";
9
+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
10
+
11
+
<ProPlanNotice />
12
+
```
13
+
14
+
You can track and analyze pull request activity across your organization's repositories by using the CodeRabbit reporting feature.
15
+
16
+
## Scheduled and on-demand reports {#types}
17
+
18
+
There are two ways to generate reports:
19
+
20
+
-**[Scheduled Reports](/guides/scheduled-reports)**: Set up automated, recurring reports that are delivered to your team on a set schedule. Supported delivery channels include the following:
21
+
22
+
- Email
23
+
- Discord
24
+
- Slack
25
+
- Teams
26
+
27
+
-**[On-demand Reports](/guides/ondemand-reports)**: If you require customized integration of reports with your own tools and workflows, then you can generate reports programmatically through our API.
28
+
29
+
For your first reports, we recommend exploring scheduled reports. Its web-based UI can help you get familiar with the options available to you.
30
+
31
+
## Customize reports using natural language {#customize}
32
+
33
+
For both scheduled and on-demand reports, you define the shape and content of your reports by providing a prompt that instructs CodeRabbit about report that you want, using natural language. The scheduled reports interface includes several example prompts that you can choose from, or you can write your own prompt. For more information, see [Customize reports](/guides/custom-reports).
34
+
35
+
## What's next {#whats-next}
36
+
37
+
-[Schedule reports](/guides/scheduled-reports)
38
+
-[Generate reports on demand](/guides/ondemand-reports)
Copy file name to clipboardExpand all lines: docs/guides/scheduled-reports.md
+7Lines changed: 7 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,8 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
11
11
12
12
CodeRabbit Pro offers automated recurring reports that provide insights into your GitHub organization's activities. These reports can be customized and delivered through various channels to help teams stay informed about development progress.
13
13
14
+
For a conceptual overview of reports in CodeRabbit, see [Generate reports](/guides/reports-overview).
15
+
14
16
## Setting Up a Recurring Report
15
17
16
18
1. Navigate to **Recurring Reports** in the [CodeRabbit dashboard](https://app.coderabbit.ai/reports/recurring)
@@ -248,3 +250,8 @@ Deleting a report will immediately stop all scheduled runs and remove access to
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
9
+
10
+
<ProPlanNotice />
11
+
```
12
+
13
+
[Pylint](https://pylint.pycqa.org/) is a static code analysis tool for Python. It checks your Python code for errors, enforces a coding standard, and looks for code smells.
14
+
15
+
## Supported Files
16
+
17
+
Pylint will run on files with the following extensions:
18
+
19
+
-`*.py`
20
+
21
+
## Features
22
+
23
+
Pylint can detect many issues such as:
24
+
25
+
- Coding standard violations (PEP8)
26
+
- Unused variables and imports
27
+
- Undefined variables
28
+
- Code smells and refactoring suggestions
29
+
- Error-prone constructs
30
+
- And many more
31
+
32
+
## Links
33
+
34
+
-[Pylint Official Website](https://pylint.pycqa.org/)
0 commit comments