@@ -120,10 +121,12 @@ The webhook `https://coderabbit.ai/bitbucketHandler` will now be installed for t
:::note
-If you are experiencing issues with the webhook, such as CodeRabbit not being able to access the repository, or not reviewing pull requests, you can manually delete the webhook to the repository.
+If you are experiencing issues with the webhook, such as CodeRabbit not being able to access the repository, or not
+reviewing pull requests, you can manually delete the webhook to the repository.
Then refresh the repository page in the CodeRabbit app and you can reinstall the webhook.
-If you cannot install the webhook please check that your Bitbucket user has the necessary permissions to install the webhook and the App Password is properly configured.
+If you cannot install the webhook please check that your Bitbucket user has the necessary permissions to install the
+webhook and the API Token is properly configured.
:::
diff --git a/docs/platforms/github-com.md b/docs/platforms/github-com.md
index 4866fd00..60d919d7 100644
--- a/docs/platforms/github-com.md
+++ b/docs/platforms/github-com.md
@@ -53,7 +53,7 @@ If you opt to authorize all repositories during setup, CodeRabbit will automatic
### 5. CodeRabbit Configuration
-You can configure CodeRabbit through a YAML file or using the [App's UI](https://app.coderabbit.ai/login).
+You can configure CodeRabbit through a YAML file or using the [App's UI](https://app.coderabbit.ai/login?free-trial).
You can tailor CodeRabbit's functionality using the `.coderabbit.yaml` file, which you place directly in your GitHub repository. This file mirrors the options available in the CodeRabbit user interface, with each setting in the YAML corresponding to a specific toggle in the UI. Configure CodeRabbit either through the coderabbit.yaml file or the interface, depending on your preference.
@@ -109,7 +109,7 @@ CodeRabbit generates detailed statistics and test plans for each pull request.
-> CodeRabbit also allows you to configure **custom review instructions** based on your organization's needs, in case you want it to follow specific guidelines beyond the standard review, to learn more on [adding custom review instructions](https://docs.coderabbit.ai/guides/review-instructions/)
+> CodeRabbit also allows you to configure **custom review instructions** based on your organization's needs, in case you want it to follow specific guidelines beyond the standard review, to learn more on [adding custom review instructions](/guides/review-instructions)
Whether you manage a popular repository or are working on a smaller project, whether it's hosted on **GitLab, GitHub, or self-hosted GitHub or GitLab**, CodeRabbit can help streamline your development process. This AI Code Review assistant is designed to save you time by automating code reviews and offering insightful feedback.
diff --git a/docs/platforms/github-enterprise-server.md b/docs/platforms/github-enterprise-server.md
index 2e8a6876..733607cb 100644
--- a/docs/platforms/github-enterprise-server.md
+++ b/docs/platforms/github-enterprise-server.md
@@ -111,6 +111,7 @@ steps below to
- Pull request review thread
- Push
- Release
+ - **Where can this GitHub App be installed?**: Select `Any account`
6. Click **Create GitHub App**.
Once the GitHub App has been created, click on **Generate a new client secret**
@@ -169,4 +170,20 @@ Use this CodeRabbit IP if your instance requires IP whitelisting
`35.222.179.152/32` and `34.170.211.100/32`.
VPN tunneling is available as an add-on package. Please reach out to us at
-[contact@coderabbit.ai](mailto:contact@coderabbit.ai) if you are interested.
+[support@coderabbit.ai](mailto:support@coderabbit.ai) if you are interested.
+
+### **FAQ**
+
+#### Who should create the OAuth App and GitHub App?
+
+The OAuth App and GitHub App should be created by a user with administrative
+privileges on the GitHub Enterprise Server instance. This user will be responsible for managing the integration with CodeRabbit.
+
+#### I see an error when trying to log in to CodeRabbit. What should I do?
+
+If you encounter an error during the login process, please ensure that:
+
+- The OAuth App and GitHub App are correctly configured with the right URLs and permissions.
+- The browser local storage and cookies related to CodeRabbit are cleared.
+
+If the issue persists, contact our support team.
diff --git a/docs/platforms/platforms.md b/docs/platforms/platforms.md
index 996089fc..d4cb1748 100644
--- a/docs/platforms/platforms.md
+++ b/docs/platforms/platforms.md
@@ -32,4 +32,4 @@ CodeRabbit supports various Git platforms to provide code review for your reposi
| Bitbucket Datacenter | [Supported](../self-hosted/bitbucket.md) |
| Bitbucket Cloud | [Supported](./bitbucket-cloud.md) |
-[login]: https://app.coderabbit.ai/login
+[login]: https://app.coderabbit.ai/login?free-trial
diff --git a/docs/platforms/self-hosted-gitlab.md b/docs/platforms/self-hosted-gitlab.md
index 53fae56f..3fa18a71 100644
--- a/docs/platforms/self-hosted-gitlab.md
+++ b/docs/platforms/self-hosted-gitlab.md
@@ -122,4 +122,4 @@ Use this CodeRabbit IP if your instance requires IP whitelisting
`35.222.179.152/32` and `34.170.211.100/32`.
VPN tunneling is available as an add-on package. Please reach out to us at
-[contact@coderabbit.ai](mailto:contact@coderabbit.ai) if you are interested.
+[support@coderabbit.ai](mailto:support@coderabbit.ai) if you are interested.
diff --git a/docs/reference/caching.md b/docs/reference/caching.md
new file mode 100644
index 00000000..cea907c0
--- /dev/null
+++ b/docs/reference/caching.md
@@ -0,0 +1,20 @@
+# Caching
+
+CodeRabbit provides caching capabilities for code and dependencies to accelerate the review process. This feature enhances your development workflow by delivering faster feedback.
+
+## Security and Privacy
+
+- Cached data is encrypted (except for OSS projects)
+- Cache expires after a maximum of one week
+- Cached data is used exclusively for speeding up reviews
+
+## Configuration
+
+You can opt out of caching in two ways:
+
+1. **Disable Cache**: Configure `Review - Disable Cache` at either:
+
+ - Organization level
+ - Repository level
+
+2. **Disable Data Retention**: Turn off the `Data Retention` setting in your Organization Settings to disable all data retention across your organization.
diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
new file mode 100644
index 00000000..bd0b3e8e
--- /dev/null
+++ b/docs/reference/configuration.md
@@ -0,0 +1,4357 @@
+---
+title: Configuration reference
+description: Complete reference for all CodeRabbit configuration options.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+This reference guide lists all of the code review configuration options that
+CodeRabbit makes available.
+
+For an overview of how configuration works with CodeRabbit, see [Configure CodeRabbit](/guides/configuration-overview).
+
+## How to use this reference {#how-to}
+
+Each entry in this reference corresponds to a single CodeRabbit configuration setting, including an informational table and a description of what the setting does. The tables have two views, which you can select with a tab:
+
+- The **Web UI** tab displays the location and default value of the setting in the CodeRabbit web interface, for both [organization settings](/guides/organization-settings) and [repository settings](/guides/repository-settings).
+- The **coderabbit.yaml** tab displays information about the field's location and datatype in [your repository's `.coderabbit.yaml` file](/getting-started/configure-coderabbit).
+
+## Global Settings
+
+### Data retention
+
+
+
+
+
+
+ | Location |
+ General > Data Retention |
+
+
+ | Default |
+ true |
+
+
+
+
+ _This setting can be defined only in the web UI settings for your
+ organization._
+
+
+
+If `true`, then CodeRabbit is allowed to retain enough data about your code
+review history in order to enable the following features:
+
+- **Caching**: allows CodeRabbit to store data about your repository between
+ code reviews, improving the speed of subsequent reviews.
+- **Knowledge base**: allows CodeRabbit to maintain its own database about
+ your repository and your team's code review preferences, which can improve
+ the quality and specificity of code reviews generated by CodeRabbit.
+
+If your organization operates under strict data-retention policies, then you can
+disable data retention. Doing so immediately deletes any cache or knowledge-base data that CodeRabbit has collected for your organization, and prevents CodeRabbit from
+retaining further cache or knowledge-base data.
+
+If you re-enable data retention, then CodeRabbit re-enables these features, and resumes collecting cache and knowledge-base data.
+
+### Early Access
+
+
+
+
+
+
+ | Location |
+ General > Early Access |
+
+
+ | Default |
+ false |
+
+
+
+
+
+
+
+ | Field |
+ `early_access` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ false |
+
+
+
+
+
+If enabled, then CodeRabbit lets you use early-access features in your
+code reviews.
+
+### Enable Free Tier
+
+
+
+
+
+
+ | Location |
+ General > Enable Free Tier |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `enable_free_tier` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+If enabled, then CodeRabbit allows free tier features for users not on a paid plan.
+
+For more information about payment tiers and features, see [Pricing](https://www.coderabbit.ai/pricing).
+
+### Language
+
+
+
+
+
+
+ | Location |
+ General > Language |
+
+
+ | Default |
+ en-US |
+
+
+
+
+
+
+
+ | Field |
+ `language` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "en-US" |
+
+
+
+
+
+Defines the written language that CodeRabbit presents its review comments in. Defaults
+to U.S. English.
+
+### Tone Instructions
+
+
+
+
+
+
+ | Location |
+ General > Tone Instructions |
+
+
+ | Default |
+ |
+
+
+
+
+
+
+
+ | Field |
+ `tone_instructions` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ |
+
+
+
+
+
+A natural-language description of the tone of voice that CodeRabbit should
+apply to its review instructions, if you want a tone different from its
+default.
+
+A few possible examples:
+
+- `Use an encouraging, supportive tone that celebrates good practices while gently suggesting improvements.`
+- `Adopt a concise, matter-of-fact style that gets straight to the point without unnecessary pleasantries.`
+- `Deliver all review comments in the style of a televised nature documentary, perhaps with David Attenborough hosting.`
+
+## Review
+
+### Basic Review Settings
+
+#### Abort On Close
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Abort On Close |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.abort_on_close` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Abort the in-progress review if the pull request is closed or merged.
+
+#### Assess Linked Issues
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Assess Linked Issues |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.assess_linked_issues` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+If enabled, then the reviews that CodeRabbit generates include assessments of how well a proposed code change addresses any issues that the pull request refers to. CodeRabbit considers issues referred to by number in the following locations:
+
+- The title of the pull request.
+- The description of the pull request.
+- (GitHub only) The **Development** field of the pull request.
+
+Besides this setting, issue assessment requires at least one of the following:
+
+- You use the built-in issue managemet system of GitHub or GitLab.
+- You have integrated CodeRabbit with an external issue manager.
+
+For more information, see [Integrate issue tracking](/integrations/issue-integrations/)
+and [Let CodeRabbit read your issue trakcer](https://docs.coderabbit.ai/guides/setup-best-practices#issues).
+
+#### Auto Apply Labels
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Auto Apply Labels |
+
+
+ | Default |
+ false |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.auto_apply_labels` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ false |
+
+
+
+
+
+Automatically apply the suggested labels to the PR/MR.
+
+#### Auto Assign Reviewers
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Auto Assign Reviewers |
+
+
+ | Default |
+ false |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.auto_assign_reviewers` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ false |
+
+
+
+
+
+Automatically assign suggested reviewers to the pull request
+
+#### Auto Title Instructions
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Auto Title Instructions |
+
+
+ | Default |
+ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.auto_title_instructions` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ |
+
+
+
+
+
+Custom instructions for auto-generating the PR/MR title.
+
+#### Auto Title Placeholder
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Auto Title Placeholder |
+
+
+ | Default |
+ @coderabbitai |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.auto_title_placeholder` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "@coderabbitai" |
+
+
+
+
+
+Add this keyword in the PR/MR title to auto-generate the title.
+
+#### Changed Files Summary
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Changed Files Summary |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.changed_files_summary` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Generate a summary of the changed files in the walkthrough.
+
+#### Collapse Walkthrough
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Collapse Walkthrough |
+
+
+ | Default |
+ false |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.collapse_walkthrough` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ false |
+
+
+
+
+
+Generate walkthrough in a markdown collapsible section.
+
+#### Commit Status
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Commit Status |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.commit_status` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Set the commit status to 'pending' when the review is in progress and 'success' when it is complete.
+
+#### Disable Cache
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Disable Cache |
+
+
+ | Default |
+ false |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.disable_cache` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ false |
+
+
+
+
+
+Activate this setting to disallow CodeRabbit from caching your repository's code and dependencies. This forces CodeRabbit to download the code and dependencies fresh from the repository for every code review that it performs.
+
+When caching is allowed, then CodeRabbit stores a cache of code and metadata from
+your repostory for up to seven days after its most recent code review. This cache
+lets CodeRabbit save time and effort in between subsquent reviews of the same
+repository. For more information, see [Caching](/reference/caching/).
+
+We recommend leaving this setting off, which allows caching, and can speed up
+code reviews. For more information, see
+[Trust the defaults](https://docs.coderabbit.ai/guides/setup-best-practices#defaults).
+
+:::note
+The [Data Retention](#data-retention) setting overrides this one. If you disable
+all data retention, then your repositories won't keep a cache.
+:::
+
+#### Fail Commit Status
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Fail Commit Status |
+
+
+ | Default |
+ false |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.fail_commit_status` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ false |
+
+
+
+
+
+Set the commit status to 'failure' when the PR cannot be reviewed by CodeRabbit for any reason.
+
+#### High Level Summary
+
+
+
+
+
+
+ | Location |
+ Review > Settings > High Level Summary |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.high_level_summary` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Generate a high level summary of the changes in the PR/MR description.
+
+#### High Level Summary In Walkthrough
+
+
+
+
+
+
+ | Location |
+ Review > Settings > High Level Summary In Walkthrough |
+
+
+ | Default |
+ false |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.high_level_summary_in_walkthrough` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ false |
+
+
+
+
+
+Include the high level summary in the walkthrough comment.
+
+#### High Level Summary Placeholder
+
+
+
+
+
+
+ | Location |
+ Review > Settings > High Level Summary Placeholder |
+
+
+ | Default |
+ @coderabbitai summary |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.high_level_summary_placeholder` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "@coderabbitai summary" |
+
+
+
+
+
+Placeholder in the PR/MR description that gets replaced with the high level summary.
+
+#### Labeling Instructions
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Labeling Instructions |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.labeling_instructions` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+Provide guidelines for suggesting labels for the PR/MR. When specific labels or instructions are provided, only those labels are considered, though previous examples are still used to inform the suggestions. If no such labels are provided, suggestions are based solely on previous PR/MRs.
+
+#### Path Filters
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Path Filters |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.path_filters` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+Path filters, if defined, restrict the portions of your repository that CodeRabbit
+uses for context when preparing code reviews.
+
+You can define a list of path specifications, relative to the root of your
+repository, to use as path filters.
+
+Paths can be _exclude paths_, which start with a leading `!` character, or _include
+paths_. If the list of paths contains at least one include path, then CodeRabbit
+includes _only_ files that match the provided paths.
+
+For example, the following list of path filters instructs CodeRabbit to limit its reviews
+only to files found in the `src` top-level directory, but exclude any `.bin` or `.csv`
+files:
+
+```bash
+src/**
+!**/*.{bin,csv}
+```
+
+:::note
+Under the hood, CodeRabbit uses your provided list of path filters as an argument
+to [`git sparse-checkout`](https://git-scm.com/docs/git-sparse-checkout) when preparing its own copy of your repository for code review
+context.
+:::
+
+We strongly recommend defining path filters for any repositories that contain
+a significant amount of generated files or data that has no contextual bearing on code reviews.
+CodeRabbit can work faster if it can ignore files that aren't relevant to pull requests.
+For more information, see [Speed up reviews by adding path filters](https://docs.coderabbit.ai/guides/setup-best-practices#filters).
+
+#### Path Instructions
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Path Instructions |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.path_instructions` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+Path instructions are additional sets of instructions, expressed in natural lanaguge,
+that you provide to CodeRabbit for reveiwing certain files in your repository.
+
+You associate each set of instuctions with a file path relative to the root
+of your repository. Your path specification can use extended glob patterns.
+
+The following example defines a set of path instructions for all TypeScript
+and JavaScript files in a reposistory's `src` directory:
+
+
+
+ 
+
+
+```yaml
+path_instructions:
+ - path: src/**/*.{ts,tsx,js}
+ instructions:
+ - Review the React.js/TypeScript/JavaScript code for best practices
+ - Check for common security vulnerabilities such as:
+ - SQL Injection
+ - Insecure dependencies
+ - Sensitive data exposure
+```
+
+
+
+For further examples of path instructions specific to various programming langauges,
+see [the `awesome-coderabbit` public repository](https://github.com/coderabbitai/awesome-coderabbit/tree/main/configs).
+
+#### Poem
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Poem |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.poem` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Generate a poem in the walkthrough comment.
+
+#### Profile {#profile}
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Profile |
+
+
+ | Default |
+ chill |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.profile` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "chill" |
+
+
+
+
+
+An overall selector for the level of detail that CodeRabbit should apply to
+its reviews. Valid values are the following:
+
+- **`Chill`**: CodeRabbit provides its usual level of commentary.
+- **`Assertive`**: CodeRabbit provides significantly deeper or more verbose commentary,
+ as much as possible.
+
+The `Chill` profile is the default setting, and is appropriate for most coding
+contexts. The `Assertive` profile mode can get quite nitpicky in some circumstances. We recommend leaving this setting in `Chill`, unless a wordier level of code critique would benefit your team's work.
+
+#### Related Issues
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Related Issues |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.related_issues` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Include possibly related issues in the walkthrough.
+
+#### Related PRs
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Related PRs |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.related_prs` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Include possibly related pull requests in the walkthrough.
+
+#### Request Changes Workflow
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Request Changes Workflow |
+
+
+ | Default |
+ false |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.request_changes_workflow` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ false |
+
+
+
+
+
+If enabled, then CodeRabbit marks a pull request as approved once all comments
+that CodeRabbit made have been resolved.
+
+Enable this setting if you want to have CodeRabbit's approval count towards
+a minimum number of approvals that your have configured your Git platform
+to require before a pull request can be merged.
+
+#### Review Status
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Review Status |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.review_status` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Post review details on each review. Additionally, post a review status when a review is skipped in certain cases.
+
+#### Sequence Diagrams
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Sequence Diagrams |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.sequence_diagrams` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Generate sequence diagrams in the walkthrough.
+
+#### Suggested Labels
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Suggested Labels |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.suggested_labels` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Suggest labels based on the changes in the pull request in the walkthrough.
+
+#### Suggested Reviewers
+
+
+
+
+
+
+ | Location |
+ Review > Settings > Suggested Reviewers |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.suggested_reviewers` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Suggest reviewers based on the changes in the pull request in the walkthrough.
+
+### Automatic Review
+
+#### Enable Automatic Review
+
+
+
+
+
+
+ | Location |
+ Review > Auto Review > Automatic Review |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.auto_review.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+If enabled, then CodeRabbit reviews new and updated pull requests automatically. For more information, see [Automatically review pull requests](https://docs.coderabbit.ai/guides/code-review-overview#review).
+
+If disabled, then CodeRabbit performs only reviews that you request manually. For more information on manual review commands, see [Manually request code reviews](/guides/code-review-overview#review).
+
+Disabling this setting also effectively disables all of the other settings listed in this section.
+
+#### Automatic Incremental Review
+
+
+
+
+
+
+ | Location |
+ Review > Auto Review > Automatic Incremental Review |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.auto_review.auto_incremental_review` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+If enabled, then CodeRabbit performs automatic reviews of existing pull requests when their associated branches have commits pushed to them. These incremental reviews happen in addition to the initial code review that CodeRabbit generates after the pull request is first created.
+
+For more information on manual review commands, see [Manually request code reviews](/guides/code-review-overview#review).
+
+We recommend leaving this option enabled.
+
+#### Base Branches {#base-branches}
+
+
+
+
+
+
+ | Location |
+ Review > Auto Review > Base Branches |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.auto_review.base_branches` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+A list of branches that CodeRabbit performs automatic code reviews on, other
+than the reposiorty's main branch (usually `main` or `master`.)
+
+For example, if you add `staging` as a base branch, then CodeRabbit automatically
+reviews pull requests on both your repository's default branch and its `staging` branch.
+
+#### Drafts
+
+
+
+
+
+
+ | Location |
+ Review > Auto Review > Drafts |
+
+
+ | Default |
+ false |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.auto_review.drafts` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ false |
+
+
+
+
+
+If defined, then CodeRabbit automatically reviews pull requests marked as a draft
+in your Git platform.
+
+#### Ignore Title Keywords
+
+
+
+
+
+
+ | Location |
+ Review > Auto Review > Ignore Title Keywords |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.auto_review.ignore_title_keywords` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+Ignore reviewing if the title of the pull request contains any of these keywords (case-insensitive).
+
+#### Labels
+
+
+
+
+
+
+ | Location |
+ Review > Auto Review > Labels |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.auto_review.labels` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+If defined with at least one label, then CodeRabbit automatically reviews
+only pull requests that have at least one of the labels in this list.
+
+In this case, you can manually request reviews of pull requests lacking a qualifying label. For more information on manual review commands, see [Manually request code reviews](/guides/code-review-overview#review).
+
+### Finishing Touches
+
+#### Docstrings
+
+
+
+
+
+
+ | Location |
+ Review > Finishing Touches > Docstrings |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.finishing_touches.docstrings.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+If enabled, then CodeRabbit can generate inline documentation for functions
+added in a pull request. For more information, see [Docstrings](/finishing-touches/docstrings).
+
+#### Unit Tests
+
+
+
+
+
+
+ | Location |
+ Review > Finishing Touches > Unit Tests |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.finishing_touches.unit_tests.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+If enabled, then CodeRabbit can generate unit tests for code
+added in a pull request. For more information, see [Unit Test Generation](/finishing-touches/unit-test-generation).
+
+## Chat
+
+### Auto Reply
+
+
+
+
+
+
+ | Location |
+ Chat > Auto Reply |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `chat.auto_reply` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Enable the bot to reply automatically without requiring the user to tag it.
+
+### Integrations
+
+### Jira
+
+
+
+
+
+
+ | Location |
+ Chat > Jira |
+
+
+ | Default |
+ auto |
+
+
+
+
+
+
+
+ | Field |
+ `chat.integrations.jira.usage` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "auto" |
+
+
+
+
+
+Enable the Jira integration for opening issues, etc. 'auto' disables the integration for public repositories.
+
+### Linear
+
+
+
+
+
+
+ | Location |
+ Chat > Linear |
+
+
+ | Default |
+ auto |
+
+
+
+
+
+
+
+ | Field |
+ `chat.integrations.linear.usage` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "auto" |
+
+
+
+
+
+Enable the Linear integration for opening issues, etc. 'auto' disables the integration for public repositories.
+
+## Knowledge Base
+
+### Basic settings
+
+#### Opt Out
+
+
+
+
+
+
+ | Location |
+ Knowledge Base > Opt Out |
+
+
+ | Default |
+ false |
+
+
+
+
+
+
+
+ | Field |
+ `knowledge_base.opt_out` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ false |
+
+
+
+
+
+Disable all knowledge base features that require data retention. If you opt out after opting in, all of your existing knowledge base data will be removed from the system.
+
+#### Pull Requests
+
+
+
+
+
+
+ | Location |
+ Knowledge Base > Pull Requests |
+
+
+ | Default |
+ auto |
+
+
+
+
+
+
+
+ | Field |
+ `knowledge_base.pull_requests.scope` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "auto" |
+
+
+
+
+
+Specify the scope of pull requests to use for the knowledge base. 'local' uses the repository's pull requests, 'global' uses the organization's pull requests, and 'auto' uses repository's pull requests for public repositories and organization's pull requests for private repositories.
+
+#### Web Search
+
+
+
+
+
+
+ | Location |
+ Knowledge Base > Web Search |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `knowledge_base.web_search.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Enable the web search integration.
+
+### Issues
+
+
+
+
+
+
+ | Location |
+ Knowledge Base > Issues |
+
+
+ | Default |
+ auto |
+
+
+
+
+
+
+
+ | Field |
+ `knowledge_base.issues.scope` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "auto" |
+
+
+
+
+
+Specify the scope of git platform (GitHub/GitLab) issues to use for the knowledge base. 'local' uses the repository's issues, 'global' uses the organization's issues, and 'auto' uses repository's issues for public repositories and organization's issues for private repositories.
+
+### Jira
+
+#### Enable Jira
+
+
+
+
+
+
+ | Location |
+ Knowledge Base > Jira |
+
+
+ | Default |
+ auto |
+
+
+
+
+
+
+
+ | Field |
+ `knowledge_base.jira.usage` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "auto" |
+
+
+
+
+
+Enable the Jira knowledge base integration. 'auto' disables the integration for public repositories.
+
+#### Project Keys
+
+
+
+
+
+
+ | Location |
+ Knowledge Base > Project Keys |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `knowledge_base.jira.project_keys` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+Specify the Jira project keys to use for the knowledge base.
+
+### Learnings
+
+
+
+
+
+
+ | Location |
+ Knowledge Base > Learnings |
+
+
+ | Default |
+ auto |
+
+
+
+
+
+
+
+ | Field |
+ `knowledge_base.learnings.scope` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "auto" |
+
+
+
+
+
+Specify the scope of learnings to use for the knowledge base. 'local' uses the repository's learnings, 'global' uses the organization's learnings, and 'auto' uses repository's learnings for public repositories and organization's learnings for private repositories.
+
+### Linear
+
+#### Enable Linear
+
+
+
+
+
+
+ | Location |
+ Knowledge Base > Linear |
+
+
+ | Default |
+ auto |
+
+
+
+
+
+
+
+ | Field |
+ `knowledge_base.linear.usage` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "auto" |
+
+
+
+
+
+Enable the Linear knowledge base integration. 'auto' disables the integration for public repositories.
+
+#### Team Keys
+
+
+
+
+
+
+ | Location |
+ Knowledge Base > Team Keys |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `knowledge_base.linear.team_keys` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+Specify the Linear team keys (identifiers) to use for the knowledge base. E.g. 'ENG'
+
+## Code Generation
+
+### Code Generation Language
+
+
+
+
+
+
+ | Location |
+ Code Generation > Language |
+
+
+ | Default |
+ en-US |
+
+
+
+
+
+
+
+ | Field |
+ `code_generation.docstrings.language` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "en-US" |
+
+
+
+
+
+Set the language for docstrings by using the corresponding ISO language code.
+
+### Docstring Path Instructions
+
+
+
+
+
+
+ | Location |
+ Code Generation > Path Instructions |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `code_generation.docstrings.path_instructions` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+Provide additional guidelines for docstring generation based on file paths.
+
+### Unit Test Path Instructions
+
+
+
+
+
+
+ | Location |
+ Code Generation > Unit Test Generation |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `code_generation.unit_tests.path_instructions` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+Provide additional guidelines for unit test generation based on file paths.
+
+## Tools
+
+CodeRabbit integrates with various third-party tools for enhanced code analysis.
+
+### actionlint
+
+actionlint is a static checker for GitHub Actions workflow files.
+
+#### Enable actionlint
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable actionlint |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.actionlint.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+is a static checker for GitHub Actions workflow files.
+
+### ast-grep
+
+Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.38.1
+
+#### Essential Rules
+
+
+
+
+
+
+ | Location |
+ Review > Tools > ast-grep > Essential Rules |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.ast-grep.essential_rules` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Use ast-grep essentials package.
+
+#### Packages
+
+
+
+
+
+
+ | Location |
+ Review > Tools > ast-grep > Packages |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.ast-grep.packages` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+Predefined packages to be used.
+
+#### Rule Dirs
+
+
+
+
+
+
+ | Location |
+ Review > Tools > ast-grep > Rule Dirs |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.ast-grep.rule_dirs` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+List of rules directories.
+
+#### Util Dirs
+
+
+
+
+
+
+ | Location |
+ Review > Tools > ast-grep > Util Dirs |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.ast-grep.util_dirs` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+List of utils directories.
+
+### Biome
+
+Biome is a fast formatter, linter, and analyzer for web projects.
+
+#### Enable Biome
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Biome |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.biome.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Biome is a fast formatter, linter, and analyzer for web projects.
+
+### Brakeman
+
+Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. | v7.0.2
+
+#### Enable Brakeman
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Brakeman |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.brakeman.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications.
+
+### Buf
+
+Buf offers linting for Protobuf files.
+
+#### Enable Buf
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Buf |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.buf.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Buf offers linting for Protobuf files.
+
+### checkmake
+
+checkmake is a linter for Makefiles.
+
+#### Enable checkmake
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable checkmake |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.checkmake.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+checkmake is a linter for Makefiles.
+
+### Checkov
+
+Checkov is a static code analysis tool for infrastructure-as-code files.
+
+#### Enable Checkov
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Checkov |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.checkov.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Checkov is a static code analysis tool for infrastructure-as-code files.
+
+### CircleCI
+
+CircleCI tool is a static checker for CircleCI config files.
+
+#### Enable CircleCI
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable CircleCI |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.circleci.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+CircleCI tool is a static checker for CircleCI config files.
+
+### Clippy
+
+Clippy is a collection of lints to catch common mistakes and improve your Rust code.
+
+#### Enable Clippy
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Clippy |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.clippy.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Clippy is a collection of lints to catch common mistakes and improve your Rust code.
+
+### Cppcheck
+
+Cppcheck is a static code analysis tool for the C and C++ programming languages.
+
+#### Enable Cppcheck
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Cppcheck |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.cppcheck.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Cppcheck is a static code analysis tool for the C and C++ programming languages.
+
+### detekt
+
+Detekt is a static code analysis tool for Kotlin files.
+
+#### Enable detekt
+
+
+
+
+
+
+ | Location |
+ Review > Tools > detekt > Enable |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.detekt.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Enable detekt.
+
+#### Config File
+
+
+
+
+
+
+ | Location |
+ Review > Tools > detekt > Config File |
+
+
+ | Default |
+ _No default_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.detekt.config_file` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ _No default_ |
+
+
+
+
+
+Optional path to the detekt configuration file relative to the repository.
+
+### dotenv-linter
+
+dotenv-linter is a tool for checking and fixing .env files for problems and best practices
+
+#### Enable dotenv-linter
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable dotenv-linter |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.dotenvLint.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+dotenv-linter is a tool for checking and fixing .env files for problems and best practices
+
+### ESLint
+
+ESLint is a static code analysis tool for JavaScript files.
+
+#### Enable ESLint
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable ESLint |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.eslint.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+ESLint is a static code analysis tool for JavaScript files.
+
+### Flake8
+
+Flake8 is a static code analysis tool for Python files.
+
+#### Enable Flake8
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Flake8 > Enable |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.flake8.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Flake8 is a static code analysis tool for Python files.
+
+### GitHub Checks
+
+GitHub Checks integration configuration.
+
+#### Enable GitHub Checks
+
+
+
+
+
+
+ | Location |
+ Review > Tools > GitHub Checks > Enable |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.github-checks.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Enable integration, defaults to true
+
+#### Timeout Ms
+
+
+
+
+
+
+ | Location |
+ Review > Tools > GitHub Checks > Timeout Ms |
+
+
+ | Default |
+ 90000 |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.github-checks.timeout_ms` |
+
+
+ | Datatype |
+ number |
+
+
+ | Default |
+ 90000 |
+
+
+
+
+
+Time in milliseconds to wait for all GitHub Checks to conclude.
+
+### Gitleaks
+
+Gitleaks is a secret scanner.
+
+#### Enable Gitleaks
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Gitleaks |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.gitleaks.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Gitleaks is a secret scanner.
+
+### golangci-lint
+
+golangci-lint is a fast linters runner for Go.
+
+#### Enable golangci-lint
+
+
+
+
+
+
+ | Location |
+ Review > Tools > golangci-lint > Enable |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.golangci-lint.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Enable golangci-lint.
+
+#### Config File
+
+
+
+
+
+
+ | Location |
+ Review > Tools > golangci-lint > Config File |
+
+
+ | Default |
+ _No default_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.golangci-lint.config_file` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ _No default_ |
+
+
+
+
+
+Optional path to the golangci-lint configuration file relative to the repository. Useful when the configuration file is named differently than the default '.golangci.yml', '.golangci.yaml', '.golangci.toml', '.golangci.json'.
+
+### Hadolint
+
+Hadolint is a Dockerfile linter.
+
+#### Enable Hadolint
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Hadolint |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.hadolint.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Hadolint is a Dockerfile linter.
+
+### HTMLHint
+
+HTMLHint is a static code analysis tool for HTML files.
+
+#### Enable HTMLHint
+
+
+
+
+
+
+ | Location |
+ Review > Tools > HTMLHint > Enable |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.htmlhint.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Enable HTMLHint.
+
+#### Config File
+
+
+
+
+
+
+ | Location |
+ Review > Tools > HTMLHint > Config File |
+
+
+ | Default |
+ _No default_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.htmlhint.config_file` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ _No default_ |
+
+
+
+
+
+Optional path to the HTMLHint configuration file relative to the repository. This is useful when the configuration file is named differently than the default '.htmlhintrc'.
+
+### LanguageTool
+
+LanguageTool is a style and grammar checker for 30+ languages.
+
+#### Disabled Categories
+
+
+
+
+
+
+ | Location |
+ Review > Tools > LanguageTool > Disabled Categories |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.languagetool.disabled_categories` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+IDs of categories to be disabled. Note: TYPOS, TYPOGRAPHY, and CASING are always disabled.
+
+#### Disabled Rules
+
+
+
+
+
+
+ | Location |
+ Review > Tools > LanguageTool > Disabled Rules |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.languagetool.disabled_rules` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+IDs of rules to be disabled. Note: EN_UNPAIRED_BRACKETS, and EN_UNPAIRED_QUOTES are always disabled.
+
+#### Enable LanguageTool
+
+
+
+
+
+
+ | Location |
+ Review > Tools > LanguageTool > Enable |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.languagetool.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Enable LanguageTool
+
+#### Enabled Categories
+
+
+
+
+
+
+ | Location |
+ Review > Tools > LanguageTool > Enabled Categories |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.languagetool.enabled_categories` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+IDs of categories to be enabled.
+
+#### Enabled Only
+
+
+
+
+
+
+ | Location |
+ Review > Tools > LanguageTool > Enabled Only |
+
+
+ | Default |
+ false |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.languagetool.enabled_only` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ false |
+
+
+
+
+
+Only the rules and categories whose IDs are specified with 'enabledRules' or 'enabledCategories' are enabled.
+
+#### Enabled Rules
+
+
+
+
+
+
+ | Location |
+ Review > Tools > LanguageTool > Enabled Rules |
+
+
+ | Default |
+ _Empty array_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.languagetool.enabled_rules` |
+
+
+ | Datatype |
+ array |
+
+
+ | Default |
+ [] |
+
+
+
+
+
+IDs of rules to be enabled. The rule won't run unless 'level' is set to a level that activates the rule.
+
+#### Level
+
+
+
+
+
+
+ | Location |
+ Review > Tools > LanguageTool > Level |
+
+
+ | Default |
+ default |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.languagetool.level` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "default" |
+
+
+
+
+
+If set to 'picky', additional rules will be activated, i.e. rules that you might only find useful when checking formal text.
+
+### Luacheck
+
+Configuration for Lua code linting to ensure code quality
+
+#### Enable Luacheck
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Luacheck |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.luacheck.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Luacheck helps maintain consistent and error-free Lua code
+
+### markdownlint
+
+markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files.
+
+#### Enable markdownlint
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable markdownlint |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.markdownlint.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files.
+
+### OXC
+
+OXC is a JavaScript/TypeScript linter written in Rust.
+
+#### Enable OXC
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable OXC |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.oxc.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+OXC is a JavaScript/TypeScript linter written in Rust.
+
+### PHPStan
+
+PHPStan is a tool to analyze PHP code.
+
+#### Enable PHPStan
+
+
+
+
+
+
+ | Location |
+ Review > Tools > PHPStan > Enable |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.phpstan.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+PHPStan requires [config file](https://phpstan.org/config-reference#config-file) in your repository root. Please ensure that this file contains the `paths:` parameter.
+
+#### Level
+
+
+
+
+
+
+ | Location |
+ Review > Tools > PHPStan > Level |
+
+
+ | Default |
+ default |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.phpstan.level` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ "default" |
+
+
+
+
+
+Specify the [rule level](https://phpstan.org/user-guide/rule-levels) to run. This setting is ignored if your configuration file already has a `level:` parameter.
+
+### PMD
+
+PMD is an extensible multilanguage static code analyzer. Itโs mainly concerned with Java.
+
+#### Enable PMD
+
+
+
+
+
+
+ | Location |
+ Review > Tools > PMD > Enable |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.pmd.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Enable PMD.
+
+#### Config File
+
+
+
+
+
+
+ | Location |
+ Review > Tools > PMD > Config File |
+
+
+ | Default |
+ _No default_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.pmd.config_file` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ _No default_ |
+
+
+
+
+
+Optional path to the PMD configuration file relative to the repository.
+
+### PHPMD
+
+PHPMD is a static code analysis tool for PHP files.
+
+#### Enable PHPMD
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable PHPMD |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.phpmd.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+PHPMD is a static code analysis tool for PHP files.
+
+### PHPCS
+
+PHPCS is a static code analysis and coding-standard checker for PHP (plus JS/CSS) files.
+
+#### Enable PHPCS
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable PHPCS |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.phpcs.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+PHPCS is a static code analysis tool for PHP, JavaScript and CSS files.
+
+### Prisma Schema Linting
+
+Configuration for Prisma Schema linting to ensure schema file quality
+
+#### Enable Prisma Schema Linting
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Prisma Schema Linting |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.prismaLint.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Prisma Schema linting helps maintain consistent and error-free schema files
+
+### Pylint
+
+Pylint is a Python static code analysis tool.
+
+#### Enable Pylint
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Pylint |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.pylint.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Pylint is a Python static code analysis tool.
+
+### Regal
+
+Regal is a linter and language server for Rego.
+
+#### Enable Regal
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Regal |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.regal.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Regal is a linter and language server for Rego.
+
+### RuboCop
+
+RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter.
+
+#### Enable RuboCop
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable RuboCop |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.rubocop.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter.
+
+### Ruff
+
+Ruff is a Python linter and code formatter.
+
+#### Enable Ruff
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Ruff |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.ruff.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Ruff is a Python linter and code formatter.
+
+### Semgrep
+
+Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues.
+
+#### Enable Semgrep
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Semgrep > Enable |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.semgrep.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Enable Semgrep.
+
+#### Config File
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Semgrep > Config File |
+
+
+ | Default |
+ _No default_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.semgrep.config_file` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ _No default_ |
+
+
+
+
+
+Optional path to the Semgrep configuration file relative to the repository.
+
+### ShellCheck
+
+ShellCheck is a static analysis tool that finds bugs in your shell scripts.
+
+#### Enable ShellCheck
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable ShellCheck |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.shellcheck.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+ShellCheck is a static analysis tool that finds bugs in your shell.
+
+### Shopify Theme Check
+
+Configuration for Shopify Theme Check to ensure theme quality and best practices
+
+#### Enable Shopify Theme Check
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable Shopify Theme Check |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.shopifyThemeCheck.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices
+
+### SQLFluff
+
+SQLFluff is an open source, dialect-flexible and configurable SQL linter.
+
+#### Enable SQLFluff
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable SQLFluff |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.sqlfluff.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+SQLFluff is an open source, dialect-flexible and configurable SQL linter.
+
+### SwiftLint
+
+SwiftLint integration configuration object.
+
+#### Enable SwiftLint
+
+
+
+
+
+
+ | Location |
+ Review > Tools > SwiftLint > Enable |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.swiftlint.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+Enable SwiftLint.
+
+#### Config File
+
+
+
+
+
+
+ | Location |
+ Review > Tools > SwiftLint > Config File |
+
+
+ | Default |
+ _No default_ |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.swiftlint.config_file` |
+
+
+ | Datatype |
+ string |
+
+
+ | Default |
+ _No default_ |
+
+
+
+
+
+Optional path to the SwiftLint configuration file relative to the repository. This is useful when the configuration file is named differently than the default '.swiftlint.yml' or '.swiftlint.yaml'.
+
+### YAMLlint
+
+YAMLlint is a linter for YAML files.
+
+#### Enable YAMLlint
+
+
+
+
+
+
+ | Location |
+ Review > Tools > Enable YAMLlint |
+
+
+ | Default |
+ true |
+
+
+
+
+
+
+
+ | Field |
+ `reviews.tools.yamllint.enabled` |
+
+
+ | Datatype |
+ boolean |
+
+
+ | Default |
+ true |
+
+
+
+
+
+YAMLlint is a linter for YAML files.
diff --git a/docs/reference/review-commands.md b/docs/reference/review-commands.md
new file mode 100644
index 00000000..cb50b59c
--- /dev/null
+++ b/docs/reference/review-commands.md
@@ -0,0 +1,48 @@
+---
+title: Code review commands
+description: A list of commands that you can issue to CodeRabbit during code reviews.
+---
+
+This page lists the various commands that you can issue to CodeRabbit through
+its chat interface during code reviews. For more information about working with
+CodeRabbit through chat, see [Interact with CodeRabbit reviews](/guides/code-review-overview#interact).
+
+| Command | Description | Use Case |
+| --------------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `@coderabbitai review` | Triggers an incremental review of new changes | When automatic reviews are disabled or you want to manually trigger a review |
+| `@coderabbitai full review` | Performs a complete review of all files from scratch | When you want to get fresh insights on the entire PR |
+| `@coderabbitai summary` | Regenerates the PR summary | When you want an updated overview after making changes |
+
+## Code review flow control
+
+| Command | Description | Use Case |
+| ---------------------- | ---------------------------------------- | --------------------------------------------------- |
+| `@coderabbitai pause` | Temporarily stops reviews on the PR | When you're making multiple rapid changes |
+| `@coderabbitai resume` | Restarts reviews after a pause | When you're ready for CodeRabbit to review again |
+| `@coderabbitai ignore` | Permanently disables reviews for this PR | When you want to handle the review process manually |
+
+## Comment management
+
+| Command | Description | Use Case |
+| ----------------------- | --------------------------------------- | ------------------------------------------------------- |
+| `@coderabbitai resolve` | Resolves all CodeRabbit review comments | When you've addressed all feedback and want to clean up |
+
+## Documentation commands
+
+| Command | Description | Use Case |
+| ---------------------------------------- | -------------------------------------------- | --------------------------------------------------- |
+| `@coderabbitai generate docstrings` | Generates docstrings for functions in the PR | When you need automatic documentation for your code |
+| `@coderabbitai auto-generate unit tests` | Generates unit tests for the PR | When you need automatic unit testing for your code |
+| `@coderabbitai configuration` | Shows current CodeRabbit settings | When you need to check or export your configuration |
+
+## Agentic chat commands
+
+| Command | Description | Use Case |
+| -------------------- | ---------------------------------------------------------- | ---------------------------------------------------- |
+| `@coderabbitai plan` | Get the agentic chat to plan an edit for previous comments | When you want CodeRabbit to change your code for you |
+
+## Help and support
+
+| Command | Description | Use Case |
+| -------------------- | ------------------------------------------ | ------------------------------------------ |
+| `@coderabbitai help` | Displays available commands and usage info | When you need guidance on using CodeRabbit |
diff --git a/docs/reference/yaml-template.md b/docs/reference/yaml-template.md
new file mode 100644
index 00000000..9fac39e2
--- /dev/null
+++ b/docs/reference/yaml-template.md
@@ -0,0 +1,192 @@
+---
+title: Configuration file template
+---
+
+You can use the following template as a basis for a new `.coderabbit.yaml` configuration file at the root level of your repository.
+
+If used as-is as a `.coderabbit.yaml` file, then this template sets the default, recommended values for [all CodeRabbit repository options](/reference/configuration). You can then update the values to best suit your team's code-review needs.
+
+For more information about using a `.coderabbit.yaml` file, see [Add a configuration file](/getting-started/configure-coderabbit).
+
+For a general overview of CodeRabbit configuration, see [Configure CodeRabbit](/guides/configuration-overview).
+
+```yaml
+# yaml-language-server: $schema=https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json
+
+language: en-US
+tone_instructions: ""
+early_access: true
+enable_free_tier: true
+reviews:
+ profile: chill
+ request_changes_workflow: false
+ high_level_summary: true
+ high_level_summary_placeholder: "@coderabbitai summary"
+ high_level_summary_in_walkthrough: false
+ auto_title_placeholder: "@coderabbitai"
+ auto_title_instructions: ""
+ review_status: true
+ commit_status: true
+ fail_commit_status: false
+ collapse_walkthrough: false
+ changed_files_summary: true
+ sequence_diagrams: true
+ assess_linked_issues: true
+ related_issues: true
+ related_prs: true
+ suggested_labels: true
+ auto_apply_labels: false
+ suggested_reviewers: true
+ auto_assign_reviewers: false
+ poem: true
+ labeling_instructions:
+ - label: ""
+ instructions: ""
+ path_filters: []
+ path_instructions:
+ - path: ""
+ instructions: ""
+ abort_on_close: true
+ disable_cache: false
+ auto_review:
+ enabled: true
+ auto_incremental_review: true
+ ignore_title_keywords: []
+ labels: []
+ drafts: false
+ base_branches: []
+ finishing_touches:
+ docstrings:
+ enabled: true
+ unit_tests:
+ enabled: true
+ tools:
+ ast-grep:
+ rule_dirs: []
+ util_dirs: []
+ essential_rules: true
+ packages: []
+ shellcheck:
+ enabled: true
+ ruff:
+ enabled: true
+ markdownlint:
+ enabled: true
+ github-checks:
+ enabled: true
+ timeout_ms: 90000
+ languagetool:
+ enabled: true
+ enabled_rules: []
+ disabled_rules: []
+ enabled_categories: []
+ disabled_categories: []
+ enabled_only: false
+ level: default
+ biome:
+ enabled: true
+ hadolint:
+ enabled: true
+ swiftlint:
+ enabled: true
+ config_file: ""
+ phpstan:
+ enabled: true
+ level: default
+ golangci-lint:
+ enabled: true
+ config_file: ""
+ yamllint:
+ enabled: true
+ gitleaks:
+ enabled: true
+ checkov:
+ enabled: true
+ detekt:
+ enabled: true
+ config_file: ""
+ eslint:
+ enabled: true
+ flake8:
+ enabled: true
+ rubocop:
+ enabled: true
+ buf:
+ enabled: true
+ regal:
+ enabled: true
+ actionlint:
+ enabled: true
+ pmd:
+ enabled: true
+ config_file: ""
+ phpmd:
+ enabled: true
+ phpcs:
+ enabled: true
+ cppcheck:
+ enabled: true
+ semgrep:
+ enabled: true
+ config_file: ""
+ circleci:
+ enabled: true
+ clippy:
+ enabled: true
+ sqlfluff:
+ enabled: true
+ prismaLint:
+ enabled: true
+ pylint:
+ enabled: true
+ oxc:
+ enabled: true
+ shopifyThemeCheck:
+ enabled: true
+ luacheck:
+ enabled: true
+ brakeman:
+ enabled: true
+ dotenvLint:
+ enabled: true
+ htmlhint:
+ enabled: true
+ checkmake:
+ enabled: true
+chat:
+ auto_reply: true
+ integrations:
+ jira:
+ usage: auto
+ linear:
+ usage: auto
+knowledge_base:
+ opt_out: false
+ web_search:
+ enabled: true
+ code_guidelines:
+ enabled: true
+ filePatterns: []
+ learnings:
+ scope: auto
+ issues:
+ scope: auto
+ jira:
+ usage: auto
+ project_keys: []
+ linear:
+ usage: auto
+ team_keys: []
+ pull_requests:
+ scope: auto
+code_generation:
+ docstrings:
+ language: en-US
+ path_instructions:
+ - path: ""
+ instructions: ""
+ unit_tests:
+ path_instructions:
+ - path: ""
+ instructions: ""
+```
diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md
index 97137b11..a843e1a7 100644
--- a/docs/self-hosted/azure-devops.md
+++ b/docs/self-hosted/azure-devops.md
@@ -64,7 +64,8 @@ LLM_PROVIDER=azure-openai
LLM_TIMEOUT=360000
AZURE_OPENAI_ENDPOINT=
AZURE_OPENAI_API_KEY=
-## it is recommended to deploy gpt-4.1-mini, o4-mini, o3 deployments, gpt-4.1 (optionally).
+# it is recommended to deploy text-embedding-3-large, gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=
AZURE_GPT41MINI_DEPLOYMENT_NAME=
AZURE_O4MINI_DEPLOYMENT_NAME=
AZURE_O3_DEPLOYMENT_NAME=
@@ -96,6 +97,7 @@ HTTPS_PROXY=[]
NO_PROXY=[]
# if using AWS Bedrock
+# it is required to have access to claude-3-haiku, claude-3-5-haiku, claude-sonnet-4, claude-opus-4.
LLM_PROVIDER=bedrock-anthropic
LLM_TIMEOUT=360000
AWS_ACCESS_KEY_ID=
@@ -115,7 +117,7 @@ CODERABBIT_API_KEY=
ENABLE_METRICS=[true]
ENABLE_LEARNINGS=[true]
# if using CodeRabbit's learnings, also provide the following
-# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
+# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
OBJECT_STORE_URI=[]
JIRA_HOST=[]
diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md
index 0adbeed6..7e7faf2b 100644
--- a/docs/self-hosted/bitbucket.md
+++ b/docs/self-hosted/bitbucket.md
@@ -56,7 +56,8 @@ LLM_PROVIDER=azure-openai
LLM_TIMEOUT=360000
AZURE_OPENAI_ENDPOINT=
AZURE_OPENAI_API_KEY=
-## it is recommended to deploy gpt-4.1-mini, o4-mini, o3 deployments, gpt-4.1 (optionally).
+# it is recommended to deploy text-embedding-3-large, gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=
AZURE_GPT41MINI_DEPLOYMENT_NAME=
AZURE_O4MINI_DEPLOYMENT_NAME=
AZURE_O3_DEPLOYMENT_NAME=
@@ -88,6 +89,7 @@ HTTPS_PROXY=[]
NO_PROXY=[]
# if using AWS Bedrock
+# it is required to have access to claude-3-haiku, claude-3-5-haiku, claude-sonnet-4, claude-opus-4.
LLM_PROVIDER=bedrock-anthropic
LLM_TIMEOUT=360000
AWS_ACCESS_KEY_ID=
@@ -110,7 +112,7 @@ CODERABBIT_API_KEY=
ENABLE_METRICS=[true]
ENABLE_LEARNINGS=[true]
# if using CodeRabbit's learnings, also provide the following
-# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
+# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
OBJECT_STORE_URI=[]
JIRA_HOST=[]
diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md
index 8f7e4962..3031e45c 100644
--- a/docs/self-hosted/github.md
+++ b/docs/self-hosted/github.md
@@ -67,7 +67,8 @@ LLM_PROVIDER=azure-openai
LLM_TIMEOUT=360000
AZURE_OPENAI_ENDPOINT=
AZURE_OPENAI_API_KEY=
-## it is recommended to deploy gpt-4.1-mini, o4-mini, o3 deployments, gpt-4.1 (optionally).
+# it is recommended to deploy text-embedding-3-large, gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=
AZURE_GPT41MINI_DEPLOYMENT_NAME=
AZURE_O4MINI_DEPLOYMENT_NAME=
AZURE_O3_DEPLOYMENT_NAME=
@@ -99,6 +100,7 @@ HTTPS_PROXY=[]
NO_PROXY=[]
# if using AWS Bedrock
+# it is required to have access to claude-3-haiku, claude-3-5-haiku, claude-sonnet-4, claude-opus-4.
LLM_PROVIDER=bedrock-anthropic
LLM_TIMEOUT=360000
AWS_ACCESS_KEY_ID=
@@ -128,7 +130,7 @@ CODERABBIT_API_KEY=
ENABLE_METRICS=[true]
ENABLE_LEARNINGS=[true]
# if using CodeRabbit's learnings, also provide the following
-# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
+# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
OBJECT_STORE_URI=[]
JIRA_HOST=[]
diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md
index 42736e2f..cd35c19f 100644
--- a/docs/self-hosted/gitlab.md
+++ b/docs/self-hosted/gitlab.md
@@ -62,7 +62,8 @@ LLM_PROVIDER=azure-openai
LLM_TIMEOUT=360000
AZURE_OPENAI_ENDPOINT=
AZURE_OPENAI_API_KEY=
-## it is recommended to deploy gpt-4.1-mini, o4-mini, o3 deployments, gpt-4.1 (optionally).
+# it is recommended to deploy text-embedding-3-large, gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=
AZURE_GPT41MINI_DEPLOYMENT_NAME=
AZURE_O4MINI_DEPLOYMENT_NAME=
AZURE_O3_DEPLOYMENT_NAME=
@@ -94,6 +95,7 @@ HTTPS_PROXY=[]
NO_PROXY=[]
# if using AWS Bedrock
+# it is required to have access to claude-3-haiku, claude-3-5-haiku, claude-sonnet-4, claude-opus-4.
LLM_PROVIDER=bedrock-anthropic
LLM_TIMEOUT=360000
AWS_ACCESS_KEY_ID=
@@ -112,6 +114,9 @@ SELF_HOSTED=gitlab
GITLAB_BOT_TOKEN=
GITLAB_WEBHOOK_SECRET=
+# if seeing '500 Internal Server Error' in CodeRabbit logs when trying to post review comments,
+# make sure to set the following environment variable to 1500 (1.5 seconds).
+GITLAB_PUBLISH_DELAY=[]
CODERABBIT_LICENSE_KEY=
@@ -119,7 +124,7 @@ CODERABBIT_API_KEY=
ENABLE_METRICS=[true]
ENABLE_LEARNINGS=[true]
# if using CodeRabbit's learnings, also provide the following
-# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
+# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
OBJECT_STORE_URI=[]
JIRA_HOST=[]
diff --git a/docs/tools/brakeman.md b/docs/tools/brakeman.md
new file mode 100644
index 00000000..d9fac002
--- /dev/null
+++ b/docs/tools/brakeman.md
@@ -0,0 +1,40 @@
+---
+title: Brakeman
+sidebar_label: Brakeman
+description: CodeRabbit's guide to Brakeman.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+```
+
+[Brakeman](https://brakemanscanner.org/) is a static analysis tool which checks Ruby on Rails applications for security vulnerabilities. It scans your application's code for potential security issues and provides detailed reports about any vulnerabilities it finds.
+
+## Supported Files
+
+Brakeman will run on files with the following extensions:
+
+- `Gemfile`
+- `*.rb`
+- `*.erb`
+
+## Features
+
+Brakeman can detect many critical vulnerabilities such as:
+
+- SQL injection
+- Cross-site scripting (XSS)
+- Mass assignment
+- Remote code execution
+- And many more security vulnerabilities
+- Out of date package versions
+- Etc
+
+## Links
+
+- [Brakeman Official Website](https://brakemanscanner.org/)
+- [Brakeman GitHub Repository](https://github.com/presidentbeef/brakeman)
+- [Brakeman Documentation](https://brakemanscanner.org/docs/)
+- [Warning Types](https://brakemanscanner.org/docs/warning_types/)
diff --git a/docs/tools/checkmake.md b/docs/tools/checkmake.md
new file mode 100644
index 00000000..8d623ca1
--- /dev/null
+++ b/docs/tools/checkmake.md
@@ -0,0 +1,30 @@
+---
+title: Checkmake
+sidebar_label: Checkmake
+description: CodeRabbit's guide to Checkmake.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+```
+
+[Checkmake](https://github.com/mrtazz/checkmake) is a linter for Makefiles.
+
+## Files
+
+Checkmake will run checks against any `Makefile`.
+
+## Configuration
+
+Checkmake supports the following config files:
+
+- `checkmake.yml`
+- `checkmake.yaml`
+
+CodeRabbit will use the default settings based on the profile selected if no config file is found.
+
+## Links
+
+- [Checkmake Configuration](https://github.com/mrtazz/checkmake#configuration)
diff --git a/docs/tools/clippy.md b/docs/tools/clippy.md
new file mode 100644
index 00000000..257af0e3
--- /dev/null
+++ b/docs/tools/clippy.md
@@ -0,0 +1,50 @@
+---
+title: Clippy
+sidebar_label: Clippy
+description: CodeRabbit's guide to Clippy.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+```
+
+[Clippy](https://github.com/rust-lang/rust-clippy) is a collection of lints to catch common mistakes and improve your Rust code. It is the official linter for the Rust programming language.
+
+## Supported Files
+
+Clippy will run on files with the following extensions:
+
+- `*.rs`
+
+## Configuration
+
+Clippy supports the following configuration files:
+
+- `clippy.toml`
+- `.clippy.toml`
+
+:::note
+
+Clippy does not require configuration to run. If no configuration file is found, it will use default settings.
+
+A Cargo.toml is required.
+
+:::
+
+## Features
+
+Clippy can detect many code quality issues such as:
+
+- Style violations
+- Common mistakes
+- Performance issues
+- Deprecated code patterns
+- And many more Rust-specific issues
+
+## Links
+
+- [Clippy GitHub Repository](https://github.com/rust-lang/rust-clippy)
+- [Clippy Documentation](https://rust-lang.github.io/rust-clippy/master/)
+- [Available Lints](https://rust-lang.github.io/rust-clippy/master/index.html)
diff --git a/docs/tools/dotenv.md b/docs/tools/dotenv.md
new file mode 100644
index 00000000..cac2613f
--- /dev/null
+++ b/docs/tools/dotenv.md
@@ -0,0 +1,33 @@
+---
+title: Dotenv Linter
+sidebar_label: Dotenv Linter
+description: CodeRabbit's guide to Dotenv Linter.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+```
+
+[Dotenv Linter](https://github.com/dotenv-linter/dotenv-linter) is a lightning-fast linter for `.env` files. It helps ensure your environment files are consistent, typo-free, and follow best practices.
+
+:::note
+
+Dotenv Linter does not require configuration to run and automatically anlysises `.env` files. If no configuration file is found, it will use default settings.
+
+:::
+
+## Features
+
+Dotenv Linter can detect:
+
+- Key duplication
+- Missing values
+- Incorrect formatting
+- Invalid characters
+- And many more issues
+
+## Links
+
+- [Dotenv Linter GitHub Repository](https://github.com/dotenv-linter/dotenv-linter)
diff --git a/docs/tools/flake8.md b/docs/tools/flake8.md
new file mode 100644
index 00000000..a1a18881
--- /dev/null
+++ b/docs/tools/flake8.md
@@ -0,0 +1,46 @@
+---
+title: Flake8
+sidebar_label: Flake8
+description: CodeRabbit's guide to Flake8.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+```
+
+[Flake8](https://flake8.pycqa.org/) is a Python linting utility that wraps PyFlakes, pycodestyle, and Mccabe to check your Python or Jupiter Notebook code for style and logical errors.
+
+## Supported Files
+
+Flake8 will run on files with the following extensions:
+
+- `*.py`
+- `*.ipynb` (using nbqa)
+
+## Configuration
+
+Flake8 supports the following config files:
+
+- `.flake8`
+
+CodeRabbit will not run Flake8 if no config file is found.
+
+## Features
+
+Flake8 can detect many issues such as:
+
+- Style violations (PEP 8)
+- Logical errors and unused imports
+- Code complexity issues
+- Syntax errors
+- And many more
+
+## Links
+
+- [Flake8 Official Website](https://flake8.pycqa.org/)
+- [Flake8 GitHub Repository](https://github.com/pycqa/flake8)
+- [Flake8 Documentation](https://flake8.pycqa.org/en/latest/)
+- [Flake8 Configuration](https://flake8.pycqa.org/en/latest/user/configuration.html)
+- [nbqa Documentation](https://github.com/nbQA-dev/nbQA)
diff --git a/docs/tools/htmlhint.md b/docs/tools/htmlhint.md
new file mode 100644
index 00000000..c8fd61ea
--- /dev/null
+++ b/docs/tools/htmlhint.md
@@ -0,0 +1,31 @@
+---
+title: HTMLHint
+sidebar_label: HTMLHint
+description: CodeRabbit's guide to HTMLHint.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+```
+
+[HTMLHint](https://htmlhint.com/) is a static code analysis tool for HTML.
+
+## Files
+
+HTMLHint will run checks against `*.html` files.
+
+## Configuration
+
+HTMLHint supports the following config files:
+
+- `.htmlhintrc`
+- `.htmlhintrc.json`
+- `htmlhintrc.json`
+
+CodeRabbit will use the default settings based on the profile selected if no config file is found.
+
+## Links
+
+- [HTMLHint Configuration](https://htmlhint.com/docs/user-guide/getting-started)
diff --git a/docs/tools/list.md b/docs/tools/list.md
new file mode 100644
index 00000000..f81880a3
--- /dev/null
+++ b/docs/tools/list.md
@@ -0,0 +1,90 @@
+---
+title: List of supported tools
+description: Overview of CodeRabbit's supported linters and security analysis tools
+---
+
+This is a list of the third-party open-source linters and security analysis tools that CodeRabbit uses to generate code reviews.
+
+For more information about fine-tuning the CodeRabbit configuration of a tool, click that tool's name in the following list.
+
+For an overview of how CodeRabbit uses these tools when generating code reviews, as well as general information about controlling their use, see [Configure third-party tools](/tools/).
+
+| Technology | Tools | Category |
+| :-------------------------- | :--------------------------------------------------------- | :-------------------------------------------------- |
+| All | [Gitleaks][Gitleaks], [Pipeline Remediation][Pipeline] | Code Security, CI/CD |
+| Azure DevOps Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
+| CircleCI | [CircleCI][CircleCI], [Pipeline Remediation][Pipeline] | Configuration Validation, CI/CD Failure Remediation |
+| CloudFormation | [Checkov][Checkov] | Code Security |
+| Cppcheck | [Cppcheck][Cppcheck] | Code Quality |
+| CSS | [Biome][Biome] | Code Quality |
+| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security |
+| Environment Files (.env) | [Dotenv Linter][DotenvLinter] | Code Quality |
+| GitHub Actions | [actionlint][actionlint], [Pipeline Remediation][Pipeline] | Code Quality, CI/CD Failure Remediation |
+| GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
+| Go | [golangci-lint][golangci-lint] | Code Quality |
+| Helm | [Checkov][Checkov] | Code Security |
+| HTML | [HTMLHint][HTMLHint] | Code Quality |
+| Javascript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
+| JSON, JSONC | [Biome][Biome] | Code Quality |
+| JSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
+| Kotlin | [detekt][detekt] | Code Quality |
+| Kubernetes | [Checkov][Checkov] | Code Security |
+| Lua | [Luacheck][Luacheck] | Code Quality |
+| Makefile | [Checkmake][Checkmake] | Code Quality |
+| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking |
+| PHP | [PHPStan][PHPStan], [PHPMD][PHPMD], [PHPCS][PHPCS] | Code Quality |
+| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
+| Java | [PMD][PMD] | Code Quality |
+| Protobuf | [Buf][Buf] | Code Quality |
+| Python | [Ruff][Ruff], [Pylint][Pylint], [Flake8][Flake8] | Code Quality |
+| Jupyter Notebooks | [Ruff][Ruff], [Pylint][Pylint], [Flake8][Flake8] | Code Quality |
+| Regal | [Regal][Regal] | Code Quality |
+| Ruby | [RuboCop][RuboCop], [Brakeman][Brakeman] | Code Quality, Code Security |
+| Rust | [Clippy][Clippy] | Code Quality |
+| Semgrep | [Semgrep][Semgrep] | Code Security |
+| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality |
+| Shopify | [Shopify CLI][ShopifyCLI] | Code Quality |
+| SQL | [SQLFluff][SQLFluff] | Code Quality |
+| Swift | [SwiftLint][SwiftLint] | Code Quality |
+| Terraform | [Checkov][Checkov] | Code Security |
+| TSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
+| Typescript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
+| YAML | [YAMLlint][YAMLlint] | Code Quality |
+| Prisma | [Prisma Lint][PrismaLint] | Code Quality |
+
+[ShellCheck]: /tools/shellcheck.md
+[SQLFluff]: /tools/sqlfluff.md
+[Ruff]: /tools/ruff.md
+[markdownlint]: /tools/markdownlint.md
+[LanguageTool]: /tools/languagetool.md
+[Biome]: /tools/biome.md
+[Hadolint]: /tools/hadolint.md
+[SwiftLint]: /tools/swiftlint.md
+[PHPStan]: /tools/phpstan.md
+[golangci-lint]: /tools/golangci-lint.md
+[YAMLlint]: /tools/yamllint.md
+[Gitleaks]: /tools/gitleaks.md
+[Checkov]: /tools/checkov.md
+[detekt]: /tools/detekt.md
+[RuboCop]: /tools/rubocop.md
+[Buf]: /tools/buf.md
+[actionlint]: /tools/actionlint.md
+[Regal]: /tools/regal.md
+[PMD]: /tools/pmd.md
+[Cppcheck]: /tools/cppcheck.md
+[CircleCI]: /tools/circleci.md
+[Semgrep]: /tools/semgrep.md
+[Pipeline]: /tools/pipeline-remediation.md
+[PrismaLint]: /tools/prisma-lint.md
+[oxlint]: /tools/oxlint.md
+[ShopifyCLI]: /tools/shopify-cli.md
+[Luacheck]: /tools/luacheck.md
+[Brakeman]: /tools/brakeman.md
+[Clippy]: /tools/clippy.md
+[Pylint]: /tools/pylint.md
+[DotenvLinter]: /tools/dotenv.md
+[HTMLHint]: /tools/htmlhint.md
+[Checkmake]: /tools/checkmake.md
+[PHPMD]: /tools/phpmd.md
+[PHPCS]: /tools/phpcs.md
+[Flake8]: /tools/flake8.md
diff --git a/docs/tools/luacheck.md b/docs/tools/luacheck.md
new file mode 100644
index 00000000..3a8414b6
--- /dev/null
+++ b/docs/tools/luacheck.md
@@ -0,0 +1,49 @@
+---
+title: Luacheck
+sidebar_label: Luacheck
+description: CodeRabbit's guide to Luacheck.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+```
+
+[Luacheck](https://github.com/mpeterv/luacheck) is a static analyzer and linter for Lua code that detects various issues such as undefined global variables, unused variables and values, accessing uninitialized variables, unreachable code, and more.
+
+## Supported Files
+
+Luacheck will run on files with the following extensions:
+
+- `.lua`
+
+## Configuration
+
+Luacheck supports the following configuration files:
+
+- `.luacheckrc`
+- `luacheckrc`
+- `.luacheckrc.lua`
+- `luacheckrc.lua`
+
+:::note
+
+Luacheck does not require configuration to run. If no configuration file is found, it will use default settings.
+
+:::
+
+## Features
+
+Luacheck can detect:
+
+- Usage of undefined global variables
+- Unused variables and values
+- Accessing uninitialized variables
+- Unreachable code
+- And many more issues
+
+## Links
+
+- [Luacheck GitHub Repository](https://github.com/mpeterv/luacheck)
+- [Luacheck Documentation](https://luacheck.readthedocs.io/)
diff --git a/docs/tools/oxlint.md b/docs/tools/oxlint.md
index 8a93cbd2..fd5e7e2c 100644
--- a/docs/tools/oxlint.md
+++ b/docs/tools/oxlint.md
@@ -1,7 +1,7 @@
---
-title: oxlint
-sidebar_label: oxlint
-description: CodeRabbit's guide to oxlint.
+title: Oxlint
+sidebar_label: Oxlint
+description: CodeRabbit's guide to Oxlint.
---
```mdx-code-block
@@ -10,37 +10,41 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
```
-[oxlint](https://github.com/oxc-project/oxc) is a blazingly fast JavaScript/TypeScript linter written in Rust that is 50-100x faster than ESLint.
+[Oxlint](https://oxc.rs/docs/guide/usage/linter) is a blazingly fast JavaScript/TypeScript linter written in Rust that is 50-100x faster than ESLint.
-## Files
+## Supported Files
-oxlint will run on files with the following extensions:
+Oxlint will run on files with the following extensions:
- `.js`
+- `.mjs`
+- `.cjs`
- `.jsx`
- `.ts`
+- `.mts`
+- `.cts`
- `.tsx`
+- `.vue`
+- `.astro`
+- `.svelte`
## Configuration
-oxlint supports the following config files:
+Oxlint supports the following configuration file:
-- `oxlint.json`
-- `.oxlintrc`
- `.oxlintrc.json`
-- `oxlint.config.json`
:::note
-oxlint does not require configuration to run. If no oxlint config file is found and Biome is enabled, CodeRabbit will use Biome instead as oxlint functionality is included within Biome. If Biome is not enabled or an oxlint config file is found, CodeRabbit will use the default oxlint config.
+If no Oxlint config file is found and Biome is enabled, CodeRabbit will use Biome instead as Oxlint functionality is included within Biome.
-:::
+If Biome is not enabled or an Oxlint config file is found, CodeRabbit will use the `.oxlintrc.json` Oxlint config to run.
-## Rule Configuration
+Oxlint does not require configuration to run if Biome is disabled and Oxlint is enabled.
-While oxlint embraces convention over configuration, you can customize rules in your config file if needed. The config file should be in JSON format. See the [oxlint documentation](https://oxc-project.github.io) for more details on available rules and configuration options.
+:::
## Links
-- [oxlint GitHub Repository](https://github.com/oxc-project/oxc)
-- [oxlint Website](https://oxc.rust-server.org)
+- [Oxlint GitHub Repository](https://github.com/oxc-project/oxc/releases/)
+- [Oxlint Website](https://oxc.rs/docs/guide/usage/linter)
diff --git a/docs/tools/phpcs.md b/docs/tools/phpcs.md
new file mode 100644
index 00000000..468e23dc
--- /dev/null
+++ b/docs/tools/phpcs.md
@@ -0,0 +1,56 @@
+---
+title: PHPCS
+sidebar_label: PHPCS
+description: CodeRabbit's guide to PHPCS.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+```
+
+[PHPCS](https://github.com/squizlabs/PHP_CodeSniffer) (PHP CodeSniffer) is a development tool that ensures your code conforms to a coding standard. It is an essential tool for any development team that wants to ensure their code is consistent and follows best practices.
+
+## Files
+
+PHPCS will run on files with the following extensions:
+
+- `.php`
+
+## Features
+
+PHPCS can detect and fix various coding standard violations including:
+
+- **PSR Standards**: Enforces PSR-1, PSR-2, PSR-12, and other coding standards
+- **Custom Standards**: Supports custom coding standards and rules
+- **Auto-fixing**: Can automatically fix many coding standard violations
+- **Custom Rules**: Allows creation of custom sniff rules
+- **Multiple Standards**: Can enforce multiple coding standards simultaneously
+
+## Popular Standards
+
+PHPCS supports many coding standards including:
+
+- **PSR-1**: Basic Coding Standard
+- **PSR-2**: Coding Style Guide
+- **PSR-12**: Extended Coding Style
+- **Squiz**: Squiz Labs coding standard
+- **PEAR**: PEAR coding standard
+- **Zend**: Zend Framework coding standard
+
+## Configuration
+
+PHPCS requires a configuration file to run. CodeRabbit will only run PHPCS if one of the following configuration files is found:
+
+- `phpcs.xml` - XML configuration file
+- `phpcs.xml.dist` - Distributed XML configuration file
+
+CodeRabbit will not run PHPCS if no configuration file is found.
+
+## Links
+
+- [PHPCS GitHub Repository](https://github.com/squizlabs/PHP_CodeSniffer)
+- [PHPCS Documentation](https://github.com/squizlabs/PHP_CodeSniffer/wiki)
+- [Available Coding Standards](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Coding-Standards)
+- [Creating Custom Standards](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Coding-Standards#creating-a-coding-standard)
diff --git a/docs/tools/phpmd.md b/docs/tools/phpmd.md
new file mode 100644
index 00000000..84df5b11
--- /dev/null
+++ b/docs/tools/phpmd.md
@@ -0,0 +1,44 @@
+---
+title: PHPMD
+sidebar_label: PHPMD
+description: CodeRabbit's guide to PHPMD.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+```
+
+[PHPMD](https://phpmd.org/) (PHP Mess Detector) is a static analysis tool for PHP that detects potential problems in your code such as possible bugs, suboptimal code, overcomplicated expressions, and unused parameters, variables, methods, and classes.
+
+## Files
+
+PHPMD will run on files with the following extensions:
+
+- `.php`
+
+## Features
+
+PHPMD can detect various code quality issues including:
+
+- **Clean Code Rules**: Detects code smells and violations of clean code principles
+- **Controversial Rules**: Identifies potentially problematic code patterns
+- **Design Rules**: Finds design-related issues and architectural problems
+- **Naming Rules**: Checks for naming convention violations
+- **Unused Code Rules**: Detects unused variables, parameters, methods, and classes
+- **Size Rules**: Identifies overly complex methods and classes
+
+### Review Mode Behavior
+
+CodeRabbit's review mode affects which PHPMD rules are applied:
+
+- **Chill Mode**: Only checks for unused code (`unusedcode` rule set)
+- **Nitpick Mode**: Checks all rule sets including clean code, code size, controversial rules, design issues, naming conventions, and unused code (`cleancode,codesize,controversial,design,naming,unusedcode`)
+
+## Links
+
+- [PHPMD Official Website](https://phpmd.org/)
+- [PHPMD GitHub Repository](https://github.com/phpmd/phpmd)
+- [PHPMD Documentation](https://phpmd.org/documentation/index.html)
+- [Available Rules](https://phpmd.org/rules/index.html)
diff --git a/docs/tools/pipeline-remediation.md b/docs/tools/pipeline-remediation.md
index d03ad33d..2beb0213 100644
--- a/docs/tools/pipeline-remediation.md
+++ b/docs/tools/pipeline-remediation.md
@@ -94,7 +94,7 @@ With CodeRabbit CI/CD Pipeline Remediation, you have coderabbit automatically re
### GitLab CI/CD
-- Pipeline failure analysis
+- GitLab CI/CD Pipeline failure analysis
- Integration with GitLab Advanced Security
- Support for DAST (Dynamic Application Security Testing) findings
- Remediation for SAST (Static Application Security Testing) issues
@@ -105,16 +105,16 @@ With CodeRabbit CI/CD Pipeline Remediation, you have coderabbit automatically re
### CircleCI
-- Workflow failure detection
+- CircleCI Pipeline failure analysis
- Job-level error analysis
- Configuration validation
- Dependency resolution
-### Azure DevOps
+### Azure DevOps Pipelines
-- Pipeline failure detection
+- Azure DevOps CI/CD Pipeline failure analysis
- Integration with Azure DevOps Checks
- Support for custom tasks and pipelines
- Remediation for build issues
@@ -174,4 +174,4 @@ Our tool handles a wide range of pipeline failures including:
- [GitHub Actions Configuration](https://docs.github.com/en/actions)
- [GitLab CI/CD Documentation](https://docs.gitlab.com/ee/ci/)
- [CircleCI Documentation](https://circleci.com/docs/)
-- [Azure DevOps Documentation](https://learn.microsoft.com/en-us/azure/devops/pipelines/get-started/pipelines-get-started?view=azure-devops)
+- [Azure DevOps Pipeline Documentation](https://learn.microsoft.com/en-us/azure/devops/pipelines/get-started/pipelines-get-started?view=azure-devops)
diff --git a/docs/tools/pylint.md b/docs/tools/pylint.md
new file mode 100644
index 00000000..6c45484d
--- /dev/null
+++ b/docs/tools/pylint.md
@@ -0,0 +1,50 @@
+---
+title: Pylint
+sidebar_label: Pylint
+description: CodeRabbit's guide to Pylint.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+```
+
+[Pylint](https://pylint.pycqa.org/) is a static code analysis tool for Python or Jupiter Notebooks. It checks your Python code for errors, enforces a coding standard, and looks for code smells.
+
+## Supported Files
+
+Pylint will run on files with the following extensions:
+
+- `*.py`
+- `.ipynb` (using nbqa)
+
+## Configuration
+
+Pylint supports the following config files:
+
+- `.pylintrc`
+- `pylintrc`
+- `.pylintrc.toml`
+- `pylintrc.toml`
+
+CodeRabbit will not run Pylint if no config file is found.
+
+## Features
+
+Pylint can detect many issues such as:
+
+- Coding standard violations (PEP8)
+- Unused variables and imports
+- Undefined variables
+- Code smells and refactoring suggestions
+- Error-prone constructs
+- And many more
+
+## Links
+
+- [Pylint Official Website](https://pylint.pycqa.org/)
+- [Pylint GitHub Repository](https://github.com/pylint-dev/pylint)
+- [Pylint Documentation](https://pylint.pycqa.org/en/latest/)
+- [Message Control](https://pylint.pycqa.org/en/latest/user_guide/message-control.html)
+- [nbqa Documentation](https://github.com/nbQA-dev/nbQA)
diff --git a/docs/tools/ruff.md b/docs/tools/ruff.md
index fe897d7b..97ebacde 100644
--- a/docs/tools/ruff.md
+++ b/docs/tools/ruff.md
@@ -10,13 +10,14 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
```
-[Ruff](https://docs.astral.sh/ruff/) is a linter for Python.
+[Ruff](https://docs.astral.sh/ruff/) is a linter for Python or Jupiter Notebooks.
## Files
Ruff will run on files with the following extensions:
- `.py`
+- `.ipynb` (using nbqa)
## Configuration
@@ -31,3 +32,4 @@ CodeRabbit will use the default settings based on the profile selected if no con
## Links
- [Ruff Configuration](https://docs.astral.sh/ruff/configuration/)
+- [nbqa Documentation](https://github.com/nbQA-dev/nbQA)
diff --git a/docs/tools/tools.md b/docs/tools/tools.md
index 113c2fee..45b376c5 100644
--- a/docs/tools/tools.md
+++ b/docs/tools/tools.md
@@ -3,6 +3,8 @@ title: Configure third-party tool use
description: Overview of CodeRabbit's supported linters and security analysis tools.
---
+This page provides an overview of how CodeRabbit uses third-party open-source tools to deliver its multifaceted code reviews. For a complete list of supported tools, see [Supported tools](/tools/list).
+
```mdx-code-block
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
@@ -40,68 +42,6 @@ Remove extraneous f prefix
(F541)
```
-## Supported Tools
-
-| Technology | Tools | Category |
-| :-------------------------- | :--------------------------------------------------------- | :-------------------------------------------------- |
-| All | [Gitleaks][Gitleaks], [Pipeline Remediation][Pipeline] | Code Security, CI/CD |
-| Azure DevOps Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
-| CircleCI | [CircleCI][CircleCI], [Pipeline Remediation][Pipeline] | Configuration Validation, CI/CD Failure Remediation |
-| CloudFormation | [Checkov][Checkov] | Code Security |
-| Cppcheck | [Cppcheck][Cppcheck] | Code Quality |
-| CSS | [Biome][Biome] | Code Quality |
-| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security |
-| GitHub Actions | [actionlint][actionlint], [Pipeline Remediation][Pipeline] | Code Quality, CI/CD Failure Remediation |
-| GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
-| Go | [golangci-lint][golangci-lint] | Code Quality |
-| Helm | [Checkov][Checkov] | Code Security |
-| Javascript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
-| JSON, JSONC | [Biome][Biome] | Code Quality |
-| JSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
-| Kotlin | [detekt][detekt] | Code Quality |
-| Kubernetes | [Checkov][Checkov] | Code Security |
-| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking |
-| PHP | [PHPStan][PHPStan] | Code Quality |
-| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
-| Java | [PMD][PMD] | Code Quality |
-| Protobuf | [Buf][Buf] | Code Quality |
-| Python | [Ruff][Ruff] | Code Quality |
-| Regal | [Regal][Regal] | Code Quality |
-| Ruby | [RuboCop][RuboCop] | Code Quality |
-| Semgrep | [Semgrep][Semgrep] | Code Security |
-| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality |
-| Shopify | [Shopify CLI][ShopifyCLI] | Code Quality |
-| SQL | [SQLFluff][SQLFluff] | Code Quality |
-| Swift | [SwiftLint][SwiftLint] | Code Quality |
-| Terraform | [Checkov][Checkov] | Code Security |
-| TSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
-| Typescript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
-| YAML | [YAMLlint][YAMLlint] | Code Quality |
-| Prisma | [Prisma Lint][PrismaLint] | Code Quality |
-
-[ShellCheck]: ./shellcheck.md
-[SQLFluff]: ./sqlfluff.md
-[Ruff]: ./ruff.md
-[markdownlint]: ./markdownlint.md
-[LanguageTool]: ./languagetool.md
-[Biome]: ./biome.md
-[Hadolint]: ./hadolint.md
-[SwiftLint]: ./swiftlint.md
-[PHPStan]: ./phpstan.md
-[golangci-lint]: ./golangci-lint.md
-[YAMLlint]: ./yamllint.md
-[Gitleaks]: ./gitleaks.md
-[Checkov]: ./checkov.md
-[detekt]: ./detekt.md
-[RuboCop]: ./rubocop.md
-[Buf]: ./buf.md
-[actionlint]: ./actionlint.md
-[Regal]: ./regal.md
-[PMD]: ./pmd.md
-[Cppcheck]: ./cppcheck.md
-[CircleCI]: ./circleci.md
-[Semgrep]: ./semgrep.md
-[Pipeline]: ./pipeline-remediation.md
-[PrismaLint]: ./prisma-lint.md
-[oxlint]: ./oxlint.md
-[ShopifyCLI]: ./shopify-cli.md
+## What's next
+
+- For a complete list of tools that CodeRabbit supports, see [Supported tools](/tools/list).
diff --git a/sidebars.ts b/sidebars.ts
index 8e701fc2..3cc53ff0 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -30,13 +30,13 @@ const sidebars: SidebarsConfig = {
docsSidebar: [
{
type: "category",
- collapsed: false,
+ collapsed: true,
label: "Get started with CodeRabbit",
items: ["overview/introduction", "getting-started/quickstart"],
},
{
type: "category",
- collapsed: false,
+ collapsed: true,
label: "Add CodeRabbit to your repository",
items: [
"platforms/platforms",
@@ -70,35 +70,51 @@ const sidebars: SidebarsConfig = {
},
{
type: "category",
- collapsed: false,
+ collapsed: true,
+ label: "Manage your account",
+ items: ["getting-started/subscription-management", "guides/roles"],
+ },
+ {
+ type: "category",
+ collapsed: true,
label: "Configure CodeRabbit",
items: [
+ "guides/configuration-overview",
+ "guides/organization-settings",
+ "guides/repository-settings",
"getting-started/configure-coderabbit",
+ "guides/initial-configuration",
"integrations/knowledge-base",
+ "guides/review-instructions",
"tools/tools",
+ "guides/roles",
],
},
{
type: "category",
- collapsed: false,
+ collapsed: true,
label: "Review pull requests",
items: [
+ "guides/code-review-overview",
"guides/commands",
+ "guides/generate-improvements",
+ "guides/code-review-troubleshooting",
"guides/agent_chat",
{
type: "category",
- collapsed: false,
+ collapsed: true,
label: "Analyze and improve your code",
items: [
"integrations/code-graph-analysis",
"finishing-touches/docstrings",
+ "finishing-touches/unit-test-generation",
],
},
],
},
{
type: "category",
- collapsed: false,
+ collapsed: true,
label: "Create and resolve issues",
items: [
"integrations/issue-integrations",
@@ -109,17 +125,39 @@ const sidebars: SidebarsConfig = {
},
{
type: "category",
- collapsed: false,
+ collapsed: true,
+ label: "Review local changes",
+ items: [
+ "guides/about-vscode",
+ "guides/install-vscode",
+ "guides/use-vscode",
+ "guides/config-vscode",
+ "guides/uninstall-vscode",
+ ],
+ },
+ {
+ type: "category",
+ collapsed: true,
label: "Generate reports",
items: [
+ "guides/reports-overview",
+ "guides/scheduled-reports",
"guides/ondemand-reports",
"guides/custom-reports",
- "guides/scheduled-reports",
],
},
{
type: "category",
- collapsed: false,
+ collapsed: true,
+ label: "Best practices",
+ items: [
+ "guides/setup-best-practices",
+ "guides/code-review-best-practices",
+ ],
+ },
+ {
+ type: "category",
+ collapsed: true,
label: "Reference",
items: [
{
@@ -127,11 +165,15 @@ const sidebars: SidebarsConfig = {
label: "CodeRabbit API",
href: "https://api.coderabbit.ai/api/swagger/",
},
+ "reference/review-commands",
+ "reference/configuration",
+ "reference/yaml-template",
{
type: "category",
label: "Supported tools",
collapsed: true,
items: [
+ "tools/list",
"tools/actionlint",
"tools/biome",
"tools/buf",
@@ -140,12 +182,16 @@ const sidebars: SidebarsConfig = {
"tools/cppcheck",
"tools/detekt",
"tools/eslint",
+ "tools/flake8",
"tools/gitleaks",
"tools/golangci-lint",
"tools/hadolint",
"tools/languagetool",
+ "tools/luacheck",
"tools/markdownlint",
"tools/oxlint",
+ "tools/phpcs",
+ "tools/phpmd",
"tools/phpstan",
"tools/pipeline-remediation",
"tools/pmd",
@@ -160,15 +206,15 @@ const sidebars: SidebarsConfig = {
"tools/yamllint",
],
},
+ "reference/caching",
],
},
{
type: "category",
- collapsed: false,
+ collapsed: true,
label: "Resources",
items: [
"getting-started/support",
- "getting-started/subscription-management",
"overview/why-coderabbit",
"faq",
"early-access",
diff --git a/src/css/custom.css b/src/css/custom.css
index 4a77db0a..7365089e 100644
--- a/src/css/custom.css
+++ b/src/css/custom.css
@@ -39,6 +39,8 @@
--ifm-navbar-height: 5rem;
--ifm-font-family-base: "Poppins", "Work Sans", sans-serif;
--ifm-background-color-primary: #f6f6f1;
+ --ifm-background-color-secondary: #e8e8e8;
+ --ifm-breadcrumb-item-background-active: #ffe9e2;
}
[data-theme="dark"] {
@@ -51,6 +53,8 @@
--ifm-color-primary-lightest: #171717;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
--ifm-background-color-primary: #171717;
+ --ifm-background-color-secondary: #232323;
+ --ifm-breadcrumb-item-background-active: #3f322e;
}
#__docusaurus {
@@ -102,6 +106,8 @@ a[docid="docs"] > svg {
overflow: hidden;
max-width: 100%;
background: #000;
+ border-radius: 1rem;
+ border: 4px solid var(--ifm-background-color-secondary);
}
.video-container iframe {
@@ -293,3 +299,39 @@ a[docid="docs"] > svg {
display: none;
}
}
+
+/* Disable automatic next/previous pagination links */
+.pagination-nav {
+ display: none;
+}
+/* ===== MARKDOWN STYLES ===== */
+.theme-doc-markdown.markdown {
+ line-height: 1.8rem;
+}
+/* ===== BREADCRUMB STYLES ===== */
+
+.breadcrumbs {
+ display: flex;
+ gap: 0.5rem;
+ overflow-x: auto;
+ white-space: nowrap;
+}
+.breadcrumbs::-webkit-scrollbar {
+ display: none;
+}
+.breadcrumbs__item {
+ display: flex;
+ align-items: center;
+ white-space: nowrap;
+ gap: 1rem;
+}
+.breadcrumbs__link {
+ transition: color 0.2s ease;
+ background-color: var(--ifm-background-color-secondary);
+}
+
+.breadcrumbs__item--active .breadcrumbs__link {
+ font-weight: 600;
+ cursor: default;
+ background-color: var(--ifm-breadcrumb-item-background-active);
+}
diff --git a/static/img/guides/path-filters.png b/static/img/guides/path-filters.png
new file mode 100644
index 00000000..9f398a51
Binary files /dev/null and b/static/img/guides/path-filters.png differ
diff --git a/static/img/guides/score-card-report-result.png b/static/img/guides/score-card-report-result.png
new file mode 100644
index 00000000..15b51539
Binary files /dev/null and b/static/img/guides/score-card-report-result.png differ
diff --git a/static/img/guides/score-card-result-comment.png b/static/img/guides/score-card-result-comment.png
new file mode 100644
index 00000000..1ea43248
Binary files /dev/null and b/static/img/guides/score-card-result-comment.png differ
diff --git a/static/img/guides/score-card-trigger-comment.png b/static/img/guides/score-card-trigger-comment.png
new file mode 100644
index 00000000..2f690948
Binary files /dev/null and b/static/img/guides/score-card-trigger-comment.png differ
diff --git a/static/img/guides/where-score-report-prompt-go.png b/static/img/guides/where-score-report-prompt-go.png
new file mode 100644
index 00000000..3b26a1f1
Binary files /dev/null and b/static/img/guides/where-score-report-prompt-go.png differ
diff --git a/static/img/integrations/login-self-hosted-github.png b/static/img/integrations/login-self-hosted-github.png
index 99f511c6..35e76ed1 100644
Binary files a/static/img/integrations/login-self-hosted-github.png and b/static/img/integrations/login-self-hosted-github.png differ
diff --git a/static/img/integrations/self-hosted-github-host-url.png b/static/img/integrations/self-hosted-github-host-url.png
index b8224720..2cb6d671 100644
Binary files a/static/img/integrations/self-hosted-github-host-url.png and b/static/img/integrations/self-hosted-github-host-url.png differ
diff --git a/static/img/knowledge-base/code-guidelines.png b/static/img/knowledge-base/code-guidelines.png
new file mode 100644
index 00000000..638a656f
Binary files /dev/null and b/static/img/knowledge-base/code-guidelines.png differ
diff --git a/static/img/reference/path-instructions.png b/static/img/reference/path-instructions.png
new file mode 100644
index 00000000..adcb5884
Binary files /dev/null and b/static/img/reference/path-instructions.png differ
diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json
index 1442d1f0..89085d9b 100644
--- a/static/schema/schema.v2.json
+++ b/static/schema/schema.v2.json
@@ -95,7 +95,17 @@
"de-LU",
"fr-FR",
"bg-BG",
- "bg"
+ "bg",
+ "he-IL",
+ "he",
+ "hi-IN",
+ "hi",
+ "vi-VN",
+ "vi",
+ "th-TH",
+ "th",
+ "bn-BD",
+ "bn"
],
"default": "en-US",
"description": "Set the language for reviews by using the corresponding ISO language code."
@@ -326,6 +336,14 @@
},
"default": [],
"description": "Base branches (other than the default branch) to review. Accepts regex patterns."
+ },
+ "ignore_usernames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": [],
+ "description": "Ignore reviewing pull requests by these usernames. These should match the Git platform usernames exactly, not the email addresses."
}
},
"additionalProperties": false,
@@ -346,6 +364,19 @@
"additionalProperties": false,
"default": {},
"description": "Docstrings | Options for generating Docstrings for your PRs/MRs."
+ },
+ "unit_tests": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Unit Tests | Allow CodeRabbit to generate unit tests for PRs/MRs."
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Unit Tests | Options for generating unit tests for your PRs/MRs."
}
},
"additionalProperties": false,
@@ -389,7 +420,7 @@
},
"additionalProperties": false,
"default": {},
- "description": "Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.31.1"
+ "description": "Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.38.1"
},
"shellcheck": {
"type": "object",
@@ -410,7 +441,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Ruff | Ruff is a Python linter and code formatter. | Enable Ruff integration. | v0.8.2"
+ "description": "Enable Ruff | Ruff is a Python linter and code formatter. | Enable Ruff integration. | v0.11.9"
}
},
"additionalProperties": false,
@@ -440,10 +471,10 @@
},
"timeout_ms": {
"type": "number",
- "maximum": 300000,
+ "maximum": 900000,
"minimum": 0,
"default": 90000,
- "description": "Time in milliseconds to wait for all GitHub Checks to conclude."
+ "description": "Time in milliseconds to wait for all GitHub Checks to conclude. Default 90 seconds, max 15 minutes (900000ms)."
}
},
"additionalProperties": false,
@@ -555,7 +586,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable PHPStan | PHPStan requires [config file](https://phpstan.org/config-reference#config-file) in your repository root. Please ensure that this file contains the `paths:` parameter. | v2.0.3"
+ "description": "Enable PHPStan | PHPStan requires [config file](https://phpstan.org/config-reference#config-file) in your repository root. Please ensure that this file contains the `paths:` parameter. | v2.1.15"
},
"level": {
"type": "string",
@@ -581,6 +612,32 @@
"default": {},
"description": "PHPStan is a tool to analyze PHP code."
},
+ "phpmd": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable PHPMD | PHPMD is a tool to find potential problems in PHP code. | v2.15.0"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "PHPMD is a tool to find potential problems in PHP code."
+ },
+ "phpcs": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable PHP CodeSniffer | PHP CodeSniffer is a PHP linter and coding standard checker. | v3.7.2"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "PHP CodeSniffer is a PHP linter and coding standard checker."
+ },
"golangci-lint": {
"type": "object",
"properties": {
@@ -604,7 +661,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable YAMLlint | YAMLlint is a linter for YAML files. | Enable YAMLlint integration. | v1.35.1"
+ "description": "Enable YAMLlint | YAMLlint is a linter for YAML files. | Enable YAMLlint integration. | v1.37.1"
}
},
"additionalProperties": false,
@@ -617,7 +674,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Gitleaks | Gitleaks is a secret scanner. | Enable Gitleaks integration. | v8.21.2"
+ "description": "Enable Gitleaks | Gitleaks is a secret scanner. | Enable Gitleaks integration. | v8.26.0"
}
},
"additionalProperties": false,
@@ -643,7 +700,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable detekt | detekt is a static code analysis tool for Kotlin files. | v1.23.7"
+ "description": "Enable detekt | detekt is a static code analysis tool for Kotlin files. | v1.23.8"
},
"config_file": {
"type": "string",
@@ -667,13 +724,26 @@
"default": {},
"description": "ESLint is a static code analysis tool for JavaScript files."
},
+ "flake8": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Flake8 | Flake8 is a Python linter that wraps PyFlakes, pycodestyle and Ned Batchelder's McCabe script. | v7.2.0"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Flake8 is a Python linter that wraps PyFlakes, pycodestyle and Ned Batchelder's McCabe script."
+ },
"rubocop": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable RuboCop | RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. | v1.73"
+ "description": "Enable RuboCop | RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. | v1.75.5"
}
},
"additionalProperties": false,
@@ -686,7 +756,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Buf | Buf offers linting for Protobuf files. | v1.47.2"
+ "description": "Enable Buf | Buf offers linting for Protobuf files. | v1.54.0"
}
},
"additionalProperties": false,
@@ -699,7 +769,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Regal | Regal is a linter and language server for Rego. | v0.29.2"
+ "description": "Enable Regal | Regal is a linter and language server for Rego. | v0.33.1"
}
},
"additionalProperties": false,
@@ -712,7 +782,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable actionlint | is a static checker for GitHub Actions workflow files. | v1.7.4"
+ "description": "Enable actionlint | is a static checker for GitHub Actions workflow files. | v1.7.7"
}
},
"additionalProperties": false,
@@ -725,7 +795,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable PMD | PMD is an extensible multilanguage static code analyzer. Itโs mainly concerned with Java. | v7.8.0"
+ "description": "Enable PMD | PMD is an extensible multilanguage static code analyzer. Itโs mainly concerned with Java. | v7.13.0"
},
"config_file": {
"type": "string",
@@ -742,7 +812,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Cppcheck | Cppcheck is a static code analysis tool for the C and C++ programming languages. | v2.10-2"
+ "description": "Enable Cppcheck | Cppcheck is a static code analysis tool for the C and C++ programming languages. | v2.17.1"
}
},
"additionalProperties": false,
@@ -755,7 +825,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.99.0"
+ "description": "Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.122.0"
},
"config_file": {
"type": "string",
@@ -772,20 +842,33 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable CircleCI | CircleCI tool is a static checker for CircleCI config files. | v0.1.31151"
+ "description": "Enable CircleCI | CircleCI tool is a static checker for CircleCI config files. | v0.1.31687"
}
},
"additionalProperties": false,
"default": {},
"description": "CircleCI tool is a static checker for CircleCI config files."
},
+ "clippy": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Clippy | Clippy is a collection of lints to catch common mistakes and improve your Rust code. | Enable Clippy integration."
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Clippy is a collection of lints to catch common mistakes and improve your Rust code."
+ },
"sqlfluff": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable SQLFluff | SQLFluff is an open source, dialect-flexible and configurable SQL linter. | v3.3.0"
+ "description": "Enable SQLFluff | SQLFluff is an open source, dialect-flexible and configurable SQL linter. | v3.4.0"
}
},
"additionalProperties": false,
@@ -798,20 +881,33 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Prisma Schema linting | Prisma Schema linting helps maintain consistent and error-free schema files | v0.10.0"
+ "description": "Enable Prisma Schema linting | Prisma Schema linting helps maintain consistent and error-free schema files | v0.10.1"
}
},
"additionalProperties": false,
"default": {},
"description": "Configuration for Prisma Schema linting to ensure schema file quality"
},
+ "pylint": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Pylint | Pylint is a Python static code analysis tool. | v3.3.7"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Pylint is a Python static code analysis tool."
+ },
"oxc": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable OXC | OXC is a JavaScript/TypeScript linter written in Rust. | v0.16.5"
+ "description": "Enable OXC | OXC is a JavaScript/TypeScript linter written in Rust. | v0.16.10"
}
},
"additionalProperties": false,
@@ -830,6 +926,71 @@
"additionalProperties": false,
"default": {},
"description": "Configuration for Shopify Theme Check to ensure theme quality and best practices"
+ },
+ "luacheck": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Lua code linting | Luacheck helps maintain consistent and error-free Lua code | v1.2.0"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Configuration for Lua code linting to ensure code quality"
+ },
+ "brakeman": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Brakeman | Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. | v7.0.2"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. | v7.0.2"
+ },
+ "dotenvLint": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable dotenv-linter | dotenv-linter is a tool for checking and fixing .env files for problems and best practices | v3.3.0"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "dotenv-linter is a tool for checking and fixing .env files for problems and best practices"
+ },
+ "htmlhint": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable HTMLHint | HTMLHint is a static code analysis tool for HTML files. | Enable HTMLHint integration. | v1.5.0"
+ }
+ },
+ "additionalProperties": false,
+ "description": "HTMLHint is a static code analysis tool for HTML files.",
+ "default": {}
+ },
+ "checkmake": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable checkmake | checkmake is a linter for Makefiles. | v0.2.2"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "checkmake is a linter for Makefiles."
}
},
"additionalProperties": false,
@@ -892,7 +1053,7 @@
"opt_out": {
"type": "boolean",
"default": false,
- "description": "Opt out | Opt out of all knowledge base features that require data retention."
+ "description": "Opt Out | Disable all knowledge base features that require data retention. If you opt out after opting in, all of your existing knowledge base data will be removed from the system."
},
"web_search": {
"type": "object",
@@ -906,6 +1067,27 @@
"additionalProperties": false,
"default": {}
},
+ "code_guidelines": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enabled | Enable CodeRabbit to enforce your organization's coding standards during reviews."
+ },
+ "filePatterns": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": [],
+ "description": "File Patterns | Specify files for your coding guideline documents in this section. CodeRabbit will scan these files to understand your team's standards and apply them during code reviews. Multiple files supported. File names are case-sensitive. Common files like: (**/.cursorrules, .github/copilot-instructions.md, **/CLAUDE.md, **/GEMINI.md, **/.cursor/rules/*, **/.windsurfrules, **/.clinerules/*, **/.rules/*, **/AGENT.md) are included by default."
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "CodeRabbit will analyse and learn from your organization's code guidelines, which you can mention in the file patterns section. These guidelines will then be used to conduct thorough code reviews."
+ },
"learnings": {
"type": "object",
"properties": {
@@ -1088,7 +1270,17 @@
"de-LU",
"fr-FR",
"bg-BG",
- "bg"
+ "bg",
+ "he-IL",
+ "he",
+ "hi-IN",
+ "hi",
+ "vi-VN",
+ "vi",
+ "th-TH",
+ "th",
+ "bn-BD",
+ "bn"
],
"default": "en-US",
"description": "Set the language for docstrings by using the corresponding ISO language code."
@@ -1120,6 +1312,37 @@
"path_instructions": []
},
"description": "Settings related to the generation of docstrings."
+ },
+ "unit_tests": {
+ "type": "object",
+ "properties": {
+ "path_instructions": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "File path glob pattern. Example: **/*.js"
+ },
+ "instructions": {
+ "type": "string",
+ "maxLength": 20000,
+ "description": "Provides additional guidelines for unit test generation based on file paths."
+ }
+ },
+ "required": ["path", "instructions"],
+ "additionalProperties": false
+ },
+ "default": [],
+ "description": "Unit Test Generation | Provide additional guidelines for unit test generation based on file paths."
+ }
+ },
+ "additionalProperties": false,
+ "default": {
+ "path_instructions": []
+ },
+ "description": "Settings related to the generation of unit tests."
}
},
"additionalProperties": false,
+
### Sample Usage
:::note
diff --git a/docs/guides/roles.md b/docs/guides/roles.md
new file mode 100644
index 00000000..c919f57d
--- /dev/null
+++ b/docs/guides/roles.md
@@ -0,0 +1,138 @@
+---
+title: Control administrative access
+description: Using the role-based authorization features of CodeRabbit
+---
+
+You can control which CodeRabbit
+administrative features are available to your organization's user accounts by
+assigning and updating account roles.
+
+## Overview of CodeRabbit roles {#overview}
+
+Every CodeRabbit account has exactly one role for each organization
+that account is associated with.
+For example, if you belong to two GitHub-based organizations that use
+CodeRabbit, then you have one CodeRabbit role set for each of those two
+organizations.
+
+CodeRabbit roles determine your ability to read or change various
+billing, account management, and other administrative functions related to
+an organization. The roles are as follows:
+
+- **Admin**: allows full read/write access to all CodeRabbit administrative features.
+- **Member**: allows read-only access to a limited set of administrative settings. This role
+ is appropriate for most developers in an organization.
+- **Billing Admin**: allows read/write access to features specific
+ to a subscription and billing management, and limited access to other administrative features.
+
+CodeRabbit users with the **Admin** role can modify the roles of other users in the
+organization.
+
+For a complete list of the administrative functions available to each role, see
+[Role permissions](#permissions).
+
+### CodeRabbit roles and Git platform roles {#and-upstream}
+
+Modifying an account's CodeRabbit role doesn't have any "upstream"
+effect on that account's role or permissions in your organization's Git platform.
+Similarly, changes to an account's role on your organization's Git platform don't
+affect that account's CodeRabbit role.
+
+For example, if you have CodeRabbit integrated with a GitHub organization, and you change an account's CodeRabbit role from **Member** to **Admin**, then that account's
+permission or ownership level with your GitHub organization doesn't change as a result.
+
+### CodeRabbit roles and developer features {#and-features}
+
+CodeRabbit roles affect only access to administrative features. Roles have no effect on using CodeRabbit developer features, such as automated code reviews.
+
+For example, if an organization has a Pro-tier
+CodeRabbit account, then any user account with a seat assigned to it can use Pro-tier features with the organization's private repositories, regardless of that account's role.
+
+For more information on seat and subscription management, see [Manage your subscription](/getting-started/subscription-management).
+
+## Default roles {#defaults}
+
+CodeRabbit assigns every user account in your organization a default role,
+using the following metrics:
+
+- If a user has an ownership-level role with the Git platform organizationโfor example,
+ **Admin** on GitHub, or **Owner** on Bitbucketโthen that user receives the default
+ CodeRabbit role of **Admin**.
+- Otherwise, the user receives the **Member** role by default.
+
+You can update a user's role from its default setting by following the steps detailed in the next section. This requires that your own account
+has an **Admin** role with the organization.
+
+CodeRabbit applies these defaults only when initially setting up for an
+account within an organization. Subsequent "upstream" role changes don't affect
+an account's CodeRabbit role.
+
+## View or set roles {#how-to}
+
+You can view and set roles from the CodeRabbit dashboard, as detailed in the
+following sections.
+
+### View roles {#view-roles}
+
+To view a list of your organization's role assignments, follow these steps:
+
+1. Go to the [CodeRabbit dashboard](https://app.coderabbit.ai/settings/repositories).
+1. At the top of the sidebar, select the organization whose user roles you want to view.
+1. On the sidebar, click **Subscription**.
+
+This displays a table of all of the CodeRabbit **Admin** and **Member** accounts associated with the selected
+organization. In this table, the **Role** column displays the CodeRabbit role for
+each account.
+
+To view a list of accounts with the **Billing Admin** role, click the **Billing Admins** tab located above the table of user accounts.
+
+### Set roles {#set-roles}
+
+:::note
+To modify users' CodeRabbit accounts, your own account must have the **Admin** role within your organization.
+:::
+
+To change a user account's CodeRabbit role, follow these steps:
+
+1. Go to your organization's list of user accounts, as detailed in the previous section.
+ If you have the **Admin** role within this organization, then the **Role** column in the user accounts table contains selectable menus.
+1. Click the menu in the user's **Role** column, and select the appropriate role from
+ the list.
+
+The only roles you can assign through this method are **Admin** and **Member**.
+You can't grant the **Billing Admin** role to an existing user account. To add an account with the **Billing Admin** role, see the next section.
+
+### Add billing admin accounts {#billing}
+
+:::note
+Billing Admin users don't require CodeRabbit seat licenses. You can add Billing Admin users regardless of how many seat licenses you have available.
+:::
+
+To add a CodeRabbit user account with the **Billing Admin** role, follow these steps:
+
+1. Go to your organization's list of user accounts, as detailed in [View roles](#view-roles).
+1. Click **Invite Billing Admin**.
+1. Enter the name and email address of the billing administrator who you want to invite to the organization.
+
+This sends an email to the address that you specified. After the recipient completes the process of joining your organization in CodeRabbit, then their record appears in the user accounts list, under the **Billing Admins** tab.
+
+## Role permissions {#permissions}
+
+The following table lists the CodeRabbit administrative functionality
+available to each of the CodeRabbit roles.
+
+| Resource | Admin | Member | Billing Admin |
+| ----------------------- | ---------- | --------- | ------------- |
+| Learning Resources | Read/Write | Read-only | No access |
+| Metrics/Dashboard | Read/Write | No access | No access |
+| Reports | Read/Write | Read-only | No access |
+| Integrations | Read/Write | Read-only | No access |
+| Repository Settings | Read/Write | Read-only | No access |
+| Organization Settings | Read/Write | Read-only | No access |
+| User Management | Read/Write | Read-only | Read-only |
+| Subscription Management | Read/Write | Read-only | Read/Write |
+| Billing Management | Read/Write | No access | Read/Write |
+
+## What's next {#whats-next}
+
+- [Manage your subscription](/getting-started/subscription-management)
diff --git a/docs/guides/scheduled-reports.md b/docs/guides/scheduled-reports.md
index 44a11f56..34c59032 100644
--- a/docs/guides/scheduled-reports.md
+++ b/docs/guides/scheduled-reports.md
@@ -11,6 +11,8 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
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.
+For a conceptual overview of reports in CodeRabbit, see [Generate reports](/guides/reports-overview).
+
## Setting Up a Recurring Report
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
- [Custom Reports](./custom-reports.md)
- [On-demand Reports](./ondemand-reports.md)
- [API Documentation](https://api.coderabbit.ai/api/swagger/)
+
+## What's next
+
+- [Customize reports](/guides/custom-reports)
+- [Generate reports on demand](/guides/ondemand-reports)
diff --git a/docs/guides/setup-best-practices.md b/docs/guides/setup-best-practices.md
new file mode 100644
index 00000000..c6caa094
--- /dev/null
+++ b/docs/guides/setup-best-practices.md
@@ -0,0 +1,131 @@
+---
+title: "Setup and configuration best practices"
+description: Best practices for seting up CodeRabbit.
+sidebar_label: Setup and configuration
+---
+
+This page contains our best-practice advice for setting up CodeRabbit, and then
+configuring its code review behavior.
+
+## Setup best practices {#setup}
+
+This section lists our recommendations for setting up CodeRabbit with your
+Git platform, and integrating CodeRabbit with other tools and services.
+
+### Give CodeRabbit its own user account {#user}
+
+CodeRabbit works best when it has a user account all to itself on your Git platform.
+Your team treats this account as a bot or service accountโeven on platforms that don't
+have a formal concept of separate service accounts, such as Bitbucket Cloud.
+
+If you use GitHub, then CodeRabbit sets up a service account named `CodeRabbitAI` for you as soon as you connect your GitHub organization to CodeRabbit. On other platforms, such as Bitbucket Cloud or Gitlab, you must set this account up yourself.
+
+For platform-specific instructions about setting up this user, see
+[Integrate with Git platforms](/platforms/).
+
+### Let CodeRabbit read your issue tracker {#issues}
+
+CodeRabbit can report on whether the changes proposed by a pull request
+successfully address specific, ticketed issues referenced by that pull request.
+
+For this to work, CodeRabbit needs read access to your team's issue management system.
+
+If you use the built-in issue management of either GitHub or GitLab, then
+CodeRabbit issue integration works without any further setup.
+
+If you use issue management systems external from your Git platform, then you need to
+take additional steps to integrate CodeRabbit with your team's issues.
+
+These are the external issue management systems that CodeRabbit supports:
+
+- Jira
+- Linear
+
+For more information, see [Integrate issue tracking](/integrations/issue-integrations/).
+
+### Set up basic reports for your team {#reports}
+
+CodeRabbit has a flexible reporting feature that can help keep your whole team
+up-to-date about the latest changes to your repositories. We recommend setting
+up at least the following scheduled reports, using templates available
+through the CodeRabbit web interface:
+
+- A daily standup report, grouped by contributor.
+- Regular release notes, grouped by repository.
+
+For more information, see [Generate reports](/guides/reports-overview).
+
+## Configuration best practices {#configuration}
+
+This section lists our recommendations for configuring the way that CodeRabbit
+works with your individual repositories.
+
+### Fine-tune reviews using YAML files {#yaml}
+
+CodeRabbit gives you two ways to configure how it works with your team's repositories:
+
+- The **Organization Settings** and **Repositories** pages of [the
+ CodeRabbit web interface](https://app.coderabbit.ai/login)
+- A [`.coderabbit.yaml` file](/getting-started/configure-coderabbit/) in your repository
+
+The web interface lets you set up your organization's code review
+preferences rapidly, and can help you get familiar with CodeRabbit configuration options.
+
+We recommend adding a `.coderabbit.yaml` file to repositories, as well. Using this file has several advantages over using only the web interface:
+
+- It applies version control to your repository's CodeRabbit settings, letting you track changes, view configuration history, and revert to previous configurations as needed.
+- During code reviews, CodeRabbit loads the file along with rest of your repository. This means that you can include setting changes as part of a pull request, and CodeRabbit both analyzes and applies these settings during its review.
+- The file makes the repository's CodeRabbit settings transparent to all of the repository's contributors.
+
+Repository-level settings defined by a `.coderabbit.yaml` take precedence over the
+settings defined for that repository or for your organization using the CodeRabbit web interface.
+
+For more information, see [Add a configuration file](/getting-started/configure-coderabbit/).
+
+### Speed up reviews by adding path filters {#filters}
+
+If your repository contains a lot of data or other content that CodeRabbit
+doesn't need for code review context, then you can include _path filters_ in
+your repository configuration. For example, a filter of `!dist/**` tells CodeRabbit
+to disregard everything in your repository's top-level `dist` directory when
+preparing a code review.
+
+Reducing the number of contextual files that CodeRabbit needs to read and analyze
+when preparing a code review can help make its code reviews faster.
+
+You can define path filters using the CodeRabbit
+web interface, or with [a `.coderabbit.yaml` file](/getting-started/configure-coderabbit/).
+
+### Trust the defaults {#defaults}
+
+CodeRabbit gives you control over a number of its core code-review features, letting you deactivate them entirely for your repositories if needed. We have chosen the default settings to meet the needs of most organizations and situations, and recommend leaving these settings at their default values if possible:
+
+- **Cache**: Keep [the cache](/reference/caching) enabled to let CodeRabbit temporarily remember details about your repository
+ between reviews, which improves review speed.
+- **Tools**: By default, CodeRabbit is allowed to use all of the [open-source linters and analyzer
+ tools](/tools) that are available to it during code reviews. This helps CodeRabbit keep its reviews broad and flexible.
+- **Knowledge base**: CodeRabbit [knowledge base](/integrations/knowledge-base/) features, including learnings and issue tracking, can require data retention. If your organization needs to meet stricter data-retention policies, then you can opt out of using these features.
+
+You can configure your use of the above features using the CodeRabbit web interface, or [a `.coderabbit.yaml` file](/getting-started/configure-coderabbit/).
+
+### Write specific CI/CD error messages {#pipeline}
+
+CodeRabbit can analyze the logs of continuous integration (CI) or continuous
+deployment (CD) tools in your pipeline. CodeRabbit can provide better remediation
+advice about CI/CD failures during code reviews if your tools' error messages
+are as specific as possible when reporting failures.
+
+For CodeRabbit to provide the best advice, configure your CI/CD failure output to include the following information:
+
+- File names associated with the failure.
+- Line numbers that identify where the failure occurred in those files.
+- An explanation of the failure, including relevant error codes or diffs.
+
+[This pull request](https://github.com/ff14-advanced-market-search/temp-fe/pull/47/files) shows an example of expanding the context of a CI error,
+in this case including a diff to show why a code-formatter check failed.
+
+---
+
+## What's next {#whats-next}
+
+- [Code review best practices](/guides/code-review-best-practices)
diff --git a/docs/guides/uninstall-vscode.md b/docs/guides/uninstall-vscode.md
new file mode 100644
index 00000000..27266d47
--- /dev/null
+++ b/docs/guides/uninstall-vscode.md
@@ -0,0 +1,25 @@
+---
+title: Uninstall the VSCode extension
+description: How to uninstall the CodeRabbit VSCode extension
+---
+
+This page is about uninstalling the CodeRabbit VSCode extension. For more information about the extension, see
+[Review local changes](/code-editors).
+
+:::note
+The instructions on this page are specific to using the extension with VSCode. If you are instead using a VSCode-compatible editor such as Cursor or Windsurf, then the steps that you need to follow are similar, but might require some adaptation.
+:::
+
+## Uninstall the extension
+
+To uninstall the VSCode extension, follow these steps:
+
+1. In the VSCode activity bar, click the CodeRabbit icon.
+
+1. In the CodeRabbit sidebar, click the door-shaped **Logout** icon.
+
+1. In the VSCode activity bar, click the **Extensions** icon.
+
+1. In the Extensions sidebar, click the gear-shaped **Manage** icon next to CodeRabbit in the list of installed extensions.
+
+1. Select **Uninstall**.
diff --git a/docs/guides/use-vscode.md b/docs/guides/use-vscode.md
new file mode 100644
index 00000000..169dc2a8
--- /dev/null
+++ b/docs/guides/use-vscode.md
@@ -0,0 +1,109 @@
+---
+title: Use the VSCode extension
+description: How to review your code with the VSCode extension.
+---
+
+This page is about performing local code reviews using the CodeRabbit VSCode extension. For more information about the extension, see
+[Review local changes](/code-editors). To learn how to install the extension, see [Install the VSCode extension](/guides/install-vscode).
+
+The CodeRabbit VSCode extension works by comparing changes in your current, checked-out Git branch against another branch in your local repository. You can use the extension to automatically perform full-branch changes after every commit, or make different kinds of comparisons by manually requesting a review.
+
+:::note
+The instructions on this page are specific to using the extension with VSCode. If you are instead using a VSCode-compatible editor such as Cursor or Windsurf, then the steps that you need to follow are similar, but might require some adaptation.
+:::
+
+## Automatically review local commits {#auto-reviews}
+
+You can let CodeRabbit automatically review commits that you make to your local Git repository. These automatic reviews compare all committed changes against the branch that your working branch is based on.
+
+To perform an automatic review, follow these steps:
+
+1. Perform a Git commit using VSCode or terminal. After you do this, a dialog appears in your VSCode window, asking **Would you like to start a review?**
+
+1. Click **Yes**. The CodeRabbit sidebar appears in your VSCode window.
+
+1. Wait for the review to complete. This might take a few minutes. To cancel a review in progress, click **Stop the review**.
+
+After the review completes, you can browse and respond to review comments as described in [Work with code reviews](#work).
+
+You can optionally configure the extension to either always or never perform automatic code reviews on commit, instead of displaying this yes-or-no dialog. For more information, see [Configure automatic review behavior](/guides/config-vscode#auto-reviews).
+
+For more control of code reviews performed using the CodeRabbit VSCode extension, you can manually request a review, as detailed in the following section.
+
+## Manually request code reviews {#manual-reviews}
+
+To manually review changes in a local Git branch using the CodeRabbit VSCode extension, follow these steps:
+
+1. Click the CodeRabbit icon in the VSCode activity bar. The CodeRabbit sidebar appears.
+
+1. If you want to compare your code changes to a branch other than its base branch, then follow these steps:
+
+ 1. In the sidebar, under **Branch**, click the name of the base branch. A **Select a base branch** dialog appears, listing other branches in your local Git repository.
+
+ 1. Select the name of a base branch to compare against.
+
+1. Select one of the review-action options from the menu at the bottom of the CodeRabbit sidebar:
+
+ - To review all changes between the base branch and your current branch, including both committed and uncommitted changes, select **Review all changes**. This is the default selection.
+
+ - To limit the review to only changes on your branch that you have committed, select **Review committed changes**. This includes commits that you have pushed to your remote repository, if any, as well as any local commits.
+
+ - To limit the review to only uncommitted changes on your branch, select **Review uncommitted changes**. This includes both staged and unstaged changes.
+
+1. Refer to the list of **Files to review** in the sidebar. This list represents all of the files that the selected review action includes. To change this list of files, repeat the previous step to choose a different review action, or use Git features like `git stash` to selectively remove changes.
+
+1. To perform the review, click the button part of the menu. The CodeRabbit sidebar displays a **Review** section with the review's progress.
+
+1. Wait for the review to complete. This might take a few minutes. To cancel a review in progress, click **Stop the review**.
+
+After the review completes, you can browse and respond to review comments as described in the following section.
+
+## Work with code reviews {#work}
+
+The CodeRabbit VSCode extension presents code reviews as a series of actionable comments, connected to specific files and lines. It gives you tools to apply its suggestions quickly, when possible.
+
+### Browse comments {#browse}
+
+After the extension finishes its review, it adds any comments to the CodeRabbit sidebar under the **Files** heading in the **Reviews** section.
+
+Each item in **Files** is a comment referring to one or more lines in that file. Click the comment to see a detailed, inline comment in the editor, attached to the appropriate file and lines.
+
+You can react to these comments however you want: you can apply their advice literally, or let them guide you to find alternate solutions, or ignore them entirely. CodeRabbit comments are metadata stored with VSCode, and are not part of your files. The presence of comments doesn't block your use of version control.
+
+### Apply suggested changes {#apply}
+
+Whenever possible, the CodeRabbit VSCode extension attaches discrete change suggestion to comments in the form of code diffs. For example, if it detects a typo in a new function name, the extension might attach a diff with a suggested correction.
+
+If you agree with CodeRabbit about the suggested fix and want to apply to exactly as it proposes, click the checkmark-shaped **Apply suggested change** icon in the inline comment. The extension makes the change for you in the editor.
+
+### Request help from your AI coding agent {#agent}
+
+If CodeRabbit determines that an AI coding agent could help with resolving one of its comments, then it adds a star-shaped **Fix with AI** icon to the inline display of that comment. To have the extension generate a request for an AI agent to address the comment, click this icon.
+
+Depending upon your IDE and the current extension settings, the extension performs one of the following actions:
+
+- If you are using VSCode with Copilot installed, then the extension can send the request directly to Copilot.
+- If you have Claude Code installed, then the extension can send the request to the `claude` command-line program.
+- As a fallback, the extension can copy the request, phrased as an AI prompt, to your clipboard. You can then manually paste this prompt into the coding AI of your IDE.
+
+For more information about configuring this behavior, see [Configure AI agent integration](/guides/config-vscode#agent).
+
+### Ignore or collapse comments {#ignore}
+
+To remove a comment from the editor, click its **Ignore** icon.
+
+To remove a comment but keep an icon in the editor noting its presence, click its **Collapse** icon.
+
+To see an ignored or collapsed comment in the editor again, click its summary in the CodeRabbit sidebar.
+
+### Browse previous reviews {#previous}
+
+If you have performed reviews prior to the most recent review in the current VSCode window, then you can browse the comments from these reviews under the **Previous reviews** heading in the CodeRabbit sidebar.
+
+If a past review comment no longer applies to the current state of your code, then clicking that comment won't display a detailed comment or suggestion in the editor.
+
+## What's next {#whats-next}
+
+- [Configure the VSCode extension](/guides/config-vscode)
+
+- [Uninstall the VSCode extension](/guides/uninstall-vscode)
diff --git a/docs/integrations/knowledge-base.md b/docs/integrations/knowledge-base.md
index 61ff141e..1da862e0 100644
--- a/docs/integrations/knowledge-base.md
+++ b/docs/integrations/knowledge-base.md
@@ -22,3 +22,21 @@ Or you can comment directly on some lines of code in the PR. `@coderabbitai do n
Watch our [video walkthrough on learnings](https://www.youtube.com/watch?v=Yu0cmmOYA-U) for more information.
:::
+
+## Code Guidelines {#code_guidelines}
+
+CodeRabbit will analyse and learn from your organisation's code guidelines, which you can set up in the knowledge base section. These guidelines will then be used to conduct thorough code reviews.
+
+The following patterns are scanned by default.
+
+```text
+**/.cursorrules
+.github/copilot-instructions.md
+**/CLAUDE.md
+**/.cursor/rules/*
+**/.windsurfrules
+**/.clinerules/*
+**/.rules/*
+```
+
+
diff --git a/docs/overview/introduction.md b/docs/overview/introduction.md
index e215f574..f937ac67 100644
--- a/docs/overview/introduction.md
+++ b/docs/overview/introduction.md
@@ -58,8 +58,8 @@ No matter how you tune and customize CodeRabbit, its default settings make it us
CodeRabbit integrates in just a few clicks with many popular Git platforms:
-- GitHub, including GitHub Enterprise Server
-- GitLab, including self-managed GitLab
+- GitHub, GitHub Enterprise Cloud, GitHub Enterprise Server,
+- GitLab, GitLab Self-Managed
- Azure DevOps
- Bitbucket Cloud
@@ -81,7 +81,6 @@ For more information, see [Issue Creation](/guides/issue-creation) and [Issue Ch
CodeRabbit collects only the minimum amount of information needed to provide you with our code review services. Our privacy and security posture centers around protecting your data through ephemerality:
- All queries to large language models (LLMs) exist in-memory only, with zero retention after each query completes.
-- We don't store a copy of your code.
- We don't use your code, code reviews, or other collected data to train LLMs.
- CodeRabbit doesn't share any collected customer data with third parties.
- We keep all customer data confidential, and isolated by organization.
@@ -95,8 +94,16 @@ Public repositories can use the Pro tier of CodeRabbit at no charge, including a
For private repositories, a number of pricing tiers are available. These range from a Free tier that offers unlimited code-change summaries, to an Enterprise tier with access to advanced features and SLA support. For more information, see [Pricing](https://www.coderabbit.ai/pricing).
+## Review local changes from within VSCode
+
+As a separate, free product, CodeRabbit offers a VSCode extension that brings a subset of core CodeRabbit features to VSCode. This lets you use the power of CodeRabbit to tune and tidy your code changes locally before pushing your changes into a formal pull request for more thorough reviews.
+
+For more information, see [Review local changes](/code-editors).
+
## What's next
- [Quickstart](/getting-started/quickstart/) lets you experience your first CodeRabbit code review first-hand.
+- [Review local changes](/code-editors) guides you through installing and using a subset of CodeRabbit features directly from your code editor.
+
- [Why CodeRabbit?](/overview/why-coderabbit) dives further into the philosophies and technologies that drive CodeRabbit.
diff --git a/docs/overview/why-coderabbit.md b/docs/overview/why-coderabbit.md
index cbdfc5f6..f04e347d 100644
--- a/docs/overview/why-coderabbit.md
+++ b/docs/overview/why-coderabbit.md
@@ -57,7 +57,7 @@ Your intelligent code review companion that understands context.
> From its foundation as a Generative AI-first platform, CodeRabbit has evolved to become the preferred code review tool among developers because of its speed, intelligence, adaptability, and support for features like contextual analysis, security scanning, and architectural insights. CodeRabbit supports all major programming languages and integrates with popular development [tools](/tools).
:::info Get Started
-If your team needs intelligent code reviews, CodeRabbit delivers. If you're new to AI-powered reviews, [sign up for a Free account](https://app.coderabbit.ai/login), join the [Discord server](https://discord.gg/coderabbit), and start the journey with us.
+If your team needs intelligent code reviews, CodeRabbit delivers. If you're new to AI-powered reviews, [sign up for a Free account](https://app.coderabbit.ai/login?free-trial), join the [Discord server](https://discord.gg/coderabbit), and start the journey with us.
:::
## CodeRabbit is Context-Aware
@@ -432,9 +432,9 @@ Try CodeRabbit on your next pull request. Experience how AI-powered code review
> Start reading more about the custom [code review instructions](/guides/review-instructions) or how CodeRabbit verify issues using [knowledge bases](/integrations/knowledge-base) like Linear and Jira.
-Transform your code reviews now, [Start your free trial today](https://app.coderabbit.ai/login) and join the Discord server and chat with CodeRabbit users and team.
+Transform your code reviews now, [Start your free trial today](https://app.coderabbit.ai/login?free-trial) and join the Discord server and chat with CodeRabbit users and team.
diff --git a/docs/platforms/bitbucket-cloud.md b/docs/platforms/bitbucket-cloud.md
index acb37f34..385d46ed 100644
--- a/docs/platforms/bitbucket-cloud.md
+++ b/docs/platforms/bitbucket-cloud.md
@@ -13,89 +13,90 @@ CodeRabbit integrates with Bitbucket Cloud to enhance code review and collaborat
This guide will assist you in effectively integrating CodeRabbit with Bitbucket Cloud.
-## Configure App Password
+## Configure API Token
-To enable CodeRabbit to interact with your Bitbucket repositories, an app password is required. This token grants the necessary permissions for interacting with the Merge Requests and Discussions APIs.
+To enable CodeRabbit to interact with your Bitbucket repositories, an API token is required. This token grants the
+necessary permissions for interacting with the Bitbucket merge request and discussion APIs.
1. Create a new Bitbucket account specifically for CodeRabbit and treat it as a service account.
2. Name the account "CodeRabbit".
-3. Generate an App Password to enable seamless integration between CodeRabbit and your Bitbucket repositories.
+3. If your Bitbucket workspace requires two-step verification, then you must also enable two-step verification on this
+ new account.
+4. Generate an API Token to enable seamless integration between CodeRabbit and your Bitbucket repositories.
-We recommend creating a new user as a service account, associating this user to the workspace you'd like to install CodeRabbit on, and providing CodeRabbit with the app password to allow access. During the installation process, CodeRabbit will automatically configure the required webhook for seamless integration.
-
-
-
-
-