+
-And supports all major programming languages and frameworks without requiring any special configuration.
+
-## Who should use CodeRabbit?
+:::tip DID YOU KNOW?
+CodeRabbit's AI can detect potential issues that would only surface in production, saving costly debugging time later.
+:::
-### Individual Developers
+## CodeRabbit is Adaptive
+
+Let the AI learn and grow with your team.
+
+Being an adaptive system means that CodeRabbit continuously learns from your team's practices and preferences without requiring manual configuration or rule setting. When reviewers accept or reject suggestions, CodeRabbit learns and applies these preferences to future reviews.
+
+### Real-World Example: Performance Optimization
+
+Here's a real example of how CodeRabbit identifies opportunities for performance improvement:
+
+
+
+
+
+
+
+ Intelligent Features
+
+
+ -
+
- Instant code understanding +
- Security vulnerability detection +
- Performance impact assessment +
- Architecture evaluation +
+
+
+
+
+
+ Context Analysis
+
+ Understanding context means analyzing how code changes affect the entire system, not just the modified files. This approach contrasts with traditional code review tools that only look at direct changes.
+
+
+
-### Development Teams
+
-- Standardize review processes
-- Reduce review bottlenecks
-- Share knowledge across the team
-- Maintain consistent code quality
+:::tip Learning from Feedback
+When you accept or reject these suggestions, CodeRabbit learns your team's preferences and adjusts future recommendations accordingly. This ensures that suggestions become increasingly relevant to your specific needs and coding standards.
+:::
-### Enterprises
+## CodeRabbit is Integrated
+
+Seamless integration with your existing workflow.
+
+CodeRabbit combines insights from multiple specialized tools into a single, coherent review:
+
+
+
+
+
+
+
+ Analyzes Patterns
+
+
+ -
+
- Identifies common performance bottlenecks +
- Learns from your codebase's patterns +
- Suggests modern best practices +
+
+
+
+
+
+ Provides Context
+
+
+ -
+
- Explains the reasoning behind suggestions +
- Highlights potential benefits +
- Offers committable suggestions +
+
-- Scale code review processes efficiently
-- Enforce security and compliance standards
-- Reduce technical debt
-- Accelerate development cycles
+But instead of flooding you with alerts, CodeRabbit provides curated, actionable feedback.
+
+## Tool Comparison
+
+
+
+
+
+
+
+ Security
+
+ Semgrep, Checkov
+
+
+
+
+
+
+
+ Style
+
+ ESLint, Prettier
+
+
+
+
+
+
+
+ Performance
+
+ Lighthouse
+
+
+
+
+
+
+
+ Dependencies
+
+ Dependabot
+
+
+
-:::tip Free for Open Source
-CodeRabbit is completely **FREE** for open-source projects. Our architecture enables us to provide a sustainable free tier that includes:
+:::note ENTERPRISE READY
+CodeRabbit is built for production environments with:
-- Unlimited public repositories
-- Full feature access
-- No credit card required
+- SOC 2 Type II certification
+- GDPR compliance
+- Zero data retention
+- Self-hosted options
:::
-## CodeRabbit Doesn't Lock You In
+## Start Reviewing Code in Seconds
-Built on open standards, easy to integrate and customize.
+> CodeRabbit makes it effortless to begin AI-powered code reviews. Our architecture enables instant setup and immediate code analysis, providing you with intelligent feedback within minutes.
-CodeRabbit:
+### Three Steps to Better Code Reviews
-- Works with your existing Git workflow
-- Requires minimal configuration
-- Supports standard code review protocols
-- Allows easy export of review data
-- Integrates with popular development tools
+1. **Sign in** with [GitHub](../platforms/github-com.md), [GitLab](../platforms/gitlab-com.mdx), or [Azure DevOps](../platforms/azure-devops.md)
+2. Select and add repositories in CodeRabbit dashboard
+3. That's it. You're good to go.
-## CodeRabbit Makes Code Reviews Easy
+:::tip INSTANT ACTIVATION
+CodeRabbit starts analyzing your first pull request immediately - no complex configuration needed.
+:::
-Set up automated code reviews in minutes.
+### What You'll Get
+
+
+
+
+
+
+
+ Immediate Analysis
+
+
+ -
+
- Scans changed files and dependencies +
- Identifies security vulnerabilities +
- Evaluates performance impact +
- Checks architectural consistency +
+
+
+
+
+
+ Communication
+
+
+ -
+
- Generates concise summary +
- Creates visual diagrams +
- Generates a changelist and walkthrough +
- Chat option +
+
+
+
+
+
+ Continuous Learning
+
+
+ -
+
- Remembers team preferences +
- Adapts to coding patterns +
- Shares knowledge across teams +
- Maintains consistent standards +
+
-1. Log in with GitHub, GitLab, or Azure DevOps
-2. Select repositories to review
-3. Create a pull request
-4. Watch CodeRabbit provide instant feedback
+### Quick Configuration Examples
-```bash
-# Example review feedback time
-Traditional Review: 24-48 hours
-CodeRabbit Review: < 5 minutes
-```
+
+
+
+
+
+
+ Immediate Benefits
+
+ - Instant PR analysis
+ - Security checks
+ - Style enforcement
+ - Performance insights
+
+
+
+
+
+
+
+ Team Features
+
+ - Custom review rules
+ - Team preferences
+ - Knowledge sharing
+ - Workflow integration
+
+
+
+
+
+
+
+ Advanced Tools
+
+ - Visual diagrams
+ - Impact analysis
+ - Batch suggestions
+ - Pattern detection
+
+
Sign Up Free
diff --git a/docs/platforms/_category_.yaml b/docs/platforms/_category_.yaml
index 185b2b05..8ae92cb7 100644
--- a/docs/platforms/_category_.yaml
+++ b/docs/platforms/_category_.yaml
@@ -1,4 +1,4 @@
-label: Git
+label: Git Platforms
position: 3
collapsible: true
collapsed: false
diff --git a/docs/platforms/azure-devops.md b/docs/platforms/azure-devops.md
index 7accacc6..12b70765 100644
--- a/docs/platforms/azure-devops.md
+++ b/docs/platforms/azure-devops.md
@@ -70,7 +70,7 @@ you will need to add the Personal Access Token.
management.
- **Use the CodeRabbit logo as the profile picture** - This further ensures easy
recognition. You can download our logo from
- [here](/img/integrations/logo.svg "download").
+ [here](/img/integrations/logo.png "download").
### Key Points to Remember
@@ -95,7 +95,8 @@ Follow these steps to generate the token:
accessible organizations."
6. Enter a name and an expiry date for the token.
7. We need to have read & write access to "Work Items" & "Code" to post reviews
- on pull requests.
+ on pull requests. If you are on the Pro tier also add "Build" access for pipeline
+ failure remediation.
8. Click "Create"
diff --git a/docs/platforms/bitbucket-cloud.md b/docs/platforms/bitbucket-cloud.md
new file mode 100644
index 00000000..acb37f34
--- /dev/null
+++ b/docs/platforms/bitbucket-cloud.md
@@ -0,0 +1,129 @@
+---
+title: "Bitbucket Cloud"
+description: "Learn how to integrate CodeRabbit with Bitbucket Cloud."
+sidebar_label: "Bitbucket Cloud"
+sidebar_position: 6
+---
+
+CodeRabbit integrates with Bitbucket Cloud to enhance code review and collaboration by:
+
+- Automatically initiating code reviews for newly created merge requests.
+- Displaying review comments and suggestions directly on merge requests.
+- Enabling seamless interaction with the CodeRabbit bot for real-time feedback and assistance.
+
+This guide will assist you in effectively integrating CodeRabbit with Bitbucket Cloud.
+
+## Configure App Password
+
+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.
+
+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.
+
+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.
+
+
AZURE_OPENAI_API_KEY=
-AZURE_GPT4OMINI_DEPLOYMENT_NAME=
-AZURE_GPT4O_DEPLOYMENT_NAME=
-## o1-mini is optional
-AZURE_O1_MINI_DEPLOYMENT_NAME=[]
-## o1-preview is optional: itโs very expensive but provides best reviews
-AZURE_O1_DEPLOYMENT_NAME=[]
-## gpt-4-turbo is optional: itโs expensive but provides better reviews than gpt-4o
-AZURE_GPT4TURBO_DEPLOYMENT_NAME=[]
+## it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+AZURE_GPT41MINI_DEPLOYMENT_NAME=
+AZURE_O4MINI_DEPLOYMENT_NAME=
+AZURE_O3_DEPLOYMENT_NAME=
+AZURE_GPT41_DEPLOYMENT_NAME=[]
+# optionally, deploy gpt-4o-mini instead of gpt-4.1-mini
+AZURE_GPT4OMINI_DEPLOYMENT_NAME=[]
+# optionally, deploy o3-mini instead of o4-mini
+AZURE_O3MINI_DEPLOYMENT_NAME=[]
+# optionally, deploy o1 instead of o3
+AZURE_O1_DEPLOYMENT_NAME=[]
+
+# OAuth2 Configuration (optional)
+# This will use client_credentials flow to get an access token,
+# and use it to make requests to the LLM provider.
+# Here is more information on this flow: https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-client-creds-grant-flow#first-case-access-token-request-with-a-shared-secret
+# It is expected that the response from the OAuth2 server will be in the format
+# {
+# "access_token": "",
+# "token_type": "Bearer",
+# "expires_in": 3599,
+# }
+OAUTH2_ENDPOINT=[]
+OAUTH2_CLIENT_ID=[]
+OAUTH2_CLIENT_SECRET=[]
+OAUTH2_SCOPE=[]
+
+HTTP_PROXY=[]
+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=
+AWS_SECRET_ACCESS_KEY=
+AWS_REGION=
TEMP_PATH=/cache
-AST_GREP_RULES_PATH=/home/jailuser/ast-grep-rules
-AST_GREP_ESSENTIALS=ast-grep-essentials
-
SELF_HOSTED=azure-devops
AZURE_DEVOPS_BOT_TOKEN=
AZURE_DEVOPS_BOT_USERNAME=
+
CODERABBIT_LICENSE_KEY=
-CODERABBIT_API_KEY=[]
-ENABLE_LEARNINGS=[true]
+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.
+OBJECT_STORE_URI=[]
JIRA_HOST=[]
JIRA_PAT=[]
LINEAR_PAT=[]
+
+ENABLE_WEB_SEARCH=[true]
+PERPLEXITY_API_KEY=[]
```
:::note
@@ -110,7 +147,7 @@ docker pull /coderabbit-agent:latest
### Verify the image is up
-You can query `/health` endpoint to verify that the coderabbit-agent service is up and running.
+You can query `/health` endpoint to verify that the `coderabbit-agent` service is up and running.
```bash
curl 127.0.0.1:8080/health
diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md
new file mode 100644
index 00000000..51cb1895
--- /dev/null
+++ b/docs/self-hosted/bitbucket.md
@@ -0,0 +1,157 @@
+---
+title: Use Self-Hosted CodeRabbit With Bitbucket Datacenter
+sidebar_label: Bitbucket Datacenter
+description: Instructions to self-host CodeRabbit and integrate it with Bitbucket Datacenter.
+sidebar_position: 4
+---
+
+:::note
+
+The self-hosted option is only available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](mailto:sales@coderabbit.ai) to learn more about the CodeRabbit Enterprise plan.
+
+:::
+
+## Create a Bitbucket User
+
+- **Username**: Set the username to "CodeRabbit" for easier identification (optional).
+- **Profile Image**: Use the CodeRabbitAI logo for the user image (optional).
+
+We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
+
+## Add User to Projects
+
+Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with permissions to:
+
+- Post reviews
+- Open pull requests
+
+## Create a Personal Access Token for CodeRabbit user
+
+Generate a personal access token for the CodeRabbit user to be added in the `.env` file as `BITBUCKET_SERVER_BOT_TOKEN`.
+
+## Add a webhook to each project
+
+1. **Navigate to Webhook Settings**: Go to the repository settings and locate the webhooks configuration page.
+2. **Configure Events**: Enable the following Pull Request events:
+ - "Opened"
+ - "Modified"
+ - "Comment Added"
+3. **Add Webhook URL**: Enter the URL pointing to the CodeRabbit service, followed by `/bitbucket_server_webhooks` (e.g., `http://127.0.0.1:8080/bitbucket_server_webhooks`).
+
+## Prepare a `.env` file
+
+Create a `.env` file with the following content:
+
+```bash
+# if using OpenAI
+LLM_PROVIDER=openai
+LLM_TIMEOUT=360000
+OPENAI_API_KEYS=
+OPENAI_BASE_URL=[]
+OPENAI_ORG_ID=[]
+OPENAI_PROJECT_ID=[]
+
+# if using Azure OpenAI
+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, gpt-4.1 (optionally).
+AZURE_GPT41MINI_DEPLOYMENT_NAME=
+AZURE_O4MINI_DEPLOYMENT_NAME=
+AZURE_O3_DEPLOYMENT_NAME=
+AZURE_GPT41_DEPLOYMENT_NAME=[]
+# optionally, deploy gpt-4o-mini instead of gpt-4.1-mini
+AZURE_GPT4OMINI_DEPLOYMENT_NAME=[]
+# optionally, deploy o3-mini instead of o4-mini
+AZURE_O3MINI_DEPLOYMENT_NAME=[]
+# optionally, deploy o1 instead of o3
+AZURE_O1_DEPLOYMENT_NAME=[]
+
+# OAuth2 Configuration (optional)
+# This will use client_credentials flow to get an access token,
+# and use it to make requests to the LLM provider.
+# Here is more information on this flow: https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-client-creds-grant-flow#first-case-access-token-request-with-a-shared-secret
+# It is expected that the response from the OAuth2 server will be in the format
+# {
+# "access_token": "",
+# "token_type": "Bearer",
+# "expires_in": 3599,
+# }
+OAUTH2_ENDPOINT=[]
+OAUTH2_CLIENT_ID=[]
+OAUTH2_CLIENT_SECRET=[]
+OAUTH2_SCOPE=[]
+
+HTTP_PROXY=[]
+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=
+AWS_SECRET_ACCESS_KEY=
+AWS_REGION=
+
+# System Configuration
+TEMP_PATH=/cache
+
+SELF_HOSTED=bitbucket-server
+
+BITBUCKET_SERVER_URL=/rest
+BITBUCKET_SERVER_WEBHOOK_SECRET=
+BITBUCKET_SERVER_BOT_TOKEN=
+BITBUCKET_SERVER_BOT_USERNAME=
+
+CODERABBIT_LICENSE_KEY=
+
+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.
+OBJECT_STORE_URI=[]
+
+JIRA_HOST=[]
+JIRA_PAT=[]
+
+LINEAR_PAT=[]
+
+ENABLE_WEB_SEARCH=[true]
+PERPLEXITY_API_KEY=[]
+```
+
+:::note
+
+- If you are using Azure OpenAI, verify that the model deployment names are in the .env file.
+ Values marked with [] are optional and can be omitted if the feature is not needed.
+- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
+
+:::
+
+## Pull the CodeRabbit Docker image
+
+Authenticate and pull the Docker image using the provided credentials file:
+
+```bash
+cat coderabbit.json | docker login -u _json_key --password-stdin us-docker.pkg.dev
+docker pull us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest
+```
+
+### Verify the image is up
+
+You can query `/health` endpoint to verify that the `coderabbit-agent` service is up and running.
+
+```bash
+curl 127.0.0.1:8080/health
+```
+
+## Host the image
+
+You can host the image on a server, serverless function, or container environment and expose port `8080`. Run the Docker image with the equivalent command on your chosen platform, ensuring you replace the `.env` file path with the path to your actual `.env` file:
+
+```bash
+docker run --env-file .env --publish 127.0.0.1:8080:8080 us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest
+```
diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md
index d3d9cec3..cce4296c 100644
--- a/docs/self-hosted/github.md
+++ b/docs/self-hosted/github.md
@@ -22,6 +22,7 @@ Set the following Repository permissions:
- Issues: Read & write
- Metadata: Read-only
- Pull requests: Read & write
+- Actions: Read-only
Set the following Organization permissions:
@@ -41,6 +42,8 @@ Set the following events:
- Push
- Release
+We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
+
## Gather information from the GitHub App
- App ID
@@ -64,14 +67,44 @@ LLM_PROVIDER=azure-openai
LLM_TIMEOUT=360000
AZURE_OPENAI_ENDPOINT=
AZURE_OPENAI_API_KEY=
-AZURE_GPT4OMINI_DEPLOYMENT_NAME=
-AZURE_GPT4O_DEPLOYMENT_NAME=
-## o1-mini is optional
-AZURE_O1_MINI_DEPLOYMENT_NAME=[]
-## o1-preview is optional: itโs very expensive but provides best reviews
-AZURE_O1_DEPLOYMENT_NAME=[]
-## gpt-4-turbo is optional: itโs expensive but provides better reviews than gpt-4o
-AZURE_GPT4TURBO_DEPLOYMENT_NAME=[]
+# it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+AZURE_GPT41MINI_DEPLOYMENT_NAME=
+AZURE_O4MINI_DEPLOYMENT_NAME=
+AZURE_O3_DEPLOYMENT_NAME=
+AZURE_GPT41_DEPLOYMENT_NAME=[]
+# optionally, deploy gpt-4o-mini instead of gpt-4.1-mini
+AZURE_GPT4OMINI_DEPLOYMENT_NAME=[]
+# optionally, deploy o3-mini instead of o4-mini
+AZURE_O3MINI_DEPLOYMENT_NAME=[]
+# optionally, deploy o1 instead of o3
+AZURE_O1_DEPLOYMENT_NAME=[]
+
+# OAuth2 Configuration (optional)
+# This will use client_credentials flow to get an access token,
+# and use it to make requests to the LLM provider.
+# Here is more information on this flow: https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-client-creds-grant-flow#first-case-access-token-request-with-a-shared-secret
+# It is expected that the response from the OAuth2 server will be in the format
+# {
+# "access_token": "",
+# "token_type": "Bearer",
+# "expires_in": 3599,
+# }
+OAUTH2_ENDPOINT=[]
+OAUTH2_CLIENT_ID=[]
+OAUTH2_CLIENT_SECRET=[]
+OAUTH2_SCOPE=[]
+
+HTTP_PROXY=[]
+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=
+AWS_SECRET_ACCESS_KEY=
+AWS_REGION=
# if using Anthropic
LLM_PROVIDER=anthropic
@@ -81,9 +114,6 @@ ANTHROPIC_BASE_URL=[]
TEMP_PATH=/cache
-AST_GREP_RULES_PATH=/home/jailuser/ast-grep-rules
-AST_GREP_ESSENTIALS=ast-grep-essentials
-
SELF_HOSTED=github
GH_WEBHOOK_SECRET=
@@ -95,26 +125,20 @@ GITHUB_APP_PEM_FILE=
CODERABBIT_LICENSE_KEY=
-CODERABBIT_API_KEY=[]
-# This will use your CodeRabbit API key to store learnings on our servers.
-ENABLE_LEARNINGS=[true]
+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.
+OBJECT_STORE_URI=[]
JIRA_HOST=[]
JIRA_PAT=[]
LINEAR_PAT=[]
-OAUTH2_ENDPOINT=[]
-OAUTH2_CLIENT_ID=[]
-OAUTH2_CLIENT_SECRET=[]
-
-# Set to true to use the on-prem knowledge base features. This will take precedence over the ENABLE_LEARNINGS flag above.
-SELF_HOSTED_KNOWLEDGE_BASE=[true]
-# The branch which CodeRabbit will store the knowledge base json files in.
-SELF_HOSTED_KNOWLEDGE_BASE_BRANCH=[coderabbitai/data]
-# URL to the host running ChromaDB 0.5.20.
-CHROMADB_URL=[http://chromadb:8000]
+ENABLE_WEB_SEARCH=[true]
+PERPLEXITY_API_KEY=[]
```
:::note
@@ -124,7 +148,7 @@ CHROMADB_URL=[http://chromadb:8000]
- For `GITHUB_APP_PEM_FILE`, flatten the PEM file by replacing newlines with `\n`.
- For `GITHUB_HOSTNAME`, use GitHub Enterprise server's hostname, for example, โgithub.acme-inc.comโ
- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
-- Refer to the [Self-hosted knowledge base](/integrations/knowledge-base#self-hosted) section for details on the `ON_PREM_KNOWLEDGE_BASE`.
+- When `ENABLE_LEARNINGS` is set to `true`, CodeRabbit will use `CODERABBIT_API_KEY` to store learnings on our servers.
:::
@@ -147,7 +171,7 @@ docker run --env-file .env --publish 127.0.0.1:8080:8080 /coder
### Verify the image is up
-You can query `/health` endpoint to verify that the coderabbit-agent service is up and running.
+You can query `/health` endpoint to verify that the `coderabbit-agent` service is up and running.
```bash
curl 127.0.0.1:8080/health
diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md
index e4275fe1..9b3a6a28 100644
--- a/docs/self-hosted/gitlab.md
+++ b/docs/self-hosted/gitlab.md
@@ -16,6 +16,8 @@ The self-hosted option is only available for CodeRabbit Enterprise customers wit
- **Username**: Set the username to "CodeRabbit" for easier identification (optional).
- **Profile Image**: Use the CodeRabbitAI logo for the user image (optional).
+We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
+
## Add User to Projects
Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with at least `Developer` access.
@@ -42,9 +44,9 @@ Consult official CodeRabbitAI documentation for a detailed [guide](https://docs.
- Issues events
- Merge request events
-## Prepare an `.env` file
+## Prepare a `.env` file
-Create an `.env` file with the following content:
+Create a `.env` file with the following content:
```bash
# if using OpenAI
@@ -60,14 +62,44 @@ LLM_PROVIDER=azure-openai
LLM_TIMEOUT=360000
AZURE_OPENAI_ENDPOINT=
AZURE_OPENAI_API_KEY=
-AZURE_GPT4OMINI_DEPLOYMENT_NAME=
-AZURE_GPT4O_DEPLOYMENT_NAME=
-## o1-mini is optional
-AZURE_O1_MINI_DEPLOYMENT_NAME=
-## o1-preview is optional: itโs very expensive but provides best reviews
-AZURE_O1_DEPLOYMENT_NAME=
-## gpt-4-turbo is optional: itโs expensive but provides better reviews
-AZURE_GPT4TURBO_DEPLOYMENT_NAME=[]
+## it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+AZURE_GPT41MINI_DEPLOYMENT_NAME=
+AZURE_O4MINI_DEPLOYMENT_NAME=
+AZURE_O3_DEPLOYMENT_NAME=
+AZURE_GPT41_DEPLOYMENT_NAME=[]
+# optionally, deploy gpt-4o-mini instead of gpt-4.1-mini
+AZURE_GPT4OMINI_DEPLOYMENT_NAME=[]
+# optionally, deploy o3-mini instead of o4-mini
+AZURE_O3MINI_DEPLOYMENT_NAME=[]
+# optionally, deploy o1 instead of o3
+AZURE_O1_DEPLOYMENT_NAME=[]
+
+# OAuth2 Configuration (optional)
+# This will use client_credentials flow to get an access token,
+# and use it to make requests to the LLM provider.
+# Here is more information on this flow: https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-client-creds-grant-flow#first-case-access-token-request-with-a-shared-secret
+# It is expected that the response from the OAuth2 server will be in the format
+# {
+# "access_token": "",
+# "token_type": "Bearer",
+# "expires_in": 3599,
+# }
+OAUTH2_ENDPOINT=[]
+OAUTH2_CLIENT_ID=[]
+OAUTH2_CLIENT_SECRET=[]
+OAUTH2_SCOPE=[]
+
+HTTP_PROXY=[]
+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=
+AWS_SECRET_ACCESS_KEY=
+AWS_REGION=
# if using Anthropic
LLM_PROVIDER=anthropic
@@ -77,23 +109,27 @@ ANTHROPIC_BASE_URL=[]
TEMP_PATH=/cache
-AST_GREP_RULES_PATH=/home/jailuser/ast-grep-rules
-AST_GREP_ESSENTIALS=ast-grep-essentials
-
SELF_HOSTED=gitlab
GITLAB_BOT_TOKEN=
GITLAB_WEBHOOK_SECRET=
+
CODERABBIT_LICENSE_KEY=
-CODERABBIT_API_KEY=[]
-ENABLE_LEARNINGS=[true]
+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.
+OBJECT_STORE_URI=[]
JIRA_HOST=[]
JIRA_PAT=[]
LINEAR_PAT=[]
+
+ENABLE_WEB_SEARCH=[true]
+PERPLEXITY_API_KEY=[]
```
:::note
diff --git a/docs/tools/_category_.yml b/docs/tools/_category_.yaml
similarity index 100%
rename from docs/tools/_category_.yml
rename to docs/tools/_category_.yaml
diff --git a/docs/tools/actionlint.md b/docs/tools/actionlint.md
index c05171f5..ab787e0d 100644
--- a/docs/tools/actionlint.md
+++ b/docs/tools/actionlint.md
@@ -1,10 +1,16 @@
---
-title: Actionlint
-sidebar_label: Actionlint
-description: CodeRabbit's guide to Actionlint.
+title: actionlint
+sidebar_label: actionlint
+description: CodeRabbit's guide to actionlint.
---
-[Actionlint](https://github.com/rhysd/actionlint/) is a static checker for
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+
+### Java Build & Testing
+
+- Maven/Gradle dependency conflicts
+- Compilation errors
+- Test failures
+- Memory allocation issues
+
+
+
+### Kubernetes Deployments
+
+- Service configuration validation
+- Resource allocation optimization
+- Network policy fixes
+- Security context remediation
+
+
+
+### NPM Package Management
+
+- Package resolution conflicts
+- Version compatibility issues
+- Security vulnerability patches
+- Build script optimization
+
+
+
+### Python Environment
+
+- Package dependency resolution
+- Virtual environment setup
+- Test framework configuration
+- Code style compliance
+
+
+
+### Security Scanning
+
+- SAST finding remediation
+- Code injection prevention
+- Security best practices
+- Compliance validation
+
+
+
+### Terraform and Infrastructure as Code
+
+- Resource configuration validation
+- State management issues
+- Provider compatibility
+- Security group optimization
+
+
+
+## Supported Platforms
+
+### GitHub Actions
+
+- Automatic detection of workflow failures
+- Inline fixes for common build issues
+- Integration with GitHub Checks
+- Support for custom actions and workflows
+
+### GitLab CI/CD
+
+- 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
+
+
+
+
+
+### CircleCI
+
+- CircleCI Pipeline failure analysis
+- Job-level error analysis
+- Configuration validation
+- Dependency resolution
+
+
+
+### Azure DevOps Pipelines
+
+- Azure DevOps CI/CD Pipeline failure analysis
+- Integration with Azure DevOps Checks
+- Support for custom tasks and pipelines
+- Remediation for build issues
+
+
+
+## Common Use Cases
+
+Our tool handles a wide range of pipeline failures including:
+
+### Build Failures
+
+- Docker build issues
+- Node.js dependency conflicts
+- Java compilation errors
+- Python package resolution
+- Go module management
+
+### Infrastructure as Code
+
+- Kubernetes manifest validation
+- Terraform template errors
+- CloudFormation stack issues
+- Ansible playbook failures
+
+### Security Pipeline Integration
+
+- SAST finding remediation
+- DAST vulnerability fixes
+- Dependency scanning
+- Container security
+
+### Testing Failures
+
+- Unit test failures
+- Integration test errors
+- End-to-end test issues
+- Performance test threshold violations
+
+## How It Works
+
+1. **Detection**: CodeRabbit monitors your pipeline runs and automatically detects failures
+2. **Analysis**: Our AI analyzes the failure logs and context to determine the root cause
+3. **Remediation**: We provide inline suggestions and automated fixes where possible
+4. **Learning**: The system learns from successful fixes to improve future recommendations
+
+## Best Practices
+
+1. **Keep Dependencies Updated**: Regular dependency updates help prevent build failures
+2. **Use Lock Files**: Lock files ensure consistent builds across environments
+3. **Implement Caching**: Proper caching strategies speed up builds and reduce failures
+4. **Monitor Resource Usage**: Ensure sufficient resources are allocated to prevent timeouts
+5. **Maintain Clean Tests**: Well-maintained tests reduce false positives
+
+## Links
+
+- [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 Pipeline Documentation](https://learn.microsoft.com/en-us/azure/devops/pipelines/get-started/pipelines-get-started?view=azure-devops)
diff --git a/docs/tools/pmd.md b/docs/tools/pmd.md
index 948083d1..31fc7144 100644
--- a/docs/tools/pmd.md
+++ b/docs/tools/pmd.md
@@ -4,7 +4,13 @@ sidebar_label: PMD
description: CodeRabbit's guide to PMD.
---
-[PMD](https://pmd.github.io/) is an extensible multilanguage static code analyzer. Itโs mainly concerned with Java.
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+.enabled` in your project's `.coderabbit.yaml` file or setting the "Review โ Tools โ Tool โ Enabled" field in CodeRabbit's settings page.
@@ -34,58 +42,6 @@ Remove extraneous f prefix
(F541)
```
-## Supported Tools
-
-| Technology | Tools | Category |
-| :-------------------------- | :--------------------------------------------------------- | :----------------------------- |
-| All | [Gitleaks][Gitleaks] | Code Security |
-| CircleCi | [CircleCi][CircleCi] | Configuration Validation |
-| 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] | Code Quality |
-| Go | [golangci-lint][golangci-lint] | Code Quality |
-| Helm | [Checkov][Checkov] | Code Security |
-| Javascript | [Biome][Biome] | Code Quality |
-| JSON, JSONC | [Biome][Biome] | Code Quality |
-| JSX | [Biome][Biome] | 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 |
-| Swift | [SwiftLint][SwiftLint] | Code Quality |
-| Terraform | [Checkov][Checkov] | Code Security |
-| TSX | [Biome][Biome] | Code Quality |
-| Typescript | [Biome][Biome] | Code Quality |
-| YAML | [YamlLint][YamlLint] | Code Quality |
-
-[ShellCheck]: ./shellcheck.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
+## What's next
+
+- For a complete list of tools that CodeRabbit supports, see [Supported tools](/tools/list).
diff --git a/docs/tools/yamllint.md b/docs/tools/yamllint.md
index 962a2a78..31649cf0 100644
--- a/docs/tools/yamllint.md
+++ b/docs/tools/yamllint.md
@@ -1,21 +1,27 @@
---
-title: Yamllint
-sidebar_label: Yamllint
-description: CodeRabbit's guide to Yamllint.
+title: YAMLlint
+sidebar_label: YAMLlint
+description: CodeRabbit's guide to YAMLlint.
---
-[Yamllint](https://yamllint.readthedocs.io/en/stable/) is a linter for YAML.
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+ 
+
+
+:::note
+
+If you wish to change the review user, you must provide the app password for the new user who will post reviews and comments. However, this requires manually removing the previous user from the projects and associated webhooks. Once this is done, you will need to reinstall the CodeRabbit app for each project.
+
+:::
+
+### Recommendations
+
+- **Create a dedicated user for CodeRabbit** - This ensures the user is exclusively for CodeRabbit, allowing better access control.
+- **Use "CodeRabbit" as the username** - This makes the user easily recognizable for future reference.
+- **Use a dedicated email address** - This helps in easy identification and management.
+- **Use the CodeRabbit logo as the profile picture** - This further ensures easy recognition. You can download our logo from [here](/img/integrations/logo.svg "download").
+- **Developer Access** Ensure the service account user has developer access to the projects that you wish to install CodeRabbit on.
+
+#### Key Points to Remember
+
+- Code reviews will be attributed to the owner of the app password.
+
+#### Generating an App password
+
+Bitbucket provides an option to generate an app password for a new user. Follow these steps to generate the password:
+
+1. Log in using the user designated for CodeRabbit reviews. This user serves as a service account for managing reviews and related activities.
+2. Go to "Personal Bitbucket Settings".
+3. Choose **App passwords**.
+4. Click **Create app password**.
+5. Enter a label easily recognizable for this app passwords usage.
+6. Ensure the following scopes are selected:
+ 1. Account - Read
+ 2. Issues - Write
+ 3. Workspace membership - Read
+ 4. Projects - Write
+ 5. Repositories - Write
+ 6. Pull requests - Write
+ 7. Webhooks - Read and write
+ 8. Pipelines - Read
+ 9. Runners - Read
+7. Click **Create**
+8. Note down the app password as it will only be displayed once.
+
+
+
+ 
+
+
+
+ 
+
+
+### Where to Provide CodeRabbit the App Password
+
+By default, if no app password is provided, CodeRabbit will prompt you to provide one during the installation process. However, if you wish to provide the token beforehand, you can do so by navigating to the **Organization Settings** tab, and selecting the **Bitbucket User** tab on the sidebar. Once entering the app password, the password will be validated and saved for future use.
+
+You can confirm the correct user is being selected by verifying the user ID shown on the UI with the user ID of the service account user you created.
+
+---
+
+### Installing CodeRabbit into your Bitbucket Repositories
+
+1. Go to the [Repositories page](https://app.coderabbit.ai/settings/repositories) in the CodeRabbit app.
+2. Select the checkbox next to the repositories where you want to install CodeRabbit. To install it on all repositories at once, select the checkbox at the top.
+3. Select **Install Repositories**.
+
+
+
+ 
+
+
+The webhook `https://coderabbit.ai/bitbucketHandler` will now be installed for the projects selected.
+
+
+
+ 
+
+
+### Troubleshooting
+
+:::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.
+
+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.
+
+:::
diff --git a/docs/platforms/github-com.md b/docs/platforms/github-com.md
index b368ce74..ecc07272 100644
--- a/docs/platforms/github-com.md
+++ b/docs/platforms/github-com.md
@@ -7,7 +7,7 @@ sidebar_position: 1
This is a step-by-step guide to integrate CodeRabbit with your GitHub repositories.
-> **CodeRabbit** is an AI code reviewer designed to ease the challenges of code review, supporting repository maintainers and teams. It not only reviews your PRs but also provides concise summaries, identifies potential issues, and offers insights that might be missed during manual reviews.
+> **CodeRabbit** is an AI code reviewer designed to ease the challenges of code review, supporting repository maintainers and teams. It reviews your PRs and provides concise summaries, identifies potential issues, and offers insights that might be missed during manual reviews.
## How CodeRabbit Works?
@@ -21,13 +21,13 @@ It preprocesses the PR content, builds context, leverages Large Language Models
### 1. Accessing CodeRabbit
-Visit the [Code Rabbit login](https://app.coderabbit.ai/login?free-trial) page. You'll see all the authentication options, select "**Login with GitHub**" to proceed.
+Visit the [CodeRabbit login](https://app.coderabbit.ai/login?free-trial) page. You'll see all the authentication options, select "**Login with GitHub**" to proceed.
### 2. Authorization
-When you choose **Login with GitHub** in step1 , you'll be prompted to authorize CodeRabbit.
+When you choose **Login with GitHub** in step1, you'll be prompted to authorize CodeRabbit.
> This step grants the necessary permissions for CodeRabbit to interact with your repositories and pull requests.
@@ -55,13 +55,15 @@ If you opt to authorize all repositories during setup, CodeRabbit will automatic
You can configure CodeRabbit through a YAML file or using the [App's UI](https://app.coderabbit.ai/login).
-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.
+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.
:::note
-If a coderabbit.yaml file exists in your GitHub repository, it takes precedence over any UI settings. Choose either the YAML file or UI configuration - you don't need to use both. **Refer Coderabbit.yaml schema [here](https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json)**
+
+If a `.coderabbit.yaml` file exists in your GitHub repository, it takes precedence over any UI settings. Choose either the YAML file or UI configuration - you don't need to use both. **Refer CodeRabbit YAML schema [here](https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json)**
+
:::
-Once your coderabbit.yaml file is prepared according to your needs, simply place it in your GitHub repository, and you're all setโCodeRabbit is now integrated.
+Once your `.coderabbit.yaml` file is prepared according to your needs, simply place it in your GitHub repository, and you're all set โ CodeRabbit is now integrated.
> When a pull request is created targeting the master branch, CodeRabbit automatically initiates its review process. It analyzes the changes and generates a summary and walkthrough of the modifications. The specific feedback and analysis provided by CodeRabbit are determined by the options you've configured in your YAML file.
@@ -89,7 +91,7 @@ The sequence diagram illustrates the precise flow of interactions between the ob
-Also check out the response when i asked for what improvements can be done on the code level
+Also, check out the response when asked for what improvements can be done on the code level.
@@ -97,7 +99,7 @@ In addition to providing reviews and summaries, **CodeRabbit** can also detect c
> For example, I accidentally set up both CodeRabbit Pro (The process we've been discussing) and the open-source version (Refer to [different config process](https://github.com/coderabbitai/ai-pr-reviewer?tab=readme-ov-file#install-instructions)) in my repository at the same time.
-Interestingly, CodeRabbit automatically detects and alerts you about configuration conflicts.
+CodeRabbit automatically detects and alerts you about configuration conflicts.
@@ -107,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 cb0e8084..733607cb 100644
--- a/docs/platforms/github-enterprise-server.md
+++ b/docs/platforms/github-enterprise-server.md
@@ -75,8 +75,7 @@ steps below to
[create a GitHub App](https://docs.github.com/en/enterprise-server@latest/apps/creating-github-apps/registering-a-github-app/registering-a-github-app):
1. Sign in to your GitHub Enterprise account.
-2. In the upper-right corner of any page, click your profile photo, then click
- **Settings**.
+2. In the upper-right corner of any page, click your profile photo, then click **Settings**.
3. In the left sidebar, click **Developer settings** > **GitHub Apps**
4. Click **New GitHub App**.
5. Set the following fields:
@@ -90,8 +89,10 @@ steps below to
- **Webhook secret**: Use a secure string and keep it handy.
- **Permissions**:
- **Repository permissions**:
+ - **Actions**: Read-only
- **Checks**: Read-only
- **Contents**: Read and write
+ - **Commit statuses**: Read and write
- **Discussions**: Read-only
- **Issues**: Read and write
- **Metadata**: Read-only
@@ -110,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**
@@ -129,6 +131,8 @@ Keep the following details handy:
+We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
+
### **Step 4: CodeRabbit UI Onboarding**
Submit the details that were accumulated in previous steps:
@@ -166,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/gitlab-com.md b/docs/platforms/gitlab-com.md
deleted file mode 100644
index ebff5ce4..00000000
--- a/docs/platforms/gitlab-com.md
+++ /dev/null
@@ -1,70 +0,0 @@
----
-title: Integrating CodeRabbit with GitLab.com
-description: Learn how to integrate CodeRabbit and add to your GitLab workflow.
-sidebar_label: GitLab.com
-sidebar_position: 2
----
-
-This guide will assist you in effectively integrating CodeRabbit with SaaS GitLab.
-
-## How it works
-
-For the CodeRabbit app to post reviews on merge requests, it needs to interact with the GitLab API, which requires a Personal Access Token. This token can be generated either by using our default CodeRabbit user or by creating a Personal Access Token from one of your existing users.
-
-The CodeRabbit default user, named "coderabbitai", is already set up in GitLab SaaS and will be added to your project when you install the CodeRabbit app. During installation, the necessary webhook for the project will also be created.
-
-If your organization prefers to use an organization user, you can create a new user in GitLab and generate a Personal Access Token for that user, following [our recommendations](#recommendations).
-
-:::note
-
-Keep in mind that if you want to change the review user, you can either disable the organization user or add a new user via the CodeRabbit UI. However, this will require manually removing the previous user from the projects and associated webhooks. Afterward, you will need to reinstall the CodeRabbit app for each project.
-
-:::
-
-## GitLab Access Tokens
-
-To interact with the GitLab API, a **Personal Access Token** is required. This token can either be generated by using our default CodeRabbit user or by creating a **Personal Access Token** from one of your existing users.
-
-Upon first login to the application (immediately after the onboarding screen), you will need to choose based on your organization's requirements.
-
-
-
-**We recommend using the default CodeRabbit user** for most organizations, as it is pre-configured. However, we understand that some organizations may prefer more control over the user or have restrictions regarding user inclusion within their organization.
-
-### Personal Access Tokens
-
-If your organization opts to use another user within the organization, you can do so by [generating a personal access token](#generating-a-personal-access-token).
-
-
-
-#### Recommendations
-
-- **Create a dedicated user for CodeRabbit** - This ensures the user is exclusively for CodeRabbit, allowing better access control.
-- **Use "CodeRabbit" as the username** - This makes the user easily recognizable for future reference.
-- **Use a dedicated email address** - This helps in easy identification and management.
-- **Use the CodeRabbit logo as the profile picture** - This further ensures easy recognition. You can download our logo from [here](/img/integrations/logo.svg "download").
-
-#### Key Points to Remember
-
-- Personal access tokens have expiration dates. Ensure the expiration date covers the duration of your intended use of the CodeRabbit app.
-- Code reviews will be attributed to the owner of the personal access token.
-- If the personal access token expires, you can add a new one via the CodeRabbit UI:
- - Navigate to the "GitLab User" page in the sidebar.
- - Click the "Update" button on the displayed card to see the same modal as the initial login.
-
-### Generating a Personal Access Token
-
-GitLab provides an option to generate a personal access token for a new user. Follow these steps to generate the token:
-
-1. Log in as the user intended for CodeRabbit reviews.
-2. Select your avatar on the left sidebar.
-3. Choose "Edit Profile."
-4. Select "Access Tokens" from the left sidebar.
-5. Click "Add New Token."
-6. Enter a name and an expiry date for the token.
-7. If no expiry date is entered, it defaults to 365 days from the current date.
-8. Ensure the following scopes are selected: `api`, `read_api`, `read_user`.
-9. Click "Create Personal Access Token."
-10. Note down the token as it will only be displayed once.
-
-
diff --git a/docs/platforms/gitlab-com.mdx b/docs/platforms/gitlab-com.mdx
new file mode 100644
index 00000000..c276cd35
--- /dev/null
+++ b/docs/platforms/gitlab-com.mdx
@@ -0,0 +1,154 @@
+---
+title: Integrating CodeRabbit with GitLab.com
+description: Learn how to integrate CodeRabbit and add to your GitLab workflow.
+sidebar_label: GitLab.com
+sidebar_position: 2
+---
+
+CodeRabbit integrates with GitLab to enhance code review and collaboration by:
+
+- Automatically initiating code reviews for newly created merge requests.
+- Displaying review comments and suggestions directly on merge requests.
+- Enabling seamless interaction with the CodeRabbit bot for real-time feedback and assistance.
+
+This guide will assist you in effectively integrating CodeRabbit with SaaS GitLab.
+
+## GitLab Access Tokens
+
+To enable CodeRabbit to interact with your GitLab repositories, an access token is required. This token grants the necessary permissions for interacting with the Merge Requests and Discussions APIs.
+
+ 1. Personal Access Token (PAT): You can create a new GitLab account specifically for CodeRabbit, name it โCodeRabbitโ and treat it as a service account. Then generate a PAT from it where PAT will enable seamless integration between CodeRabbit and your GitLab repositories.
+ 2. Group Access Token: If your organization uses GitLab Premium or Ultimate, you can generate a Group Access Token. This option automatically creates a bot user associated with the group for managing access and posting reviews.
+
+### Personal Access Token
+
+We recommend creating a new user as a service account, associating this user to the group you'd like to install CodeRabbit on, and providing CodeRabbit with the personal access token to allow access. During the installation process, CodeRabbit will automatically configure the required webhook for seamless integration.
+
+
+
+ 
+
+
+:::note
+
+If you wish to change the review user, you must provide the access token for the new user who will post reviews and comments. However, this requires manually removing the previous user from the projects and associated webhooks. Once this is done, you will need to reinstall the CodeRabbit app for each project.
+
+:::
+
+
+
+ 
+
+
+#### Recommendations
+
+- **Create a dedicated user for CodeRabbit** - This ensures the user is exclusively for CodeRabbit, allowing better access control.
+- **Use "CodeRabbit" as the username** - This makes the user easily recognizable for future reference.
+- **Use a dedicated email address** - This helps in easy identification and management.
+- **Use the CodeRabbit logo as the profile picture** - This further ensures easy recognition. You can download our logo from [here](/img/integrations/logo.svg "download").
+- **Ensure Developer Access** - Ensure the dedicated user has (at least) **Developer** access to the group or projects that you wish to install CodeRabbit on.
+
+#### Key Points to Remember
+
+- Personal access tokens have expiration dates. Ensure the expiration date **covers the duration** of your intended use of CodeRabbit.
+- Code reviews will be attributed to the owner of the personal access token.
+- If the personal access token expires, you can add a new one via the CodeRabbit UI:
+ - Navigate to the **GitLab User** page in the sidebar.
+ - Enter the new Access token, and click the **Update** button on the page.
+
+#### Generating a Personal Access Token
+
+GitLab provides an option to generate a personal access token for a new user. Follow these steps to generate the token:
+
+1. Log in using the user designated for CodeRabbit reviews. This user serves as a service account for managing reviews and related activities.
+2. Select your avatar on the left sidebar.
+3. Choose **Edit Profile**.
+4. Select **Access Tokens** from the left sidebar.
+5. Click [Add New Token.](https://gitlab.com/-/user_settings/personal_access_tokens)
+6. Enter a name and an expiry date for the token.
+7. If no expiry date is entered, it defaults to 365 days from the current date.
+8. Ensure the following scopes are selected: `api`, `read_api`, `read_user`.
+9. Click **Create Personal Access Token**
+10. Note down the token as it will only be displayed once.
+
+
+
+ 
+
+
+---
+
+### Group Access Token
+
+Creating a Group Access Token in GitLab automatically generates a bot user. Ensure that the token is configured with Developer access. Once set up, you only need to provide this token for integration. Note that a Group Access Token is limited to the scope of the group where it was created. To configure additional groups, you will need to generate a separate Group Access Token for each group.
+
+:::note
+
+By default, GitLab restricts this option to users on the Premium or Ultimate tiers.
+
+:::
+
+#### Generating a Group Access Token
+
+1. Navigate to the group you wish to install CodeRabbit on.
+2. Select **Settings** from the left sidebar.
+3. Select **Access Tokens** within the Settings heading.
+4. Create a Group Access Token.
+5. Ensure the following scopes are selected: `api`.
+6. Ensure Developer Access is provided.
+
+---
+
+### Where to Provide CodeRabbit the Access Token
+
+By default, if no access token is provided, CodeRabbit will prompt you to provide one during the installation process. However, if you wish to provide the token beforehand, you can do so by navigating to the **Organization Settings** tab, and selecting the **GitLab User** tab on the sidebar. Once entering the token, the token will be validated and saved for future use.
+
+You can confirm the correct user is being selected by verifying the user ID shown on the UI with the user ID of the service account user you created.
+
+---
+
+### Installing CodeRabbit into your GitLab Repositories
+
+1. Go to the [Repositories page](https://app.coderabbit.ai/settings/repositories) in the CodeRabbit app.
+2. Select the checkbox next to the repositories where you want to install CodeRabbit. To install it on all repositories at once, select the checkbox at the top.
+3. Select **Install Repositories**.
+
+
+
+
+
+
+The webhook `https://coderabbit.ai/gitlabHandler` will now be installed for the projects selected.
+
+
+
+ 
+
+
+### Troubleshooting
+
+:::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.
+
+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 GitLab user has the necessary permissions to install the webhook and the PAT is not expired.
+
+:::
diff --git a/docs/platforms/platforms.md b/docs/platforms/platforms.md
index 038b329c..996089fc 100644
--- a/docs/platforms/platforms.md
+++ b/docs/platforms/platforms.md
@@ -1,8 +1,6 @@
---
-title: Supported Git Platforms
-sidebar_label: Supported Git Platforms
+title: Integrate with Git platforms
description: Overview of CodeRabbit's supported Git platforms.
-sidebar_position: 1
---
CodeRabbit supports various Git platforms to provide code review for your repositories. For the cloud-hosted Git platforms, you can [login][login] to CodeRabbit and add your repositories. The following platforms are supported:
@@ -11,28 +9,27 @@ CodeRabbit supports various Git platforms to provide code review for your reposi
| Host | Support |
| ------------------------ | ---------------------------------------- |
-| GitHub.com | [Supported][login] |
+| GitHub.com | [Supported](github-com.md) |
| GitHub Enterprise Server | [Supported](github-enterprise-server.md) |
## GitLab
| Host | Support |
| ------------------- | ---------------------------------- |
-| GitLab.com | [Supported](gitlab-com.md) |
+| GitLab.com | [Supported](gitlab-com.mdx) |
| GitLab Self Managed | [Supported](self-hosted-gitlab.md) |
## Azure DevOps
-| Host | Support |
-| ------------------- | ---------------------------- |
-| Azure DevOps | [Supported](azure-devops.md) |
-| Azure DevOps Server | [Supported] |
+| Host | Support |
+| ------------ | ---------------------------- |
+| Azure DevOps | [Supported](azure-devops.md) |
## Bitbucket
-| Host | Support |
-| --------------------- | ----------- |
-| Cloud | Coming soon |
-| Bitbucket Data Center | Coming soon |
+| Host | Support |
+| -------------------- | ---------------------------------------- |
+| Bitbucket Datacenter | [Supported](../self-hosted/bitbucket.md) |
+| Bitbucket Cloud | [Supported](./bitbucket-cloud.md) |
[login]: https://app.coderabbit.ai/login
diff --git a/docs/platforms/self-hosted-gitlab.md b/docs/platforms/self-hosted-gitlab.md
index 4ef7623c..3fa18a71 100644
--- a/docs/platforms/self-hosted-gitlab.md
+++ b/docs/platforms/self-hosted-gitlab.md
@@ -71,6 +71,8 @@ After the user is created, you can retrieve the **User ID** from that user's
profile and generate an [**access token**](#generating-personal-access-token).
The access token is used to post reviews on merge requests.
+We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
+
#### **Creating OAuth2 application**
For self-managed GitLab, we recommend creating an instance-wide application
@@ -120,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/review-commands.md b/docs/reference/review-commands.md
new file mode 100644
index 00000000..011bf9d5
--- /dev/null
+++ b/docs/reference/review-commands.md
@@ -0,0 +1,47 @@
+---
+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 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/self-hosted/_category_.yaml b/docs/self-hosted/_category_.yaml
index 1025807f..84f0b578 100644
--- a/docs/self-hosted/_category_.yaml
+++ b/docs/self-hosted/_category_.yaml
@@ -1,4 +1,4 @@
-label: Self-Hosted
+label: Self-Hosted CodeRabbit
position: 4
collapsible: true
collapsed: false
diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md
index c02cb7e8..f1a820a3 100644
--- a/docs/self-hosted/azure-devops.md
+++ b/docs/self-hosted/azure-devops.md
@@ -11,11 +11,13 @@ The self-hosted option is only available for CodeRabbit Enterprise customers wit
:::
-## Create a Azure DevOps User
+## Create an Azure DevOps User
- **Username**: Set the username to "CodeRabbit" for easier identification (optional).
- **Profile Image**: Use the CodeRabbitAI logo for the user image (optional).
+We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
+
## Add User to Projects
Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with rights to post reviews & open PRs.
@@ -28,6 +30,7 @@ Generate a personal access token for the CodeRabbit user to be added in the `.en
- `Code` - Full
- `Work Items` - Read, write, and manage
+- `Build` - Read
Consult official CodeRabbitAI documentation for a detailed [guide](https://docs.coderabbit.ai/platforms/azure-devops#generating-a-personal-access-token) on creating personal access tokens.
@@ -61,34 +64,68 @@ LLM_PROVIDER=azure-openai
LLM_TIMEOUT=360000
AZURE_OPENAI_ENDPOINT=
+
+
+### Java Build & Testing
+
+- Maven/Gradle dependency conflicts
+- Compilation errors
+- Test failures
+- Memory allocation issues
+
+
+
+### Kubernetes Deployments
+
+- Service configuration validation
+- Resource allocation optimization
+- Network policy fixes
+- Security context remediation
+
+
+
+### NPM Package Management
+
+- Package resolution conflicts
+- Version compatibility issues
+- Security vulnerability patches
+- Build script optimization
+
+
+
+### Python Environment
+
+- Package dependency resolution
+- Virtual environment setup
+- Test framework configuration
+- Code style compliance
+
+
+
+### Security Scanning
+
+- SAST finding remediation
+- Code injection prevention
+- Security best practices
+- Compliance validation
+
+
+
+### Terraform and Infrastructure as Code
+
+- Resource configuration validation
+- State management issues
+- Provider compatibility
+- Security group optimization
+
+
+
+## Supported Platforms
+
+### GitHub Actions
+
+- Automatic detection of workflow failures
+- Inline fixes for common build issues
+- Integration with GitHub Checks
+- Support for custom actions and workflows
+
+### GitLab CI/CD
+
+- 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
+
+
+
+
+
+### CircleCI
+
+- CircleCI Pipeline failure analysis
+- Job-level error analysis
+- Configuration validation
+- Dependency resolution
+
+
+
+### Azure DevOps Pipelines
+
+- Azure DevOps CI/CD Pipeline failure analysis
+- Integration with Azure DevOps Checks
+- Support for custom tasks and pipelines
+- Remediation for build issues
+
+
+
+## Common Use Cases
+
+Our tool handles a wide range of pipeline failures including:
+
+### Build Failures
+
+- Docker build issues
+- Node.js dependency conflicts
+- Java compilation errors
+- Python package resolution
+- Go module management
+
+### Infrastructure as Code
+
+- Kubernetes manifest validation
+- Terraform template errors
+- CloudFormation stack issues
+- Ansible playbook failures
+
+### Security Pipeline Integration
+
+- SAST finding remediation
+- DAST vulnerability fixes
+- Dependency scanning
+- Container security
+
+### Testing Failures
+
+- Unit test failures
+- Integration test errors
+- End-to-end test issues
+- Performance test threshold violations
+
+## How It Works
+
+1. **Detection**: CodeRabbit monitors your pipeline runs and automatically detects failures
+2. **Analysis**: Our AI analyzes the failure logs and context to determine the root cause
+3. **Remediation**: We provide inline suggestions and automated fixes where possible
+4. **Learning**: The system learns from successful fixes to improve future recommendations
+
+## Best Practices
+
+1. **Keep Dependencies Updated**: Regular dependency updates help prevent build failures
+2. **Use Lock Files**: Lock files ensure consistent builds across environments
+3. **Implement Caching**: Proper caching strategies speed up builds and reduce failures
+4. **Monitor Resource Usage**: Ensure sufficient resources are allocated to prevent timeouts
+5. **Maintain Clean Tests**: Well-maintained tests reduce false positives
+
+## Links
+
+- [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 Pipeline Documentation](https://learn.microsoft.com/en-us/azure/devops/pipelines/get-started/pipelines-get-started?view=azure-devops)
diff --git a/docs/tools/pmd.md b/docs/tools/pmd.md
index 948083d1..31fc7144 100644
--- a/docs/tools/pmd.md
+++ b/docs/tools/pmd.md
@@ -4,7 +4,13 @@ sidebar_label: PMD
description: CodeRabbit's guide to PMD.
---
-[PMD](https://pmd.github.io/) is an extensible multilanguage static code analyzer. Itโs mainly concerned with Java.
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+