# Table of Contents - [Introduction - CodeRabbit](#introduction-coderabbit) - [Changelog - CodeRabbit](#changelog-coderabbit) - [CodeRabbit for VS Code, Cursor, and Windsurf Is Here 🎉 - CodeRabbit](#coderabbit-for-vs-code-cursor-and-windsurf-is-here-coderabbit) - [Issue Validation - CodeRabbit](#issue-validation-coderabbit) - [Enhanced PHP Static Analysis: PHPMD and PHPCS Support - CodeRabbit](#enhanced-php-static-analysis-phpmd-and-phpcs-support-coderabbit) - [Enhanced Reporting Capabilities - CodeRabbit](#enhanced-reporting-capabilities-coderabbit) - [GDPR Compliance - CodeRabbit](#gdpr-compliance-coderabbit) - [Dark theme support for UI App - CodeRabbit](#dark-theme-support-for-ui-app-coderabbit) - [Self-hosted GitLab Integration - CodeRabbit](#self-hosted-gitlab-integration-coderabbit) - [Enhanced Markdown Review - CodeRabbit](#enhanced-markdown-review-coderabbit) - [Enhanced Python Static Analysis: nbqa Support for Jupyter Notebooks - CodeRabbit](#enhanced-python-static-analysis-nbqa-support-for-jupyter-notebooks-coderabbit) - [YML File Customization - CodeRabbit](#yml-file-customization-coderabbit) - [Microsoft Teams Integration & Bitbucket Support - CodeRabbit](#microsoft-teams-integration-bitbucket-support-coderabbit) - [Related PRs and Label suggestions - CodeRabbit](#related-prs-and-label-suggestions-coderabbit) - [Resolve Command - CodeRabbit](#resolve-command-coderabbit) - [Introducing CodeRabbit for GitLab Integration - CodeRabbit](#introducing-coderabbit-for-gitlab-integration-coderabbit) - [Integrate MCP servers - CodeRabbit](#integrate-mcp-servers-coderabbit) - [Review local changes - CodeRabbit](#review-local-changes-coderabbit) - [Early Access Program - CodeRabbit](#early-access-program-coderabbit) - [Manage your subscription - CodeRabbit](#manage-your-subscription-coderabbit) - [Add a configuration file - CodeRabbit](#add-a-configuration-file-coderabbit) - [Add organizations - CodeRabbit](#add-organizations-coderabbit) - [Get support - CodeRabbit](#get-support-coderabbit) - [Security and SAST Remediation Improvements - CodeRabbit](#security-and-sast-remediation-improvements-coderabbit) - [Shopify CLI Integration & Bitbucket Cloud Reporting - CodeRabbit](#shopify-cli-integration-bitbucket-cloud-reporting-coderabbit) - [Streamlined Multi-Repository Installation for GitLab and Azure DevOps - CodeRabbit](#streamlined-multi-repository-installation-for-gitlab-and-azure-devops-coderabbit) - [Generate unit tests - CodeRabbit](#generate-unit-tests-coderabbit) - [Quickstart - CodeRabbit](#quickstart-coderabbit) - [Generate docstrings - CodeRabbit](#generate-docstrings-coderabbit) - [Control and manage code reviews - CodeRabbit](#control-and-manage-code-reviews-coderabbit) - [Code review troubleshooting - CodeRabbit](#code-review-troubleshooting-coderabbit) - [Set permissions - CodeRabbit](#set-permissions-coderabbit) - [Support for On-premises Learning and GitLab Follow-up Issue Creation - CodeRabbit](#support-for-on-premises-learning-and-gitlab-follow-up-issue-creation-coderabbit) - [New Dashboard - CodeRabbit](#new-dashboard-coderabbit) - [Configure the VSCode extension - CodeRabbit](#configure-the-vscode-extension-coderabbit) - [Create issues - CodeRabbit](#create-issues-coderabbit) - [Request Changes Workflow - CodeRabbit](#request-changes-workflow-coderabbit) - [GitLab Pipeline Failure Detection and Remediation - CodeRabbit](#gitlab-pipeline-failure-detection-and-remediation-coderabbit) - [CodeRabbit Chat - CodeRabbit](#coderabbit-chat-coderabbit) - [Install the VSCode extension - CodeRabbit](#install-the-vscode-extension-coderabbit) - [Overview - CodeRabbit](#overview-coderabbit) - [Generate improvements - CodeRabbit](#generate-improvements-coderabbit) - [Lua Support with Luacheck - CodeRabbit](#lua-support-with-luacheck-coderabbit) - [New Features and Improvements - CodeRabbit](#new-features-and-improvements-coderabbit) - [Learnings and Metrics Iteration for CodeRabbit Self-Hosted Customers - CodeRabbit](#learnings-and-metrics-iteration-for-coderabbit-self-hosted-customers-coderabbit) - [Organization preferences - CodeRabbit](#organization-preferences-coderabbit) - [Overview - CodeRabbit](#overview-coderabbit) - [Repository preferences - CodeRabbit](#repository-preferences-coderabbit) - [Generate reports on demand - CodeRabbit](#generate-reports-on-demand-coderabbit) - [Issue Chat - CodeRabbit](#issue-chat-coderabbit) - [Overview - CodeRabbit](#overview-coderabbit) - [Unit Test Generation - Beta - CodeRabbit](#unit-test-generation-beta-coderabbit) - [New Security and Code Quality Tools - CodeRabbit](#new-security-and-code-quality-tools-coderabbit) - [Teach CodeRabbit your review preferences - CodeRabbit](#teach-coderabbit-your-review-preferences-coderabbit) - [Linked Issues - CodeRabbit](#linked-issues-coderabbit) - [Static Analyzers and Linters Integration - CodeRabbit](#static-analyzers-and-linters-integration-coderabbit) - [Role based access - CodeRabbit](#role-based-access-coderabbit) - [New Features and Improvements - CodeRabbit](#new-features-and-improvements-coderabbit) - [Use the VSCode extension - CodeRabbit](#use-the-vscode-extension-coderabbit) - [Uninstall the VSCode extension - CodeRabbit](#uninstall-the-vscode-extension-coderabbit) - [Knowledge base - CodeRabbit](#knowledge-base-coderabbit) - [Use with self-hosted CodeRabbit - CodeRabbit](#use-with-self-hosted-coderabbit-coderabbit) - [Setup best practices - CodeRabbit](#setup-best-practices-coderabbit) - [Integrate issue tracking - CodeRabbit](#integrate-issue-tracking-coderabbit) - [Schedule reports - CodeRabbit](#schedule-reports-coderabbit) - [Initial configuration guide - CodeRabbit](#initial-configuration-guide-coderabbit) - [Caching - CodeRabbit](#caching-coderabbit) - [Code review best practices - CodeRabbit](#code-review-best-practices-coderabbit) - [ Code Graph Analysis - CodeRabbit](#-code-graph-analysis-coderabbit) - [Linear Issue Creation - CodeRabbit](#linear-issue-creation-coderabbit) - [SOC 2 Type II Compliance - CodeRabbit](#soc-2-type-ii-compliance-coderabbit) - [Code review commands - CodeRabbit](#code-review-commands-coderabbit) - [Customize reports - CodeRabbit](#customize-reports-coderabbit) - [New Static Analysis Tools - CodeRabbit](#new-static-analysis-tools-coderabbit) - [Multiple Features Release - CodeRabbit](#multiple-features-release-coderabbit) - [GitLab - CodeRabbit](#gitlab-coderabbit) - [Azure DevOps - CodeRabbit](#azure-devops-coderabbit) - [Bitbucket Cloud - CodeRabbit](#bitbucket-cloud-coderabbit) - [On-prem GitLab - CodeRabbit](#on-prem-gitlab-coderabbit) - [New Features and Improvements - CodeRabbit](#new-features-and-improvements-coderabbit) - [Path-Based Review Instructions - CodeRabbit](#path-based-review-instructions-coderabbit) - [GitHub - CodeRabbit](#github-coderabbit) - [Overview - CodeRabbit](#overview-coderabbit) - [GitHub Enterprise Server - CodeRabbit](#github-enterprise-server-coderabbit) - [Linters & security analysis tools - CodeRabbit](#linters-security-analysis-tools-coderabbit) - [Configuration file template - CodeRabbit](#configuration-file-template-coderabbit) - [Why CodeRabbit? - CodeRabbit](#why-coderabbit-coderabbit) - [Introduction - CodeRabbit](#introduction-coderabbit) - [On-prem CodeRabbit & Azure DevOps - CodeRabbit](#on-prem-coderabbit-azure-devops-coderabbit) - [On-prem CodeRabbit & GitHub - CodeRabbit](#on-prem-coderabbit-github-coderabbit) - [Configure third-party tool use - CodeRabbit](#configure-third-party-tool-use-coderabbit) - [Introduction - CodeRabbit](#introduction-coderabbit) - [Review instructions - CodeRabbit](#review-instructions-coderabbit) - [FAQs - CodeRabbit](#faqs-coderabbit) - [On-prem CodeRabbit & GitLab - CodeRabbit](#on-prem-coderabbit-gitlab-coderabbit) - [Unit Test Generation, Early Access - CodeRabbit](#unit-test-generation-early-access-coderabbit) - [Integrate with Git platforms - CodeRabbit](#integrate-with-git-platforms-coderabbit) - [Configuration reference - CodeRabbit](#configuration-reference-coderabbit) - [On-prem CodeRabbit & Bitbucket Datacenter - CodeRabbit](#on-prem-coderabbit-bitbucket-datacenter-coderabbit) - [Biome - CodeRabbit](#biome-coderabbit) - [actionlint - CodeRabbit](#actionlint-coderabbit) - [Brakeman - CodeRabbit](#brakeman-coderabbit) - [Buf - CodeRabbit](#buf-coderabbit) - [golangci-lint - CodeRabbit](#golangci-lint-coderabbit) - [Checkmake - CodeRabbit](#checkmake-coderabbit) - [Dotenv Linter - CodeRabbit](#dotenv-linter-coderabbit) - [CircleCI - CodeRabbit](#circleci-coderabbit) - [Checkov - CodeRabbit](#checkov-coderabbit) - [Regal - CodeRabbit](#regal-coderabbit) - [Shopify CLI - CodeRabbit](#shopify-cli-coderabbit) - [ShellCheck - CodeRabbit](#shellcheck-coderabbit) - [SwiftLint - CodeRabbit](#swiftlint-coderabbit) - [SQLFluff - CodeRabbit](#sqlfluff-coderabbit) - [Hadolint - CodeRabbit](#hadolint-coderabbit) - [PMD - CodeRabbit](#pmd-coderabbit) - [Oxlint - CodeRabbit](#oxlint-coderabbit) - [RuboCop - CodeRabbit](#rubocop-coderabbit) - [LanguageTool - CodeRabbit](#languagetool-coderabbit) - [PHPStan - CodeRabbit](#phpstan-coderabbit) - [Clippy - CodeRabbit](#clippy-coderabbit) - [PHPMD - CodeRabbit](#phpmd-coderabbit) - [Prisma Lint - CodeRabbit](#prisma-lint-coderabbit) - [Pipeline Failure Remediation - CodeRabbit](#pipeline-failure-remediation-coderabbit) - [Luacheck - CodeRabbit](#luacheck-coderabbit) - [detekt - CodeRabbit](#detekt-coderabbit) - [markdownlint - CodeRabbit](#markdownlint-coderabbit) - [ESLint - CodeRabbit](#eslint-coderabbit) - [Pylint - CodeRabbit](#pylint-coderabbit) - [List of supported tools - CodeRabbit](#list-of-supported-tools-coderabbit) - [OSV-Scanner - CodeRabbit](#osv-scanner-coderabbit) - [Gitleaks - CodeRabbit](#gitleaks-coderabbit) - [Flake8 - CodeRabbit](#flake8-coderabbit) - [Semgrep - CodeRabbit](#semgrep-coderabbit) - [HTMLHint - CodeRabbit](#htmlhint-coderabbit) - [PHPCS - CodeRabbit](#phpcs-coderabbit) - [Ruff - CodeRabbit](#ruff-coderabbit) - [Cppcheck - CodeRabbit](#cppcheck-coderabbit) - [Linters & security analysis tools - CodeRabbit](#linters-security-analysis-tools-coderabbit) - [Integrate with Git platforms - CodeRabbit](#integrate-with-git-platforms-coderabbit) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) --- # Introduction - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Get started Introduction On this page * [Core features](https://docs.coderabbit.ai/overview/introduction#core-features) * [Easier to review pull requests](https://docs.coderabbit.ai/overview/introduction#easier-to-review-pull-requests) * [Uses AI to do in-depth code reviews](https://docs.coderabbit.ai/overview/introduction#uses-ai-to-do-in-depth-code-reviews) * [Automatic handling of finishing touches of pull requests](https://docs.coderabbit.ai/overview/introduction#automatic-handling-of-finishing-touches-of-pull-requests) * [Embedded in your Pull Requests](https://docs.coderabbit.ai/overview/introduction#embedded-in-your-pull-requests) * [Learns from every interaction](https://docs.coderabbit.ai/overview/introduction#learns-from-every-interaction) * [Supports major Git platforms](https://docs.coderabbit.ai/overview/introduction#supports-major-git-platforms) * [Integrate with issue trackers](https://docs.coderabbit.ai/overview/introduction#integrate-with-issue-trackers) * [Data privacy and security](https://docs.coderabbit.ai/overview/introduction#data-privacy-and-security) * [Flexible pricing, free for public repositories](https://docs.coderabbit.ai/overview/introduction#flexible-pricing%2C-free-for-public-repositories) * [Review local changes from within your IDE](https://docs.coderabbit.ai/overview/introduction#review-local-changes-from-within-your-ide) * [What’s next](https://docs.coderabbit.ai/overview/introduction#what%E2%80%99s-next) This page provides a conceptual introduction to CodeRabbit. For a hands-on tutorial, see [Quickstart](https://docs.coderabbit.ai/getting-started/quickstart) . **CodeRabbit** is an AI-powered code reviewer that delivers context-aware feedback on pull requests. CodeRabbit helps by: Making it easier to review pull requests. Using AI to do in-depth code reviews. Automatically handling finishing touches of pull requests. Developers can interact directly with the CodeRabbit bot within their existing Git platform’s pull request interface to add context, ask questions, or even have the bot generate code. Over time, **CodeRabbit learns from user input and improves its suggestions**. [​](https://docs.coderabbit.ai/overview/introduction#core-features) Core features ------------------------------------------------------------------------------------ Core CodeRabbit features include the following: #### [​](https://docs.coderabbit.ai/overview/introduction#easier-to-review-pull-requests) Easier to review pull requests Set of features that make it easier to review pull requests. Get a rundown of the changes, a diagram, and institutionalize knowledge via chat. Summary ------- Creates an AI-generated summary of the code changes in a pull request. Walkthrough ----------- Creates a table with the files changed, and a one line summary of the changes. Diagram ------- Creates a diagram of the code changes in a pull request. Chat to learn ------------- Chat with CodeRabbit about the code changes in a pull request. #### [​](https://docs.coderabbit.ai/overview/introduction#uses-ai-to-do-in-depth-code-reviews) Uses AI to do in-depth code reviews CodeRabbit uses a multi-step process to achieve the best AI pull reviews in the market. Features include: Code guidelines --------------- Automatically detects and applies code guidelines for Cursor, Claude Code, Cline and more. Code graph ---------- Creates a graph of the code changes in a pull request. Learnings --------- Learns and adapts to your team’s code style and review preferences through chat, code guidelines, and path-based instructions. Sandbox ------- Creates an ephemeral sandbox environment to test code changes in a pull request. 40+ linters ----------- Applies dozens of open-source, industry-standard code analyzers to every commit. Web search ---------- Uses web search to find up-to-date information about libraries, frameworks, and other code. AI code reviews --------------- Implements code reviews as familiar pull-request comments. Code suggestions ---------------- Provides code suggestions you can copy/paste, commit directly, or a prompt you can paste into your AI IDE. IDE extensions -------------- Review local changes from within VSCode, Cursor, Windsurf, and many more. Linked issues ------------- Reviews any issues linked to the pull request to verify that they are addressed. #### [​](https://docs.coderabbit.ai/overview/introduction#automatic-handling-of-finishing-touches-of-pull-requests) Automatic handling of finishing touches of pull requests Unit tests ---------- Generate unit tests with the click of a checkbox. Docstrings ---------- Generate docstrings for your code. [​](https://docs.coderabbit.ai/overview/introduction#embedded-in-your-pull-requests) Embedded in your Pull Requests ---------------------------------------------------------------------------------------------------------------------- CodeRabbit shares its reviews as comments attached to pull requests, using the same Git platform that your team already uses. Further commits in the same pull request prompt CodeRabbit to make further reviews, using the earlier reviews as context. Each time that it performs a code review, CodeRabbit runs the relevant code changes through [an array of industry-standard code linters, security analyzers, and other tools](https://docs.coderabbit.ai/tools) . CodeRabbit synthesizes the output of these tools into its reviews, offering a high-level analysis that can suggest areas for further focus and improvement. Your team can have conversations with CodeRabbit about its reviews by replying to it with follow-up comments on pull requests, asking it questions or making observations about the review using natural language. CodeRabbit continues the conversation appropriately, offering further insights about the code changes, or adjusting its own review style based on feedback. ### [​](https://docs.coderabbit.ai/overview/introduction#learns-from-every-interaction) Learns from every interaction As you interact with CodeRabbit through chat, it learns the review preferences of your team, and applies them to all future reviews on a given repository. For example, if CodeRabbit uses a linter to suggest that your pull request use four-space indentations, but your team uses a two-space indentation style, then you can reply to CodeRabbit’s pull-request comment to tell it exactly that. CodeRabbit acknowledges your feedback and adjusts all of its subsequent reviews with that repository appropriately. For a video introduction to this feature, see [CodeRabbit Learnings](https://www.youtube.com/watch?v=Yu0cmmOYA-U) . If you need to fine-tune CodeRabbit’s behavior beyond this, then you can [add a CodeRabbit-specific configuration file](https://docs.coderabbit.ai/getting-started/configure-coderabbit) to your repository, or use the CodeRabbit web UI to set further preferences. This file can include [path-based instructions](https://docs.coderabbit.ai/guides/review-instructions) for how CodeRabbit should review different files within your codebase. No matter how you tune and customize CodeRabbit, its default settings make it useful out of the box, able to meaningfully review pull requests within minutes of its introduction to a repository. ### [​](https://docs.coderabbit.ai/overview/introduction#supports-major-git-platforms) Supports major Git platforms CodeRabbit integrates in just a few clicks with many popular Git platforms: [GitHub\ ------\ \ GitHub, GitHub Enterprise Cloud, GitHub Enterprise Server](https://docs.coderabbit.ai/platforms/github-com) [GitLab\ ------\ \ GitLab, GitLab Self-Managed](https://docs.coderabbit.ai/platforms/gitlab-com) [Azure DevOps\ ------------\ \ Azure DevOps](https://docs.coderabbit.ai/platforms/azure-devops) [Bitbucket\ ---------\ \ Bitbucket Cloud, Bitbucket Server](https://docs.coderabbit.ai/platforms/bitbucket-cloud) For more information, see [Supported Git Platforms](https://docs.coderabbit.ai/platforms) . CodeRabbit also offers a self-hosted option available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](https://docs.coderabbit.ai/cdn-cgi/l/email-protection#c4b7a5a8a1b784a7aba0a1b6a5a6a6adb0eaa5ad) to learn more about the CodeRabbit Enterprise plan. ### [​](https://docs.coderabbit.ai/overview/introduction#integrate-with-issue-trackers) Integrate with issue trackers You can integrate CodeRabbit with issue-management platforms. This lets you ask CodeRabbit to create tickets during code reviews, or chat with CodeRabbit about your code from within issue comments. Compatible platforms include the following: * GitHub Issues * GitLab Issues * Jira * Linear For more information, see [Issue Creation](https://docs.coderabbit.ai/guides/issue-creation) and [Issue Chat](https://docs.coderabbit.ai/guides/issue-chat) . [​](https://docs.coderabbit.ai/overview/introduction#data-privacy-and-security) Data privacy and security ------------------------------------------------------------------------------------------------------------ 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 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. * Our data collection and storage practices comply with SOC 2 and GDPR standards. For more information about how we protect your data, see [the CodeRabbit Trust Center](https://trust.coderabbit.ai/) . [​](https://docs.coderabbit.ai/overview/introduction#flexible-pricing%2C-free-for-public-repositories) Flexible pricing, free for public repositories -------------------------------------------------------------------------------------------------------------------------------------------------------- Public repositories can use the Pro tier of CodeRabbit at no charge, including all of the code-review features described on this page. Rate limits might apply. 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) . [​](https://docs.coderabbit.ai/overview/introduction#review-local-changes-from-within-your-ide) Review local changes from within your IDE -------------------------------------------------------------------------------------------------------------------------------------------- As a separate, free product, CodeRabbit offers a VSCode extension that brings a subset of core CodeRabbit features to VSCode, Cursor, Windsurf, and more. 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](https://docs.coderabbit.ai/code-editors) . [​](https://docs.coderabbit.ai/overview/introduction#what%E2%80%99s-next) What’s next ---------------------------------------------------------------------------------------- * [Quickstart](https://docs.coderabbit.ai/getting-started/quickstart) lets you experience your first CodeRabbit code review first-hand. * [Review local changes](https://docs.coderabbit.ai/code-editors) guides you through installing and using a subset of CodeRabbit features directly from your code editor. * [Why CodeRabbit?](https://docs.coderabbit.ai/overview/why-coderabbit) dives further into the philosophies and technologies that drive CodeRabbit. [Quickstart](https://docs.coderabbit.ai/getting-started/quickstart) Assistant Responses are generated using AI and may contain mistakes. --- # Changelog - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Changelog [​](https://docs.coderabbit.ai/changelog#undefined) August 14, 2025 ### [​](https://docs.coderabbit.ai/changelog#osv-scanner-integration) OSV-Scanner integration We’ve added support for [OSV-Scanner](https://github.com/google/osv-scanner) , Google’s vulnerability scanner that identifies security vulnerabilities in your project’s dependencies and installed packages using the [OSV.dev](https://osv.dev/) database. [​](https://docs.coderabbit.ai/changelog#undefined) August 13, 2025 ### [​](https://docs.coderabbit.ai/changelog#coderabbit-vs-code-extension-v1-0) CodeRabbit VS Code extension v1.0 The VS Code extension now delivers the same powerful PR reviews directly in your IDE, with one-click fixes and full integration with your favorite AI coding tools. Code with AI, review with CodeRabbit, apply fixes instantly—all without before you even commit.What’s new: * `Apply all` fixes at once sends every suggestion to your AI coding tool with one click * Full context awareness for Pro accounts (Learnings, code quality tools, security checks, agent guidelines) * Users can now provide feedback on individual suggestions * Support for additional AI coding tools: Cline, Roo, Kilo Code, Augment Code, and Codex CLI Download the [VS Code extension](https://coderabbit.link/GPWYdai) and start reviewing PRs directly in your IDE. [​](https://docs.coderabbit.ai/changelog#undefined) August 4, 2025 ### [​](https://docs.coderabbit.ai/changelog#integrate-mcp-servers-early-access) Integrate MCP servers - Early Access Pro users can now connect CodeRabbit to external MCP servers to provide more context for code reviews. Our AI automatically pulls relevant information from your documentation, project management tools, and internal wikis to better understand your code changes and business requirements.Connect any custom or third-party MCP servers through Settings > Integrations to get reviews and chat conversations that understand your full development context. Or read the [docs](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations) for more details. [​](https://docs.coderabbit.ai/changelog#undefined) August 1, 2025 ### [​](https://docs.coderabbit.ai/changelog#dark-theme-support-for-ui-app) Dark theme support for UI App CodeRabbit app now supports Light, Dark, and System themes. Use the new theme toggle next to your profile to switch modes. [​](https://docs.coderabbit.ai/changelog#undefined) July 23, 2025 ![unit tests in beta - UI in a PR](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/changelog/unit-test-beta.png) ### [​](https://docs.coderabbit.ai/changelog#%E2%9A%A1%EF%B8%8F-unit-test-generation-beta) ⚡️ Unit Test Generation - Beta CodeRabbit’s unit test generation is now available in Beta! Automatically generate comprehensive unit tests for your code changes, ensuring better test coverage and catching edge cases you might miss. Our AI analyzes your code structure and creates tests that follow best practices and your project’s testing patterns.Learn more [here](https://docs.coderabbit.ai/finishing-touches/unit-test-generation) , or just try it under ✨ Finishing Touches. [​](https://docs.coderabbit.ai/changelog#undefined) July 17, 2025 ### [​](https://docs.coderabbit.ai/changelog#enhanced-reporting-capabilities) Enhanced Reporting Capabilities We’re excited to announce significant improvements to our reporting system that will make your automated reports more powerful and actionable! #### [​](https://docs.coderabbit.ai/changelog#exclusion-filters-with-not-in-option) Exclusion Filters with NOT\_IN Option Reports now support exclusion filters using the `NOT_IN` option, allowing you to filter out pull requests based on their repository, label, user, or team. This gives you more granular control over what appears in your reports, helping you focus on the most relevant information. #### [​](https://docs.coderabbit.ai/changelog#next-steps-section-in-daily-standup-reports) Next Steps Section in Daily Standup Reports We’ve enhanced the default daily standup report template to include a “Next Steps” section. This provides clear guidance on what actions authors and reviewers should take regarding each pull request or change, making your reports more actionable and helping teams stay on track. #### [​](https://docs.coderabbit.ai/changelog#ci%2Fcd-github-action-check-status-awareness) CI/CD GitHub Action Check Status Awareness Reports now include CI/CD GitHub Action check status as a data source. Your reports will be aware of which CI/CD checks are failing or passing, giving you better visibility into the health of your pull requests and helping identify potential issues before they become blockers. #### [​](https://docs.coderabbit.ai/changelog#score-card-custom-report-option) Score Card Custom Report Option We’ve added a new optional score card report feature that allows you to grade and create report cards for your developers. This custom report optional data source provides a structured way to evaluate developer performance and contributions. See our [custom reports documentation](https://docs.coderabbit.ai/guides/custom-reports#remove-prs-without-a-score-cardchart-bot-comment) for more details on how to implement score cards in your reports. [​](https://docs.coderabbit.ai/changelog#undefined) July 10, 2025 ### [​](https://docs.coderabbit.ai/changelog#enhanced-python-static-analysis%3A-nbqa-support-for-jupyter-notebooks) Enhanced Python Static Analysis: nbqa Support for Jupyter Notebooks We’re excited to announce enhanced Python static analysis capabilities with nbqa support for Jupyter Notebooks!Our existing integrated [Ruff](https://docs.astral.sh/ruff/) , [Flake8](https://flake8.pycqa.org/) and [Pylint](https://pylint.pycqa.org/) tools now support linting Jupyter Notebooks (`.ipynb` files) using [nbqa](https://github.com/nbQA-dev/nbQA) . This allows you to maintain code quality across your Python projects, including Jupyter Notebooks.See our [Ruff](https://docs.coderabbit.ai/tools/ruff) , [Flake8](https://docs.coderabbit.ai/tools/flake8) , and [Pylint](https://docs.coderabbit.ai/tools/pylint) documentation for more details. [​](https://docs.coderabbit.ai/changelog#undefined) July 3, 2025 ### [​](https://docs.coderabbit.ai/changelog#enhanced-python-static-analysis%3A-flake8-support) Enhanced Python Static Analysis: Flake8 Support We’re excited to announce enhanced Python static analysis capabilities with [Flake8](https://flake8.pycqa.org/) support![Flake8](https://flake8.pycqa.org/) is a Python linting utility that wraps PyFlakes, pycodestyle, and Mccabe to check your Python code for style and logical errors.See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details. [​](https://docs.coderabbit.ai/changelog#undefined) July 1, 2025 ### [​](https://docs.coderabbit.ai/changelog#enhanced-code-guidelines-support) Enhanced Code Guidelines Support We’ve expanded our code guidelines scanning capabilities to provide even better code review experiences. CodeRabbit now automatically scans and learns from additional configuration files to understand your organization’s coding standards and preferences.**New supported patterns:** * `**/.cursorrules` - Cursor IDE rules and preferences * `.github/copilot-instructions.md` - GitHub Copilot instructions * `**/CLAUDE.md` - Claude-specific coding guidelines * `**/.cursor/rules/*` - Cursor rules directory * `**/.windsurfrules` - Windsurf IDE rules * `**/.clinerules/*` - Cline IDE rules * `**/.rules/*` - General rules directory These guidelines are automatically analyzed and applied during code reviews to ensure consistency with your team’s coding standards. You can configure these patterns in the knowledge base section of your CodeRabbit settings. [​](https://docs.coderabbit.ai/changelog#undefined) June 27, 2025 ### [​](https://docs.coderabbit.ai/changelog#enhanced-php-static-analysis%3A-phpmd-and-phpcs-support) Enhanced PHP Static Analysis: PHPMD and PHPCS Support We’re excited to announce enhanced PHP static analysis capabilities with two powerful new tools! * [PHPMD](https://phpmd.org/) (PHP Mess Detector) is a static analysis tool that detects potential problems in your PHP code such as possible bugs, suboptimal code, overcomplicated expressions, and unused parameters, variables, methods, and classes. * [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer) (PHP CodeSniffer) is a development tool that ensures your PHP code conforms to coding standards like PSR-1, PSR-2, PSR-12, and custom standards. It can automatically fix many coding standard violations. See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details. [​](https://docs.coderabbit.ai/changelog#undefined) June 11, 2025 ### [​](https://docs.coderabbit.ai/changelog#enhanced-static-analysis%3A-htmlhint-and-checkmake-support) Enhanced Static Analysis: HTMLHint and Checkmake Support We’re excited to announce that two new static analysis tools are now supported on CodeRabbit! * [HTMLHint](https://htmlhint.com/) is a static code analysis tool for HTML that helps maintain code quality by detecting common mistakes and enforcing best practices. * [Checkmake](https://github.com/mrtazz/checkmake) is a linter for Makefiles that helps ensure your build scripts follow best practices and maintain consistency. [​](https://docs.coderabbit.ai/changelog#undefined) June 10, 2025 ### [​](https://docs.coderabbit.ai/changelog#unit-test-generation%2C-early-access) Unit Test Generation, Early Access We’re excited to announce that our new unit test generation feature is now available in early access! CodeRabbit can now automatically generate unit tests for your code changes.Key capabilities: * **Intelligent Test Generation**: Automatically creates unit tests that cover edge cases, error scenarios, and core functionality * **Context-Aware**: Generates tests that understand your existing codebase patterns and testing conventions * **One-Click Integration**: Simply comment `@coderabbitai generate unit tests` on any pull request or specific file, or click on the checkbox available in the walkthrough comment for Early Access customers. You can customize the generated tests to fit your specific requirements. [​](https://docs.coderabbit.ai/changelog#undefined) June 5, 2025 ### [​](https://docs.coderabbit.ai/changelog#enhanced-static-analysis%3A-dotenv-linter-and-pylint-support) Enhanced Static Analysis: Dotenv Linter and Pylint Support We’re excited to announce that two new static analysis tools are now supported on CodeRabbit! * [Dotenv Linter](https://github.com/dotenv-linter/dotenv-linter) is a fast, opinionated linter for `.env` files that helps prevent misconfigurations by detecting typos, invalid syntax, and duplicated keys. * [Pylint](https://github.com/PyCQA/pylint) is a widely used static analysis and code quality tool for Python. It checks for errors, enforces coding standards, and looks for code smells in your Python codebase. [​](https://docs.coderabbit.ai/changelog#undefined) May 25, 2025 ### [​](https://docs.coderabbit.ai/changelog#new-security-and-code-quality-tools) New Security and Code Quality Tools We’re excited to announce the addition of two powerful tools to our static analysis arsenal: * **Brakeman**: A static analysis security vulnerability scanner for Ruby on Rails applications. It helps identify security issues in your Ruby codebase by analyzing Gemfile, Ruby files (_.rb), and ERB templates (_.erb). * **Clippy**: The official linter for Rust code, helping catch common mistakes and improve your Rust code quality. It analyzes \*.rs files and supports configuration through clippy.toml files. Both tools can be configured through their respective config files or through CodeRabbit’s settings page. See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details. [​](https://docs.coderabbit.ai/changelog#undefined) May 19, 2025 ### [​](https://docs.coderabbit.ai/changelog#lua-support-with-luacheck) Lua Support with Luacheck We’re excited to announce enhanced support for Lua code analysis with [Luacheck](https://github.com/mpeterv/luacheck) , a powerful static analyzer and linter for Lua code. [​](https://docs.coderabbit.ai/changelog#undefined) May 14, 2025 ### [​](https://docs.coderabbit.ai/changelog#coderabbit-for-vs-code%2C-cursor%2C-and-windsurf-is-here-%F0%9F%8E%89) CodeRabbit for VS Code, Cursor, and Windsurf Is Here 🎉 We’re thrilled to announce that CodeRabbit’s AI code reviews have officially landed inside **VS Code and all its forks, including Cursor and Windsurf!** No more review bottlenecks or context switches: now you can get _instant, inline feedback right in your editor, completely free._**Why you’ll love it:** * 📝 **Inline Code Reviews**: Senior-dev-level annotation on every line. CodeRabbit becomes your AI pair programmer, annotating staged & unstaged commits before you even open a PR. * 🚀 **Built for Flow, Not Friction**: Code, review, commit—rise & repeat without breaking your flow state. Reviews run automatically on every commit so you ship faster. * 🛠️ **Fix-with-AI**: One-Click Fix for quick tweaks; “Fix with AI” hands off more complex suggestions to your favorite coding agent, complete with full context. * 🧩 **Compatible with Cursor, Windsurf & Language-Agnostic**: Works out of the box on VS Code, Cursor, Windsurf. Supports Java, JavaScript, PHP, Python, TypeScript, Go, Ruby, and more. Pair these IDE-embedded reviews with our deeper Git-platform reviews for a multi-layered approach that catches more bugs and cuts down overall review time. * [Join the launch discussion on Discord](https://discord.com/channels/1134356397673414807/1145813948193575023/1372210767838842950) * [Install the CodeRabbit VSCode Extension](https://coderabbit.link/vscode) [​](https://docs.coderabbit.ai/changelog#undefined) April 19, 2025 ### [​](https://docs.coderabbit.ai/changelog#docstring-path-instructions) Docstring Path Instructions You can now provide path-based instructions for the generation of docstring in `.coderabbit.yaml`.Example: Copy code_generation: docstrings: path_instructions: - path: "**/*.ts" instructions: | End all docstrings with a notice that says "Auto-generated by CodeRabbit.". Do not omit the closing tags; the docstring must be valid. See the [docstrings documentation](https://docs.coderabbit.ai/finishing-touches/docstrings#path-instructions) for more details. [​](https://docs.coderabbit.ai/changelog#undefined) April 14, 2025 ### [​](https://docs.coderabbit.ai/changelog#shopify-cli-integration-%26-bitbucket-cloud-reporting) Shopify CLI Integration & Bitbucket Cloud Reporting We’re excited to announce two significant updates: #### [​](https://docs.coderabbit.ai/changelog#shopify-cli-integration) Shopify CLI Integration We’ve added support for [Shopify CLI](https://docs.coderabbit.ai/tools/shopify-cli) , a powerful tool for validating and analyzing Shopify themes and apps. This integration helps ensure your Shopify projects follow best practices by: * Validating Liquid syntax and theme requirements * Checking app extension configurations * Identifying performance bottlenecks * Ensuring accessibility standards * Detecting security vulnerabilities #### [​](https://docs.coderabbit.ai/changelog#bitbucket-cloud-scheduled-reporting) Bitbucket Cloud Scheduled Reporting Our reporting capabilities now extend to Bitbucket Cloud! You can now: * Schedule automated reports for your Bitbucket Cloud repositories * Generate customized summaries of team performance * Track PR review metrics * Deliver reports via Email, Slack, Microsoft Teams, or Discord [​](https://docs.coderabbit.ai/changelog#undefined) April 11, 2025 ### [​](https://docs.coderabbit.ai/changelog#agent-chat) Agent Chat This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. We’re thrilled to introduce agentic planning on GitHub for CodeRabbit chat as Generally Available for Pro users. This enhancement lets you make more advanced requests that span multiple files. Just add a review or issue comment on any pull request, or issue comment on an issue, issue tagging `@coderabbitai` along with your natural language request for a code change, and the chat will develop a plan for complex modifications. Upon reviewing the plan and getting your consent, CodeRabbit will emit a stacked PR, commit or copyable snippet to your PR or issue for those code changes. [​](https://docs.coderabbit.ai/changelog#undefined) April 8, 2025 ### [​](https://docs.coderabbit.ai/changelog#new-static-analysis-tools) New Static Analysis Tools We’ve expanded our static analysis capabilities with two new tools: * **Oxlint**: A high-performance JavaScript/TypeScript linter written in Rust. * **Prisma Lint**: A dedicated linter for Prisma schema files to help enforce consistent conventions and best practices. Both tools can be configured through their respective config files or through CodeRabbit’s settings page. See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details. [​](https://docs.coderabbit.ai/changelog#undefined) April 1, 2025 ### [​](https://docs.coderabbit.ai/changelog#code-graph-analysis) Code Graph Analysis Code reviews automatically analyze dependencies across multiple files to enhance the context from code definitions (e.g., types) to improve accuracy and reduce false positives.This is a very powerful feature that gathers context behind code changes in one file that have dependencies in another file.🔍 See it in action: Review details → Additional context used → Code definitions In the review status message. It is automatically enabled for all users. ### [​](https://docs.coderabbit.ai/changelog#automatically-run-a-web-query-to-include-latest-information) Automatically Run a Web Query to Include Latest Information CodeRabbit now performs Web Queries automatically to include the most recent publicly available information — even if it wasn’t included in the latest LLM update. This feature is enabled by default for all users, and you may notice it being used in review comments and chat responses.Web Queries allow CodeRabbit to fetch the latest documentation and external content to improve the accuracy and relevance of its output. You can disable this feature by setting web\_search: false in your knowledge\_base settings. ### [​](https://docs.coderabbit.ai/changelog#coderabbit-auto-resolve) CodeRabbit Auto-Resolve CodeRabbit can now detect when suggested changes have been implemented and automatically resolve the related review threads on your behalf. ### [​](https://docs.coderabbit.ai/changelog#dashboard-redesign) Dashboard Redesign This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. New and Improved Dashboards to provide more useful feedback such as: * Average PR Merge Time * Weekly Pull Request Activity * Number of PRs Reviewed * Acceptance rate of CodeRabbit Suggestions * Tool Findings * Review Feedback Breakdown and much more! Check out the new dashboard to view these metrics about your organization. ### [​](https://docs.coderabbit.ai/changelog#multi-step-agent-chat) Multi-Step Agent Chat This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. We’re thrilled to introduce agentic planning on GitHub for CodeRabbit chat as an Experimental feature for Early Access users. This enhancement lets you make more advanced requests that span multiple files. Just add a review comment on any pull request tagging `@coderabbitai` along with your natural language request for a code change, and the chat will develop a plan for complex modifications. Upon reviewing the plan and getting your consent, CodeRabbit will emit a stacked PR to your PR for those code changes. ### [​](https://docs.coderabbit.ai/changelog#additional-static-analysis-support) Additional Static Analysis Support We are continually expanding our support for static analysis tools. We’ve recently added support for: * SQLFluff * Added Oxlint for faster linting * Oxlint is a blazingly fast JavaScript/TypeScript linter written in Rust * Replaces ESLint for basic linting while maintaining ESLint for more complex rules * Up to 50-100x faster than traditional ESLint [​](https://docs.coderabbit.ai/changelog#undefined) February 25, 2025 ### [​](https://docs.coderabbit.ai/changelog#docstrings) Docstrings This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. We’re excited to announce the launch of the Docstrings feature! This functionality allows developers to generate docstrings on a pull request. By commenting `@coderabbitai generate docstrings` on any pull request, you can automatically generate docstrings for functions in the code changes.The list of supported languages and software forges is available in [the documentation](https://docs.coderabbit.ai/finishing-touches/docstrings) . ### [​](https://docs.coderabbit.ai/changelog#azure-devops-pipeline-failure-detection) Azure DevOps Pipeline Failure Detection We’re excited to announce that our pipeline error detection capabilities now extend to Azure DevOps! Just like with GitHub Actions, GitLab CI/CD, and CircleCI, you can now automatically detect and fix pipeline failures in your Azure DevOps pipelines. [​](https://docs.coderabbit.ai/changelog#undefined) February 4, 2025 ### [​](https://docs.coderabbit.ai/changelog#bitbucket-cloud-support-%26-circleci-pipeline-failure-detection) Bitbucket Cloud Support & CircleCI Pipeline Failure Detection We’re excited to announce two major updates: #### [​](https://docs.coderabbit.ai/changelog#bitbucket-cloud-integration) Bitbucket Cloud Integration CodeRabbit is now available for Bitbucket Cloud users! This integration includes: * Automated code reviews for pull requests * Inline review comments and suggestions * Real-time bot interaction for feedback and assistance Check out our [Bitbucket Cloud integration guide](https://docs.coderabbit.ai/platforms/bitbucket-cloud) to get started. #### [​](https://docs.coderabbit.ai/changelog#circleci-pipeline-failure-detection-and-remediation) [CircleCI](https://circleci.com/) Pipeline Failure Detection and Remediation We’ve expanded our pipeline error detection to [CircleCI](https://circleci.com/) ! Just like with GitHub Actions and GitLab CI/CD, you can now automatically detect and fix pipeline failures from your CircleCI workflows. [​](https://docs.coderabbit.ai/changelog#undefined) January 21, 2025 ### [​](https://docs.coderabbit.ai/changelog#linear-issue-creation) Linear Issue Creation We have added the ability to create issues directly from AI Code Review Comments allowing developers to convert code review feedback into actionable Linear issues. [​](https://docs.coderabbit.ai/changelog#undefined) January 13, 2025 ### [​](https://docs.coderabbit.ai/changelog#gitlab-pipeline-failure-detection-and-remediation) GitLab Pipeline Failure Detection and Remediation We’ve expanded our pipeline error detection capabilities to GitLab Users! Just like with GitHub Actions, you can now automatically detect and fix pipeline failures in your GitLab CI/CD workflows. [​](https://docs.coderabbit.ai/changelog#undefined) January 2, 2025 ### [​](https://docs.coderabbit.ai/changelog#github-action-failure-detection-and-remediation) GitHub Action Failure Detection and Remediation We’re excited to announce our new pipeline error detection tool. Never let a failing pipeline block your progress again!Automatically fix build failures for GitHub Actions! This feature automatically identifies common pipeline and build failures, providing instant fixes across multiple technologies such Python, Node.js, Java, Terraform, Docker, Kubernetes and more!Key capabilities: * Automatic detection and analysis of pipeline build failures * One-click fix build failure suggestions for common issues * Comprehensive support for popular frameworks and tools * Integration with existing GitHub Checks Future support planned for: * Azure DevOps CI/CD * GitLab CI/CD * CircleCI [​](https://docs.coderabbit.ai/changelog#undefined) December 23, 2024 ### [​](https://docs.coderabbit.ai/changelog#streamlined-multi-repository-installation-for-gitlab-and-azure-devops) Streamlined Multi-Repository Installation for GitLab and Azure DevOps We’re thrilled to announce a significant enhancement to CodeRabbit that simplifies your workflow! You can now install CodeRabbit on multiple repositories simultaneously for GitLab and Azure DevOps, eliminating the need to activate each repository individually.With this update, you can: * ✅ Select Multiple Repositories: Check the boxes next to the repositories you wish to activate. * 🖱️ One-Click Installation: Select the **Install Repositories** button on the top right to integrate CodeRabbit across all selected projects instantly. [​](https://docs.coderabbit.ai/changelog#undefined) December 12, 2024 ### [​](https://docs.coderabbit.ai/changelog#docstrings-beta) Docstrings (Beta) We have launched a new functionality as part of our finishing touches initiative to allow developers to generate docstrings on a pull request. This feature lets you generate docstrings by commenting `@coderabbitai generate docstrings` on any pull request. This works for both new and existing documentation. See [our documentation](https://docs.coderabbit.ai/finishing-touches/docstrings) for details. [​](https://docs.coderabbit.ai/changelog#undefined) November 25, 2024 ### [​](https://docs.coderabbit.ai/changelog#code-review-performance-enhancements-with-improved-comment-resolution-logic) Code Review Performance Enhancements with Improved Comment Resolution Logic We have implemented several performance improvements that will enhance the speed of code review and are committed to making code review as efficient as possible across all your web development needs. We have also further refined the logic to reduce duplicate comments once a comment is resolved. [​](https://docs.coderabbit.ai/changelog#undefined) November 20, 2024 ### [​](https://docs.coderabbit.ai/changelog#support-for-on-premises-learning-and-gitlab-follow-up-issue-creation) Support for On-premises Learning and GitLab Follow-up Issue Creation Learnings enable developers to fine-tune the AI for their specific files, repositories, and codebase, enhancing future reviews. We’re excited to extend this feature to our on-premises customers. Additionally, we’ve improved our automated workflow to create follow-up issues directly from Merge Request reviews in GitLab. [​](https://docs.coderabbit.ai/changelog#undefined) November 8, 2024 ### [​](https://docs.coderabbit.ai/changelog#eslint-support) ESLint Support We’re excited to announce support for **ESLint**, now extending to .vue, .svelte, and .astro files, in addition to the traditional .js, .ts, and .jsx extensions. We’ve enhanced compatibility for monorepos, offering improved integration with Yarn and Pnpm workspaces for seamless project management.Our solution respects your existing ESLint configurations, requiring only that all dependencies are properly defined in your package.json. Please note that private plugins are not yet supported. We’re dedicated to streamlining code quality maintenance and making it as efficient as possible across your web development projects. [​](https://docs.coderabbit.ai/changelog#undefined) October 31, 2024 ### [​](https://docs.coderabbit.ai/changelog#learnings-and-metrics-iteration-for-coderabbit-self-hosted-customers) Learnings and Metrics Iteration for CodeRabbit Self-Hosted Customers We’ve enhanced the accessibility of Learnings and Metrics for self-hosted CodeRabbit customers, delivering a more seamless experience. Easily track learning patterns and insights, with the added convenience of generating API keys directly within the interface.**Setup:** * Generate an API key in the CodeRabbit UI * Enable Learnings and Metrics by either: * Configuring your .env file * Contacting CodeRabbit support for assistance [​](https://docs.coderabbit.ai/changelog#undefined) October 30, 2024 ### [​](https://docs.coderabbit.ai/changelog#microsoft-teams-integration-%26-bitbucket-support) Microsoft Teams Integration & Bitbucket Support Our integration capabilities just got a major upgrade with **Microsoft Teams** and **Bitbucket** support. * Microsoft Teams integration is now available as part of the Reporting feature, providing a direct notification pipeline to keep your team informed and up-to-date. * We’ve also launched Bitbucket Data Center support including Pull Request integration with essential review functionalities, detailed summaries, and inline comments to seamlessly apply review suggestions. [​](https://docs.coderabbit.ai/changelog#undefined) October 22, 2024 ### [​](https://docs.coderabbit.ai/changelog#security-and-sast-remediation-improvements) Security and SAST Remediation Improvements * Enabling comprehensive security analysis directly from context within GitHub Checks. * CodeRabbit now seamlessly integrates with top SAST tools that create github check annotation comments such as: Codacy, SonarCloud, Code Climate, GitHub Advanced Security, Palo Alto Prisma Cloud, and more! * We have added a [YouTube Tutorial](https://www.youtube.com/watch?v=tfy3FdsoUtU) for a step-by-step guide on using CodeRabbit with Codacy and SonarCloud during pull requests. * Improved the [Semgrep Documentation](https://docs.coderabbit.ai/tools/semgrep) . * CodeRabbit now automatically detects Semgrep rulesets from default `semgrep.yml` or `semgrep.config.yml` files, eliminating the need for manual configuration. [​](https://docs.coderabbit.ai/changelog#undefined) September 9, 2024 ### [​](https://docs.coderabbit.ai/changelog#related-prs-and-label-suggestions) Related PRs and Label suggestions * **Possibly Related PRs**: The walkthrough comment now provides a list of potentially related PRs, helping you quickly recall relevant context from past work. * **Suggested labels**: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or via configuration file. > Note: Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default). [​](https://docs.coderabbit.ai/changelog#undefined) August 15, 2024 ### [​](https://docs.coderabbit.ai/changelog#new-dashboard) New Dashboard We’re excited to share our updated dashboard, designed to give you better insights into CodeRabbit review metrics.What’s new: * Flexible Time Selector: Choose different periods to analyze your data * Useful Context: See how learnings, tools, and path instructions are used in reviews * New Visuals: Check out the bar, line, and stats charts for a better understanding * Custom Filters: Easily filter data by user, repository, pull request, and review profile * Tools Overview: See tool usage based on severity and total incidents reported These updates are here to help you get more from the dashboard. Take a look today! [​](https://docs.coderabbit.ai/changelog#undefined) July 31, 2024 ### [​](https://docs.coderabbit.ai/changelog#grant-admin-privileges-to-members) Grant Admin Privileges to Members You can now grant admin privileges to members of your organization in CodeRabbit. Admins will have the ability to manage subscriptions and seat allocations for the organization. [​](https://docs.coderabbit.ai/changelog#undefined) July 16, 2024 ### [​](https://docs.coderabbit.ai/changelog#new-features-and-improvements) New Features and Improvements #### [​](https://docs.coderabbit.ai/changelog#learnings-page) Learnings Page We’re thrilled to announce the new **Learnings** page! Users can now interact with learnings captured in PR comments, enhancing future reviews. Log into CodeRabbit and navigate to the Learnings tab, where you can filter learnings by Repository, File Path, and User. You can also edit or delete learnings that are no longer relevant to your project. #### [​](https://docs.coderabbit.ai/changelog#reports-beta-page) Reports (Beta) Page Introducing the beta release of **Reports**!Generate recurring summaries of team performance and latest PR reviews with features like: * Scheduling regular report generation * Specifying parameters such as repository, team, user, or label * Selecting report styles (Daily Stand-Up, Sprint Report, Release Notes, Custom) * Enabling your choice of delivery channel (Email, Slack, or Discord) #### [​](https://docs.coderabbit.ai/changelog#sequence-diagrams-configuration) Sequence Diagrams Configuration You can now choose whether to auto-generate sequence diagrams in the PR Walkthrough comment. Enable this via the CodeRabbit settings page or by setting reviews.sequence\_diagrams in the .coderabbit.yaml file. #### [​](https://docs.coderabbit.ai/changelog#enhanced-tool-settings-%26-new-analysis-tools) Enhanced Tool Settings & New Analysis Tools We’ve refined the default settings to be less noisy and more actionable. Additionally, we’ve added new static analysis and security tools: * **YAMLlint**: A linter for YAML files * **Gitleaks**: A lightweight, open-source secret scanner to prevent security breaches * **Checkov**: Scans infrastructure as code for misconfigurations before they become security issues #### [​](https://docs.coderabbit.ai/changelog#gitlab-integration-update) GitLab Integration Update The GitLab integration now offers more flexibility and security. Users can use Personal Access Tokens (PATs) from within their organization to post reviews. This enhancement ensures reviews are posted with appropriate organizational context and permissions, improving traceability and security. [​](https://docs.coderabbit.ai/changelog#undefined) May 28, 2024 ### [​](https://docs.coderabbit.ai/changelog#new-features-and-improvements-2) New Features and Improvements #### [​](https://docs.coderabbit.ai/changelog#sequence-diagrams) Sequence Diagrams CodeRabbit now generates sequence diagrams for code changes, providing reviewers with a clear visualization of the control flow for improved understanding. #### [​](https://docs.coderabbit.ai/changelog#auto-generate-pr-titles) Auto-Generate PR Titles A new option, `auto_title_placeholder`, is now available and defaults to `@coderabbitai` title. This feature allows users to set a placeholder title, enabling CodeRabbit to automatically generate an appropriate title when the review process begins. #### [​](https://docs.coderabbit.ai/changelog#new-commands) New Commands We have introduced new commands for interacting with CodeRabbit, detailed under the “Tips” section of a review walkthrough: * `@coderabbitai full review`: Conducts a full review from scratch, covering all files again * `@coderabbitai summary`: Regenerates the summary of the PR * `@coderabbitai configuration`: Displays the current CodeRabbit configuration for the repository #### [​](https://docs.coderabbit.ai/changelog#improved-handling-of-closed-prs) Improved Handling of Closed PRs We have been observing that many PRs get closed quickly and CodeRabbit continues to review them. PRs get closed quickly for various reasons - changes are too small, the author is confident (perhaps, overly?), or the changes were unnecessary. With this improvement, we now stop the review process midway if we detect that the PR has been closed. [​](https://docs.coderabbit.ai/changelog#undefined) May 23, 2024 ### [​](https://docs.coderabbit.ai/changelog#new-features-and-improvements-3) New Features and Improvements #### [​](https://docs.coderabbit.ai/changelog#review-settings) Review Settings Users can now select between **Chill** and **Assertive** review tones to tailor feedback styles according to their preferences. The **Assertive** profile posts more comments and nitpicks the code more aggressively, while the **Chill** profile is more relaxed and posts fewer comments. #### [​](https://docs.coderabbit.ai/changelog#more-static-analysis-support) More Static Analysis Support We are continually expanding our support for static analysis tools. We’ve recently added support for * Biome * Hadolint * ast-grep. Update your .coderabbit.yaml file or visit the settings page to enable or disable the tools you wish to use. #### [​](https://docs.coderabbit.ai/changelog#tone-settings) Tone Settings Users can now personalize CodeRabbit to review code in the style of their favorite characters or personalities. Here are a few of our top examples: * Mr. T: “You must talk like Mr. T in all your code reviews. I pity the fool who doesn’t!” * Pirate: “Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!” * Snarky Ex-Girlfriend: “You must talk like a snarky ex-girlfriend in all your code reviews. You’re welcome.” #### [​](https://docs.coderabbit.ai/changelog#revamped-settings-page) Revamped Settings Page We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long-time coming; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa. [​](https://docs.coderabbit.ai/changelog#undefined) April 18, 2024 ### [​](https://docs.coderabbit.ai/changelog#static-analyzers-and-linters-integration) Static Analyzers and Linters Integration CodeRabbit now runs static analyzers, linters and provides one-click fixes for the issues identified. AI helps reduce the false positives and focus on the critical findings. CodeRabbit will respect the existing configuration files of these tools if they already exist in the project. For example, if your project already uses ruff and has a ruff.toml file at the root of the project, that will be used. In cases where project configurations are not found, CodeRabbit defaults will be used. Currently, CodeRabbit runs markdownlint, shellcheck, ruff, and languagetool. We will continue to add more tools. The default configuration can be changed through the .coderabbit.yaml file.Are there any specific tools you’d like us to add? Let us know. We’d love to hear your suggestions! [​](https://docs.coderabbit.ai/changelog#undefined) April 1, 2024 ### [​](https://docs.coderabbit.ai/changelog#gdpr-compliance) GDPR Compliance Excited to announce that CodeRabbit is now GDPR-compliant in accordance with EU regulations! [​](https://docs.coderabbit.ai/changelog#undefined) March 12, 2024 ### [​](https://docs.coderabbit.ai/changelog#github-check-fixes) GitHub Check Fixes CodeRabbit now offers fixes for GitHub Check failures on pull requests. With this change, Check Runs on GitHub that add Annotations to Pull Requests will be used. For example, popular GitHub Actions published by reviewdog (action-golangci-lint, action-staticcheck, action-eslint) and super-linter among many others can report issues on Pull Requests as annotations. Checks that output logs will be supported shortly. The CodeRabbit GitHub App requires permission to read Checks for this feature to work. To enable this, please grant the necessary permissions by visiting the CodeRabbit GitHub app settings under [installation](https://github.com/settings/installations) . Support for GitLab will follow. [​](https://docs.coderabbit.ai/changelog#undefined) March 11, 2024 ### [​](https://docs.coderabbit.ai/changelog#soc-2-type-ii-compliance) SOC 2 Type II Compliance CodeRabbit is now SOC 2 Type II compliant to ensure top-tier security, availability, integrity, and privacy for our users. [​](https://docs.coderabbit.ai/changelog#undefined) March 2, 2024 ### [​](https://docs.coderabbit.ai/changelog#enhanced-markdown-review) Enhanced Markdown Review CodeRabbit now offers a more comprehensive review of the markdown changes. In addition to the AI suggestions, we do a thorough check for spelling, grammar, word choice, language style, as well as improvements in paraphrasing and punctuation. [​](https://docs.coderabbit.ai/changelog#undefined) January 17, 2024 ### [​](https://docs.coderabbit.ai/changelog#self-hosted-gitlab-integration) Self-hosted GitLab Integration CodeRabbit now supports integration with Self-Hosted GitLab instances. Check out our [setup instructions](https://docs.coderabbit.ai/integrations/self-hosted-gitlab) for detailed instructions. [​](https://docs.coderabbit.ai/changelog#undefined) January 2, 2024 ### [​](https://docs.coderabbit.ai/changelog#deep-insights-feature-release) Deep Insights Feature Release Working as recursive autonomous agent, CodeRabbit uses shell scripts to perform complex operations on the entire codebase, verifying changes and providing deeper insights.Here are some uses cases: * Want to defer implementing the CodeRabbit suggestion to a later time? Ask the bot the create an issue * Generate unit tests - comment `@coderabbitai generate unit tests` for the src/utils.ts * In PR comments, ask the bot to gather insights on your repository including latest commits, frequently changed files, recent contributors etc * When the CodeRabbit review comment is addressed, let the bot know and it can validate with the latest commit Really excited to see how this feature gets used, especially with access to the CLI commands. There are some suggestions in the pull request tips but we are looking forward to seeing additional use cases of how developers use this feature. Please consider sharing your experiences. [​](https://docs.coderabbit.ai/changelog#undefined) December 18, 2023 ### [​](https://docs.coderabbit.ai/changelog#request-changes-workflow) Request Changes Workflow Enable Request Changes review workflow for CodeRabbit reviews via .coderabbit.yaml under the field `request_changes_workflow` (default: false). When enabled, review comments are posted as request changes and CodeRabbit review will be marked approved once all the review comments are resolved. [​](https://docs.coderabbit.ai/changelog#undefined) December 5, 2023 ### [​](https://docs.coderabbit.ai/changelog#multiple-features-release) Multiple Features Release #### [​](https://docs.coderabbit.ai/changelog#learnings) Learnings CodeRabbit can now learn from your conversations to fine-tune your reviews. If you encounter inaccurate feedback or something not relevant to your codebase, just let the bot know, and it will remember the context for the future. We understand that coding practices and standards evolve. Using the chat, you can inform the bot, and it will remove any existing learnings that are no longer relevant. This feature does not work if you have opted out of data storage. #### [​](https://docs.coderabbit.ai/changelog#codebase-verification) Codebase Verification Verifies the reference of the changes on the overall codebase and identifies missing changes. #### [​](https://docs.coderabbit.ai/changelog#jira-and-linear-integrations) Jira and Linear Integrations You can now integrate Jira and Linear with CodeRabbit to provide additional context when reviewing pull requests. If you use either of these systems, we highly recommend enabling this integration for a more seamless experience. Stay tuned—more integrations are coming soon! #### [​](https://docs.coderabbit.ai/changelog#related-issues) Related Issues Identifies all issues affected by the code changes. This helps understand the impact on the overall product. It also assists in identifying duplicate issues or the impact on any other existing issues. This feature is unavailable for users who have opted out of data collection. [​](https://docs.coderabbit.ai/changelog#undefined) November 5, 2023 ### [​](https://docs.coderabbit.ai/changelog#issue-validation) Issue Validation CodeRabbit review can now assess the pull request changes against the linked GitHub or GitLab issue. Integration with other workflow systems including Jira and Linear is under development. [​](https://docs.coderabbit.ai/changelog#undefined) November 1, 2023 ### [​](https://docs.coderabbit.ai/changelog#committable-suggestions) Committable Suggestions Review comments can now post committable suggestions that can be committed within the pull request with a single click. [​](https://docs.coderabbit.ai/changelog#undefined) October 28, 2023 ### [​](https://docs.coderabbit.ai/changelog#resolve-command) Resolve Command Use `@coderabbitai resolve` to mark all the CodeRabbit review comments as resolved all at once. [​](https://docs.coderabbit.ai/changelog#undefined) October 23, 2023 ### [​](https://docs.coderabbit.ai/changelog#coderabbit-commands) CodeRabbit Commands Introducing additional CodeRabbit commands for managing code reviews: * Pause Reviews: Use `@coderabbitai pause` in a PR comment to halt ongoing reviews * Resume Reviews: Enter `@coderabbitai resume` in a PR comment to continue paused reviews * On-Demand Reviews: Disable automatic reviews for your repository to switch to on-demand reviews. Use `@coderabbitai review` in a PR comment. This command will override all review filters that might be set up in the repository settings and will initiate a one-time review * Help Command: You can at any time post `@coderabbitai help` in a PR comment to get the list of all valid commands [​](https://docs.coderabbit.ai/changelog#undefined) October 12, 2023 ### [​](https://docs.coderabbit.ai/changelog#yml-file-customization) YML File Customization CodeRabbit customizations made easy! You can now customize CodeRabbit using a YML file from your repository. To learn more, refer to our comprehensive documentation on customizing CodeRabbit. [​](https://docs.coderabbit.ai/changelog#undefined) September 21, 2023 ### [​](https://docs.coderabbit.ai/changelog#path-based-review-instructions) Path-Based Review Instructions This section explains how to add custom code review instructions for the entire project or specific file paths in your project using glob patterns. Developers can provide tailored review guidelines based on the file paths. These instructions are needed only if you want the reviewer to follow specific instructions besides the standard review.Adding file path prompts allows developers to specify custom instructions for different parts of the codebase. For example, you may want to enforce style guide by file types or directories.Sample Usage: Copy path: **/*.js instructions: Review the javascript code against the google javascript style guide and point out any mismatches Copy path: tests/**.* instructions: Review the following unit test code written using the Mocha test library. Ensure that: The code adheres to best practices associated with Mocha. Descriptive test names are used to clearly convey the intent of each test. > Note: > > * Paths accept glob patterns > * Instructions generally work well for specific additional instructions. However, they are not that effective if you are instructing AI not to do something > * Test the review feedback on pull requests and tailor as necessary [​](https://docs.coderabbit.ai/changelog#undefined) September 19, 2023 ### [​](https://docs.coderabbit.ai/changelog#introducing-coderabbit-for-gitlab-integration) Introducing CodeRabbit for GitLab Integration CodeRabbit is now available for GitLab! We know many of you have been waiting for this integration. Thank you for your patience. Sign up for the free trial! Assistant Responses are generated using AI and may contain mistakes. --- # CodeRabbit for VS Code, Cursor, and Windsurf Is Here 🎉 - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation CodeRabbit for VS Code, Cursor, and Windsurf Is Here 🎉 On this page * [CodeRabbit for VS Code, Cursor, and Windsurf Is Here 🎉](https://docs.coderabbit.ai/changelog/coderabbit-for-vs-code-cursor-and-windsurf-is-here-#coderabbit-for-vs-code%2C-cursor%2C-and-windsurf-is-here-%F0%9F%8E%89) ### [​](https://docs.coderabbit.ai/changelog/coderabbit-for-vs-code-cursor-and-windsurf-is-here-#coderabbit-for-vs-code%2C-cursor%2C-and-windsurf-is-here-%F0%9F%8E%89) CodeRabbit for VS Code, Cursor, and Windsurf Is Here 🎉 We’re thrilled to announce that CodeRabbit’s AI code reviews have officially landed inside **VS Code and all its forks, including Cursor and Windsurf!** No more review bottlenecks or context switches: now you can get _instant, inline feedback right in your editor, completely free._ **Why you’ll love it:** * 📝 **Inline Code Reviews**: Senior-dev-level annotation on every line. CodeRabbit becomes your AI pair programmer, annotating staged & unstaged commits before you even open a PR. * 🚀 **Built for Flow, Not Friction**: Code, review, commit—rinse & repeat without breaking your flow state. Reviews run automatically on every commit so you ship faster. * 🛠️ **Fix-with-AI**: One-Click Fix for quick tweaks; “Fix with AI” hands off more complex suggestions to your favorite coding agent, complete with full context. * 🧩 **Compatible with Cursor, Windsurf & Language-Agnostic**: Works out of the box on VS Code, Cursor, Windsurf. Supports Java, JavaScript, PHP, Python, TypeScript, Go, Ruby, and more. Pair these IDE-embedded reviews with our deeper Git-platform reviews for a multi-layered approach that catches more bugs and cuts down overall review time. * [Join the launch discussion on Discord](https://discord.com/channels/1134356397673414807/1145813948193575023/1372210767838842950) * [Install the CodeRabbit VSCode Extension](https://coderabbit.link/vscode) Assistant Responses are generated using AI and may contain mistakes. --- # Issue Validation - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Issue Validation On this page * [Issue Validation](https://docs.coderabbit.ai/changelog/issue-validation#issue-validation) ### [​](https://docs.coderabbit.ai/changelog/issue-validation#issue-validation) Issue Validation CodeRabbit review can now assess the pull request changes against the linked GitHub or GitLab issue. Integration with other workflow systems including Jira and Linear is under development. Assistant Responses are generated using AI and may contain mistakes. --- # Enhanced PHP Static Analysis: PHPMD and PHPCS Support - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Enhanced PHP Static Analysis: PHPMD and PHPCS Support On this page * [Enhanced PHP Static Analysis: PHPMD and PHPCS Support](https://docs.coderabbit.ai/changelog/enhanced-php-static-analysis-phpmd-and-phpcs-support#enhanced-php-static-analysis%3A-phpmd-and-phpcs-support) ### [​](https://docs.coderabbit.ai/changelog/enhanced-php-static-analysis-phpmd-and-phpcs-support#enhanced-php-static-analysis%3A-phpmd-and-phpcs-support) Enhanced PHP Static Analysis: PHPMD and PHPCS Support We’re excited to announce enhanced PHP static analysis capabilities with two powerful new tools! * [PHPMD](https://phpmd.org/) (PHP Mess Detector) is a static analysis tool that detects potential problems in your PHP code such as possible bugs, suboptimal code, overcomplicated expressions, and unused parameters, variables, methods, and classes. * [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer) (PHP CodeSniffer) is a development tool that ensures your PHP code conforms to coding standards like PSR-1, PSR-2, PSR-12, and custom standards. It can automatically fix many coding standard violations. See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details. Assistant Responses are generated using AI and may contain mistakes. --- # Enhanced Reporting Capabilities - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Enhanced Reporting Capabilities On this page * [Enhanced Reporting Capabilities](https://docs.coderabbit.ai/changelog/enhanced-reporting-capabilities#enhanced-reporting-capabilities) * [Exclusion Filters with NOT\_IN Option](https://docs.coderabbit.ai/changelog/enhanced-reporting-capabilities#exclusion-filters-with-not-in-option) * [Next Steps Section in Daily Standup Reports](https://docs.coderabbit.ai/changelog/enhanced-reporting-capabilities#next-steps-section-in-daily-standup-reports) * [CI/CD GitHub Action Check Status Awareness](https://docs.coderabbit.ai/changelog/enhanced-reporting-capabilities#ci%2Fcd-github-action-check-status-awareness) * [Score Card Custom Report Option](https://docs.coderabbit.ai/changelog/enhanced-reporting-capabilities#score-card-custom-report-option) ### [​](https://docs.coderabbit.ai/changelog/enhanced-reporting-capabilities#enhanced-reporting-capabilities) Enhanced Reporting Capabilities We’re excited to announce significant improvements to our reporting system that will make your automated reports more powerful and actionable! #### [​](https://docs.coderabbit.ai/changelog/enhanced-reporting-capabilities#exclusion-filters-with-not-in-option) Exclusion Filters with NOT\_IN Option Reports now support exclusion filters using the `NOT_IN` option, allowing you to filter out pull requests based on their repository, label, user, or team. This gives you more granular control over what appears in your reports, helping you focus on the most relevant information. #### [​](https://docs.coderabbit.ai/changelog/enhanced-reporting-capabilities#next-steps-section-in-daily-standup-reports) Next Steps Section in Daily Standup Reports We’ve enhanced the default daily standup report template to include a “Next Steps” section. This provides clear guidance on what actions authors and reviewers should take regarding each pull request or change, making your reports more actionable and helping teams stay on track. #### [​](https://docs.coderabbit.ai/changelog/enhanced-reporting-capabilities#ci%2Fcd-github-action-check-status-awareness) CI/CD GitHub Action Check Status Awareness Reports now include CI/CD GitHub Action check status as a data source. Your reports will be aware of which CI/CD checks are failing or passing, giving you better visibility into the health of your pull requests and helping identify potential issues before they become blockers. #### [​](https://docs.coderabbit.ai/changelog/enhanced-reporting-capabilities#score-card-custom-report-option) Score Card Custom Report Option We’ve added a new optional score card report feature that allows you to grade and create report cards for your developers. This custom report optional data source provides a structured way to evaluate developer performance and contributions. See our [custom reports documentation](https://docs.coderabbit.ai/guides/custom-reports#remove-prs-without-a-score-cardchart-bot-comment) for more details on how to implement score cards in your reports. Assistant Responses are generated using AI and may contain mistakes. --- # GDPR Compliance - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation GDPR Compliance On this page * [GDPR Compliance](https://docs.coderabbit.ai/changelog/gdpr-compliance#gdpr-compliance) ### [​](https://docs.coderabbit.ai/changelog/gdpr-compliance#gdpr-compliance) GDPR Compliance Excited to announce that CodeRabbit is now GDPR-compliant in accordance with EU regulations! Assistant Responses are generated using AI and may contain mistakes. --- # Dark theme support for UI App - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Dark theme support for UI App CodeRabbit app now supports Light, Dark, and System themes. Use the new theme toggle next to your profile to switch modes. Assistant Responses are generated using AI and may contain mistakes. --- # Self-hosted GitLab Integration - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Self-hosted GitLab Integration On this page * [Self-hosted GitLab Integration](https://docs.coderabbit.ai/changelog/self-hosted-gitlab-integration#self-hosted-gitlab-integration) ### [​](https://docs.coderabbit.ai/changelog/self-hosted-gitlab-integration#self-hosted-gitlab-integration) Self-hosted GitLab Integration CodeRabbit now supports integration with Self-Hosted GitLab instances. Check out our [setup instructions](https://docs.coderabbit.ai/integrations/self-hosted-gitlab) for detailed instructions. Assistant Responses are generated using AI and may contain mistakes. --- # Enhanced Markdown Review - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Enhanced Markdown Review On this page * [Enhanced Markdown Review](https://docs.coderabbit.ai/changelog/enhanced-markdown-review#enhanced-markdown-review) ### [​](https://docs.coderabbit.ai/changelog/enhanced-markdown-review#enhanced-markdown-review) Enhanced Markdown Review CodeRabbit now offers a more comprehensive review of the markdown changes. In addition to the AI suggestions, we do a thorough check for spelling, grammar, word choice, language style, as well as improvements in paraphrasing and punctuation. Assistant Responses are generated using AI and may contain mistakes. --- # Enhanced Python Static Analysis: nbqa Support for Jupyter Notebooks - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Enhanced Python Static Analysis: nbqa Support for Jupyter Notebooks On this page * [Enhanced Python Static Analysis: nbqa Support for Jupyter Notebooks](https://docs.coderabbit.ai/changelog/enhanced-python-static-analysis-nbqa-support-for-jupyter-notebooks#enhanced-python-static-analysis%3A-nbqa-support-for-jupyter-notebooks) ### [​](https://docs.coderabbit.ai/changelog/enhanced-python-static-analysis-nbqa-support-for-jupyter-notebooks#enhanced-python-static-analysis%3A-nbqa-support-for-jupyter-notebooks) Enhanced Python Static Analysis: nbqa Support for Jupyter Notebooks We’re excited to announce enhanced Python static analysis capabilities with nbqa support for Jupyter Notebooks! Our existing integrated [Ruff](https://docs.astral.sh/ruff/) , [Flake8](https://flake8.pycqa.org/) and [Pylint](https://pylint.pycqa.org/) tools now support linting Jupyter Notebooks (`.ipynb` files) using [nbqa](https://github.com/nbQA-dev/nbQA) . This allows you to maintain code quality across your Python projects, including Jupyter Notebooks. See our [Ruff](https://docs.coderabbit.ai/tools/ruff) , [Flake8](https://docs.coderabbit.ai/tools/flake8) , and [Pylint](https://docs.coderabbit.ai/tools/pylint) documentation for more details. Assistant Responses are generated using AI and may contain mistakes. --- # YML File Customization - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation YML File Customization On this page * [YML File Customization](https://docs.coderabbit.ai/changelog/yml-file-customization#yml-file-customization) ### [​](https://docs.coderabbit.ai/changelog/yml-file-customization#yml-file-customization) YML File Customization CodeRabbit customizations made easy! You can now customize CodeRabbit using a YML file from your repository. To learn more, refer to our comprehensive documentation on customizing CodeRabbit. Assistant Responses are generated using AI and may contain mistakes. --- # Microsoft Teams Integration & Bitbucket Support - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Microsoft Teams Integration & Bitbucket Support On this page * [Microsoft Teams Integration & Bitbucket Support](https://docs.coderabbit.ai/changelog/microsoft-teams-integration-bitbucket-support#microsoft-teams-integration-%26-bitbucket-support) ### [​](https://docs.coderabbit.ai/changelog/microsoft-teams-integration-bitbucket-support#microsoft-teams-integration-%26-bitbucket-support) Microsoft Teams Integration & Bitbucket Support Our integration capabilities just got a major upgrade with **Microsoft Teams** and **Bitbucket** support. * Microsoft Teams integration is now available as part of the Reporting feature, providing a direct notification pipeline to keep your team informed and up-to-date. * We’ve also launched Bitbucket Data Center support including Pull Request integration with essential review functionalities, detailed summaries, and inline comments to seamlessly apply review suggestions. Assistant Responses are generated using AI and may contain mistakes. --- # Related PRs and Label suggestions - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Related PRs and Label suggestions On this page * [Related PRs and Label suggestions](https://docs.coderabbit.ai/changelog/related-prs-and-label-suggestions#related-prs-and-label-suggestions) ### [​](https://docs.coderabbit.ai/changelog/related-prs-and-label-suggestions#related-prs-and-label-suggestions) Related PRs and Label suggestions * **Possibly Related PRs**: The walkthrough comment now provides a list of potentially related PRs, helping you quickly recall relevant context from past work. * **Suggested labels**: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or via configuration file. > Note: Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default). Assistant Responses are generated using AI and may contain mistakes. --- # Resolve Command - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Resolve Command On this page * [Resolve Command](https://docs.coderabbit.ai/changelog/resolve-command#resolve-command) ### [​](https://docs.coderabbit.ai/changelog/resolve-command#resolve-command) Resolve Command Use `@coderabbitai resolve` to mark all the CodeRabbit review comments as resolved all at once. Assistant Responses are generated using AI and may contain mistakes. --- # Introducing CodeRabbit for GitLab Integration - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Introducing CodeRabbit for GitLab Integration On this page * [Introducing CodeRabbit for GitLab Integration](https://docs.coderabbit.ai/changelog/introducing-coderabbit-for-gitlab-integration#introducing-coderabbit-for-gitlab-integration) ### [​](https://docs.coderabbit.ai/changelog/introducing-coderabbit-for-gitlab-integration#introducing-coderabbit-for-gitlab-integration) Introducing CodeRabbit for GitLab Integration CodeRabbit is now available for GitLab! We know many of you have been waiting for this integration. Thank you for your patience. Sign up for the free trial! Assistant Responses are generated using AI and may contain mistakes. --- # Integrate MCP servers - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Configure Integrate MCP servers On this page * [Considerations](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations#considerations) * [Setup](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations#setup) * [Configuration steps](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations#configuration-steps) * [How it works](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations#how-it-works) * [During code reviews](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations#during-code-reviews) * [In chat interactions](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations#in-chat-interactions) MCP integrations is a Pro feature in Beta. You can enable CodeRabbit to connect to external tools and data sources through the Model Context Protocol (MCP) integration. This allows CodeRabbit to serve as the client, and grants it with richer contextual understanding for: * Code reviews * The validation step for code suggestions * Chat in the PR Use the MCP integration as a way to access your documentation, project management tools, knowledge bases, Figma designs, and more. [​](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations#considerations) Considerations ----------------------------------------------------------------------------------------------------------- A few things to keep in mind: * CodeRabbit acts as the MCP client, not the server. It ingests data. * The constraint is understanding what MCP data can be helpful for code reviews. See above for how CodeRabbit uses MCP data. * This approach unlocks integrations in a way that wasn’t possible before. You don’t have to wait for CodeRabbit to have a formal integration, if it has an MCP server, we can connect to it. [​](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations#setup) Setup ----------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations#configuration-steps) Configuration steps 1. Navigate to Integrations Page within your CodeRabbit app settings and select the new MCP Server tab 2. To add a new MCP server, click “Add MCP Integration” and provide your server connection details along with the name 3. Complete the authentication process for your MCP server 4. Enable or disable individual MCP tools for each server [​](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations#how-it-works) How it works ------------------------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations#during-code-reviews) During code reviews CodeRabbit automatically calls relevant MCP tools during analysis to: * Gather additional review context. * Validate and enhance suggested review comments. Enhanced review comments will include enriched insights while maintaining your existing workflow. Tools used during analysis are listed under “Additional context used.” ### [​](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations#in-chat-interactions) In chat interactions MCP integration enhances chat by: * Retrieving contextual information based on discussion topics * Accessing external documentation and knowledge bases [Knowledge base](https://docs.coderabbit.ai/integrations/knowledge-base) [Review instructions](https://docs.coderabbit.ai/guides/review-instructions) Assistant Responses are generated using AI and may contain mistakes. --- # Review local changes - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation IDE extensions Review local changes On this page * [About the VSCode extension​](https://docs.coderabbit.ai/code-editors#about-the-vscode-extension%E2%80%8B) * [Features​](https://docs.coderabbit.ai/code-editors#features%E2%80%8B) * [Price and limitations​](https://docs.coderabbit.ai/code-editors#price-and-limitations%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/code-editors#what%E2%80%99s-next%E2%80%8B) This page is about the CodeRabbit IDE extensions. For a broader overview of CodeRabbit, see [Introduction](https://docs.coderabbit.ai/overview/introduction) . [​](https://docs.coderabbit.ai/code-editors#about-the-vscode-extension%E2%80%8B) About the VSCode extension[​](https://docs.coderabbit.ai/code-editors#about-the-vscode-extension "Direct link to About the VSCode extension") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The CodeRabbit VSCode extension lets you apply a limited subset of CodeRabbit’s code-review features to your local development environment, directly from the VSCode IDE. It also works with other text editors that are able to install and use VSCode extensions, such as Cursor and Windsurf. You can use the extension on its own, or you can use it to complement your local development on a repository whose remote has CodeRabbit installed. The extension is intended to let you use the power of CodeRabbit to rapidly tune and tidy your code changes locally, before you publish your changes to your team’s remote repository and start a more thorough code review. [​](https://docs.coderabbit.ai/code-editors#features%E2%80%8B) Features[​](https://docs.coderabbit.ai/code-editors#features "Direct link to Features") ---------------------------------------------------------------------------------------------------------------------------------------------------------- The extension includes the following features: * Automatic code reviews on every local Git commit. * Manually requested reviews of local code changes. * One-click application of simpler suggested code fixes. * Integration with AI coding agents, including Copilot and Claude Code, to help you resolve more complex suggestions. * Full compatibility with text editors derived from VSCode, including Cursor and Windsurf. [​](https://docs.coderabbit.ai/code-editors#price-and-limitations%E2%80%8B) Price and limitations[​](https://docs.coderabbit.ai/code-editors#price-and-limitations "Direct link to Price and limitations") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This extension is free to install and use, and works with any tier of CodeRabbit account. Rate limits apply to the number of local reviews that you can request per hour. The extension makes only basic CodeRabbit review features available, with default settings applied. Advanced CodeRabbit features, such as interactive chat and project learnings, aren’t available through the VSCode extension. These features are available only by [integrating CodeRabbit on your remote repository](https://docs.coderabbit.ai/platforms) , and then allowing CodeRabbit to review pull requests. [​](https://docs.coderabbit.ai/code-editors#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/code-editors#whats-next "Direct link to What's next") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Install the VSCode extension](https://docs.coderabbit.ai/guides/install-vscode) * [Use the VSCode extension](https://docs.coderabbit.ai/guides/use-vscode) * [Use with Self-hosted CodeRabbit](https://docs.coderabbit.ai/guides/use-vscode-selfhosted) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/about-vscode.md) Last updated on **Jul 31, 2025** [Linked Issues](https://docs.coderabbit.ai/guides/linked-issues) [Install the VSCode extension](https://docs.coderabbit.ai/guides/install-vscode) Assistant Responses are generated using AI and may contain mistakes. --- # Early Access Program - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Resources Early Access Program On this page * [Beta​](https://docs.coderabbit.ai/early-access#beta%E2%80%8B) * [Experiments​](https://docs.coderabbit.ai/early-access#experiments%E2%80%8B) [​](https://docs.coderabbit.ai/early-access#beta%E2%80%8B) Beta[​](https://docs.coderabbit.ai/early-access#beta "Direct link to Beta") ------------------------------------------------------------------------------------------------------------------------------------------ Beta features are ready for public testing. * The documentation may be incomplete or outdated. * The changelog may be missing. * The feature may not be fully stable. * Edge cases may not be fully covered. * Some parts of the feature may not be implemented. * They may not represent the end result of the planned feature and may not have a satisfactory user experience. Whenever you use a beta feature, you may see a warning like this: This feature is in [beta](https://docs.coderabbit.ai/early-access#beta) . [​](https://docs.coderabbit.ai/early-access#experiments%E2%80%8B) Experiments[​](https://docs.coderabbit.ai/early-access#experiments "Direct link to Experiments") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- Experiments are ways for CodeRabbit’s development team to gather more experience with in-development features. * They are highly unstable and may not work at all. * There is no guarantee that they will reach the beta stage and they may be cancelled at any time without any prior notice. * They are not ready for public use and may not be sufficiently documented. * We are not gathering feedback for experiments - the direction they take can vary widely. Whenever you use an experiment, you may see a warning like this: This feature is [experimental](https://docs.coderabbit.ai/early-access#experiments) . [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/early-access.md) Last updated on **Jul 31, 2025** [FAQs](https://docs.coderabbit.ai/faq) [Future development](https://docs.coderabbit.ai/future-development) Assistant Responses are generated using AI and may contain mistakes. --- # Manage your subscription - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Manage your account Manage your subscription On this page * [Accessing Billing Information​](https://docs.coderabbit.ai/getting-started/subscription-management#accessing-billing-information%E2%80%8B) * [Invoices and Payment History​](https://docs.coderabbit.ai/getting-started/subscription-management#invoices-and-payment-history%E2%80%8B) * [Managing Your Subscription Plan​](https://docs.coderabbit.ai/getting-started/subscription-management#managing-your-subscription-plan%E2%80%8B) * [Changing Plans​](https://docs.coderabbit.ai/getting-started/subscription-management#changing-plans%E2%80%8B) * [Adjusting Seat Count​](https://docs.coderabbit.ai/getting-started/subscription-management#adjusting-seat-count%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/getting-started/subscription-management#what%E2%80%99s-next%E2%80%8B) [​](https://docs.coderabbit.ai/getting-started/subscription-management#accessing-billing-information%E2%80%8B) Accessing Billing Information[​](https://docs.coderabbit.ai/getting-started/subscription-management#accessing-billing-information "Direct link to Accessing Billing Information") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/getting-started/subscription-management#invoices-and-payment-history%E2%80%8B) Invoices and Payment History[​](https://docs.coderabbit.ai/getting-started/subscription-management#invoices-and-payment-history "Direct link to Invoices and Payment History") You can access your billing history and download invoices by: 1. Going to [**Subscription**](https://app.coderabbit.ai/settings/subscription) on the sidebar > **Manage Subscription** 2. Once in the customer portal select **Billing History** 3. Click to download an invoice from any specific month of billing ![Subscription page navigation](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/subscription-page-a66da6f28e39bf3a0bcfc29cad19feb1.png) ![Billing history view](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/billing-history-1b7eb54de80b4a7643cc7c233f182730.png) ![Downloading an invoice](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/download-invoice-1a862c2bd05b69131bd88d2c365cf257.png) [​](https://docs.coderabbit.ai/getting-started/subscription-management#managing-your-subscription-plan%E2%80%8B) Managing Your Subscription Plan[​](https://docs.coderabbit.ai/getting-started/subscription-management#managing-your-subscription-plan "Direct link to Managing Your Subscription Plan") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ ### [​](https://docs.coderabbit.ai/getting-started/subscription-management#changing-plans%E2%80%8B) Changing Plans[​](https://docs.coderabbit.ai/getting-started/subscription-management#changing-plans "Direct link to Changing Plans") To upgrade or change your subscription plan: 1. Going to [**Subscription**](https://app.coderabbit.ai/settings/subscription) on the sidebar > **Manage Subscription** 2. Once in the customer portal click the box with your plan highlighted at the top of the page 3. Click **Update number of seats or change your plan** 4. Click **Change** on the section at the top mentioning your current plan 5. Select the new plan you’d like to change to 6. Click **Update** ![Changing your plan](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/manage-subscription-7b3567183ccea59458e73941e97dbf16.png) ![Changing your plan](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/edit-subscription-a4901e9e012168cb98baf2258ec2d46f.png) ![Changing your plan](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/change-seats-3872a588b70a98439afdf273db5ce4c7.png) ![Changing your plan](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/change-plan-2d871386a82f2356a3e9a817eb7abc70.png) ### [​](https://docs.coderabbit.ai/getting-started/subscription-management#adjusting-seat-count%E2%80%8B) Adjusting Seat Count[​](https://docs.coderabbit.ai/getting-started/subscription-management#adjusting-seat-count "Direct link to Adjusting Seat Count") To modify the number of seats in your subscription: 1. Going to [**Subscription**](https://app.coderabbit.ai/settings/subscription) on the sidebar > **Manage Subscription** 2. Once in the customer portal click the box with your plan highlighted at the top of the page 3. Click **Update number of seats or change your plan** 4. Enter the new number of seats needed 5. Click **Update Subscription** ![Changing your plan](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/manage-subscription-7b3567183ccea59458e73941e97dbf16.png) ![Changing your plan](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/edit-subscription-a4901e9e012168cb98baf2258ec2d46f.png) ![Changing your plan](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/change-seats-3872a588b70a98439afdf273db5ce4c7.png) [​](https://docs.coderabbit.ai/getting-started/subscription-management#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/getting-started/subscription-management#whats-next "Direct link to What's next") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Control administrative access](https://docs.coderabbit.ai/guides/roles) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/getting-started/subscription-management.md) Last updated on **Jul 31, 2025** [Linters & security analysis tools](https://docs.coderabbit.ai/tools) [Role based access](https://docs.coderabbit.ai/guides/roles) Assistant Responses are generated using AI and may contain mistakes. --- # Add a configuration file - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Configure Add a configuration file On this page * [Configure CodeRabbit using a YAML File​](https://docs.coderabbit.ai/getting-started/configure-coderabbit#configure-coderabbit-using-a-yaml-file%E2%80%8B) * [Shared configuration​](https://docs.coderabbit.ai/getting-started/configure-coderabbit#shared-configuration%E2%80%8B) 1. Configure using CodeRabbit YAML file 2. Configure using CodeRabbit UI for each repository 3. Configure using CodeRabbit UI for the organization In this guide, we will cover the configuration using a YAML file. For reference, you can find curated examples of YAML configurations in our [`awesome-coderabbit`](https://github.com/coderabbitai/awesome-coderabbit) repository. [​](https://docs.coderabbit.ai/getting-started/configure-coderabbit#configure-coderabbit-using-a-yaml-file%E2%80%8B) Configure CodeRabbit using a YAML File[​](https://docs.coderabbit.ai/getting-started/configure-coderabbit#configure-coderabbit-using-a-yaml-file "Direct link to Configure CodeRabbit using a YAML File") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Move existing UI configuration to a YAML file?Use the `@coderabbitai configuration` command on any PR to get the current configuration in a YAML format. You can then copy the configuration to a `.coderabbit.yaml` file in the root of your repository. You can add a `.coderabbit.yaml` configuration file to the root of your repositories. For a complete sample `.coderabbit.yaml` file which you can add to your repository and update as needed, see [Configuration file template](https://docs.coderabbit.ai/reference/yaml-template) . Write your configuration file in the below editor to validate: `.coderabbit.yaml` configuration file should exist in the feature branch for CodeRabbit review. The configuration file can be used to set the following options: Loading … Refer: [CodeRabbit Configuration Schema](https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json) . Please note that code reviews commence with new pull requests or incremental commits to existing pull requests once the CodeRabbit app is installed. Should you have any questions or require assistance, our support team is here to help. [​](https://docs.coderabbit.ai/getting-started/configure-coderabbit#shared-configuration%E2%80%8B) Shared configuration[​](https://docs.coderabbit.ai/getting-started/configure-coderabbit#shared-configuration "Direct link to Shared configuration") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- If you are self-hosting CodeRabbit in an air-gapped environment, you can use the shared configuration feature to share the configuration across multiple repositories. To use shared configuration, you need to: 1. Create a `.coderabbit.yaml` file and host it in a location that is accessible to from the CodeRabbit instance. 2. Create a `.coderabbit.yaml` file in the root of your repository with the following content: Copy remote_config: url: "https://your-config-location/.coderabbit.yaml" [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/getting-started/configure-coderabbit.md) Last updated on **Jul 31, 2025** [Repository preferences](https://docs.coderabbit.ai/guides/repository-settings) [Initial configuration guide](https://docs.coderabbit.ai/guides/initial-configuration) Assistant Responses are generated using AI and may contain mistakes. --- # Add organizations - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Add CodeRabbit to your repository Add organizations On this page * [What’s next​](https://docs.coderabbit.ai/getting-started/adding-organizations#what%E2%80%99s-next%E2%80%8B) 1. Navigate to [coderabbit.ai](https://coderabbit.ai/) 2. Click the “Refresh” button next to your organizations list to check for new organizations 3. Find the organization you want to add in the list 4. Click the “Grant” button next to the organization name ![Checking for new organizations](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/check-for-new-orgs-737f894deedee730a79c1123011dc31c.png) ![Granting permission to organization](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/grant-permission-25e8329e13fbfa0b9b8a9c377533b58b.png) This will grant CodeRabbit access to the selected organization, allowing it to: * Read organization and team membership * Read organization projects * Access user email addresses (read-only) > Note: Organizations control which applications are allowed to access their private data. You may need organization admin approval to complete this process. [​](https://docs.coderabbit.ai/getting-started/adding-organizations#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/getting-started/adding-organizations#whats-next "Direct link to What's next") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Manage your subscription](https://docs.coderabbit.ai/getting-started/subscription-management) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/getting-started/adding-organizations.md) Last updated on **Jul 31, 2025** [Bitbucket Cloud](https://docs.coderabbit.ai/platforms/bitbucket-cloud) [Set permissions](https://docs.coderabbit.ai/getting-started/upgrading-permissions) Assistant Responses are generated using AI and may contain mistakes. --- # Get support - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Resources Get support On this page * [Discord Server​](https://docs.coderabbit.ai/getting-started/support#discord-server%E2%80%8B) * [Support Tickets​](https://docs.coderabbit.ai/getting-started/support#support-tickets%E2%80%8B) * [Customer Responsibilities​](https://docs.coderabbit.ai/getting-started/support#customer-responsibilities%E2%80%8B) * [Etiquette​](https://docs.coderabbit.ai/getting-started/support#etiquette%E2%80%8B) [​](https://docs.coderabbit.ai/getting-started/support#discord-server%E2%80%8B) Discord Server[​](https://docs.coderabbit.ai/getting-started/support#discord-server "Direct link to Discord Server") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- All CodeRabbit users have access to the [CodeRabbit Discord Server](https://discord.gg/coderabbit) , where you can ask questions or see what others are doing with CodeRabbit. You will find CodeRabbit users and members of the CodeRabbit team actively engaged. [​](https://docs.coderabbit.ai/getting-started/support#support-tickets%E2%80%8B) Support Tickets[​](https://docs.coderabbit.ai/getting-started/support#support-tickets "Direct link to Support Tickets") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ For assistance from our support team, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://app.coderabbit.ai/login?free-trial) . This will open a chat window where you can submit your support ticket. Complete the support ticket by providing your name, email, a description of your issue, and attaching any necessary files. If you are reporting a bug, please provide the GitHub or GitLab organization name. ![How to Open a Support Ticket-CodeRabbit ](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/cr_support_help_light-d2c0c157c2b4a0a1fe14f7c3e9b8502f.png) ![How to Open a Support Ticket-CodeRabbit ](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/cr_support_help_dark-cd6c55cd5175a560881bce1ffe3a3d8f.png) If you are a paying user and cannot access the support ticket form in the CodeRabbit UI for some reason, you can contact CodeRabbit support at the following email address: [\[email protected\]](https://docs.coderabbit.ai/cdn-cgi/l/email-protection#5b282e2b2b34292f1b38343f3e293a3939322f753a32) . [​](https://docs.coderabbit.ai/getting-started/support#customer-responsibilities%E2%80%8B) Customer Responsibilities[​](https://docs.coderabbit.ai/getting-started/support#customer-responsibilities "Direct link to Customer Responsibilities") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- > To ensure efficient resolution of issues, customers are expected to 1. Provide detailed information about the issue. 2. Cooperate with the Support team during troubleshooting. 3. Utilize available self-service resources/docs for basic inquiries. [​](https://docs.coderabbit.ai/getting-started/support#etiquette%E2%80%8B) Etiquette[​](https://docs.coderabbit.ai/getting-started/support#etiquette "Direct link to Etiquette") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Regardless of the method or location through which CodeRabbit provides Support, communication should be professional and respectful. Any communication that is deemed objectionable by CodeRabbit staff is not tolerated. This includes but is not limited to any communication that is abusive or contains profane language. > CodeRabbit reserves the right to terminate Support Services in the event of any such objectionable communication. To see more common issues faced by CodeRabbit users, visit our [FAQ section](https://docs.coderabbit.ai/faq) for detailed answers and solutions to frequently encountered problems. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/getting-started/support.md) Last updated on **Jul 31, 2025** [Caching](https://docs.coderabbit.ai/reference/caching) [On-prem CodeRabbit & GitHub](https://docs.coderabbit.ai/self-hosted/github) Assistant Responses are generated using AI and may contain mistakes. --- # Security and SAST Remediation Improvements - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Security and SAST Remediation Improvements On this page * [Security and SAST Remediation Improvements](https://docs.coderabbit.ai/changelog/security-and-sast-remediation-improvements#security-and-sast-remediation-improvements) ### [​](https://docs.coderabbit.ai/changelog/security-and-sast-remediation-improvements#security-and-sast-remediation-improvements) Security and SAST Remediation Improvements * Enabling comprehensive security analysis directly from context within GitHub Checks. * CodeRabbit now seamlessly integrates with top SAST tools that create github check annotation comments such as: Codacy, SonarCloud, Code Climate, GitHub Advanced Security, Palo Alto Prisma Cloud, and more! * We have added a [YouTube Tutorial](https://www.youtube.com/watch?v=tfy3FdsoUtU) for a step-by-step guide on using CodeRabbit with Codacy and SonarCloud during pull requests. * Improved the [Semgrep Documentation](https://docs.coderabbit.ai/tools/semgrep) . * CodeRabbit now automatically detects Semgrep rulesets from default `semgrep.yml` or `semgrep.config.yml` files, eliminating the need for manual configuration. Assistant Responses are generated using AI and may contain mistakes. --- # Shopify CLI Integration & Bitbucket Cloud Reporting - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Shopify CLI Integration & Bitbucket Cloud Reporting On this page * [Shopify CLI Integration & Bitbucket Cloud Reporting](https://docs.coderabbit.ai/changelog/shopify-cli-integration-bitbucket-cloud-reporting#shopify-cli-integration-%26-bitbucket-cloud-reporting) * [Shopify CLI Integration](https://docs.coderabbit.ai/changelog/shopify-cli-integration-bitbucket-cloud-reporting#shopify-cli-integration) * [Bitbucket Cloud Scheduled Reporting](https://docs.coderabbit.ai/changelog/shopify-cli-integration-bitbucket-cloud-reporting#bitbucket-cloud-scheduled-reporting) ### [​](https://docs.coderabbit.ai/changelog/shopify-cli-integration-bitbucket-cloud-reporting#shopify-cli-integration-%26-bitbucket-cloud-reporting) Shopify CLI Integration & Bitbucket Cloud Reporting We’re excited to announce two significant updates: #### [​](https://docs.coderabbit.ai/changelog/shopify-cli-integration-bitbucket-cloud-reporting#shopify-cli-integration) Shopify CLI Integration We’ve added support for [Shopify CLI](https://docs.coderabbit.ai/tools/shopify-cli) , a powerful tool for validating and analyzing Shopify themes and apps. This integration helps ensure your Shopify projects follow best practices by: * Validating Liquid syntax and theme requirements * Checking app extension configurations * Identifying performance bottlenecks * Ensuring accessibility standards * Detecting security vulnerabilities #### [​](https://docs.coderabbit.ai/changelog/shopify-cli-integration-bitbucket-cloud-reporting#bitbucket-cloud-scheduled-reporting) Bitbucket Cloud Scheduled Reporting Our reporting capabilities now extend to Bitbucket Cloud! You can now: * Schedule automated reports for your Bitbucket Cloud repositories * Generate customized summaries of team performance * Track PR review metrics * Deliver reports via Email, Slack, Microsoft Teams, or Discord Assistant Responses are generated using AI and may contain mistakes. --- # Streamlined Multi-Repository Installation for GitLab and Azure DevOps - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Streamlined Multi-Repository Installation for GitLab and Azure DevOps On this page * [Streamlined Multi-Repository Installation for GitLab and Azure DevOps](https://docs.coderabbit.ai/changelog/streamlined-multi-repository-installation-for-gitlab-and-azure-devops#streamlined-multi-repository-installation-for-gitlab-and-azure-devops) ### [​](https://docs.coderabbit.ai/changelog/streamlined-multi-repository-installation-for-gitlab-and-azure-devops#streamlined-multi-repository-installation-for-gitlab-and-azure-devops) Streamlined Multi-Repository Installation for GitLab and Azure DevOps We’re thrilled to announce a significant enhancement to CodeRabbit that simplifies your workflow! You can now install CodeRabbit on multiple repositories simultaneously for GitLab and Azure DevOps, eliminating the need to activate each repository individually. With this update, you can: * ✅ Select Multiple Repositories: Check the boxes next to the repositories you wish to activate. * 🖱️ One-Click Installation: Select the **Install Repositories** button on the top right to integrate CodeRabbit across all selected projects instantly. Assistant Responses are generated using AI and may contain mistakes. --- # Generate unit tests - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Analyze & improve your code Generate unit tests On this page * [Usage​](https://docs.coderabbit.ai/finishing-touches/unit-test-generation#usage%E2%80%8B) * [Path Instructions​](https://docs.coderabbit.ai/finishing-touches/unit-test-generation#path-instructions%E2%80%8B) * [Supported software forges​](https://docs.coderabbit.ai/finishing-touches/unit-test-generation#supported-software-forges%E2%80%8B) * [Supported CI/CD systems​](https://docs.coderabbit.ai/finishing-touches/unit-test-generation#supported-ci%2Fcd-systems%E2%80%8B) This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. This feature is in beta. Unit Test Generation is part of the [finishing touches](https://docs.coderabbit.ai/future-development#finishing-touches) . [​](https://docs.coderabbit.ai/finishing-touches/unit-test-generation#usage%E2%80%8B) Usage[​](https://docs.coderabbit.ai/finishing-touches/unit-test-generation#usage "Direct link to Usage") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ![Unit Test Generation](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/finishing-touches/assets/images/utg.gif) Once you are done with your pull request and its reviews, you may want to perform finishing touches to your code, such as adding unit tests. You can request CodeRabbit to generate unit tests by typing `@coderabbitai generate unit tests` in a comment under that pull request or by clicking a checkbox under **Generate Unit Tests** in the CodeRabbit Walkthrough. Once sent, CodeRabbit will perform the following actions: * The CodeRabbit agent will examine your code for places where it needs tests * Unit tests will be generated for the PR, in a separate PR, in the same PR in a new commit, or in a comment to copy-paste, depending on your choice * If (and only if) you choose to generate the unit tests in a separate PR, CodeRabbit will examine your GitHub checks (build steps and tests and such) and adjust the PR to deal with build failures, test failures and similar. [​](https://docs.coderabbit.ai/finishing-touches/unit-test-generation#path-instructions%E2%80%8B) Path Instructions[​](https://docs.coderabbit.ai/finishing-touches/unit-test-generation#path-instructions "Direct link to Path Instructions") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You can customize the generated unit tests by providing instructions based on file paths in your `.coderabbit.yaml`. The `path` is a [minimatch](https://github.com/isaacs/minimatch) pattern. Copy code_generation: unit_tests: path_instructions: - path: "**/*.ts" instructions: | Use vitest for testing framework. Generate comprehensive test cases including edge cases and error conditions. Do not omit the imports; the test file must be valid. [​](https://docs.coderabbit.ai/finishing-touches/unit-test-generation#supported-software-forges%E2%80%8B) Supported software forges[​](https://docs.coderabbit.ai/finishing-touches/unit-test-generation#supported-software-forges "Direct link to Supported software forges") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- These software forges are supported: * GitHub [​](https://docs.coderabbit.ai/finishing-touches/unit-test-generation#supported-ci%2Fcd-systems%E2%80%8B) Supported CI/CD systems[​](https://docs.coderabbit.ai/finishing-touches/unit-test-generation#supported-cicd-systems "Direct link to Supported CI/CD systems") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- These CI/CD systems are supported for post-generation adjustments: * GitHub actions [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/finishing-touches/unit-test-generation.md) Last updated on **Jul 31, 2025** [Generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) [Integrate issue tracking](https://docs.coderabbit.ai/integrations/issue-integrations) Assistant Responses are generated using AI and may contain mistakes. --- # Quickstart - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Get started Quickstart On this page * [Before you begin​](https://docs.coderabbit.ai/getting-started/quickstart#before-you-begin%E2%80%8B) * [Integrate CodeRabbit with your GitHub account​](https://docs.coderabbit.ai/getting-started/quickstart#integrate-coderabbit-with-your-github-account%E2%80%8B) * [Add CodeRabbit to your repository​](https://docs.coderabbit.ai/getting-started/quickstart#add-coderabbit-to-your-repository%E2%80%8B) * [Let CodeRabbit perform a code review​](https://docs.coderabbit.ai/getting-started/quickstart#let-coderabbit-perform-a-code-review%E2%80%8B) * [Ask CodeRabbit for more information​](https://docs.coderabbit.ai/getting-started/quickstart#ask-coderabbit-for-more-information%E2%80%8B) * [Clean up​](https://docs.coderabbit.ai/getting-started/quickstart#clean-up%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/getting-started/quickstart#what%E2%80%99s-next%E2%80%8B) 1 Integrate CodeRabbit into a GitHub-based repository that you own 2 Observe CodeRabbit perform a code review of a pull request that you initiate 3 Converse with CodeRabbit about the code review 4 Prompt CodeRabbit to generate its own improvements to the pull request When you complete this tutorial, you’ll have seen CodeRabbit’s code-review feature in action, and glimpsed a few of its other AI-driven abilities as well. For a more general overview of CodeRabbit, see [Introduction](https://docs.coderabbit.ai/) . While this tutorial focuses on GitHub, CodeRabbit also works with GitLab, Azure DevOps, and Bitbucket. For more information, see [Integrate with Git platforms](https://docs.coderabbit.ai/platforms) . [​](https://docs.coderabbit.ai/getting-started/quickstart#before-you-begin%E2%80%8B) Before you begin[​](https://docs.coderabbit.ai/getting-started/quickstart#before-you-begin "Direct link to Before you begin") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Create a new, private repository on GitHub. Name the new repository `coderabbit-test`, and let it have otherwise default GitHub settings. [​](https://docs.coderabbit.ai/getting-started/quickstart#integrate-coderabbit-with-your-github-account%E2%80%8B) Integrate CodeRabbit with your GitHub account[​](https://docs.coderabbit.ai/getting-started/quickstart#integrate-coderabbit-with-your-github-account "Direct link to Integrate CodeRabbit with your GitHub account") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ To integrate CodeRabbit with your GitHub account, follow these steps: 1 Create an account Visit [the CodeRabbit login page](https://app.coderabbit.ai/login?free-trial) . 2 Login with your git provider Click **Login with GitHub**. 3 Authorize Click **Authorize coderabbitai**. CodeRabbit takes a moment to set up the integration. After it finishes, the CodeRabbit dashboard appears. [​](https://docs.coderabbit.ai/getting-started/quickstart#add-coderabbit-to-your-repository%E2%80%8B) Add CodeRabbit to your repository[​](https://docs.coderabbit.ai/getting-started/quickstart#add-coderabbit-to-your-repository "Direct link to Add CodeRabbit to your repository") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ To add CodeRabbit to your test repository, follow these steps: 1 Access repository settings On the CodeRabbit dashboard, click **Add Repositories**. A GitHub repository-access dialog appears. 2 Grant repository access Select the **Only select repositories** radio button. 3 Select your test repository From the **Select repositories** menu, select the `coderabbit-test` repository that you created earlier in this Quickstart. 4 Install and authorize CodeRabbit Click **Install & Authorize**. CodeRabbit requests read and write access to your repository in order for its code review, issue management, and pull request generation features to work. CodeRabbit never stores your code. For more information, see [the CodeRabbit Trust Center](https://trust.coderabbit.ai/) . 5 Complete signup if prompted If a CodeRabbit **Complete your signup** dialog appears, then fill it out with the requested information before continuing. CodeRabbit is now ready to use with your test repository. The next steps demonstrate its core code-review features. [​](https://docs.coderabbit.ai/getting-started/quickstart#let-coderabbit-perform-a-code-review%E2%80%8B) Let CodeRabbit perform a code review[​](https://docs.coderabbit.ai/getting-started/quickstart#let-coderabbit-perform-a-code-review "Direct link to Let CodeRabbit perform a code review") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ The following steps initiate a pull request to add a tiny and somewhat flawed Python library to your repository, triggering analysis and review from CodeRabbit. Use your usual Git workflow to perform the following steps in the `coderabbit-test` repository: 1 Create a branch Create a branch named `add-utils`. 2 Create a new file In that new `add-utils` branch, create a new file called `simple_utils.py`, with the following content: Copy # simple_utils.py - A tiny utility library def reverse_string(text): """Reverses the characters in a string.""" return text[::-1] def count_words(sentence): return len(sentence.split()) def celsius_to_fahrenheit(celsius): return (celsius * 9/5) + 32 3 Commit the file Commit the added file to the `add-utils` branch. Use any text you want for the commit message. 4 Create a pull request Create a pull request that proposes to merge the `add-utils` branch into the `main` branch. Use any text you want for the pull request message. After a few moments, CodeRabbit responds to the pull request using the `@coderabbitai` GitHub account. It performs the following actions, all of which are visible on the pull request’s page on GitHub: * If you didn’t write a pull request summary, then CodeRabbit adds a new summary to the pull request. * CodeRabbit posts a comment titled **Walkthrough** containing analysis and commentary about the content of the pull request. * CodeRabbit attaches a detailed code review to the pull request as another comment. Part of the review resembles the following screenshot: ![An example code review comment](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/quickstart-comment-9310a2af173d5afbd2c74a762e6bd808.png) This shows that CodeRabbit has noticed some flaws with this Python library, including a lack of docstrings and input validation. The review comment identifies these flaws, and suggests how you might improve them. [​](https://docs.coderabbit.ai/getting-started/quickstart#ask-coderabbit-for-more-information%E2%80%8B) Ask CodeRabbit for more information[​](https://docs.coderabbit.ai/getting-started/quickstart#ask-coderabbit-for-more-information "Direct link to Ask CodeRabbit for more information") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- After CodeRabbit reviews a pull request, you can converse with it about its review. You can also give CodeRabbit special commands to request it to perform specific functions, such as generating appropriate code changes for you. 1. Post the following as a new GitHub comment attached to the pull request: Chat in PR Copy @coderabbitai Why do all of these functions need docstrings? Isn't it obvious enough what they do? After a few moments, CodeRabbit posts its reply, explaining its motivations for its recommendation. The reply might resemble the following: > You’re right that these functions are quite self-explanatory from their names alone. Docstrings aren’t strictly necessary for every function, especially in smaller projects with clear function names. While docstrings do provide benefits (IDE tooltips, documentation generation, help for future developers), they can sometimes feel redundant for very straightforward functions. It’s ultimately a matter of coding style and project requirements. If you prefer to skip docstrings for obvious utility functions in this project, that’s perfectly reasonable. Would you like me to adjust my review approach regarding documentation for this repository? In this case, CodeRabbit is offering to adjust its future behavior when reviewing changes to this repository. Instead, follow the next step to ask CodeRabbit to implement part of its suggestions. 2. Post the following as another new comment: Copy @coderabbitai generate docstrings After a few moments, CodeRabbit does the following: * CodeRabbit creates a new branch, based on `add-utils`. * CodeRabbit commits changes to the branch that adds suggested docstrings to `add-utils`. * CodeRabbit opens a new pull request between the new branch and `add-utils`. [​](https://docs.coderabbit.ai/getting-started/quickstart#clean-up%E2%80%8B) Clean up[​](https://docs.coderabbit.ai/getting-started/quickstart#clean-up "Direct link to Clean up") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Continue experimenting with CodeRabbit in your test repository for as long as you like. When you’re finished, you can delete the repository. You are now ready to add CodeRabbit to other repositories that you own, and let it review some real pull requests. [​](https://docs.coderabbit.ai/getting-started/quickstart#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/getting-started/quickstart#whats-next "Direct link to What's next") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Integrate CodeRabbit](https://docs.coderabbit.ai/platforms) with your repositories on GitHub, GitLab, Azure DevOps, or Bitbucket. * [Configure CodeRabbit](https://docs.coderabbit.ai/getting-started/configure-coderabbit) beyond its default settings. * [Add custom review instructions](https://docs.coderabbit.ai/guides/review-instructions) . * [Get support for CodeRabbit](https://docs.coderabbit.ai/getting-started/support) . * [Learn more about how CodeRabbit works](https://docs.coderabbit.ai/overview/why-coderabbit) . [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/getting-started/quickstart.md) Last updated on **Jul 31, 2025** [Introduction](https://docs.coderabbit.ai/overview/introduction) [Overview](https://docs.coderabbit.ai/platforms/overview) Assistant Responses are generated using AI and may contain mistakes. --- # Generate docstrings - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Analyze & improve your code Generate docstrings On this page * [Usage​](https://docs.coderabbit.ai/finishing-touches/docstrings#usage%E2%80%8B) * [Path Instructions​](https://docs.coderabbit.ai/finishing-touches/docstrings#path-instructions%E2%80%8B) * [Supported software forges​](https://docs.coderabbit.ai/finishing-touches/docstrings#supported-software-forges%E2%80%8B) * [Supported languages​](https://docs.coderabbit.ai/finishing-touches/docstrings#supported-languages%E2%80%8B) This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. Docstrings generation is part of the [finishing touches](https://docs.coderabbit.ai/future-development#finishing-touches) . [​](https://docs.coderabbit.ai/finishing-touches/docstrings#usage%E2%80%8B) Usage[​](https://docs.coderabbit.ai/finishing-touches/docstrings#usage "Direct link to Usage") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Once you are done with your pull request and its reviews, you may want to perform finishing touches to your code, such as adding in-code documentation. You can request CodeRabbit to generate docstrings by typing `@coderabbitai generate docstrings` in a comment under that pull request or by clicking the **Generate Docstrings** checkbox under **Finishing Touches** in the CodeRabbit Walkthrough. Once sent, CodeRabbit will perform the following actions: * All functions that are in the pull request’s changes will be fetched using `ast-grep` * Docstrings will be generated for the functions where they are missing or incomplete * These docstrings will be committed in a new branch in the same repository * CodeRabbit will open a pull request from this new branch to the existing pull request Here’s an example of what a pull request may look like: ![Docstrings PR](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/finishing-touches/assets/images/docstrings-pull-request-9148dc697aa77238c93a4797a87f726a.png) CodeRabbit cannot perform further modifications to opened pull requests. From there, it’s your turn to checkout the branch and improve it to satisfaction. We believe that this workflow provides a significant headstart to documenting code. This feature has been rigorously tested and is now available for all Pro plan users. Additionally, you can provide feedback about this feature on [Discord](https://discord.com/channels/1134356397673414807/1317286905557287022) . [​](https://docs.coderabbit.ai/finishing-touches/docstrings#path-instructions%E2%80%8B) Path Instructions[​](https://docs.coderabbit.ai/finishing-touches/docstrings#path-instructions "Direct link to Path Instructions") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ You can customize the generated docstrings by providing instructions based on file paths in your `.coderabbit.yaml`. The `path` is a [minimatch](https://github.com/isaacs/minimatch) pattern. Copy code_generation: docstrings: path_instructions: - path: "**/*.ts" instructions: | End all docstrings with a notice that says "Auto-generated by CodeRabbit.". Do not omit the closing tags; the docstring must be valid. [​](https://docs.coderabbit.ai/finishing-touches/docstrings#supported-software-forges%E2%80%8B) Supported software forges[​](https://docs.coderabbit.ai/finishing-touches/docstrings#supported-software-forges "Direct link to Supported software forges") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- These software forges are supported: * Azure DevOps * GitHub * GitLab While Bitbucket is not officially supported, docstrings can still be generated. However, they will be posted in a comment under the pull request. Full support for Bitbucket is planned. [​](https://docs.coderabbit.ai/finishing-touches/docstrings#supported-languages%E2%80%8B) Supported languages[​](https://docs.coderabbit.ai/finishing-touches/docstrings#supported-languages "Direct link to Supported languages") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- These languages are supported: * Bash * C * C# * C++ * Elixir * Go * Java * JavaScript * Kotlin * Lua * Php * Python * React TypeScript * Ruby * Rust * Swift * TypeScript CodeRabbit uses `ast-grep` to parse the code. If you want a new language to be supported, please look into [Add New Language to ast-grep](https://ast-grep.github.io/contributing/add-lang.html#add-new-language-to-ast-grep) first. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/finishing-touches/docstrings.md) Last updated on **Jul 31, 2025** [Code Graph Analysis](https://docs.coderabbit.ai/integrations/code-graph-analysis) [Generate unit tests](https://docs.coderabbit.ai/finishing-touches/unit-test-generation) Assistant Responses are generated using AI and may contain mistakes. --- # Control and manage code reviews - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Review pull requests Control and manage code reviews On this page * [Control automatic code reviews​](https://docs.coderabbit.ai/guides/commands#control-automatic-code-reviews%E2%80%8B) * [Pause and resume automatic code reviews​](https://docs.coderabbit.ai/guides/commands#pause-and-resume-automatic-code-reviews%E2%80%8B) * [Disable automatic code reviews​](https://docs.coderabbit.ai/guides/commands#disable-automatic-code-reviews%E2%80%8B) * [Manually request code reviews​](https://docs.coderabbit.ai/guides/commands#manually-request-code-reviews%E2%80%8B) * [Resolve comments​](https://docs.coderabbit.ai/guides/commands#resolve-comments%E2%80%8B) * [Update information about the pull request​](https://docs.coderabbit.ai/guides/commands#update-information-about-the-pull-request%E2%80%8B) * [Update the summary text​](https://docs.coderabbit.ai/guides/commands#update-the-summary-text%E2%80%8B) * [Diagram the pull request history​](https://docs.coderabbit.ai/guides/commands#diagram-the-pull-request-history%E2%80%8B) * [Get information about CodeRabbit​](https://docs.coderabbit.ai/guides/commands#get-information-about-coderabbit%E2%80%8B) * [Display current configuration​](https://docs.coderabbit.ai/guides/commands#display-current-configuration%E2%80%8B) * [Display a quick-reference guide​](https://docs.coderabbit.ai/guides/commands#display-a-quick-reference-guide%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/commands#what%E2%80%99s-next%E2%80%8B) You can control CodeRabbit’s behavior with a specific pull request by mentioning the username of its bot, `@coderabbitai`, alongside keywords in comments or the pull request description, as specified by the next sections of this page. For a complete CodeRabbit command reference, see [Code review command reference](https://docs.coderabbit.ai/reference/review-commands) . [​](https://docs.coderabbit.ai/guides/commands#control-automatic-code-reviews%E2%80%8B) Control automatic code reviews[​](https://docs.coderabbit.ai/guides/commands#flow "Direct link to Control automatic code reviews") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ By default, CodeRabbit automatically reviews every new pull request created in your repository. It updates its review with comments whenever the pull request has new commits pushed to it. The following sections show you how to tell CodeRabbit to modify this behavior with a specific pull request, such as pausing reviews, or resolving open comments. For more information about permanently configuring the behavior of CodeRabbit on your repository, see [Add a configuration file](https://docs.coderabbit.ai/getting-started/configure-coderabbit) . ### [​](https://docs.coderabbit.ai/guides/commands#pause-and-resume-automatic-code-reviews%E2%80%8B) Pause and resume automatic code reviews[​](https://docs.coderabbit.ai/guides/commands#pause-resume "Direct link to Pause and resume automatic code reviews") You can tell CodeRabbit to pause its automatic reviews of a pull request. If you do, then you can still manually request CodeRabbit to review changes using the commands listed on [Code review command reference](https://docs.coderabbit.ai/reference/review-commands) . To pause automated reviews of a pull request, post the following comment to the pull request: Copy @coderabbitai pause To resume automated reviews after pausing them, post the following comment to the pull request: Copy @coderabbitai resume ### [​](https://docs.coderabbit.ai/guides/commands#disable-automatic-code-reviews%E2%80%8B) Disable automatic code reviews[​](https://docs.coderabbit.ai/guides/commands#ignore "Direct link to Disable automatic code reviews") To disable automatic code reviews for a pull request, add the following line anywhere in the pull request description: Copy @coderabbitai ignore As long as that text remains in the description, CodeRabbit will not automatically review any commits associated with that pull request. You can still [chat with CodeRabbit](https://docs.coderabbit.ai/guides/agent_chat) and issue other commands in the pull request comments. To enable automatic reviews on that pull request, delete “`@coderabbitai ignore`” from the pull request description. CodeRabbit commences automatic reviews starting with the next commit made to the branch under review. [​](https://docs.coderabbit.ai/guides/commands#manually-request-code-reviews%E2%80%8B) Manually request code reviews[​](https://docs.coderabbit.ai/guides/commands#request "Direct link to Manually request code reviews") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ You can ask CodeRabbit to perform a code review at any time. This can be useful when you have paused automated code reviews. Manually requested reviews have two types: * A _full review_ disregards any comments that CodeRabbit has already made on this pull request, and generates a complete review of the entire pull request. * An _incremental review_ takes all comments that CodeRabbit has made since its most recent full review into consideration, and generates a review of only the new changes. To manually request a full review, post the following comment to the pull request: Copy @coderabbitai full review To manually request an incremental review, post the following comment to the pull request: Copy @coderabbitai review [​](https://docs.coderabbit.ai/guides/commands#resolve-comments%E2%80%8B) Resolve comments[​](https://docs.coderabbit.ai/guides/commands#resolve "Direct link to Resolve comments") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To have CodeRabbit mark all of its previous comments as resolved, post the following comment to the pull request: Copy @coderabbitai resolve [​](https://docs.coderabbit.ai/guides/commands#update-information-about-the-pull-request%E2%80%8B) Update information about the pull request[​](https://docs.coderabbit.ai/guides/commands#update "Direct link to Update information about the pull request") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The commands in this section request CodeRabbit to generate and post updated information about the pull request itself. ### [​](https://docs.coderabbit.ai/guides/commands#update-the-summary-text%E2%80%8B) Update the summary text[​](https://docs.coderabbit.ai/guides/commands#summary "Direct link to Update the summary text") To have CodeRabbit update the generated summary of the branch’s proposed changes to the pull request’s description, post the following comment: Copy @coderabbitai summary CodeRabbit updates the summary text to the description under the heading “Summary by CodeRabbit”. ### [​](https://docs.coderabbit.ai/guides/commands#diagram-the-pull-request-history%E2%80%8B) Diagram the pull request history[​](https://docs.coderabbit.ai/guides/commands#diagram "Direct link to Diagram the pull request history") To have CodeRabbit post a comment that contains a sequence diagram which visualizes the history of the pull request under review, post the following comment: Copy @coderabbitai generate sequence diagram [​](https://docs.coderabbit.ai/guides/commands#get-information-about-coderabbit%E2%80%8B) Get information about CodeRabbit[​](https://docs.coderabbit.ai/guides/commands#info "Direct link to Get information about CodeRabbit") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ The commands in this section request CodeRabbit to display its own configuration or documentation. ### [​](https://docs.coderabbit.ai/guides/commands#display-current-configuration%E2%80%8B) Display current configuration[​](https://docs.coderabbit.ai/guides/commands#config "Direct link to Display current configuration") To have CodeRabbit post a comment listing out its current configuration with your repository, post the following comment to the pull request: Copy @coderabbitai configuration ### [​](https://docs.coderabbit.ai/guides/commands#display-a-quick-reference-guide%E2%80%8B) Display a quick-reference guide[​](https://docs.coderabbit.ai/guides/commands#help "Direct link to Display a quick-reference guide") To have CodeRabbit post a comment to the pull request with a quick-reference guide to its own commands and other features, post the following comment to the pull request: Copy @coderabbitai help [​](https://docs.coderabbit.ai/guides/commands#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/commands#whats-next "Direct link to What's next") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Generate code improvements](https://docs.coderabbit.ai/guides/generate-improvements) * [Best practices](https://docs.coderabbit.ai/guides/code-review-best-practices) * [Troubleshooting](https://docs.coderabbit.ai/guides/code-review-troubleshooting) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/commands.md) Last updated on **Jul 31, 2025** [Overview](https://docs.coderabbit.ai/guides/code-review-overview) [Generate improvements](https://docs.coderabbit.ai/guides/generate-improvements) Assistant Responses are generated using AI and may contain mistakes. --- # Code review troubleshooting - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Review pull requests Code review troubleshooting If a CodeRabbit command doesn’t seem to work: 1. Check that you have the necessary repository permissions. 2. Verify the command syntax. 3. Look for any response from CodeRabbit in the PR comments. 4. Use `@coderabbitai help` for command guidance. Need help? Join our community on [Discord](https://discord.gg/coderabbit) or [contact our support team](https://docs.coderabbit.ai/getting-started/support) . [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/code-review-troubleshooting.md) Last updated on **Jul 31, 2025** [Generate improvements](https://docs.coderabbit.ai/guides/generate-improvements) [CodeRabbit Chat](https://docs.coderabbit.ai/guides/agent_chat) Assistant Responses are generated using AI and may contain mistakes. --- # Set permissions - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Add CodeRabbit to your repository Set permissions 1. Navigate to your organization or repository settings in GitHub 2. Go to the “GitHub Apps” or “Installed GitHub Apps” section 3. Find CodeRabbit in the list of installed apps 4. Click “Configure” 5. Review and accept the new permissions ![Permission warning example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/permission-warning-5ae71501a21d040a0a3142c6ae247393.png) ![Granting updated permissions](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/grant-permission-25e8329e13fbfa0b9b8a9c377533b58b.png) ![Updated permissions](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/updated-permissions-e69565bdcc98dca8616e78f5b0cfa46a.png) Common reasons for permission updates include: * Access to new GitHub features * Enhanced repository scanning capabilities * Additional workflow automation features * Improved security features > Note: If you’re not an organization admin, you may need to request approval from your organization administrators to update the permissions. After accepting the new permissions, CodeRabbit will have the access it needs to function properly. If you continue to experience issues, try refreshing your browser or reaching out to our support team. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/getting-started/upgrading-permissions.md) Last updated on **Jul 31, 2025** [Add organizations](https://docs.coderabbit.ai/getting-started/adding-organizations) [Overview](https://docs.coderabbit.ai/guides/code-review-overview) Assistant Responses are generated using AI and may contain mistakes. --- # Support for On-premises Learning and GitLab Follow-up Issue Creation - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Support for On-premises Learning and GitLab Follow-up Issue Creation On this page * [Support for On-premises Learning and GitLab Follow-up Issue Creation](https://docs.coderabbit.ai/changelog/support-for-on-premises-learning-and-gitlab-follow-up-issue-creation#support-for-on-premises-learning-and-gitlab-follow-up-issue-creation) ### [​](https://docs.coderabbit.ai/changelog/support-for-on-premises-learning-and-gitlab-follow-up-issue-creation#support-for-on-premises-learning-and-gitlab-follow-up-issue-creation) Support for On-premises Learning and GitLab Follow-up Issue Creation Learnings enable developers to fine-tune the AI for their specific files, repositories, and codebase, enhancing future reviews. We’re excited to extend this feature to our on-premises customers. Additionally, we’ve improved our automated workflow to create follow-up issues directly from Merge Request reviews in GitLab. Assistant Responses are generated using AI and may contain mistakes. --- # New Dashboard - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation New Dashboard On this page * [New Dashboard](https://docs.coderabbit.ai/changelog/new-dashboard#new-dashboard) ### [​](https://docs.coderabbit.ai/changelog/new-dashboard#new-dashboard) New Dashboard We’re excited to share our updated dashboard, designed to give you better insights into CodeRabbit review metrics. What’s new: * Flexible Time Selector: Choose different periods to analyze your data * Useful Context: See how learnings, tools, and path instructions are used in reviews * New Visuals: Check out the bar, line, and stats charts for a better understanding * Custom Filters: Easily filter data by user, repository, pull request, and review profile * Tools Overview: See tool usage based on severity and total incidents reported These updates are here to help you get more from the dashboard. Take a look today! Assistant Responses are generated using AI and may contain mistakes. --- # Configure the VSCode extension - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation IDE extensions Configure the VSCode extension On this page * [Find the settings screen​](https://docs.coderabbit.ai/guides/config-vscode#find-the-settings-screen%E2%80%8B) * [Configure AI agent integration​](https://docs.coderabbit.ai/guides/config-vscode#configure-ai-agent-integration%E2%80%8B) * [Configure automatic review behavior​](https://docs.coderabbit.ai/guides/config-vscode#configure-automatic-review-behavior%E2%80%8B) * [Use with self-hosted CodeRabbit​](https://docs.coderabbit.ai/guides/config-vscode#use-with-self-hosted-coderabbit%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/config-vscode#what%E2%80%99s-next%E2%80%8B) This page is about configuring the CodeRabbit VSCode extension. For more information about the extension, see [Review local changes](https://docs.coderabbit.ai/code-editors) . 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. [​](https://docs.coderabbit.ai/guides/config-vscode#find-the-settings-screen%E2%80%8B) Find the settings screen[​](https://docs.coderabbit.ai/guides/config-vscode#find "Direct link to Find the settings screen") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To navigate to the settings screen for the CodeRabbit VSCode extension, follow these steps: 1. Open the CodeRabbit activity bar/sidebar. 2. In the sidebar, click on gear shaped icon on top right(beside logout icon). 3. You can also search for CodeRabbit: Settings in the command palette to open the settings. The settings screen contains the following configuration controls. [​](https://docs.coderabbit.ai/guides/config-vscode#configure-ai-agent-integration%E2%80%8B) Configure AI agent integration[​](https://docs.coderabbit.ai/guides/config-vscode#agent "Direct link to Configure AI agent integration") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The **Agent Type** setting lets you choose the extension’s response to using the **Fix with AI** feature during code reviews. Your options are the following: * **Native**: The extension prompts the AI agent associated with your IDE to apply the suggested fix. This works only with VSCode(using Copilot) and Cursor(you have to start the task). If you have this option selected when using a different IDE, then the extension instead copies the prompt to your clipboard. * **Claude Code**: The extension opens the Terminal pane of your IDE and tries to use the `claude` command-line program to apply the suggested fix to your code. You need to have [Claude Code](https://www.anthropic.com/claude-code) installed for this option to be effective. * **Codex CLI**: The extension opens the Terminal pane of your IDE and tries to use the `codex` command-line program to apply the suggested fix to your code. You need to have [Codex CLI](https://github.com/openai/codex) installed for this option to be effective. * **OpenCode**: The extension opens the Terminal pane of your IDE and tries to use the `opencode` command-line program to apply the suggested fix to your code. You need to have [OpenCode](https://opencode.ai/) installed for this option to be effective. * **Cline**: The extension opens the `Cline` sidebar and runs a task to apply the suggested fix to your code. You need to have the [Cline](https://cline.bot/) extension installed for this option to be effective. * **Roo**: The extension opens the `Roo` sidebar and runs a task to apply the suggested fix to your code. You need to have the [Roo](https://github.com/RooCodeInc/Roo-Code) extension installed for this option to be effective. * **Kilo Code**: The extension opens the `Kilo Code` sidebar and runs a task to apply the suggested fix to your code. You need to have the [Kilo Code](https://kilocode.ai/) extension installed for this option to be effective. * **Augment Code**: The extension opens the `Augment Code` sidebar with the prompt to apply the suggested fix to your code, and you can start the task. You need to have the [Augment Code](https://www.augmentcode.com/) extension installed for this option to be effective. * **Clipboard**: The extension copies prompt text describing the suggested fix to your clipboard. From there, you can manually paste the prompt into the coding AI agent that you use with your IDE. For more information about the **Fix with AI** feature, see [Request help from your AI coding agent](https://docs.coderabbit.ai/guides/use-vscode#agent) . [​](https://docs.coderabbit.ai/guides/config-vscode#configure-automatic-review-behavior%E2%80%8B) Configure automatic review behavior[​](https://docs.coderabbit.ai/guides/config-vscode#auto-reviews "Direct link to Configure automatic review behavior") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The **Auto Review Mode** setting lets you control the behavior of the automatic code reviews that the extension can perform after you make commits to your local Git repository. Your options are the following: * **Disabled**: The extension doesn’t perform automatic code reviews. * **Prompt**: After every commit, the extension displays a dialog asking if you’d like it to perform a code review. * **Auto**: The extension always performs a review after every commit. For more information about this feature, see [Automatically review local commits](https://docs.coderabbit.ai/guides/use-vscode#auto-reviews) . [​](https://docs.coderabbit.ai/guides/config-vscode#use-with-self-hosted-coderabbit%E2%80%8B) Use with self-hosted CodeRabbit[​](https://docs.coderabbit.ai/guides/config-vscode#self-hosted-coderabbit "Direct link to Use with self-hosted CodeRabbit") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This setting is only used when you’re using a self-hosted instance of CodeRabbit. If you’re using the CodeRabbit Cloud service, you don’t need to configure this setting. You will need to login and logout of the extension after adding this value. [​](https://docs.coderabbit.ai/guides/config-vscode#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/config-vscode#whats-next "Direct link to What's next") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Use the VSCode extension](https://docs.coderabbit.ai/guides/use-vscode) * [Uninstall the VSCode extension](https://docs.coderabbit.ai/guides/uninstall-vscode) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/config-vscode.md) Last updated on **Jul 31, 2025** [Use with self-hosted CodeRabbit](https://docs.coderabbit.ai/guides/use-vscode-selfhosted) [Uninstall the VSCode extension](https://docs.coderabbit.ai/guides/uninstall-vscode) Assistant Responses are generated using AI and may contain mistakes. --- # Create issues - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Create and resolve issues Create issues On this page * [Creating Issues Through Agentic Chat​](https://docs.coderabbit.ai/guides/issue-creation#creating-issues-through-agentic-chat%E2%80%8B) * [Supported Platforms​](https://docs.coderabbit.ai/guides/issue-creation#supported-platforms%E2%80%8B) * [GitHub Issues​](https://docs.coderabbit.ai/guides/issue-creation#github-issues%E2%80%8B) * [GitLab Issues​](https://docs.coderabbit.ai/guides/issue-creation#gitlab-issues%E2%80%8B) * [Jira​](https://docs.coderabbit.ai/guides/issue-creation#jira%E2%80%8B) * [Linear​](https://docs.coderabbit.ai/guides/issue-creation#linear%E2%80%8B) * [Tips for Issue Creation​](https://docs.coderabbit.ai/guides/issue-creation#tips-for-issue-creation%E2%80%8B) This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. CodeRabbit provides seamless issue creation capabilities across multiple platforms including GitHub, GitLab, Jira, and Linear. You can create issues directly from pull request discussions or through the agentic chat interface. [​](https://docs.coderabbit.ai/guides/issue-creation#creating-issues-through-agentic-chat%E2%80%8B) Creating Issues Through Agentic Chat[​](https://docs.coderabbit.ai/guides/issue-creation#creating-issues-through-agentic-chat "Direct link to Creating Issues Through Agentic Chat") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Using CodeRabbit’s chat functions, you can create issues naturally through conversations in comments or comment threads. Simply mention `@coderabbitai` and ask to create an issue. ![Creating issues inline](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/create-issue-inline-b91a86abf63c16c0b2c23e1a02503708.png) When using CodeRabbit’s [agentic chat](https://docs.coderabbit.ai/guides/agent_chat) , CodeRabbit will help you format and create the issue with appropriate details based on your description and desired issue platform. ![Creating issues through agentic chat](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/create-issue-agentic-16f6b85f1b33448734443087830912fd.png) [​](https://docs.coderabbit.ai/guides/issue-creation#supported-platforms%E2%80%8B) Supported Platforms[​](https://docs.coderabbit.ai/guides/issue-creation#supported-platforms "Direct link to Supported Platforms") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ ### [​](https://docs.coderabbit.ai/guides/issue-creation#github-issues%E2%80%8B) GitHub Issues[​](https://docs.coderabbit.ai/guides/issue-creation#github-issues "Direct link to GitHub Issues") CodeRabbit can create GitHub issues directly in your repository. The integration works automatically without additional setup. ### [​](https://docs.coderabbit.ai/guides/issue-creation#gitlab-issues%E2%80%8B) GitLab Issues[​](https://docs.coderabbit.ai/guides/issue-creation#gitlab-issues "Direct link to GitLab Issues") Similar to GitHub, GitLab issue creation is supported out of the box. ### [​](https://docs.coderabbit.ai/guides/issue-creation#jira%E2%80%8B) Jira[​](https://docs.coderabbit.ai/guides/issue-creation#jira "Direct link to Jira") To create Jira issues, ensure you have [configured the Jira integration](https://docs.coderabbit.ai/integrations/issue-integrations#jira) first. ### [​](https://docs.coderabbit.ai/guides/issue-creation#linear%E2%80%8B) Linear[​](https://docs.coderabbit.ai/guides/issue-creation#linear "Direct link to Linear") Make sure you have [set up the Linear integration](https://docs.coderabbit.ai/integrations/issue-integrations#linear) to create Linear issues. [​](https://docs.coderabbit.ai/guides/issue-creation#tips-for-issue-creation%E2%80%8B) Tips for Issue Creation[​](https://docs.coderabbit.ai/guides/issue-creation#tips-for-issue-creation "Direct link to Tips for Issue Creation") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * Use natural language when creating issues through agentic chat * Include code snippets when relevant * Specify assignees if known * Set appropriate priorities * Add deadlines or milestones if applicable For more detailed information about issue tracking integrations, see our [Issue Integrations](https://docs.coderabbit.ai/integrations/issue-integrations) guide. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/issue-creation.md) Last updated on **Jul 31, 2025** [Issue Chat](https://docs.coderabbit.ai/guides/issue-chat) [Linked Issues](https://docs.coderabbit.ai/guides/linked-issues) Assistant Responses are generated using AI and may contain mistakes. --- # Request Changes Workflow - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Request Changes Workflow On this page * [Request Changes Workflow](https://docs.coderabbit.ai/changelog/request-changes-workflow#request-changes-workflow) ### [​](https://docs.coderabbit.ai/changelog/request-changes-workflow#request-changes-workflow) Request Changes Workflow Enable Request Changes review workflow for CodeRabbit reviews via .coderabbit.yaml under the field `request_changes_workflow` (default: false). When enabled, review comments are posted as request changes and CodeRabbit review will be marked approved once all the review comments are resolved. Assistant Responses are generated using AI and may contain mistakes. --- # GitLab Pipeline Failure Detection and Remediation - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation GitLab Pipeline Failure Detection and Remediation On this page * [GitLab Pipeline Failure Detection and Remediation](https://docs.coderabbit.ai/changelog/gitlab-pipeline-failure-detection-and-remediation#gitlab-pipeline-failure-detection-and-remediation) ### [​](https://docs.coderabbit.ai/changelog/gitlab-pipeline-failure-detection-and-remediation#gitlab-pipeline-failure-detection-and-remediation) GitLab Pipeline Failure Detection and Remediation We’ve expanded our pipeline error detection capabilities to GitLab Users! Just like with GitHub Actions, you can now automatically detect and fix pipeline failures in your GitLab CI/CD workflows. Assistant Responses are generated using AI and may contain mistakes. --- # CodeRabbit Chat - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Review pull requests CodeRabbit Chat On this page * [Invocation​](https://docs.coderabbit.ai/guides/agent_chat#invocation%E2%80%8B) * [Features​](https://docs.coderabbit.ai/guides/agent_chat#features%E2%80%8B) * [Script Writing​](https://docs.coderabbit.ai/guides/agent_chat#script-writing%E2%80%8B) * [Web Search​](https://docs.coderabbit.ai/guides/agent_chat#web-search%E2%80%8B) * [Code Graph Analysis Integration​](https://docs.coderabbit.ai/guides/agent_chat#code-graph-analysis-integration%E2%80%8B) * [Jira and Linear Integration​](https://docs.coderabbit.ai/guides/agent_chat#jira-and-linear-integration%E2%80%8B) * [Learnings Integration​](https://docs.coderabbit.ai/guides/agent_chat#learnings-integration%E2%80%8B) * [Single Step Code Generation​](https://docs.coderabbit.ai/guides/agent_chat#single-step-code-generation%E2%80%8B) * [Configuration Changes​](https://docs.coderabbit.ai/guides/agent_chat#configuration-changes%E2%80%8B) * [Agentic Chat (Chat with Planning)​](https://docs.coderabbit.ai/guides/agent_chat#agentic-chat-chat-with-planning-%E2%80%8B) * [Help and Feedback​](https://docs.coderabbit.ai/guides/agent_chat#help-and-feedback%E2%80%8B) This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. CodeRabbit Chat is a powerful pull-request-specific assistant designed to streamline your development workflow. You can interact directly in pull request review comments and pull request comments to ask questions, have CodeRabbit rewrite code, or generate new code. [​](https://docs.coderabbit.ai/guides/agent_chat#invocation%E2%80%8B) Invocation[​](https://docs.coderabbit.ai/guides/agent_chat#invocation "Direct link to Invocation") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To invoke CodeRabbit Chat, simply comment on a pull request using the handle `@coderabbitai` without any explicit command (so without the [explicit CodeRabbit commands](https://docs.coderabbit.ai/guides/commands) ) in plain natural language. The permission flow for the chat is the same as the deterministic CodeRabbit commands. Upon being invoked, CodeRabbit processes your request and responds with the necessary assistance. This assistance may entail generating scripts, updating issue tracking systems, offering detailed code suggestions, or even submitting an entire pull request (with your consent). [​](https://docs.coderabbit.ai/guides/agent_chat#features%E2%80%8B) Features[​](https://docs.coderabbit.ai/guides/agent_chat#features "Direct link to Features") -------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/guides/agent_chat#script-writing%E2%80%8B) Script Writing[​](https://docs.coderabbit.ai/guides/agent_chat#script-writing "Direct link to Script Writing") CodeRabbit Chat can automatically generate scripts in various programming languages (mainly shell scripting) to answer questions about your codebase. If incorrect or non-running or non-germane shell scripts are created, CodeRabbit goes and tries again, and the whole script iteration process will be displayed to you in an Analysis Flow. All scripts are run in a secure sandboxed execution environment. ### [​](https://docs.coderabbit.ai/guides/agent_chat#web-search%E2%80%8B) Web Search[​](https://docs.coderabbit.ai/guides/agent_chat#web-search "Direct link to Web Search") CodeRabbit Chat integrates real-time web search capabilities, enabling it to fetch up-to-date information to support its responses. The CodeRabbit Chat response will indicate this if it decides to search the web to answer your query. Set `enabled` to false within `web_search` within `knowledge_base` within the config in order to turn this off. ### [​](https://docs.coderabbit.ai/guides/agent_chat#code-graph-analysis-integration%E2%80%8B) Code Graph Analysis Integration[​](https://docs.coderabbit.ai/guides/agent_chat#code-graph-analysis-integration "Direct link to Code Graph Analysis Integration") CodeRabbit Chat is capable of analyzing definitions of code symbols from the symbol graph it generates from your codebase. CodeRabbit can use these code definitions to enhance context when providing a chat response and review comments. CodeRabbit Chat will indicate in its response if it has found relevant symbols and snippets surrounding those symbols in your codebase. Set the environment variable `ENABLE_CODE_GRAPH` to false in self-hosted CodeRabbit instances to turn this feature off in self-hosted instances. ### [​](https://docs.coderabbit.ai/guides/agent_chat#jira-and-linear-integration%E2%80%8B) Jira and Linear Integration[​](https://docs.coderabbit.ai/guides/agent_chat#jira-and-linear-integration "Direct link to Jira and Linear Integration") CodeRabbit Chat can deal with existing issue tracking system integrations in order to integrate with your existing issues. For details on setting up issue tracking integrations, see our [Issue Integrations](https://docs.coderabbit.ai/integrations/issue-integrations) guide and [Issue Creation](https://docs.coderabbit.ai/guides/issue-creation) guide. ### [​](https://docs.coderabbit.ai/guides/agent_chat#learnings-integration%E2%80%8B) Learnings Integration[​](https://docs.coderabbit.ai/guides/agent_chat#learnings-integration "Direct link to Learnings Integration") CodeRabbit Chat can insert and delete Learnings from your Learnings database. Simply ask it to do so in plain natural language. ### [​](https://docs.coderabbit.ai/guides/agent_chat#single-step-code-generation%E2%80%8B) Single Step Code Generation[​](https://docs.coderabbit.ai/guides/agent_chat#single-step-code-generation "Direct link to Single Step Code Generation") For rapid prototyping and quick fixes, CodeRabbit Chat is capable of generating code snippets in a single step. ### [​](https://docs.coderabbit.ai/guides/agent_chat#configuration-changes%E2%80%8B) Configuration Changes[​](https://docs.coderabbit.ai/guides/agent_chat#configuration-changes "Direct link to Configuration Changes") CodeRabbit is also capable of managing its own configuration settings upon request. This self-management allows the assistant to dynamically adapt to changing project requirements. By simplifying configuration updates, CodeRabbit helps users quickly adjust to new workflows or requirements without interrupting the development process. [​](https://docs.coderabbit.ai/guides/agent_chat#agentic-chat-chat-with-planning-%E2%80%8B) Agentic Chat (Chat with Planning)[​](https://docs.coderabbit.ai/guides/agent_chat#agentic-chat-chat-with-planning "Direct link to Agentic Chat (Chat with Planning)") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- When facing complex coding challenges, CodeRabbit Agentic Chat supports multi-step agentic flows that involve detailed planning and execution. Once the multi-step workflow is complete, CodeRabbit can automatically issue a pull request for the changes so you can consent to the code changes or edit them. CodeRabbit can also place changes in the existing pull request branch or create copyable snippets. Agent chat can be invoked explicitly with the `@coderabbitai plan` command. CodeRabbit cannot perform further modifications to opened pull requests. From there, it’s your turn to checkout the branch and improve it to satisfaction. We believe that this workflow provides a significant headstart to implementing code. Agentic Chat is currently only available on Github issue, pull request and pull request review comments. ### [​](https://docs.coderabbit.ai/guides/agent_chat#help-and-feedback%E2%80%8B) Help and Feedback[​](https://docs.coderabbit.ai/guides/agent_chat#help-and-feedback "Direct link to Help and Feedback") Need help? Join our community on [Discord](https://discord.gg/coderabbit) or contact our support team. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/agent_chat.md) Last updated on **Jul 31, 2025** [Code review troubleshooting](https://docs.coderabbit.ai/guides/code-review-troubleshooting) [Code Graph Analysis](https://docs.coderabbit.ai/integrations/code-graph-analysis) Assistant Responses are generated using AI and may contain mistakes. --- # Install the VSCode extension - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation IDE extensions Install the VSCode extension On this page * [Before you begin​](https://docs.coderabbit.ai/guides/install-vscode#before-you-begin%E2%80%8B) * [Install the extension​](https://docs.coderabbit.ai/guides/install-vscode#install-the-extension%E2%80%8B) * [Install using the marketplace website​](https://docs.coderabbit.ai/guides/install-vscode#install-using-the-marketplace-website%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/install-vscode#what%E2%80%99s-next%E2%80%8B) This page is about installing the CodeRabbit VSCode extension. For more information about the extension, see [Review local changes](https://docs.coderabbit.ai/code-editors) . 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. [​](https://docs.coderabbit.ai/guides/install-vscode#before-you-begin%E2%80%8B) Before you begin[​](https://docs.coderabbit.ai/guides/install-vscode#before-you-begin "Direct link to Before you begin") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Before you can use the CodeRabbit VSCode extension, you need a CodeRabbit account. If you don’t already have an account, you can create one by visiting [the CodeRabbit login page](https://app.coderabbit.ai/login?free-trial) . [​](https://docs.coderabbit.ai/guides/install-vscode#install-the-extension%E2%80%8B) Install the extension[​](https://docs.coderabbit.ai/guides/install-vscode#install-the-extension "Direct link to Install the extension") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To install the CodeRabbit extension, follow these steps: 1. In the editor activity bar, click **Extensions**. 2. In sidebar, type `coderabbit` into the **Search Extensions in Marketplace** search bar. After a moment, **CodeRabbit** appears in the sidebar as a search result. 3. Select **CodeRabbit**. A summary of the CodeRabbit VSCode extension appears in the window’s main pane, along with installation controls. 4. If you would like your editor to automatically check for and apply future updates to the extension, then keep the **Auto Update** checkbox selected. Otherwise, clear the checkbox. 5. Click **Install**. 6. A **Log in to CodeRabbit to get started** dialog appears. Click **Login**. If the dialog gets dismissed or times out first, then you can follow these alternate steps: 1. Click the CodeRabbit icon in the VSCode activity bar. 2. Click the **Use CodeRabbit for Free** button. 7. Grant VSCode permission to open your browser, if asked. 8. In your web browser, log into your CodeRabbit account. 9. After signing in, the browser will redirect you back to VSCode. If the redirect does not occur, follow these steps: 1. Copy the code displayed in the success window. 2. Click **Paste code from browser**. 3. Paste the code into the input field that appears. This connects your CodeRabbit account with the CodeRabbit VSCode extension. [​](https://docs.coderabbit.ai/guides/install-vscode#install-using-the-marketplace-website%E2%80%8B) Install using the marketplace website[​](https://docs.coderabbit.ai/guides/install-vscode#install-using-the-marketplace-website "Direct link to Install using the marketplace website") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ If you are using the VSCode IDE, and not an IDE that derives from it such as Cursor or Windsurf, then you can alternatively obtain and install the CodeRabbit VSCode extension by visiting [the extension’s page on the Visual Studio Marketplace](https://coderabbit.link/vscode-docs) . If you do install the extension this way, then you still need to connect your CodeRabbit account to the extension after installing it, as described in the previous section. [​](https://docs.coderabbit.ai/guides/install-vscode#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/install-vscode#whats-next "Direct link to What's next") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Use the VSCode extension](https://docs.coderabbit.ai/guides/use-vscode) * [Configure the VSCode extension](https://docs.coderabbit.ai/guides/config-vscode) * [Use with Self-hosted CodeRabbit](https://docs.coderabbit.ai/guides/use-vscode-selfhosted) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/install-vscode.md) Last updated on **Jul 31, 2025** [Review local changes](https://docs.coderabbit.ai/code-editors) [Use the VSCode extension](https://docs.coderabbit.ai/guides/use-vscode) Assistant Responses are generated using AI and may contain mistakes. --- # Overview - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Configure Overview On this page * [About CodeRabbit configuration​](https://docs.coderabbit.ai/guides/configuration-overview#about-coderabbit-configuration%E2%80%8B) * [Configuration methods​](https://docs.coderabbit.ai/guides/configuration-overview#configuration-methods%E2%80%8B) * [Organization settings​](https://docs.coderabbit.ai/guides/configuration-overview#organization-settings%E2%80%8B) * [Repository settings​](https://docs.coderabbit.ai/guides/configuration-overview#repository-settings%E2%80%8B) * [Configuration priority​](https://docs.coderabbit.ai/guides/configuration-overview#configuration-priority%E2%80%8B) * [Priority order (highest to lowest)​](https://docs.coderabbit.ai/guides/configuration-overview#priority-order-highest-to-lowest-%E2%80%8B) * [How priority works​](https://docs.coderabbit.ai/guides/configuration-overview#how-priority-works%E2%80%8B) * [Configuration inheritance​](https://docs.coderabbit.ai/guides/configuration-overview#configuration-inheritance%E2%80%8B) * [Initial configuration​](https://docs.coderabbit.ai/guides/configuration-overview#initial-configuration%E2%80%8B) * [Learnings​](https://docs.coderabbit.ai/guides/configuration-overview#learnings%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/configuration-overview#what%E2%80%99s-next%E2%80%8B) [​](https://docs.coderabbit.ai/guides/configuration-overview#about-coderabbit-configuration%E2%80%8B) About CodeRabbit configuration[​](https://docs.coderabbit.ai/guides/configuration-overview#about-coderabbit-configuration "Direct link to About CodeRabbit configuration") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ CodeRabbit has [a lot of configuration options](https://docs.coderabbit.ai/reference/configuration) , with default settings that are designed to meet most needs. CodeRabbit is designed to work “out of the box”: if you don’t change any of the configuration settings away from the defaults, then CodeRabbit starts automatically adding code reviews to new pull requests in your repositories. However, understanding how to configure CodeRabbit lets you tune its behavior to the particulars of your team’s code. A few advantages of manually configuring CodeRabbit include the following: * Adjust the level of detail in CodeRabbit code reviews. * Customize review instructions to meet your specific coding standards. * Take advantage of agentic workflows that can speed up your review cycles. [​](https://docs.coderabbit.ai/guides/configuration-overview#configuration-methods%E2%80%8B) Configuration methods[​](https://docs.coderabbit.ai/guides/configuration-overview#methods "Direct link to Configuration methods") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You can configure CodeRabbit in several ways, from global organization settings down to configuration directives for specific repositories. ### [​](https://docs.coderabbit.ai/guides/configuration-overview#organization-settings%E2%80%8B) Organization settings[​](https://docs.coderabbit.ai/guides/configuration-overview#org "Direct link to Organization settings") If you want to apply the same CodeRabbit configuration to all of your organization’s repositories, then you can manage organizational settings using the CodeRabbit web UI. For more information, see [Set your organization preferences](https://docs.coderabbit.ai/guides/organization-settings) . ### [​](https://docs.coderabbit.ai/guides/configuration-overview#repository-settings%E2%80%8B) Repository settings[​](https://docs.coderabbit.ai/guides/configuration-overview#repo "Direct link to Repository settings") If you want to apply separate CodeRabbit configuration to your organization’s different repositories, then you can manage repository-specific CodeRabbit settings in two ways: * Add a `.coderabbit.yaml` file to the top level of your repository. * Use the CodeRabbit web interface. For more information, see [Set your repository preferences](https://docs.coderabbit.ai/guides/repository-settings) . While the web interface provides and easier way to explore the available configuration options for your repository, we recommend using a `.coderabbit.yaml` file [as a best practice](https://docs.coderabbit.ai/guides/setup-best-practices#yaml) . [​](https://docs.coderabbit.ai/guides/configuration-overview#configuration-priority%E2%80%8B) Configuration priority[​](https://docs.coderabbit.ai/guides/configuration-overview#priority "Direct link to Configuration priority") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- CodeRabbit follows a specific hierarchy when determining which configuration settings to use. Understanding this priority system helps you manage your configuration effectively: ### [​](https://docs.coderabbit.ai/guides/configuration-overview#priority-order-highest-to-lowest-%E2%80%8B) Priority order (highest to lowest)[​](https://docs.coderabbit.ai/guides/configuration-overview#priority-order-highest-to-lowest "Direct link to Priority order (highest to lowest)") 1. **Local `.coderabbit.yaml` file of head branch** 2. **Repository settings** (web UI) 3. **Organization settings** (web UI) ### [​](https://docs.coderabbit.ai/guides/configuration-overview#how-priority-works%E2%80%8B) How priority works[​](https://docs.coderabbit.ai/guides/configuration-overview#how-priority-works "Direct link to How priority works") * **If you have a local `.coderabbit.yaml` file in your head branch**: All repository and organization settings are ignored. Only the local YAML file configuration is used. Anything not defined in that file uses default settings. * **If you don’t have a local YAML file but have enabled repository settings**: Organization settings are ignored. Only repository settings are used. * **If you have organization settings and repository settings are disabled**: Only organization settings are used. ### [​](https://docs.coderabbit.ai/guides/configuration-overview#configuration-inheritance%E2%80%8B) Configuration inheritance[​](https://docs.coderabbit.ai/guides/configuration-overview#configuration-inheritance "Direct link to Configuration inheritance") When a configuration source is active, it completely overrides all lower-priority sources. For example, if you set `reviews.tools.github-checks.timeout_ms` to `900000` in organization settings, but you have a local `.coderabbit.yaml` file that doesn’t define this setting, CodeRabbit will use the default value of `90000` instead of the organization setting. This means that configuration is not merged or inherited - the highest priority source takes complete control over all settings. [​](https://docs.coderabbit.ai/guides/configuration-overview#initial-configuration%E2%80%8B) Initial configuration[​](https://docs.coderabbit.ai/guides/configuration-overview#initial "Direct link to Initial configuration") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The [Initial configuration guide](https://docs.coderabbit.ai/guides/initial-configuration) tours you through several settings that we recommend that you review after you set up CodeRabbit with your organization. [​](https://docs.coderabbit.ai/guides/configuration-overview#learnings%E2%80%8B) Learnings[​](https://docs.coderabbit.ai/guides/configuration-overview#learnings "Direct link to Learnings") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ As a complement to the configuration methods listed above, CodeRabbit keeps an internal database with _learnings_ that it collects about your team’s code review preferences, based on your interactions with the CodeRabbit bot over time. CodeRabbit learnings let you fine-tune the ways that CodeRabbit conducts its code reviews in ways that are highly specific to your repositories, and your team’s coding styles. For more information, see [Teach CodeRabbit your review preferences](https://docs.coderabbit.ai/guides/learnings) . [​](https://docs.coderabbit.ai/guides/configuration-overview#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/configuration-overview#whats-next "Direct link to What's next") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Initial configuration guide](https://docs.coderabbit.ai/guides/initial-configuration) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/configuration-overview.md) Last updated on **Jul 31, 2025** [Uninstall the VSCode extension](https://docs.coderabbit.ai/guides/uninstall-vscode) [Organization preferences](https://docs.coderabbit.ai/guides/organization-settings) Assistant Responses are generated using AI and may contain mistakes. --- # Generate improvements - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Review pull requests Generate improvements On this page * [Overview of CodeRabbit code generation​](https://docs.coderabbit.ai/guides/generate-improvements#overview-of-coderabbit-code-generation%E2%80%8B) * [Code generation commands​](https://docs.coderabbit.ai/guides/generate-improvements#code-generation-commands%E2%80%8B) * [Generate inline documentation​](https://docs.coderabbit.ai/guides/generate-improvements#generate-inline-documentation%E2%80%8B) * [Generate solutions to open review comments​](https://docs.coderabbit.ai/guides/generate-improvements#generate-solutions-to-open-review-comments%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/generate-improvements#what%E2%80%99s-next%E2%80%8B) This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. This page is about using CodeRabbit to generate improvements to code under review. For a general overview of performing code reviews with CodeRabbit, see [Review pull requests](https://docs.coderabbit.ai/guides/code-review-overview) . [​](https://docs.coderabbit.ai/guides/generate-improvements#overview-of-coderabbit-code-generation%E2%80%8B) Overview of CodeRabbit code generation[​](https://docs.coderabbit.ai/guides/generate-improvements#overview "Direct link to Overview of CodeRabbit code generation") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ This feature is available only on GitHub. You can request CodeRabbit to generate improvements to a branch that it is currently reviewing. To do this, write out your request prompt in a comment addressed to `@coderabbitai`, such as with the following examples: * `@coderabbitai Please implement the changes you suggested in your code review.` * `@coderabbitai Add input validation with proper error messages to these new functions.` * `@coderabbitai Break this large function into smaller, more focused methods.` In addition to this kind of free-form request, you can also give CodeRabbit keyword-based commands for common code-generation requests, as described in [Code generation commands](https://docs.coderabbit.ai/guides/generate-improvements#commands) . This includes the `plan` keyword, which acts as shorthand for the first prompt on the previous list. After you give it a code-generation prompt or command, CodeRabbit delivers its suggested improvements by taking these steps: 1. CodeRabbit posts a comment or two to the pull request, detailing its improvement plans. 2. CodeRabbit publishes a new branch, based on the open pull request’s branch, to the remote repository. 3. CodeRabbit opens a new pull request based on this new branch, and links to it from the original pull request. CodeRabbit doesn’t make any further changes to the new branch or to the new pull request after it creates them. From that point on, it’s fully up to you what to do with the new, suggested-change branch. The best practice is to effectively take ownership of the new branch for yourself, deciding whether it’s worth merging into the original pull request branch, and making any further updates you’d like to make first. You can use comments in the new branch to ask CodeRabbit to explain its changes, if needed, or to otherwise converse with CodeRabbit about the suggested improvements. Because it’s just an ordinary Git branch, the presence of the suggested-change branch doesn’t block the ongoing code review in the original pull request branch. You are free to merge, defer, or close the suggested-change pull request that CodeRabbit made, using any method or timing that fits your workflow. [​](https://docs.coderabbit.ai/guides/generate-improvements#code-generation-commands%E2%80%8B) Code generation commands[​](https://docs.coderabbit.ai/guides/generate-improvements#commands "Direct link to Code generation commands") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ This section lists short commands that you can give CodeRabbit to have it accomplish common code-generation tasks. For more complex tasks, you can instead write out full prompts, as described in the previous section. For a complete CodeRabbit command reference, see [Code review command reference](https://docs.coderabbit.ai/reference/review-commands) . ### [​](https://docs.coderabbit.ai/guides/generate-improvements#generate-inline-documentation%E2%80%8B) Generate inline documentation[​](https://docs.coderabbit.ai/guides/generate-improvements#docstrings "Direct link to Generate inline documentation") To have CodeRabbit generate missing documentation for function code added by the pull request, post the following comment to the pull request: Copy @coderabbitai generate docstrings For more information about how CodeRabbit can generate inline documentation, including the Git platforms and programming languages that this feature supports, see [Docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) . ### [​](https://docs.coderabbit.ai/guides/generate-improvements#generate-solutions-to-open-review-comments%E2%80%8B) Generate solutions to open review comments[​](https://docs.coderabbit.ai/guides/generate-improvements#plan "Direct link to Generate solutions to open review comments") To have CodeRabbit generate and add a new repository branch with code improvements that try to address its own code review comments, post the following comment to the pull request: Copy @coderabbitai plan Using this keyword is essentially shorthand for writing out a prompt like the following: Copy @coderabbitai Implement the changes that you suggested and apply them to this pull request. If you want to give CodeRabbit more specific implement instructions other than a general request to implement its own suggestions, then you can write out those instructions as a full prompt, instead of using the one-word `plan` command. [​](https://docs.coderabbit.ai/guides/generate-improvements#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/generate-improvements#whats-next "Direct link to What's next") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Control and manage code reviews](https://docs.coderabbit.ai/guides/commands) * [Best practices](https://docs.coderabbit.ai/guides/code-review-best-practices) * [Troubleshooting](https://docs.coderabbit.ai/guides/code-review-troubleshooting) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/generate-improvements.md) Last updated on **Jul 31, 2025** [Control and manage code reviews](https://docs.coderabbit.ai/guides/commands) [Code review troubleshooting](https://docs.coderabbit.ai/guides/code-review-troubleshooting) Assistant Responses are generated using AI and may contain mistakes. --- # Lua Support with Luacheck - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Lua Support with Luacheck On this page * [Lua Support with Luacheck](https://docs.coderabbit.ai/changelog/lua-support-with-luacheck#lua-support-with-luacheck) ### [​](https://docs.coderabbit.ai/changelog/lua-support-with-luacheck#lua-support-with-luacheck) Lua Support with Luacheck We’re excited to announce enhanced support for Lua code analysis with [Luacheck](https://github.com/mpeterv/luacheck) , a powerful static analyzer and linter for Lua code. Assistant Responses are generated using AI and may contain mistakes. --- # New Features and Improvements - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation New Features and Improvements On this page * [New Features and Improvements](https://docs.coderabbit.ai/changelog/new-features-and-improvements-2#new-features-and-improvements) * [Review Settings](https://docs.coderabbit.ai/changelog/new-features-and-improvements-2#review-settings) * [More Static Analysis Support](https://docs.coderabbit.ai/changelog/new-features-and-improvements-2#more-static-analysis-support) * [Tone Settings](https://docs.coderabbit.ai/changelog/new-features-and-improvements-2#tone-settings) * [Revamped Settings Page](https://docs.coderabbit.ai/changelog/new-features-and-improvements-2#revamped-settings-page) ### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements-2#new-features-and-improvements) New Features and Improvements #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements-2#review-settings) Review Settings Users can now select between **Chill** and **Assertive** review tones to tailor feedback styles according to their preferences. The **Assertive** profile posts more comments and nitpicks the code more aggressively, while the **Chill** profile is more relaxed and posts fewer comments. #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements-2#more-static-analysis-support) More Static Analysis Support We are continually expanding our support for static analysis tools. We’ve recently added support for * Biome * Hadolint * ast-grep. Update your .coderabbit.yaml file or visit the settings page to enable or disable the tools you wish to use. #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements-2#tone-settings) Tone Settings Users can now personalize CodeRabbit to review code in the style of their favorite characters or personalities. Here are a few of our top examples: * Mr. T: “You must talk like Mr. T in all your code reviews. I pity the fool who doesn’t!” * Pirate: “Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!” * Snarky Ex-Girlfriend: “You must talk like a snarky ex-girlfriend in all your code reviews. You’re welcome.” #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements-2#revamped-settings-page) Revamped Settings Page We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long-time coming; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa. Assistant Responses are generated using AI and may contain mistakes. --- # Learnings and Metrics Iteration for CodeRabbit Self-Hosted Customers - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Learnings and Metrics Iteration for CodeRabbit Self-Hosted Customers On this page * [Learnings and Metrics Iteration for CodeRabbit Self-Hosted Customers](https://docs.coderabbit.ai/changelog/learnings-and-metrics-iteration-for-coderabbit-self-hosted-customers#learnings-and-metrics-iteration-for-coderabbit-self-hosted-customers) ### [​](https://docs.coderabbit.ai/changelog/learnings-and-metrics-iteration-for-coderabbit-self-hosted-customers#learnings-and-metrics-iteration-for-coderabbit-self-hosted-customers) Learnings and Metrics Iteration for CodeRabbit Self-Hosted Customers We’ve enhanced the accessibility of Learnings and Metrics for self-hosted CodeRabbit customers, delivering a more seamless experience. Easily track learning patterns and insights, with the added convenience of generating API keys directly within the interface. **Setup:** * Generate an API key in the CodeRabbit UI * Enable Learnings and Metrics by either: * Configuring your .env file * Contacting CodeRabbit support for assistance Assistant Responses are generated using AI and may contain mistakes. --- # Organization preferences - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Configure Organization preferences On this page * [About organization settings​](https://docs.coderabbit.ai/guides/organization-settings#about-organization-settings%E2%80%8B) * [Browse and modify your organization settings​](https://docs.coderabbit.ai/guides/organization-settings#browse-and-modify-your-organization-settings%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/organization-settings#what%E2%80%99s-next%E2%80%8B) For a general overview of configuring CodeRabbit, see [Configure CodeRabbit](https://docs.coderabbit.ai/guides/configuration-overview) . [​](https://docs.coderabbit.ai/guides/organization-settings#about-organization-settings%E2%80%8B) About organization settings[​](https://docs.coderabbit.ai/guides/organization-settings#about "Direct link to About organization settings") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ You can use the CodeRabbit web interface to set the CodeRabbit configuration for all of the Git repositories associated with your organization. By default, all of your repositories apply your organization’s CodeRabbit configuration. You have the option to define separate settings for some or all of your individual repositories, instead. For more information, see [Set your repository preferences](https://docs.coderabbit.ai/guides/repository-settings) . [​](https://docs.coderabbit.ai/guides/organization-settings#browse-and-modify-your-organization-settings%E2%80%8B) Browse and modify your organization settings[​](https://docs.coderabbit.ai/guides/organization-settings#modify "Direct link to Browse and modify your organization settings") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To view or modify your organizational settings, follow these steps: 1. Visit [the CodeRabbit web interface](https://app.coderabbit.ai/settings/repositories) . 2. In the sidebar, click **Organization Settings** > **Configuration**. 3. Browse and modify the settings as needed. If you do make changes, click **Apply Changes** when you are finished. [​](https://docs.coderabbit.ai/guides/organization-settings#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/organization-settings#whats-next "Direct link to What's next") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Initial configuration guide](https://docs.coderabbit.ai/guides/initial-configuration) * [Configuration best practices](https://docs.coderabbit.ai/guides/setup-best-practices#configuration) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/organization-settings.md) Last updated on **Jul 31, 2025** [Overview](https://docs.coderabbit.ai/guides/configuration-overview) [Repository preferences](https://docs.coderabbit.ai/guides/repository-settings) Assistant Responses are generated using AI and may contain mistakes. --- # Overview - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Generate reports Overview On this page * [Scheduled and on-demand reports​](https://docs.coderabbit.ai/guides/reports-overview#scheduled-and-on-demand-reports%E2%80%8B) * [Customize reports using natural language​](https://docs.coderabbit.ai/guides/reports-overview#customize-reports-using-natural-language%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/reports-overview#what%E2%80%99s-next%E2%80%8B) This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. You can track and analyze pull request activity across your organization’s repositories by using the CodeRabbit reporting feature. [​](https://docs.coderabbit.ai/guides/reports-overview#scheduled-and-on-demand-reports%E2%80%8B) Scheduled and on-demand reports[​](https://docs.coderabbit.ai/guides/reports-overview#types "Direct link to Scheduled and on-demand reports") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- There are two ways to generate reports: * **[Scheduled Reports](https://docs.coderabbit.ai/guides/scheduled-reports) **: Set up automated, recurring reports that are delivered to your team on a set schedule. **Use this option if you want to adjust your settings and send a report more than once**. Supported delivery channels include the following: * Email * Discord * Slack * Teams * **[On-demand Reports](https://docs.coderabbit.ai/guides/ondemand-reports) **: If you want to test a report format and produce a single report once, try the “On-demand Reports” Option. You can also generate reports programmatically through our API, but we do not recommend this as the API reporting is in beta. If you want to run an **On-demand Report** more than once then you must use the **Scheduled Reports** option. In almost every scenario we recommend using the **Scheduled Reports** option. The **On-demand Report** does not have any additional benefits from the **Scheduled Reports** and has many limitations. [​](https://docs.coderabbit.ai/guides/reports-overview#customize-reports-using-natural-language%E2%80%8B) Customize reports using natural language[​](https://docs.coderabbit.ai/guides/reports-overview#customize "Direct link to Customize reports using natural language") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- For both scheduled and on-demand reports, you define the shape and content of your reports by providing a prompt that instructs CodeRabbit about report that you want, using natural language. The scheduled reports interface includes several example prompts that you can choose from, or you can write your own prompt. For more information, see [Customize reports](https://docs.coderabbit.ai/guides/custom-reports) . [​](https://docs.coderabbit.ai/guides/reports-overview#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/reports-overview#whats-next "Direct link to What's next") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Schedule reports](https://docs.coderabbit.ai/guides/scheduled-reports) * [Generate reports on demand](https://docs.coderabbit.ai/guides/ondemand-reports) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/reports-overview.md) Last updated on **Jul 31, 2025** [Role based access](https://docs.coderabbit.ai/guides/roles) [Schedule reports](https://docs.coderabbit.ai/guides/scheduled-reports) Assistant Responses are generated using AI and may contain mistakes. --- # Repository preferences - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Configure Repository preferences On this page * [About repository settings​](https://docs.coderabbit.ai/guides/repository-settings#about-repository-settings%E2%80%8B) * [Configure your repository with .coderabbit.yaml​](https://docs.coderabbit.ai/guides/repository-settings#configure-your-repository-with-coderabbit-yaml%E2%80%8B) * [Browse and modify your settings using the web interface​](https://docs.coderabbit.ai/guides/repository-settings#browse-and-modify-your-settings-using-the-web-interface%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/repository-settings#what%E2%80%99s-next%E2%80%8B) [​](https://docs.coderabbit.ai/guides/repository-settings#about-repository-settings%E2%80%8B) About repository settings[​](https://docs.coderabbit.ai/guides/repository-settings#about "Direct link to About repository settings") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- CodeRabbit provides two ways to manage its code-review behavior with each of your organization’s repositories: * Add a `.coderabbit.yaml` file to your repository. * View or modify your per-repository settings using the CodeRabbit web interface. If your repository contains a `.coderabbit.yaml` file at the top level of its default branch, then CodeRabbit applies all of its settings to that repository’s code reviews. CodeRabbit applies its own default values to any configuration settings not defined by your `.coderabbit.yaml` file. If your repository doesn’t have a `.coderabbit.yaml` file, then CodeRabbit applies the configuration from the CodeRabbit web interface, instead. While the web interface provides an easier way to explore the available configuration options for your repository, we recommend using a `.coderabbit.yaml` file [as a best practice](https://docs.coderabbit.ai/guides/setup-best-practices#yaml) . [​](https://docs.coderabbit.ai/guides/repository-settings#configure-your-repository-with-coderabbit-yaml%E2%80%8B) Configure your repository with `.coderabbit.yaml`[​](https://docs.coderabbit.ai/guides/repository-settings#configure-your-repository-with-coderabbityaml "Direct link to configure-your-repository-with-coderabbityaml") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To add a `.coderabbit.yaml` file to your repository, merge a copy of [our template configuration file](https://docs.coderabbit.ai/reference/yaml-template) to the top level of your default branch. From there, you can update your repository’s CodeRabbit configuration by updating the `.coderabbit.yaml` file exactly as you would any other text file in your repository. For more information about the `.coderabbit.yaml` file, see [Add a configuration file](https://docs.coderabbit.ai/getting-started/configure-coderabbit) . [​](https://docs.coderabbit.ai/guides/repository-settings#browse-and-modify-your-settings-using-the-web-interface%E2%80%8B) Browse and modify your settings using the web interface[​](https://docs.coderabbit.ai/guides/repository-settings#modify "Direct link to Browse and modify your settings using the web interface") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To view or modify your repository settings using the CodeRabbit web interface, follow these steps: 1. Visit [the CodeRabbit web interface](https://app.coderabbit.ai/settings/repositories) . 2. In the sidebar, click **Repositories**. 3. Click the gear-shaped **Settings** icon of the repository whose settings you want to view or modify. 4. If the **Use Organization Settings** toggle is on, then click it to turn it off. If you leave it on, then CodeRabbit applies the settings you have set through [the organization-configuration page](https://docs.coderabbit.ai/guides/organization-settings) to this repository. 5. Browse and modify the settings as needed. If you do make changes, click **Apply Changes** when you are finished. [​](https://docs.coderabbit.ai/guides/repository-settings#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/repository-settings#whats-next "Direct link to What's next") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Initial configuration guide](https://docs.coderabbit.ai/guides/initial-configuration) * [Configuration best practices](https://docs.coderabbit.ai/guides/setup-best-practices#configuration) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/repository-settings.md) Last updated on **Jul 31, 2025** [Organization preferences](https://docs.coderabbit.ai/guides/organization-settings) [Add a configuration file](https://docs.coderabbit.ai/getting-started/configure-coderabbit) Assistant Responses are generated using AI and may contain mistakes. --- # Generate reports on demand - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Generate reports Generate reports on demand On this page * [Overview​](https://docs.coderabbit.ai/guides/ondemand-reports#overview%E2%80%8B) * [API Access​](https://docs.coderabbit.ai/guides/ondemand-reports#api-access%E2%80%8B) * [Create an API key​](https://docs.coderabbit.ai/guides/ondemand-reports#create-an-api-key%E2%80%8B) * [Generate an On-demand report​](https://docs.coderabbit.ai/guides/ondemand-reports#generate-an-on-demand-report%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/ondemand-reports#what%E2%80%99s-next%E2%80%8B) This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. [​](https://docs.coderabbit.ai/guides/ondemand-reports#overview%E2%80%8B) Overview[​](https://docs.coderabbit.ai/guides/ondemand-reports#overview "Direct link to Overview") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This page is about using the CodeRabbit API to generate on-demand reports about your organization’s usage of CodeRabbit. For a conceptual overview of reports in CodeRabbit, see [Generate reports](https://docs.coderabbit.ai/guides/reports-overview) . If you’re new to CodeRabbit’s reporting features, then we recommend starting with [Scheduled reports](https://docs.coderabbit.ai/guides/scheduled-reports) to understand the available options and capabilities. In almost every scenario we recommend using the **Scheduled Reports** option. The **On-demand Report** does not have any additional benefits from the **Scheduled Reports** and has many limitations. [​](https://docs.coderabbit.ai/guides/ondemand-reports#api-access%E2%80%8B) API Access[​](https://docs.coderabbit.ai/guides/ondemand-reports#api-access "Direct link to API Access") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- CodeRabbit offers a way to generate on-demand reports using the [CodeRabbit API](https://api.coderabbit.ai/api/swagger/) . You will need an API Key to access the CodeRabbit API and generate an on-demand report. [​](https://docs.coderabbit.ai/guides/ondemand-reports#create-an-api-key%E2%80%8B) Create an API key[​](https://docs.coderabbit.ai/guides/ondemand-reports#create-an-api-key "Direct link to Create an API key") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Sign in to your CodeRabbit account and navigate to the [**API Keys**](https://app.coderabbit.ai/settings/api-keys) page under ‘Organization Settings’ in the left sidebar. Click on the **Create API Key** button and enter a name for the API Key. Copy the API key, and keep it safe as it won’t be visible again. ![API Keys](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/api_keys-b7e09b7dc03a5d8ceb09d1db0a8dc12c.png) [​](https://docs.coderabbit.ai/guides/ondemand-reports#generate-an-on-demand-report%E2%80%8B) Generate an On-demand report[​](https://docs.coderabbit.ai/guides/ondemand-reports#generate-an-on-demand-report "Direct link to Generate an On-demand report") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Once you have the API key, pass it in the `x-coderabbitai-api-key` header when calling the API: Copy curl -X 'POST' \ 'https://api.coderabbit.ai/api/v1/report.generate' \ -H 'accept: application/json' \ -H 'x-coderabbitai-api-key: cr-xxxxxxxxxxxxx' \ -H 'Content-Type: application/json' \ -d '{ "from": "2024-05-01", "to": "2024-05-15" }' Sample output: Copy [ { "group": "Developer Activity", "report": "*Developer Activity*:\n\n 🟢 **Update README.md** [#10](https://gitlab.com/master-group123/sub-group/project1/-/merge_requests/10)\n• Summary: The change updates the project description and modifies a section header for clearer instructions.\n• Last activity: 1 day ago, mergeable\n• Insights:\n - :magnifying_glass: @user2 Suggested updating the wording to make it clearer" }] If you get a 401 UNAUTHORIZED error, check if you’re passing the right API key in the `x-coderabbitai-api-key` header The on-demand report generation endpoints take in inputs as per the schema shown below: Loading … [API Reference](https://api.coderabbit.ai/api/swagger/) [​](https://docs.coderabbit.ai/guides/ondemand-reports#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/ondemand-reports#whats-next "Direct link to What's next") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Customize reports](https://docs.coderabbit.ai/guides/custom-reports) * [Scheduled reports](https://docs.coderabbit.ai/guides/scheduled-reports) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/ondemand-reports.md) Last updated on **Jul 31, 2025** [Schedule reports](https://docs.coderabbit.ai/guides/scheduled-reports) [Customize reports](https://docs.coderabbit.ai/guides/custom-reports) Assistant Responses are generated using AI and may contain mistakes. --- # Issue Chat - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Create and resolve issues Issue Chat On this page * [Getting Started​](https://docs.coderabbit.ai/guides/issue-chat#getting-started%E2%80%8B) * [Core Capabilities​](https://docs.coderabbit.ai/guides/issue-chat#core-capabilities%E2%80%8B) * [Code Analysis​](https://docs.coderabbit.ai/guides/issue-chat#code-analysis%E2%80%8B) * [Agentic Thought Chain​](https://docs.coderabbit.ai/guides/issue-chat#agentic-thought-chain%E2%80%8B) * [Feature Planning Support​](https://docs.coderabbit.ai/guides/issue-chat#feature-planning-support%E2%80%8B) * [Additional Use Cases​](https://docs.coderabbit.ai/guides/issue-chat#additional-use-cases%E2%80%8B) * [Open Source Support​](https://docs.coderabbit.ai/guides/issue-chat#open-source-support%E2%80%8B) * [Documentation Assistance​](https://docs.coderabbit.ai/guides/issue-chat#documentation-assistance%E2%80%8B) * [Marketing Content Generation​](https://docs.coderabbit.ai/guides/issue-chat#marketing-content-generation%E2%80%8B) * [Best Practices​](https://docs.coderabbit.ai/guides/issue-chat#best-practices%E2%80%8B) * [Related Resources​](https://docs.coderabbit.ai/guides/issue-chat#related-resources%E2%80%8B) This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. CodeRabbit provides an intelligent chat interface directly within GitHub and GitLab issues. This allows developers to have natural conversations about code, get answers to questions, create AI powered code searches, plan features, and gain deeper insights into their codebase - all without leaving their issue tracking workflow. [​](https://docs.coderabbit.ai/guides/issue-chat#getting-started%E2%80%8B) Getting Started[​](https://docs.coderabbit.ai/guides/issue-chat#getting-started "Direct link to Getting Started") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ To start a conversation with CodeRabbit in any issue: 1. Simply mention `@coderabbitai` (or your custom bot name if configured) in an issue comment 2. Ask your question or make your request in natural language 3. CodeRabbit will analyze the context and respond accordingly Organizations can configure a custom bot name by creating their own bot user. The bot will respond to mentions of that custom name instead of `@coderabbitai`. ![Github Chat Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/chat-example-9e011732591105a9bc699b12c4f57dd2.png) ![Gitlab Chat Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/gitlab-issue-chat-7e3271860e1d77febbe8ebd933ca5d90.png) [​](https://docs.coderabbit.ai/guides/issue-chat#core-capabilities%E2%80%8B) Core Capabilities[​](https://docs.coderabbit.ai/guides/issue-chat#core-capabilities "Direct link to Core Capabilities") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/guides/issue-chat#code-analysis%E2%80%8B) Code Analysis[​](https://docs.coderabbit.ai/guides/issue-chat#code-analysis "Direct link to Code Analysis") When chatting in issues, CodeRabbit has access to your repository and powerful tools that allow it to analyze and understand your codebase like a real developer. This includes: * Full access to search and analyze the repository code * Advanced static analysis capabilities * Command line tools for code search and manipulation (e.g. grep, awk, sed, etc.) * Complete git history and metadata information * Access to past CodeRabbit learnings and insights This allows CodeRabbit to: * Search through code to find relevant examples * Analyze code patterns and relationships * Generate statistics and metrics * Provide context-aware answers about the codebase * Create AI powered code searches * Use tribal knowledge from learnings to enhance responses ![Script Execution Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/chat-script-execution-96a8ae863bcf52ff14dfc65965883e7c.png) ![Chat Learnings Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/chat-learnings-use-fd4328e37e2467211d4fde83368df348.png) ### [​](https://docs.coderabbit.ai/guides/issue-chat#agentic-thought-chain%E2%80%8B) Agentic Thought Chain[​](https://docs.coderabbit.ai/guides/issue-chat#agentic-thought-chain "Direct link to Agentic Thought Chain") When [agentic thought chain](https://docs.coderabbit.ai/guides/agent_chat) is enabled, CodeRabbit will use an agentic thought chain to plan out a response using multiple commands in series to articulate a more advanced response. ![Agentic Thought Chain Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/agentic-thought-chain-03e45a0a9a62a7516877ef1e591ff8aa.png) All scripts run in the Agentic Thought Chain are run in a secure sandboxed execution environment. ### [​](https://docs.coderabbit.ai/guides/issue-chat#feature-planning-support%E2%80%8B) Feature Planning Support[​](https://docs.coderabbit.ai/guides/issue-chat#feature-planning-support "Direct link to Feature Planning Support") Issue chat is particularly valuable during feature planning phases: * **Code Impact Analysis**: Ask about which parts of the codebase might be affected by proposed changes * **Pattern Discovery**: Find similar implementations or related code * **Dependency Mapping**: Understand relationships between components * **Technical Feasibility**: Get insights into potential challenges or approaches Example conversation: ![Feature Planning Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/feature-planning-6bd118d2176b9b9d57fbcc6c6bf60637.png) [​](https://docs.coderabbit.ai/guides/issue-chat#additional-use-cases%E2%80%8B) Additional Use Cases[​](https://docs.coderabbit.ai/guides/issue-chat#additional-use-cases "Direct link to Additional Use Cases") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/guides/issue-chat#open-source-support%E2%80%8B) Open Source Support[​](https://docs.coderabbit.ai/guides/issue-chat#open-source-support "Direct link to Open Source Support") Issue chat, like all Pro CodeRabbit features, is free for open source projects. CodeRabbit acts as a powerful support tool for open source maintainers by: * Answering common user questions with detailed, contextual responses * Providing relevant code examples and implementation patterns * Explaining error messages with debugging context and solutions * Suggesting step-by-step debugging approaches with code snippets * Helping triage and categorize issues * Identifying potential duplicates and related issues * Offering guidance on best practices and common pitfalls * Reducing maintainer burden by handling routine support tasks Example: ![Open Source Support Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/open-source-support-be9a6f166ba69da81f8d023dbdece4b1.png) ### [​](https://docs.coderabbit.ai/guides/issue-chat#documentation-assistance%E2%80%8B) Documentation Assistance[​](https://docs.coderabbit.ai/guides/issue-chat#documentation-assistance "Direct link to Documentation Assistance") Use issue chat to generate high level descriptions of the code and services in your repositories. This can be used to create README documentation which can be used across platforms like [wikis](https://docs.github.com/en/communities/documenting-your-project-with-wikis) , [Confluence](https://www.atlassian.com/software/confluence/guides) , [Notion](https://www.notion.so/help/guides) and more: * Generate high level documentation * Create usage examples and mermaid diagrams * Provide content to assist in updating README files * Write tutorials Example: ![Documentation Assistance Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/high-level-docs-b2cb8a0bb4fdbce34ffe145370ef1c70.png) ### [​](https://docs.coderabbit.ai/guides/issue-chat#marketing-content-generation%E2%80%8B) Marketing Content Generation[​](https://docs.coderabbit.ai/guides/issue-chat#marketing-content-generation "Direct link to Marketing Content Generation") CodeRabbit can assist with creating content on new features for social media posts, blogs, and more: * Release announcements * Blog post drafts * Social media content * Community updates Example: ![Marketing Content Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/marketing-posts-a67f317538b5a001b4469999275378ec.png) [​](https://docs.coderabbit.ai/guides/issue-chat#best-practices%E2%80%8B) Best Practices[​](https://docs.coderabbit.ai/guides/issue-chat#best-practices "Direct link to Best Practices") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. **Be Specific** * Provide context in your questions * Mention specific files or features when relevant * Clarify your goals or requirements 2. **Iterative Refinement** * Start with broad questions * Follow up for more details * Ask for clarification when needed 3. **Collaborative Planning** * Include stakeholders in the conversation * Use issue chat to document decisions * Reference related issues or PRs 4. **Keep Questions Focused** * CodeRabbit works best with clear, specific questions * Link to specific files, directories or pull requests to help refine answers and provide better context * CodeRabbit does not generate API documentation, Swagger specs, or other technical documentation that requires high accuracy * Break down complex questions into smaller, more manageable ones * Use multiple messages to ask follow up questions if needed [​](https://docs.coderabbit.ai/guides/issue-chat#related-resources%E2%80%8B) Related Resources[​](https://docs.coderabbit.ai/guides/issue-chat#related-resources "Direct link to Related Resources") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Agentic Chat](https://docs.coderabbit.ai/guides/agent_chat) * [Issue Creation](https://docs.coderabbit.ai/guides/issue-creation) * [Commands](https://docs.coderabbit.ai/guides/commands) * [Tooling Guide](https://docs.coderabbit.ai/tools) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/issue-chat.md) Last updated on **Jul 31, 2025** [Integrate issue tracking](https://docs.coderabbit.ai/integrations/issue-integrations) [Create issues](https://docs.coderabbit.ai/guides/issue-creation) Assistant Responses are generated using AI and may contain mistakes. --- # Overview - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Review pull requests Overview On this page * [Automatically review pull requests​](https://docs.coderabbit.ai/guides/code-review-overview#automatically-review-pull-requests%E2%80%8B) * [Events that trigger automated reviews​](https://docs.coderabbit.ai/guides/code-review-overview#events-that-trigger-automated-reviews%E2%80%8B) * [Which pull requests get automatically reviewed​](https://docs.coderabbit.ai/guides/code-review-overview#which-pull-requests-get-automatically-reviewed%E2%80%8B) * [Interact with CodeRabbit reviews​](https://docs.coderabbit.ai/guides/code-review-overview#interact-with-coderabbit-reviews%E2%80%8B) * [Chat with CodeRabbit​](https://docs.coderabbit.ai/guides/code-review-overview#chat-with-coderabbit%E2%80%8B) * [Manage CodeRabbit review behavior​](https://docs.coderabbit.ai/guides/code-review-overview#manage-coderabbit-review-behavior%E2%80%8B) * [Generate improvements​](https://docs.coderabbit.ai/guides/code-review-overview#generate-improvements%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/code-review-overview#what%E2%80%99s-next%E2%80%8B) CodeRabbit reviews take the form of pull request comments that include summaries, analyses, and initial critiques of the proposed changes. This information, usually added to pull requests within minutes, can help your team perform more rapid, better-informed code reviews. The following sections present an overview of this feature. For a hands-on example that lets you experience a CodeRabbit code review using a real repository, see [Quickstart](https://docs.coderabbit.ai/getting-started/quickstart) . [​](https://docs.coderabbit.ai/guides/code-review-overview#automatically-review-pull-requests%E2%80%8B) Automatically review pull requests[​](https://docs.coderabbit.ai/guides/code-review-overview#review "Direct link to Automatically review pull requests") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- After you [integrate CodeRabbit with your repository](https://docs.coderabbit.ai/platforms) , CodeRabbit proceeds to automatically review every subsequent pull request, as soon as each one is created. CodeRabbit performs code reviews by attaching comments to the pull request. These comments contain detailed summaries and analyses of the changes, as well as listing out problems or areas for potential improvement that it found. CodeRabbit uses [a variety of open-source linters and security tools](https://docs.coderabbit.ai/tools) and a custom code verification agent to provide this analysis. CodeRabbit also consults several models to further analyze and critique the proposed changes, using all of the content of your repository as context. The code-review comment that CodeRabbit attaches to your pull request synthesizes and summarizes all of the information collected from these different sources. For more information about the graph analysis that CodeRabbit includes with its reviews when available, see [CodeRabbit Code Graph Analysis](https://docs.coderabbit.ai/integrations/code-graph-analysis) . ### [​](https://docs.coderabbit.ai/guides/code-review-overview#events-that-trigger-automated-reviews%E2%80%8B) Events that trigger automated reviews[​](https://docs.coderabbit.ai/guides/code-review-overview#events "Direct link to Events that trigger automated reviews") By default, the following activity in your repository triggers CodeRabbit to perform a code review: * If CodeRabbit sees a new pull request, then it immediately performs a full review of the proposed code changes. * If an open pull request that CodeRabbit has already reviewed gets modified with another commit, then CodeRabbit performs an incremental review that focuses on the new commit. ### [​](https://docs.coderabbit.ai/guides/code-review-overview#which-pull-requests-get-automatically-reviewed%E2%80%8B) Which pull requests get automatically reviewed[​](https://docs.coderabbit.ai/guides/code-review-overview#eligibility "Direct link to Which pull requests get automatically reviewed") CodeRabbit automatically reviews a pull request when **either** of the following statements is true: * The pull request is in a public repository. CodeRabbit reviews pull requests against the main branch of your public repositories by default. This feature is available to every subscription tier, including the free plan. * The pull request is in a private repository and your organization is on the Pro plan with a seat assigned to you. Only under this condition does CodeRabbit review private-repository pull requests. This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. [​](https://docs.coderabbit.ai/guides/code-review-overview#interact-with-coderabbit-reviews%E2%80%8B) Interact with CodeRabbit reviews[​](https://docs.coderabbit.ai/guides/code-review-overview#interact "Direct link to Interact with CodeRabbit reviews") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- After CodeRabbit attaches its initial code-review comment to a pull request, you can directly interact with CodeRabbit by mentioning its username, `@coderabbitai`, in comments that you post to the pull request. These interactions can serve several purposes: * Free-form discussion about the pull request and the ongoing code review. * Commands to have CodeRabbit perform specific actions regarding the code review. * Prompts to have CodeRabbit generate its own improvements to the branch under review. ### [​](https://docs.coderabbit.ai/guides/code-review-overview#chat-with-coderabbit%E2%80%8B) Chat with CodeRabbit[​](https://docs.coderabbit.ai/guides/code-review-overview#chat "Direct link to Chat with CodeRabbit") You can have open-ended, natural-language discussion with CodeRabbit during a code review, treating it as an LLM-powered chatbot that has your entire code repository available for context. For more information, see [CodeRabbit Chat](https://docs.coderabbit.ai/guides/agent_chat) . ### [​](https://docs.coderabbit.ai/guides/code-review-overview#manage-coderabbit-review-behavior%E2%80%8B) Manage CodeRabbit review behavior[​](https://docs.coderabbit.ai/guides/code-review-overview#manage "Direct link to Manage CodeRabbit review behavior") CodeRabbit recognizes a variety of keyword-based commands that let you control its behavior during a code review, including the following: * Pause or resume automated reviews of the pull request. * Manually request a review, when automated reviews are paused. * Resolve all open comments authored by CodeRabbit. For more information, see [Control and manage code reviews](https://docs.coderabbit.ai/guides/commands) . ### [​](https://docs.coderabbit.ai/guides/code-review-overview#generate-improvements%E2%80%8B) Generate improvements[​](https://docs.coderabbit.ai/guides/code-review-overview#generate "Direct link to Generate improvements") You can command CodeRabbit to generate improvements to the branch under review. CodeRabbit accomplishes this by publishing a new branch based on the branch under review, and creating a new pull request for your own review. Available code-generation commands let you request the following from CodeRabbit: * Implement the suggestions for improvements that CodeRabbit has made in its earlier code review comments. * Generate inline documentation for any undocumented functions that this pull request proposes to add. For more information, see [Generate improvements](https://docs.coderabbit.ai/guides/generate-improvements) . [​](https://docs.coderabbit.ai/guides/code-review-overview#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/code-review-overview#whats-next "Direct link to What's next") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Control and manage code reviews](https://docs.coderabbit.ai/guides/commands) * [Generate code improvements](https://docs.coderabbit.ai/guides/generate-improvements) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/code-review-overview.md) Last updated on **Jul 31, 2025** [Set permissions](https://docs.coderabbit.ai/getting-started/upgrading-permissions) [Control and manage code reviews](https://docs.coderabbit.ai/guides/commands) Assistant Responses are generated using AI and may contain mistakes. --- # Unit Test Generation - Beta - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Unit Test Generation - Beta On this page * [⚡️ Unit Test Generation - Beta](https://docs.coderabbit.ai/changelog/unit-test-generation-beta#%E2%9A%A1%EF%B8%8F-unit-test-generation-beta) ### [​](https://docs.coderabbit.ai/changelog/unit-test-generation-beta#%E2%9A%A1%EF%B8%8F-unit-test-generation-beta) ⚡️ Unit Test Generation - Beta CodeRabbit’s unit test generation is now available in Beta! Automatically generate comprehensive unit tests for your code changes, ensuring better test coverage and catching edge cases you might miss. Our AI analyzes your code structure and creates tests that follow best practices and your project’s testing patterns. Learn more [here](https://docs.coderabbit.ai/finishing-touches/unit-test-generation) , or just try it under ✨ Finishing Touches. Assistant Responses are generated using AI and may contain mistakes. --- # New Security and Code Quality Tools - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation New Security and Code Quality Tools On this page * [New Security and Code Quality Tools](https://docs.coderabbit.ai/changelog/new-security-and-code-quality-tools#new-security-and-code-quality-tools) ### [​](https://docs.coderabbit.ai/changelog/new-security-and-code-quality-tools#new-security-and-code-quality-tools) New Security and Code Quality Tools We’re excited to announce the addition of two powerful tools to our static analysis arsenal: * **Brakeman**: A static analysis security vulnerability scanner for Ruby on Rails applications. It helps identify security issues in your Ruby codebase by analyzing Gemfile, Ruby files (_.rb), and ERB templates (_.erb). * **Clippy**: The official linter for Rust code, helping catch common mistakes and improve your Rust code quality. It analyzes \*.rs files and supports configuration through clippy.toml files. Both tools can be configured through their respective config files or through CodeRabbit’s settings page. See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details. Assistant Responses are generated using AI and may contain mistakes. --- # Teach CodeRabbit your review preferences - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Teach CodeRabbit your review preferences On this page * [About CodeRabbit learnings​](https://docs.coderabbit.ai/guides/learnings#about-coderabbit-learnings%E2%80%8B) * [Add learnings​](https://docs.coderabbit.ai/guides/learnings#add-learnings%E2%80%8B) * [An example of adding a learning​](https://docs.coderabbit.ai/guides/learnings#an-example-of-adding-a-learning%E2%80%8B) * [Best practices for new learnings​](https://docs.coderabbit.ai/guides/learnings#best-practices-for-new-learnings%E2%80%8B) * [View learnings​](https://docs.coderabbit.ai/guides/learnings#view-learnings%E2%80%8B) * [Filter displayed learnings​](https://docs.coderabbit.ai/guides/learnings#filter-displayed-learnings%E2%80%8B) * [Edit or delete learnings​](https://docs.coderabbit.ai/guides/learnings#edit-or-delete-learnings%E2%80%8B) * [Configure learnings storage and application​](https://docs.coderabbit.ai/guides/learnings#configure-learnings-storage-and-application%E2%80%8B) * [Opt out of learnings storage​](https://docs.coderabbit.ai/guides/learnings#opt-out-of-learnings-storage%E2%80%8B) * [Specify the scope of applied learnings​](https://docs.coderabbit.ai/guides/learnings#specify-the-scope-of-applied-learnings%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/learnings#what%E2%80%99s-next%E2%80%8B) For a conceptual overview of CodeRabbit configuration methods, see [Configure CodeRabbit](https://docs.coderabbit.ai/guides/configuration-overview) . For more information about performing code reviews with CodeRabbit, see [Review pull requests](https://docs.coderabbit.ai/guides/code-review-overview) . [​](https://docs.coderabbit.ai/guides/learnings#about-coderabbit-learnings%E2%80%8B) About CodeRabbit learnings[​](https://docs.coderabbit.ai/guides/learnings#about "Direct link to About CodeRabbit learnings") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- As your team works with CodeRabbit, it learns your team’s code-review preferences based on chat interactions, and adds these preferences to an internal database that it associates with your Git platform organization. We call these internal records _learnings_. [YouTube video player](https://www.youtube.com/embed/Yu0cmmOYA-U?si=WIeOxqPw4ZFFgvlw) CodeRabbit learnings are flexible, natural-language statements about code-review preferences whose purpose can include the following: * Special instructions about reviewing particular files. * Guidance for reviewing all of the files of one repository. * Code-review preferences that CodeRabbit must apply across all of your organization’s repositories. Every time CodeRabbit prepares to add a comment to a pull request or issue, it loads all of the learnings that it has collected about your organization’s code review preferences. CodeRabbit applies these learnings as additional context or instructions for its comment. CodeRabbit learnings complement the more traditional configuration that you set for your organization and its repositories using the CodeRabbit web interface or [`.coderabbit.yaml` files](https://docs.coderabbit.ai/getting-started/configure-coderabbit) . Learnings give you a convenient way to quickly set or correct the behavior of CodeRabbit in ways that are highly specific to your team’s coding style, or in ways that the CodeRabbit configuration options don’t otherwise account for. You can review and edit your organization’s CodeRabbit learnings at any time, as detailed later in this page. [​](https://docs.coderabbit.ai/guides/learnings#add-learnings%E2%80%8B) Add learnings[​](https://docs.coderabbit.ai/guides/learnings#add "Direct link to Add learnings") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To add learnings to the database CodeRabbit keeps about your organization’s preferences, communicate your preferences directly to the appropriate CodeRabbit service account using natural language, in a comment attached to any pull request or issue. For more information about chatting with CodeRabbit using comments, see [CodeRabbit chat](https://docs.coderabbit.ai/guides/agent_chat) . If CodeRabbit decides to create one or more learnings based on a comment, then it makes this explicit in its response to that comment by adding a collapsible section titled **Learnings Added** to its own response comment. ### [​](https://docs.coderabbit.ai/guides/learnings#an-example-of-adding-a-learning%E2%80%8B) An example of adding a learning[​](https://docs.coderabbit.ai/guides/learnings#example "Direct link to An example of adding a learning") Imagine a scenario where CodeRabbit has reviewed a GitHub-based pull request from your team that adds a feature to an authentication middleware library. CodeRabbit has flagged a certain file as needing improvement, attaching this comment to the relevant lines in its review: > Consider using nested try-catch blocks here to handle different error scenarios more comprehensively. If this critique disagrees with your team’s coding practices specific to try-catch blocks, then you can reply to this CodeRabbit using a comment of your own, addressed to the `@coderabbitai` service account on GitHub: > @coderabbitai Actually, we’ve found that nested try-catch blocks make our auth middleware harder to debug in production. We prefer early returns with specific error codes - it’s cleaner and our monitoring tools can track them better. CodeRabbit considers your reply, and decides to make a learning out of it. It acknowledges this in another reply: > You’re absolutely right about the debugging benefits. Early returns with specific error codes do provide better clarity and monitoring capabilities. I’ll remember this preference for your authentication middleware. Thank you for the guidance! CodeRabbit also adds a **Learnings added** section to this comment, making explicit the fact that this chat has modified its future behavior with your team. CodeRabbit then creates a new learnings record for itself. Along with metadata such as the pull request number, filename, and GitHub user associated with the learning, CodeRabbit adds this self-instructive text to the new record: > In authentication middleware, prefer returning early with specific error codes rather than nested try-catch blocks. This improves readability and makes error tracking easier in production environments. ### [​](https://docs.coderabbit.ai/guides/learnings#best-practices-for-new-learnings%E2%80%8B) Best practices for new learnings[​](https://docs.coderabbit.ai/guides/learnings#best-practices "Direct link to Best practices for new learnings") When communicating with CodeRabbit during an active code review, you can help make any resulting learnings more specific by replying directly to review comments that CodeRabbit has left on specific files, rather than leaving comments on the overall pull request. This gives CodeRabbit more context when considering feedback, allowing it to create more specific learnings. [​](https://docs.coderabbit.ai/guides/learnings#view-learnings%E2%80%8B) View learnings[​](https://docs.coderabbit.ai/guides/learnings#view "Direct link to View learnings") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To view the learnings that CodeRabbit has associated with your organization, follow these steps: 1. Visit [the CodeRabbit web interface](https://app.coderabbit.ai/settings/repositories) . 2. In the sidebar, click **Learnings**. This displays a paged list of all of the learnings associated with your organization, sorted by creation time, newest-first. To see more details about any learnings record, click its text. ### [​](https://docs.coderabbit.ai/guides/learnings#filter-displayed-learnings%E2%80%8B) Filter displayed learnings[​](https://docs.coderabbit.ai/guides/learnings#filter "Direct link to Filter displayed learnings") Over time, the learnings that CodeRabbit gathers for your organization can become quite numerous. This can make manually browsing the full list difficult. The CodeRabbit web interface has search and filtering tools to help you find specific learnings, based on the topic of the learning text, or on other metadata. To filter the displayed learnings by topic or concept, enter that topic or concept into the **Similarity search** field, and set **Top K** to the number of results you want returned. Because this is a vector-based similarity search, the returned learnings don’t necessarily contain the exact text of your search terms. For example, to see the top ten learnings that have to do with error reporting, enter `error reporting` into **Similarity search** and set **Top K** to `10`. To filter the displayed learnings by repository, user, or file path, click **\+ Filters**, and select additional criteria. ### [​](https://docs.coderabbit.ai/guides/learnings#edit-or-delete-learnings%E2%80%8B) Edit or delete learnings[​](https://docs.coderabbit.ai/guides/learnings#edit "Direct link to Edit or delete learnings") If your account has the **Admin** [CodeRabbit role](https://docs.coderabbit.ai/guides/roles) with your organization, then you can freely edit the text of any stored learning, or delete it outright. To edit or delete a learning, follow these steps: 1. Click the **Action** menu on the learning record, which resembles three dots. 2. Select **Edit** or **Delete**. [​](https://docs.coderabbit.ai/guides/learnings#configure-learnings-storage-and-application%E2%80%8B) Configure learnings storage and application[​](https://docs.coderabbit.ai/guides/learnings#configure "Direct link to Configure learnings storage and application") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- CodeRabbit has several configuration options that modify the storage and application of learnings. ### [​](https://docs.coderabbit.ai/guides/learnings#opt-out-of-learnings-storage%E2%80%8B) Opt out of learnings storage[​](https://docs.coderabbit.ai/guides/learnings#opt-out "Direct link to Opt out of learnings storage") CodeRabbit enables learnings by default. To disable learnings, modify one of the following configuration options: * To disable all CodeRabbit [knowledge base](https://docs.coderabbit.ai/integrations/knowledge-base) features for your organization or repository, which includes learnings, enable [the _Opt out_ setting](https://docs.coderabbit.ai/reference/configuration#opt-out) . * To disable all CodeRabbit features that require long-term data retention about your organization’s use of CodeRabbit—including learnings—disable [the _Data retention_ setting](https://docs.coderabbit.ai/reference/configuration#data-retention) . Disabling data retention immediately and irrevocably deletes all learnings that CodeRabbit has associated with your organization. ### [​](https://docs.coderabbit.ai/guides/learnings#specify-the-scope-of-applied-learnings%E2%80%8B) Specify the scope of applied learnings[​](https://docs.coderabbit.ai/guides/learnings#scope "Direct link to Specify the scope of applied learnings") [The Learnings configuration setting](https://docs.coderabbit.ai/reference/configuration#learnings) lets you specify the _scope_ that CodeRabbit applies to all of the learnings it has collected about your organization. You can set this option to one of the following values: * **`auto`**: When reviewing a public repository, CodeRabbit applies only the learnings specific to that repository. When reviewing private repository, CodeRabbit applies all of your organization’s learnings. This is the default setting. * **`global`**: CodeRabbit applies all of your organization’s learnings to all code reviews. * **`local`**: CodeRabbit applies only learnings associated with code reviews’ respective repositories. [​](https://docs.coderabbit.ai/guides/learnings#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/learnings#whats-next "Direct link to What's next") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Add review instructions](https://docs.coderabbit.ai/guides/review-instructions) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/learnings.md) Last updated on **Jul 31, 2025** Assistant Responses are generated using AI and may contain mistakes. --- # Linked Issues - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Create and resolve issues Linked Issues On this page * [Understanding Linked Issues​](https://docs.coderabbit.ai/guides/linked-issues#understanding-linked-issues%E2%80%8B) * [Best Practices for Issue Writing​](https://docs.coderabbit.ai/guides/linked-issues#best-practices-for-issue-writing%E2%80%8B) * [Issue Titles​](https://docs.coderabbit.ai/guides/linked-issues#issue-titles%E2%80%8B) * [Issue Descriptions​](https://docs.coderabbit.ai/guides/linked-issues#issue-descriptions%E2%80%8B) * [Consistent Terminology​](https://docs.coderabbit.ai/guides/linked-issues#consistent-terminology%E2%80%8B) * [Linking Issues Effectively​](https://docs.coderabbit.ai/guides/linked-issues#linking-issues-effectively%E2%80%8B) * [In Pull Requests​](https://docs.coderabbit.ai/guides/linked-issues#in-pull-requests%E2%80%8B) * [Cross-References​](https://docs.coderabbit.ai/guides/linked-issues#cross-references%E2%80%8B) * [How CodeRabbit Assesses Linked Issues​](https://docs.coderabbit.ai/guides/linked-issues#how-coderabbit-assesses-linked-issues%E2%80%8B) * [Tips for Better Assessments​](https://docs.coderabbit.ai/guides/linked-issues#tips-for-better-assessments%E2%80%8B) * [Related Resources​](https://docs.coderabbit.ai/guides/linked-issues#related-resources%E2%80%8B) [​](https://docs.coderabbit.ai/guides/linked-issues#understanding-linked-issues%E2%80%8B) Understanding Linked Issues[​](https://docs.coderabbit.ai/guides/linked-issues#understanding-linked-issues "Direct link to Understanding Linked Issues") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ A linked issue is one that is explicitly referenced in your pull request description using platform-specific syntax: * GitHub: `fixes #123`, `closes #123`, `resolves #123` * GitLab: `closes #123`, `fixes #123`, or full URLs * Jira/Linear: Full URLs to tickets When CodeRabbit detects linked issues, it analyzes them against your pull request changes to determine if the requirements are met: ![Linked Issue Assessment Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/linked-issue-7b0c76ee708b1992f70f9c9635d31824.png) [​](https://docs.coderabbit.ai/guides/linked-issues#best-practices-for-issue-writing%E2%80%8B) Best Practices for Issue Writing[​](https://docs.coderabbit.ai/guides/linked-issues#best-practices-for-issue-writing "Direct link to Best Practices for Issue Writing") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/guides/linked-issues#issue-titles%E2%80%8B) Issue Titles[​](https://docs.coderabbit.ai/guides/linked-issues#issue-titles "Direct link to Issue Titles") Create descriptive, technical titles that clearly state the goal: ✅ Good Examples: * “Add PrismaLint integration to configuration flow” * “Fix race condition in user authentication” * “Implement caching for GraphQL queries” ❌ Poor Examples: * “Fix bug” * “Update code” * “Improve performance” ### [​](https://docs.coderabbit.ai/guides/linked-issues#issue-descriptions%E2%80%8B) Issue Descriptions[​](https://docs.coderabbit.ai/guides/linked-issues#issue-descriptions "Direct link to Issue Descriptions") Write comprehensive descriptions that provide clear technical context: 1. **Problem Statement** * Clearly describe what needs to be changed * Include technical details about affected components * Reference specific files or functions if known 2. **Expected Solution** * Outline the desired implementation approach * Include code examples or pseudo-code when relevant * List specific acceptance criteria Example Description: Copy Problem:The configuration system doesn't validate Prisma schema files before deployment,leading to potential runtime errors.Solution:Integrate PrismaLint into the configuration flow to:- Validate schema files during PR checks- Enforce consistent naming conventions- Prevent common Prisma anti-patternsAffected Components:- Configuration validation pipeline- CI/CD workflow- Schema validation logicAcceptance Criteria:- [ ] PrismaLint runs on all PR checks- [ ] Failed validations block merging- [ ] Clear error messages for schema issues ### [​](https://docs.coderabbit.ai/guides/linked-issues#consistent-terminology%E2%80%8B) Consistent Terminology[​](https://docs.coderabbit.ai/guides/linked-issues#consistent-terminology "Direct link to Consistent Terminology") Use consistent terminology between issues and pull requests: ✅ Good: * Use the same technical terms consistently * Reference components with their exact names * Maintain consistent naming patterns ❌ Poor: * Mixing different terms for the same component * Using vague or non-technical language * Inconsistent capitalization or formatting [​](https://docs.coderabbit.ai/guides/linked-issues#linking-issues-effectively%E2%80%8B) Linking Issues Effectively[​](https://docs.coderabbit.ai/guides/linked-issues#linking-issues-effectively "Direct link to Linking Issues Effectively") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/guides/linked-issues#in-pull-requests%E2%80%8B) In Pull Requests[​](https://docs.coderabbit.ai/guides/linked-issues#in-pull-requests "Direct link to In Pull Requests") 1. **Direct References** Copy Fixes #123Resolves organization/repo#456Closes https://github.com/org/repo/issues/789 2. **Multiple Issues** Copy This PR addresses:- Fixes #123- Closes #456- Resolves https://jira.company.com/browse/PROJ-789 ### [​](https://docs.coderabbit.ai/guides/linked-issues#cross-references%E2%80%8B) Cross-References[​](https://docs.coderabbit.ai/guides/linked-issues#cross-references "Direct link to Cross-References") For better traceability: 1. Add PR references in issue comments 2. Use complete URLs when linking external systems 3. Maintain bidirectional links between related issues [​](https://docs.coderabbit.ai/guides/linked-issues#how-coderabbit-assesses-linked-issues%E2%80%8B) How CodeRabbit Assesses Linked Issues[​](https://docs.coderabbit.ai/guides/linked-issues#how-coderabbit-assesses-linked-issues "Direct link to How CodeRabbit Assesses Linked Issues") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- CodeRabbit evaluates linked issues by: 1. Analyzing issue titles and descriptions 2. Comparing changes in the pull request 3. Validating if requirements are met 4. Providing an assessment with: * ✅: If the objective has been addressed in the PR. The ‘Explanation’ column will be left blank. * ❌: If the objective has not been addressed in the PR. Here a brief explanation is added to the ‘Explanation’ column. * ❓: If it is unclear whether the objective has been addressed. Here a brief explanation is added to the ‘Explanation’ column. Only the issue title and description are considered in the assessment. Comments and discussion threads are not currently analyzed. [​](https://docs.coderabbit.ai/guides/linked-issues#tips-for-better-assessments%E2%80%8B) Tips for Better Assessments[​](https://docs.coderabbit.ai/guides/linked-issues#tips-for-better-assessments "Direct link to Tips for Better Assessments") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ 1. **Be Specific** * Include clear, measurable objectives * List specific technical requirements * Reference affected code components 2. **Provide Context** * Explain why changes are needed * Document current behavior * Describe expected outcomes 3. **Use Technical Details** * Include file paths when known * Reference specific functions or classes * Mention relevant technologies 4. **Keep It Focused** * One main objective per issue * Clear scope boundaries * Specific acceptance criteria [​](https://docs.coderabbit.ai/guides/linked-issues#related-resources%E2%80%8B) Related Resources[​](https://docs.coderabbit.ai/guides/linked-issues#related-resources "Direct link to Related Resources") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Add review instructions](https://docs.coderabbit.ai/guides/review-instructions) * [Issue Chat](https://docs.coderabbit.ai/guides/issue-chat) * [Issue Creation](https://docs.coderabbit.ai/guides/issue-creation) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/linked-issues.md) Last updated on **Jul 31, 2025** [Create issues](https://docs.coderabbit.ai/guides/issue-creation) [Review local changes](https://docs.coderabbit.ai/code-editors) Assistant Responses are generated using AI and may contain mistakes. --- # Static Analyzers and Linters Integration - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Static Analyzers and Linters Integration On this page * [Static Analyzers and Linters Integration](https://docs.coderabbit.ai/changelog/static-analyzers-and-linters-integration#static-analyzers-and-linters-integration) ### [​](https://docs.coderabbit.ai/changelog/static-analyzers-and-linters-integration#static-analyzers-and-linters-integration) Static Analyzers and Linters Integration CodeRabbit now runs static analyzers, linters and provides one-click fixes for the issues identified. AI helps reduce the false positives and focus on the critical findings. CodeRabbit will respect the existing configuration files of these tools if they already exist in the project. For example, if your project already uses ruff and has a ruff.toml file at the root of the project, that will be used. In cases where project configurations are not found, CodeRabbit defaults will be used. Currently, CodeRabbit runs markdownlint, shellcheck, ruff, and languagetool. We will continue to add more tools. The default configuration can be changed through the .coderabbit.yaml file. Are there any specific tools you’d like us to add? Let us know. We’d love to hear your suggestions! Assistant Responses are generated using AI and may contain mistakes. --- # Role based access - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Manage your account Role based access On this page * [Overview of CodeRabbit roles​](https://docs.coderabbit.ai/guides/roles#overview-of-coderabbit-roles%E2%80%8B) * [CodeRabbit roles and Git platform roles​](https://docs.coderabbit.ai/guides/roles#coderabbit-roles-and-git-platform-roles%E2%80%8B) * [CodeRabbit roles and developer features​](https://docs.coderabbit.ai/guides/roles#coderabbit-roles-and-developer-features%E2%80%8B) * [Default roles​](https://docs.coderabbit.ai/guides/roles#default-roles%E2%80%8B) * [View or set roles​](https://docs.coderabbit.ai/guides/roles#view-or-set-roles%E2%80%8B) * [View roles​](https://docs.coderabbit.ai/guides/roles#view-roles%E2%80%8B) * [Set roles​](https://docs.coderabbit.ai/guides/roles#set-roles%E2%80%8B) * [Add billing admin accounts​](https://docs.coderabbit.ai/guides/roles#add-billing-admin-accounts%E2%80%8B) * [Role permissions​](https://docs.coderabbit.ai/guides/roles#role-permissions%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/roles#what%E2%80%99s-next%E2%80%8B) [​](https://docs.coderabbit.ai/guides/roles#overview-of-coderabbit-roles%E2%80%8B) Overview of CodeRabbit roles[​](https://docs.coderabbit.ai/guides/roles#overview "Direct link to Overview of CodeRabbit roles") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 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](https://docs.coderabbit.ai/guides/roles#permissions) . ### [​](https://docs.coderabbit.ai/guides/roles#coderabbit-roles-and-git-platform-roles%E2%80%8B) CodeRabbit roles and Git platform roles[​](https://docs.coderabbit.ai/guides/roles#and-upstream "Direct link to CodeRabbit roles and Git platform roles") 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. ### [​](https://docs.coderabbit.ai/guides/roles#coderabbit-roles-and-developer-features%E2%80%8B) CodeRabbit roles and developer features[​](https://docs.coderabbit.ai/guides/roles#and-features "Direct link to CodeRabbit roles and developer 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](https://docs.coderabbit.ai/getting-started/subscription-management) . [​](https://docs.coderabbit.ai/guides/roles#default-roles%E2%80%8B) Default roles[​](https://docs.coderabbit.ai/guides/roles#defaults "Direct link to Default roles") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 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. [​](https://docs.coderabbit.ai/guides/roles#view-or-set-roles%E2%80%8B) View or set roles[​](https://docs.coderabbit.ai/guides/roles#how-to "Direct link to View or set roles") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You can view and set roles from the CodeRabbit dashboard, as detailed in the following sections. ### [​](https://docs.coderabbit.ai/guides/roles#view-roles%E2%80%8B) View roles[​](https://docs.coderabbit.ai/guides/roles#view-roles "Direct link to 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) . 2. At the top of the sidebar, select the organization whose user roles you want to view. 3. 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. ### [​](https://docs.coderabbit.ai/guides/roles#set-roles%E2%80%8B) Set roles[​](https://docs.coderabbit.ai/guides/roles#set-roles "Direct link to Set roles") 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. 2. 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. ### [​](https://docs.coderabbit.ai/guides/roles#add-billing-admin-accounts%E2%80%8B) Add billing admin accounts[​](https://docs.coderabbit.ai/guides/roles#billing "Direct link to Add billing admin accounts") 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](https://docs.coderabbit.ai/guides/roles#view-roles) . 2. Click **Invite Billing Admin**. 3. 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. [​](https://docs.coderabbit.ai/guides/roles#role-permissions%E2%80%8B) Role permissions[​](https://docs.coderabbit.ai/guides/roles#permissions "Direct link to Role 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 | [​](https://docs.coderabbit.ai/guides/roles#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/roles#whats-next "Direct link to What's next") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Manage your subscription](https://docs.coderabbit.ai/getting-started/subscription-management) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/roles.md) Last updated on **Jul 31, 2025** [Manage your subscription](https://docs.coderabbit.ai/getting-started/subscription-management) [Overview](https://docs.coderabbit.ai/guides/reports-overview) Assistant Responses are generated using AI and may contain mistakes. --- # New Features and Improvements - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation New Features and Improvements On this page * [New Features and Improvements](https://docs.coderabbit.ai/changelog/new-features-and-improvements#new-features-and-improvements) * [Learnings Page](https://docs.coderabbit.ai/changelog/new-features-and-improvements#learnings-page) * [Reports (Beta) Page](https://docs.coderabbit.ai/changelog/new-features-and-improvements#reports-beta-page) * [Sequence Diagrams Configuration](https://docs.coderabbit.ai/changelog/new-features-and-improvements#sequence-diagrams-configuration) * [Enhanced Tool Settings & New Analysis Tools](https://docs.coderabbit.ai/changelog/new-features-and-improvements#enhanced-tool-settings-%26-new-analysis-tools) * [GitLab Integration Update](https://docs.coderabbit.ai/changelog/new-features-and-improvements#gitlab-integration-update) ### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements#new-features-and-improvements) New Features and Improvements #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements#learnings-page) Learnings Page We’re thrilled to announce the new **Learnings** page! Users can now interact with learnings captured in PR comments, enhancing future reviews. Log into CodeRabbit and navigate to the Learnings tab, where you can filter learnings by Repository, File Path, and User. You can also edit or delete learnings that are no longer relevant to your project. #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements#reports-beta-page) Reports (Beta) Page Introducing the beta release of **Reports**! Generate recurring summaries of team performance and latest PR reviews with features like: * Scheduling regular report generation * Specifying parameters such as repository, team, user, or label * Selecting report styles (Daily Stand-Up, Sprint Report, Release Notes, Custom) * Enabling your choice of delivery channel (Email, Slack, or Discord) #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements#sequence-diagrams-configuration) Sequence Diagrams Configuration You can now choose whether to auto-generate sequence diagrams in the PR Walkthrough comment. Enable this via the CodeRabbit settings page or by setting reviews.sequence\_diagrams in the .coderabbit.yaml file. #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements#enhanced-tool-settings-%26-new-analysis-tools) Enhanced Tool Settings & New Analysis Tools We’ve refined the default settings to be less noisy and more actionable. Additionally, we’ve added new static analysis and security tools: * **YAMLlint**: A linter for YAML files * **Gitleaks**: A lightweight, open-source secret scanner to prevent security breaches * **Checkov**: Scans infrastructure as code for misconfigurations before they become security issues #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements#gitlab-integration-update) GitLab Integration Update The GitLab integration now offers more flexibility and security. Users can use Personal Access Tokens (PATs) from within their organization to post reviews. This enhancement ensures reviews are posted with appropriate organizational context and permissions, improving traceability and security. Assistant Responses are generated using AI and may contain mistakes. --- # Use the VSCode extension - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation IDE extensions Use the VSCode extension On this page * [Automatically review local commits​](https://docs.coderabbit.ai/guides/use-vscode#automatically-review-local-commits%E2%80%8B) * [Manually request code reviews​](https://docs.coderabbit.ai/guides/use-vscode#manually-request-code-reviews%E2%80%8B) * [Work with code reviews​](https://docs.coderabbit.ai/guides/use-vscode#work-with-code-reviews%E2%80%8B) * [Browse comments​](https://docs.coderabbit.ai/guides/use-vscode#browse-comments%E2%80%8B) * [Apply suggested changes​](https://docs.coderabbit.ai/guides/use-vscode#apply-suggested-changes%E2%80%8B) * [Request help from your AI coding agent​](https://docs.coderabbit.ai/guides/use-vscode#request-help-from-your-ai-coding-agent%E2%80%8B) * [Ignore or collapse comments​](https://docs.coderabbit.ai/guides/use-vscode#ignore-or-collapse-comments%E2%80%8B) * [Browse previous reviews​](https://docs.coderabbit.ai/guides/use-vscode#browse-previous-reviews%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/use-vscode#what%E2%80%99s-next%E2%80%8B) This page is about performing local code reviews using the CodeRabbit VSCode extension. For more information about the extension, see [Review local changes](https://docs.coderabbit.ai/code-editors) . To learn how to install the extension, see [Install the VSCode extension](https://docs.coderabbit.ai/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. 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. [​](https://docs.coderabbit.ai/guides/use-vscode#automatically-review-local-commits%E2%80%8B) Automatically review local commits[​](https://docs.coderabbit.ai/guides/use-vscode#auto-reviews "Direct link to Automatically review local commits") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ 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?** 2. Click **Yes**. The CodeRabbit sidebar appears in your VSCode window. 3. 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](https://docs.coderabbit.ai/guides/use-vscode#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](https://docs.coderabbit.ai/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. [​](https://docs.coderabbit.ai/guides/use-vscode#manually-request-code-reviews%E2%80%8B) Manually request code reviews[​](https://docs.coderabbit.ai/guides/use-vscode#manual-reviews "Direct link to Manually request code 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. 2. 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. 2. Select the name of a base branch to compare against. 3. 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. 4. 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. 5. To perform the review, click the button part of the menu. The CodeRabbit sidebar displays a **Review** section with the review’s progress. 6. 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. [​](https://docs.coderabbit.ai/guides/use-vscode#work-with-code-reviews%E2%80%8B) Work with code reviews[​](https://docs.coderabbit.ai/guides/use-vscode#work "Direct link to Work with code reviews") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 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. ### [​](https://docs.coderabbit.ai/guides/use-vscode#browse-comments%E2%80%8B) Browse comments[​](https://docs.coderabbit.ai/guides/use-vscode#browse "Direct link to Browse comments") 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. ### [​](https://docs.coderabbit.ai/guides/use-vscode#apply-suggested-changes%E2%80%8B) Apply suggested changes[​](https://docs.coderabbit.ai/guides/use-vscode#apply "Direct link to Apply suggested changes") 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. ### [​](https://docs.coderabbit.ai/guides/use-vscode#request-help-from-your-ai-coding-agent%E2%80%8B) Request help from your AI coding agent[​](https://docs.coderabbit.ai/guides/use-vscode#agent "Direct link to Request help from your AI coding 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](https://docs.coderabbit.ai/guides/config-vscode#agent) . ### [​](https://docs.coderabbit.ai/guides/use-vscode#ignore-or-collapse-comments%E2%80%8B) Ignore or collapse comments[​](https://docs.coderabbit.ai/guides/use-vscode#ignore "Direct link to Ignore or collapse comments") 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. ### [​](https://docs.coderabbit.ai/guides/use-vscode#browse-previous-reviews%E2%80%8B) Browse previous reviews[​](https://docs.coderabbit.ai/guides/use-vscode#previous "Direct link to Browse previous reviews") 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. [​](https://docs.coderabbit.ai/guides/use-vscode#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/use-vscode#whats-next "Direct link to What's next") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Configure the VSCode extension](https://docs.coderabbit.ai/guides/config-vscode) * [Uninstall the VSCode extension](https://docs.coderabbit.ai/guides/uninstall-vscode) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/use-vscode.md) Last updated on **Jul 31, 2025** [Install the VSCode extension](https://docs.coderabbit.ai/guides/install-vscode) [Use with self-hosted CodeRabbit](https://docs.coderabbit.ai/guides/use-vscode-selfhosted) Assistant Responses are generated using AI and may contain mistakes. --- # Uninstall the VSCode extension - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation IDE extensions Uninstall the VSCode extension On this page * [Uninstall the extension​](https://docs.coderabbit.ai/guides/uninstall-vscode#uninstall-the-extension%E2%80%8B) This page is about uninstalling the CodeRabbit VSCode extension. For more information about the extension, see [Review local changes](https://docs.coderabbit.ai/code-editors) . 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. [​](https://docs.coderabbit.ai/guides/uninstall-vscode#uninstall-the-extension%E2%80%8B) Uninstall the extension[​](https://docs.coderabbit.ai/guides/uninstall-vscode#uninstall-the-extension "Direct link to Uninstall the extension") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To uninstall the VSCode extension, follow these steps: 1. In the VSCode activity bar, click the CodeRabbit icon. 2. In the CodeRabbit sidebar, click the door-shaped **Logout** icon. 3. In the VSCode activity bar, click the **Extensions** icon. 4. In the Extensions sidebar, click the gear-shaped **Manage** icon next to CodeRabbit in the list of installed extensions. 5. Select **Uninstall**. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/uninstall-vscode.md) Last updated on **Jul 31, 2025** [Configure the VSCode extension](https://docs.coderabbit.ai/guides/config-vscode) [Overview](https://docs.coderabbit.ai/guides/configuration-overview) Assistant Responses are generated using AI and may contain mistakes. --- # Knowledge base - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Configure Knowledge base On this page * [Issue Tracking Integration​](https://docs.coderabbit.ai/integrations/knowledge-base#issue-tracking-integration%E2%80%8B) * [Learnings​](https://docs.coderabbit.ai/integrations/knowledge-base#learnings%E2%80%8B) * [Code Guidelines​](https://docs.coderabbit.ai/integrations/knowledge-base#code-guidelines%E2%80%8B) [​](https://docs.coderabbit.ai/integrations/knowledge-base#issue-tracking-integration%E2%80%8B) Issue Tracking Integration[​](https://docs.coderabbit.ai/integrations/knowledge-base#issue-tracking-integration "Direct link to Issue Tracking Integration") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- CodeRabbit can integrate with your issue tracking systems to provide better context during code reviews. For details on setting up issue tracking integrations, see our [Issue Integrations](https://docs.coderabbit.ai/integrations/issue-integrations) guide. [​](https://docs.coderabbit.ai/integrations/knowledge-base#learnings%E2%80%8B) Learnings[​](https://docs.coderabbit.ai/integrations/knowledge-base#learnings "Direct link to Learnings") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You can tell the bot to remember things about either specific lines in files, or generally about the entire repository, or even across repositories. For example, you can add a comment in a PR to chat directly with CodeRabbit. `@coderabbitai always remember to enforce camelCase`. Or you can comment directly on some lines of code in the PR. `@coderabbitai do not complain about lack of error handling here, it is handled higher up the execution stack.` For more information, see [Teach CodeRabbit your review preferences](https://docs.coderabbit.ai/guides/learnings) . [​](https://docs.coderabbit.ai/integrations/knowledge-base#code-guidelines%E2%80%8B) Code Guidelines[​](https://docs.coderabbit.ai/integrations/knowledge-base#code_guidelines "Direct link to 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. Copy **/.cursorrules .github/copilot-instructions.md **/CLAUDE.md**/ .cursor/rules/***/ .windsurfrules**/ .clinerules/***/ .rules/* ![Illustration of code guidelines configuration](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/integrations/assets/images/code-guidelines-11562724c62bf74072039fd1f8a9d9d0.png) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/integrations/knowledge-base.md) Last updated on **Jul 31, 2025** [Initial configuration guide](https://docs.coderabbit.ai/guides/initial-configuration) [Integrate MCP servers](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations) Assistant Responses are generated using AI and may contain mistakes. --- # Use with self-hosted CodeRabbit - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation IDE extensions Use with self-hosted CodeRabbit On this page * [Prerequisites​](https://docs.coderabbit.ai/guides/use-vscode-selfhosted#prerequisites%E2%80%8B) * [Connect your self-hosted instance​](https://docs.coderabbit.ai/guides/use-vscode-selfhosted#connect-your-self-hosted-instance%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/use-vscode-selfhosted#what%E2%80%99s-next%E2%80%8B) This page is about setting up the VSCode extension with self-hosted CodeRabbit. If you are instead using the managed offering, see [Install the VSCode extension](https://docs.coderabbit.ai/guides/install-vscode) . [​](https://docs.coderabbit.ai/guides/use-vscode-selfhosted#prerequisites%E2%80%8B) Prerequisites[​](https://docs.coderabbit.ai/guides/use-vscode-selfhosted#prerequisites "Direct link to Prerequisites") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Your extension version should be greater than `0.12.1`. 2. Logout of the extension if previously logged in. [​](https://docs.coderabbit.ai/guides/use-vscode-selfhosted#connect-your-self-hosted-instance%E2%80%8B) Connect your self-hosted instance[​](https://docs.coderabbit.ai/guides/use-vscode-selfhosted#connect-self-hosted-instance "Direct link to Connect your self-hosted instance") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To connect the VSCode extension to your self-hosted instance, follow these steps: 1. Click on the “Self hosting CodeRabbit?” button, below the “Use CodeRabbit for free” button. 2. Enter your self-hosted instance URL when prompted. * Make sure the instance URL is reachable within your network and websocket connections are allowed. 3. Select your git provider which you are using with your self-hosted CodeRabbit. (GitLab, Self-Hosted Gitlab, GitHub, GitHub Enterprise) * If using GitHub or GitHub Enterprise, enter your [Github Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) when prompted. You should be connected to your self-hosted instance and ready to use the VSCode extension. [​](https://docs.coderabbit.ai/guides/use-vscode-selfhosted#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/use-vscode-selfhosted#whats-next "Direct link to What's next") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Use the VSCode extension](https://docs.coderabbit.ai/guides/use-vscode) * [Configure the VSCode extension](https://docs.coderabbit.ai/guides/config-vscode) * [Uninstall the VSCode extension](https://docs.coderabbit.ai/guides/uninstall-vscode) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/use-vscode-selfhosted.md) Last updated on **Jul 31, 2025** [Use the VSCode extension](https://docs.coderabbit.ai/guides/use-vscode) [Configure the VSCode extension](https://docs.coderabbit.ai/guides/config-vscode) Assistant Responses are generated using AI and may contain mistakes. --- # Setup best practices - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Best practices Setup best practices On this page * [Setup best practices​](https://docs.coderabbit.ai/guides/setup-best-practices#setup-best-practices%E2%80%8B) * [Give CodeRabbit its own user account​](https://docs.coderabbit.ai/guides/setup-best-practices#give-coderabbit-its-own-user-account%E2%80%8B) * [Let CodeRabbit read your issue tracker​](https://docs.coderabbit.ai/guides/setup-best-practices#let-coderabbit-read-your-issue-tracker%E2%80%8B) * [Set up basic reports for your team​](https://docs.coderabbit.ai/guides/setup-best-practices#set-up-basic-reports-for-your-team%E2%80%8B) * [Configuration best practices​](https://docs.coderabbit.ai/guides/setup-best-practices#configuration-best-practices%E2%80%8B) * [Fine-tune reviews using YAML files​](https://docs.coderabbit.ai/guides/setup-best-practices#fine-tune-reviews-using-yaml-files%E2%80%8B) * [Speed up reviews by adding path filters​](https://docs.coderabbit.ai/guides/setup-best-practices#speed-up-reviews-by-adding-path-filters%E2%80%8B) * [Trust the defaults​](https://docs.coderabbit.ai/guides/setup-best-practices#trust-the-defaults%E2%80%8B) * [Write specific CI/CD error messages​](https://docs.coderabbit.ai/guides/setup-best-practices#write-specific-ci%2Fcd-error-messages%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/setup-best-practices#what%E2%80%99s-next%E2%80%8B) [​](https://docs.coderabbit.ai/guides/setup-best-practices#setup-best-practices%E2%80%8B) Setup best practices[​](https://docs.coderabbit.ai/guides/setup-best-practices#setup "Direct link to Setup best practices") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This section lists our recommendations for setting up CodeRabbit with your Git platform, and integrating CodeRabbit with other tools and services. ### [​](https://docs.coderabbit.ai/guides/setup-best-practices#give-coderabbit-its-own-user-account%E2%80%8B) Give CodeRabbit its own user account[​](https://docs.coderabbit.ai/guides/setup-best-practices#user "Direct link to Give CodeRabbit its own user account") 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](https://docs.coderabbit.ai/platforms) . ### [​](https://docs.coderabbit.ai/guides/setup-best-practices#let-coderabbit-read-your-issue-tracker%E2%80%8B) Let CodeRabbit read your issue tracker[​](https://docs.coderabbit.ai/guides/setup-best-practices#issues "Direct link to Let CodeRabbit read your issue tracker") 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](https://docs.coderabbit.ai/integrations/issue-integrations) . ### [​](https://docs.coderabbit.ai/guides/setup-best-practices#set-up-basic-reports-for-your-team%E2%80%8B) Set up basic reports for your team[​](https://docs.coderabbit.ai/guides/setup-best-practices#reports "Direct link to Set up basic reports for your team") 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](https://docs.coderabbit.ai/guides/reports-overview) . [​](https://docs.coderabbit.ai/guides/setup-best-practices#configuration-best-practices%E2%80%8B) Configuration best practices[​](https://docs.coderabbit.ai/guides/setup-best-practices#configuration "Direct link to Configuration best practices") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This section lists our recommendations for configuring the way that CodeRabbit works with your individual repositories. ### [​](https://docs.coderabbit.ai/guides/setup-best-practices#fine-tune-reviews-using-yaml-files%E2%80%8B) Fine-tune reviews using YAML files[​](https://docs.coderabbit.ai/guides/setup-best-practices#yaml "Direct link to Fine-tune reviews using YAML files") 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](https://docs.coderabbit.ai/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](https://docs.coderabbit.ai/getting-started/configure-coderabbit) . ### [​](https://docs.coderabbit.ai/guides/setup-best-practices#speed-up-reviews-by-adding-path-filters%E2%80%8B) Speed up reviews by adding path filters[​](https://docs.coderabbit.ai/guides/setup-best-practices#filters "Direct link to Speed up reviews by adding path 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](https://docs.coderabbit.ai/getting-started/configure-coderabbit) . ### [​](https://docs.coderabbit.ai/guides/setup-best-practices#trust-the-defaults%E2%80%8B) Trust the defaults[​](https://docs.coderabbit.ai/guides/setup-best-practices#defaults "Direct link to Trust the 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](https://docs.coderabbit.ai/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](https://docs.coderabbit.ai/tools) that are available to it during code reviews. This helps CodeRabbit keep its reviews broad and flexible. * **Knowledge base**: CodeRabbit [knowledge base](https://docs.coderabbit.ai/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](https://docs.coderabbit.ai/getting-started/configure-coderabbit) . ### [​](https://docs.coderabbit.ai/guides/setup-best-practices#write-specific-ci%2Fcd-error-messages%E2%80%8B) Write specific CI/CD error messages[​](https://docs.coderabbit.ai/guides/setup-best-practices#pipeline "Direct link to Write specific CI/CD error messages") 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. * * * [​](https://docs.coderabbit.ai/guides/setup-best-practices#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/setup-best-practices#whats-next "Direct link to What's next") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Code review best practices](https://docs.coderabbit.ai/guides/code-review-best-practices) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/setup-best-practices.md) Last updated on **Jul 31, 2025** [Customize reports](https://docs.coderabbit.ai/guides/custom-reports) [Code review best practices](https://docs.coderabbit.ai/guides/code-review-best-practices) Assistant Responses are generated using AI and may contain mistakes. --- # Integrate issue tracking - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Create and resolve issues Integrate issue tracking On this page * [Jira​](https://docs.coderabbit.ai/integrations/issue-integrations#jira%E2%80%8B) * [CodeRabbit App​](https://docs.coderabbit.ai/integrations/issue-integrations#coderabbit-app%E2%80%8B) * [CodeRabbit Configuration​](https://docs.coderabbit.ai/integrations/issue-integrations#coderabbit-configuration%E2%80%8B) * [Example Usage​](https://docs.coderabbit.ai/integrations/issue-integrations#example-usage%E2%80%8B) * [Linear​](https://docs.coderabbit.ai/integrations/issue-integrations#linear%E2%80%8B) * [CodeRabbit App​](https://docs.coderabbit.ai/integrations/issue-integrations#coderabbit-app%E2%80%8B-2) * [CodeRabbit Configuration​](https://docs.coderabbit.ai/integrations/issue-integrations#coderabbit-configuration%E2%80%8B-2) * [Example Usage​](https://docs.coderabbit.ai/integrations/issue-integrations#example-usage%E2%80%8B-2) * [GitHub​](https://docs.coderabbit.ai/integrations/issue-integrations#github%E2%80%8B) * [Example Usage​](https://docs.coderabbit.ai/integrations/issue-integrations#example-usage%E2%80%8B-3) [​](https://docs.coderabbit.ai/integrations/issue-integrations#jira%E2%80%8B) Jira[​](https://docs.coderabbit.ai/integrations/issue-integrations#jira "Direct link to Jira") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. ### [​](https://docs.coderabbit.ai/integrations/issue-integrations#coderabbit-app%E2%80%8B) CodeRabbit App[​](https://docs.coderabbit.ai/integrations/issue-integrations#coderabbit-app "Direct link to CodeRabbit App") 1. Navigate to [integrations](https://app.coderabbit.ai/integrations) in the CodeRabbit app. 2. Toggle the Jira switch to enable the integration. Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira login page. Enter your Jira credentials to authenticate the integration. ### [​](https://docs.coderabbit.ai/integrations/issue-integrations#coderabbit-configuration%E2%80%8B) CodeRabbit Configuration[​](https://docs.coderabbit.ai/integrations/issue-integrations#coderabbit-configuration "Direct link to CodeRabbit Configuration") 1. Add Jira’s Project Keys to the `knowledge_base.jira.project_keys` field in your project’s CodeRabbit configuration file at `.coderabbit.yaml`. ### [​](https://docs.coderabbit.ai/integrations/issue-integrations#example-usage%E2%80%8B) Example Usage[​](https://docs.coderabbit.ai/integrations/issue-integrations#example-usage "Direct link to Example Usage") You can link an issue to your pull request, allowing CodeRabbit to assess whether your changes satisfy the issue’s requirements. To link a Jira Issue, you can add the Jira Issue into the PR description as shown below. Copy // (Jira Project Key - Issue Number)Closes CR-5 You can also create new Jira issues directly through CodeRabbit. See our [Issue Creation guide](https://docs.coderabbit.ai/guides/issue-creation#jira) for details. [​](https://docs.coderabbit.ai/integrations/issue-integrations#linear%E2%80%8B) Linear[​](https://docs.coderabbit.ai/integrations/issue-integrations#Linear "Direct link to Linear") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. With CodeRabbit, you can easily link your pull requests with Linear. It makes your life simpler by automatically creating Linear issues with all the code context, keeping your issues and pull requests in sync both ways. Plus, it lets you generate issues straight from pull requests, track how you’re hitting your goals, and even turn code review feedback into actionable tasks in Linear. ### [​](https://docs.coderabbit.ai/integrations/issue-integrations#coderabbit-app%E2%80%8B-2) CodeRabbit App[​](https://docs.coderabbit.ai/integrations/issue-integrations#coderabbit-app-1 "Direct link to CodeRabbit App") 1. Navigate to [integrations](https://app.coderabbit.ai/integrations) in the CodeRabbit app. 2. Toggle the Linear switch to enable the integration. Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear login page. Enter your Linear credentials to authenticate the integration. ### [​](https://docs.coderabbit.ai/integrations/issue-integrations#coderabbit-configuration%E2%80%8B-2) CodeRabbit Configuration[​](https://docs.coderabbit.ai/integrations/issue-integrations#coderabbit-configuration-1 "Direct link to CodeRabbit Configuration") 1. Add Linear’s Team Keys to the `knowledge_base.linear.team_keys` field in your project’s CodeRabbit configuration file at `.coderabbit.yaml`. ### [​](https://docs.coderabbit.ai/integrations/issue-integrations#example-usage%E2%80%8B-2) Example Usage[​](https://docs.coderabbit.ai/integrations/issue-integrations#example-usage-1 "Direct link to Example Usage") To link a Linear Issue, you can add the Linear Issue via the team key and issue number into the PR description as shown below. Copy // (Linear Team Key - Issue Number)Closes ENG-123 You can also create new Linear issues directly through CodeRabbit. Learn more in our [Issue Creation guide](https://docs.coderabbit.ai/guides/issue-creation#linear) . [​](https://docs.coderabbit.ai/integrations/issue-integrations#github%E2%80%8B) GitHub[​](https://docs.coderabbit.ai/integrations/issue-integrations#github "Direct link to GitHub") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. GitHub issue integration works automatically without any additional setup required. ### [​](https://docs.coderabbit.ai/integrations/issue-integrations#example-usage%E2%80%8B-3) Example Usage[​](https://docs.coderabbit.ai/integrations/issue-integrations#example-usage-2 "Direct link to Example Usage") To link a GitHub Issue, you can add the issue into the PR description as shown below. Copy // (# GitHub Issue Number)Closes #123 [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/integrations/issue-integrations.md) Last updated on **Jul 31, 2025** [Generate unit tests](https://docs.coderabbit.ai/finishing-touches/unit-test-generation) [Issue Chat](https://docs.coderabbit.ai/guides/issue-chat) Assistant Responses are generated using AI and may contain mistakes. --- # Schedule reports - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Generate reports Schedule reports On this page * [Setting Up a Recurring Report​](https://docs.coderabbit.ai/guides/scheduled-reports#setting-up-a-recurring-report%E2%80%8B) * [Schedule Configuration​](https://docs.coderabbit.ai/guides/scheduled-reports#schedule-configuration%E2%80%8B) * [Frequency Options​](https://docs.coderabbit.ai/guides/scheduled-reports#frequency-options%E2%80%8B) * [Time Settings​](https://docs.coderabbit.ai/guides/scheduled-reports#time-settings%E2%80%8B) * [Report Parameters​](https://docs.coderabbit.ai/guides/scheduled-reports#report-parameters%E2%80%8B) * [Report Content​](https://docs.coderabbit.ai/guides/scheduled-reports#report-content%E2%80%8B) * [Report Templates​](https://docs.coderabbit.ai/guides/scheduled-reports#report-templates%E2%80%8B) * [Communication Channels​](https://docs.coderabbit.ai/guides/scheduled-reports#communication-channels%E2%80%8B) * [Email​](https://docs.coderabbit.ai/guides/scheduled-reports#email%E2%80%8B) * [Slack/Discord​](https://docs.coderabbit.ai/guides/scheduled-reports#slack%2Fdiscord%E2%80%8B) * [Microsoft Teams​](https://docs.coderabbit.ai/guides/scheduled-reports#microsoft-teams%E2%80%8B) * [Managing Reports​](https://docs.coderabbit.ai/guides/scheduled-reports#managing-reports%E2%80%8B) * [Preview Reports​](https://docs.coderabbit.ai/guides/scheduled-reports#preview-reports%E2%80%8B) * [Grouping Options​](https://docs.coderabbit.ai/guides/scheduled-reports#grouping-options%E2%80%8B) * [Primary Grouping​](https://docs.coderabbit.ai/guides/scheduled-reports#primary-grouping%E2%80%8B) * [Subgrouping​](https://docs.coderabbit.ai/guides/scheduled-reports#subgrouping%E2%80%8B) * [Report Lifecycle Management​](https://docs.coderabbit.ai/guides/scheduled-reports#report-lifecycle-management%E2%80%8B) * [Editing Reports​](https://docs.coderabbit.ai/guides/scheduled-reports#editing-reports%E2%80%8B) * [Disabling Reports​](https://docs.coderabbit.ai/guides/scheduled-reports#disabling-reports%E2%80%8B) * [Deleting Reports​](https://docs.coderabbit.ai/guides/scheduled-reports#deleting-reports%E2%80%8B) * [Best Practices​](https://docs.coderabbit.ai/guides/scheduled-reports#best-practices%E2%80%8B) * [Related Resources​](https://docs.coderabbit.ai/guides/scheduled-reports#related-resources%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/scheduled-reports#what%E2%80%99s-next%E2%80%8B) This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. 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](https://docs.coderabbit.ai/guides/reports-overview) . [​](https://docs.coderabbit.ai/guides/scheduled-reports#setting-up-a-recurring-report%E2%80%8B) Setting Up a Recurring Report[​](https://docs.coderabbit.ai/guides/scheduled-reports#setting-up-a-recurring-report "Direct link to Setting Up a Recurring Report") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Navigate to **Recurring Reports** in the [CodeRabbit dashboard](https://app.coderabbit.ai/reports/recurring) 2. Click **Create Report** 3. Configure the following settings: ### [​](https://docs.coderabbit.ai/guides/scheduled-reports#schedule-configuration%E2%80%8B) Schedule Configuration[​](https://docs.coderabbit.ai/guides/scheduled-reports#schedule-configuration "Direct link to Schedule Configuration") ![Schedule Configuration](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/report-params-f367cab2fedf802ef4ad557bf4cc3da8.png) The schedule configuration allows you to set precise timing for your reports: #### [​](https://docs.coderabbit.ai/guides/scheduled-reports#frequency-options%E2%80%8B) Frequency Options[​](https://docs.coderabbit.ai/guides/scheduled-reports#frequency-options "Direct link to Frequency Options") * **Days of Week** * Select any combination of days (Sun-Sat) * Set frequency (every 1-3 weeks) * Ideal for weekly team syncs or sprint reviews * **Days of Month** * Select specific dates (1-31) * Special date handling: * 31st: Runs on the last day of every month * 30th: Skips February * 29th: Only runs in February during leap years #### [​](https://docs.coderabbit.ai/guides/scheduled-reports#time-settings%E2%80%8B) Time Settings[​](https://docs.coderabbit.ai/guides/scheduled-reports#time-settings "Direct link to Time Settings") * Set specific time for report generation * Choose from comprehensive timezone list (e.g., America/New\_York) * Reports run at the specified time in the selected timezone Choose a time that works for all team members, especially for distributed teams across different time zones. ### [​](https://docs.coderabbit.ai/guides/scheduled-reports#report-parameters%E2%80%8B) Report Parameters[​](https://docs.coderabbit.ai/guides/scheduled-reports#report-parameters "Direct link to Report Parameters") Reports can be filtered using multiple parameters, match pull requests using the **IN** option and exclude pull requests using the **NOT\_IN** option: * **Repositories**: Select specific repositories to monitor * **Labels**: Filter by GitHub labels with operators: * IN: Match any selected label * NOT\_IN: Exclude any pr with select label * ALL: Match all selected labels * **Users**: Filter by specific GitHub users * **Teams**: Filter by organization teams * Note: Team filtering is not available for GitLab repositories Each parameter can be: * Added or removed as needed * Combined with other parameters for precise filtering * Modified using different operators ### [​](https://docs.coderabbit.ai/guides/scheduled-reports#report-content%E2%80%8B) Report Content[​](https://docs.coderabbit.ai/guides/scheduled-reports#report-content "Direct link to Report Content") Reports include comprehensive PR information: * PR metadata: * Title and description * Creation and last activity dates * Status (merged, mergeable, draft) * State (open, closed, merged) * Collaboration details: * Labels and reviewers * Comments and discussions * Team associations * Repository context * Author information PRs are marked as stale after 168 hours (7 days) of inactivity. This helps identify potential workflow bottlenecks. ### [​](https://docs.coderabbit.ai/guides/scheduled-reports#report-templates%E2%80%8B) Report Templates[​](https://docs.coderabbit.ai/guides/scheduled-reports#report-templates "Direct link to Report Templates") CodeRabbit offers several built-in templates: 1. **Daily Standup Report**: A concise summary of pull requests and activities. 2. **Sprint Report**: A structured overview of sprint goals, completed tasks, in-progress work, and blockers. 3. **Release Notes**: A high-level changelog with summary and significant changes. 4. **[Custom Templates](https://docs.coderabbit.ai/guides/custom-reports) **: Create your own format using prompts. Allows for endless customization such as native language reporting (Japanese, Spanish, French, etc.), custom formatting, custom titles, and more. Example custom prompt: Copy Please provide a summary of:- All pull request activities- Related issues and comments- Code review discussions- Quality gate statusDo not include:- Bot conversations- Sequence diagrams ### [​](https://docs.coderabbit.ai/guides/scheduled-reports#communication-channels%E2%80%8B) Communication Channels[​](https://docs.coderabbit.ai/guides/scheduled-reports#communication-channels "Direct link to Communication Channels") Configure where your reports will be delivered: ![Report Delivery Platforms](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/report-platforms-a696bfc2f918addcfb1d762df8a8f491.png) #### [​](https://docs.coderabbit.ai/guides/scheduled-reports#email%E2%80%8B) Email[​](https://docs.coderabbit.ai/guides/scheduled-reports#email "Direct link to Email") * Enter individual email addresses * Use distribution lists for team-wide delivery #### [​](https://docs.coderabbit.ai/guides/scheduled-reports#slack%2Fdiscord%E2%80%8B) Slack/Discord[​](https://docs.coderabbit.ai/guides/scheduled-reports#slackdiscord "Direct link to Slack/Discord") 1. Connect your workspace through OAuth 2. Select target channels 3. CodeRabbit bot will be installed automatically 4. If installation fails check the [slack service](https://slack-status.com/) or [discord status](https://discordstatus.com/) page for any outages. #### [​](https://docs.coderabbit.ai/guides/scheduled-reports#microsoft-teams%E2%80%8B) Microsoft Teams[​](https://docs.coderabbit.ai/guides/scheduled-reports#microsoft-teams "Direct link to Microsoft Teams") 1. Create a webhook in your Teams channel 2. Add the webhook URL to CodeRabbit 3. Select target channels Create separate reports if you need to send to multiple channels with different formats. Learn more about [custom report formats](https://docs.coderabbit.ai/guides/custom-reports) . [​](https://docs.coderabbit.ai/guides/scheduled-reports#managing-reports%E2%80%8B) Managing Reports[​](https://docs.coderabbit.ai/guides/scheduled-reports#managing-reports "Direct link to Managing Reports") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ ### [​](https://docs.coderabbit.ai/guides/scheduled-reports#preview-reports%E2%80%8B) Preview Reports[​](https://docs.coderabbit.ai/guides/scheduled-reports#preview-reports "Direct link to Preview Reports") Test your configuration using the **Preview Report** button to generate a sample report instantly. ### [​](https://docs.coderabbit.ai/guides/scheduled-reports#grouping-options%E2%80%8B) Grouping Options[​](https://docs.coderabbit.ai/guides/scheduled-reports#grouping-options "Direct link to Grouping Options") Reports can be organized hierarchically using groups and subgroups: #### [​](https://docs.coderabbit.ai/guides/scheduled-reports#primary-grouping%E2%80%8B) Primary Grouping[​](https://docs.coderabbit.ai/guides/scheduled-reports#primary-grouping "Direct link to Primary Grouping") Select from these options to organize your main report structure: * **None**: No grouping, flat list of items * **Repository**: Group by source repository * **Label**: Group by PR labels * **Team**: Group by team ownership * **User**: Group by PR author #### [​](https://docs.coderabbit.ai/guides/scheduled-reports#subgrouping%E2%80%8B) Subgrouping[​](https://docs.coderabbit.ai/guides/scheduled-reports#subgrouping "Direct link to Subgrouping") After selecting a primary group, you can add a secondary level of organization: * Choose any remaining grouping option for further categorization * Subgroups create a nested hierarchy within primary groups * Select “None” to use only primary grouping Choose grouping options that match your team’s workflow. For example: * Use Repository → Team for large multi-team organizations * Use User → Label to track individual contributions by type * Use Team → Repository to monitor team activity across repos ### [​](https://docs.coderabbit.ai/guides/scheduled-reports#report-lifecycle-management%E2%80%8B) Report Lifecycle Management[​](https://docs.coderabbit.ai/guides/scheduled-reports#report-lifecycle-management "Direct link to Report Lifecycle Management") Control your reports through their entire lifecycle: #### [​](https://docs.coderabbit.ai/guides/scheduled-reports#editing-reports%E2%80%8B) Editing Reports[​](https://docs.coderabbit.ai/guides/scheduled-reports#editing-reports "Direct link to Editing Reports") * Make your desired changes to any configuration settings * Click the **Save** button to apply your changes * Changes take effect from the next scheduled run Remember to click **Save** when you’re done making changes. Your modifications will be discarded if you navigate away without saving. #### [​](https://docs.coderabbit.ai/guides/scheduled-reports#disabling-reports%E2%80%8B) Disabling Reports[​](https://docs.coderabbit.ai/guides/scheduled-reports#disabling-reports "Direct link to Disabling Reports") * Toggle the **Active** switch to temporarily pause a report * Disabled reports: * Maintain their configuration * Skip scheduled runs * Can be re-enabled at any time * Show “Disabled” status in the dashboard #### [​](https://docs.coderabbit.ai/guides/scheduled-reports#deleting-reports%E2%80%8B) Deleting Reports[​](https://docs.coderabbit.ai/guides/scheduled-reports#deleting-reports "Direct link to Deleting Reports") * Click the **Delete** button (trash icon) next to the report * Confirm deletion in the modal * Note: This action is permanent and cannot be undone * All report history and configuration will be removed Deleting a report will immediately stop all scheduled runs and remove access to historical reports. Consider disabling instead of deleting if you might need the report again. [​](https://docs.coderabbit.ai/guides/scheduled-reports#best-practices%E2%80%8B) Best Practices[​](https://docs.coderabbit.ai/guides/scheduled-reports#best-practices "Direct link to Best Practices") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. **Scheduling** * Align report timing with your team’s workflow * Consider timezone differences for distributed teams 2. **Content** * Keep prompts focused on actionable information * Use grouping to improve readability * Exclude unnecessary details that may create noise 3. **Distribution** * Use channels your team actively monitors * Consider creating separate reports for different audiences (e.g., management vs. development team) [​](https://docs.coderabbit.ai/guides/scheduled-reports#related-resources%E2%80%8B) Related Resources[​](https://docs.coderabbit.ai/guides/scheduled-reports#related-resources "Direct link to Related Resources") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Custom Reports](https://docs.coderabbit.ai/guides/custom-reports) * [On-demand Reports](https://docs.coderabbit.ai/guides/ondemand-reports) * [API Documentation](https://api.coderabbit.ai/api/swagger/) [​](https://docs.coderabbit.ai/guides/scheduled-reports#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/scheduled-reports#whats-next "Direct link to What's next") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Customize reports](https://docs.coderabbit.ai/guides/custom-reports) * [Generate reports on demand](https://docs.coderabbit.ai/guides/ondemand-reports) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/scheduled-reports.md) Last updated on **Jul 31, 2025** [Overview](https://docs.coderabbit.ai/guides/reports-overview) [Generate reports on demand](https://docs.coderabbit.ai/guides/ondemand-reports) Assistant Responses are generated using AI and may contain mistakes. --- # Initial configuration guide - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Configure Initial configuration guide On this page * [How to use this guide​](https://docs.coderabbit.ai/guides/initial-configuration#how-to-use-this-guide%E2%80%8B) * [Data retention and knowledge base settings​](https://docs.coderabbit.ai/guides/initial-configuration#data-retention-and-knowledge-base-settings%E2%80%8B) * [Enable or disable data retention globally​](https://docs.coderabbit.ai/guides/initial-configuration#enable-or-disable-data-retention-globally%E2%80%8B) * [Configure cache use​](https://docs.coderabbit.ai/guides/initial-configuration#configure-cache-use%E2%80%8B) * [Configure knowledge base retention​](https://docs.coderabbit.ai/guides/initial-configuration#configure-knowledge-base-retention%E2%80%8B) * [Configure learnings​](https://docs.coderabbit.ai/guides/initial-configuration#configure-learnings%E2%80%8B) * [Tune the length of code reviews​](https://docs.coderabbit.ai/guides/initial-configuration#tune-the-length-of-code-reviews%E2%80%8B) * [Adjust path-specific CodeRabbit behavior​](https://docs.coderabbit.ai/guides/initial-configuration#adjust-path-specific-coderabbit-behavior%E2%80%8B) * [Add path filters​](https://docs.coderabbit.ai/guides/initial-configuration#add-path-filters%E2%80%8B) * [Add general path instructions​](https://docs.coderabbit.ai/guides/initial-configuration#add-general-path-instructions%E2%80%8B) * [Add documentation or unit-test path instructions​](https://docs.coderabbit.ai/guides/initial-configuration#add-documentation-or-unit-test-path-instructions%E2%80%8B) * [Set Automatic review behavior​](https://docs.coderabbit.ai/guides/initial-configuration#set-automatic-review-behavior%E2%80%8B) * [Configure incremental reviews​](https://docs.coderabbit.ai/guides/initial-configuration#configure-incremental-reviews%E2%80%8B) * [Restrict automatic reviews to certain labels​](https://docs.coderabbit.ai/guides/initial-configuration#restrict-automatic-reviews-to-certain-labels%E2%80%8B) * [Automatically review more branches​](https://docs.coderabbit.ai/guides/initial-configuration#automatically-review-more-branches%E2%80%8B) * [Configure tools​](https://docs.coderabbit.ai/guides/initial-configuration#configure-tools%E2%80%8B) * [Other code review settings​](https://docs.coderabbit.ai/guides/initial-configuration#other-code-review-settings%E2%80%8B) * [Adjust code-review strictness​](https://docs.coderabbit.ai/guides/initial-configuration#adjust-code-review-strictness%E2%80%8B) * [Configure pull request approval​](https://docs.coderabbit.ai/guides/initial-configuration#configure-pull-request-approval%E2%80%8B) * [Configure chat-based issue creation​](https://docs.coderabbit.ai/guides/initial-configuration#configure-chat-based-issue-creation%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/guides/initial-configuration#what%E2%80%99s-next%E2%80%8B) For a general overview of how configuration in CodeRabbit works, see [Configure CodeRabbit](https://docs.coderabbit.ai/guides/configuration-overview) . For an exhaustive reference of all configuration options, see [Configuration reference](https://docs.coderabbit.ai/reference/configuration) . [​](https://docs.coderabbit.ai/guides/initial-configuration#how-to-use-this-guide%E2%80%8B) How to use this guide[​](https://docs.coderabbit.ai/guides/initial-configuration#use "Direct link to How to use this guide") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This guide walks you through several CodeRabbit configuration options that you can set in order to tune CodeRabbit code review behavior for your repositories. The default behavior and settings of CodeRabbit works for most repositories, in most situations. However, becoming familiar with the key settings described by this page can help you tune the behavior of CodeRabbit for the specific needs of your team. You can use this guide when initially setting up your organization and repositories with CodeRabbit, or you can return to it after using CodeRabbit for a while, when you feel ready to customize its behavior. Each section in the guide links to specific entries in the configuration reference. Each entry in the linked reference specifies the location of its configuration setting, in either the CodeRabbit web UI or your `.coderabbit.yaml` file. [​](https://docs.coderabbit.ai/guides/initial-configuration#data-retention-and-knowledge-base-settings%E2%80%8B) Data retention and knowledge base settings[​](https://docs.coderabbit.ai/guides/initial-configuration#data-retention "Direct link to Data retention and knowledge base settings") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ These settings help you control how much data about your code that CodeRabbit retains. CodeRabbit temporarily stores information about your repositories in order to tailored reviews more quickly and better tailored to your team’s needs. You can opt of these features if your organization has stricter data-retention policies. For more information about CodeRabbit data-retention policies, see [Data privacy and security](https://docs.coderabbit.ai/#data-privacy-and-security) . ### [​](https://docs.coderabbit.ai/guides/initial-configuration#enable-or-disable-data-retention-globally%E2%80%8B) Enable or disable data retention globally[​](https://docs.coderabbit.ai/guides/initial-configuration#data-retention-setting "Direct link to Enable or disable data retention globally") This setting is available only at the organization level, and not per-repository. Your CodeRabbit organization has a data-retention setting which acts as a master-switch to all CodeRabbit features that require it to store its own data about your repositories. If you disable data retention, then none of your repositories can use knowledge base or caching features, even if you configure those repositories to enable them. We recommend leaving this on. However, if your use of CodeRabbit requires strict data retention policy, then you can turn this off. For more information, see [Data retention](https://docs.coderabbit.ai/reference/configuration#data-retention) in the configuration reference. ### [​](https://docs.coderabbit.ai/guides/initial-configuration#configure-cache-use%E2%80%8B) Configure cache use[​](https://docs.coderabbit.ai/guides/initial-configuration#cache "Direct link to Configure cache use") By default, CodeRabbit keeps a temporary cache of data about your repository in order to make subsequent code reviews faster. If this conflicts with your organization’s data-retention policies, then you can disable this feature. For more information, see [Disable cache](https://docs.coderabbit.ai/reference/configuration#disable-cache) in the configuration reference. ### [​](https://docs.coderabbit.ai/guides/initial-configuration#configure-knowledge-base-retention%E2%80%8B) Configure knowledge base retention[​](https://docs.coderabbit.ai/guides/initial-configuration#opt-out "Direct link to Configure knowledge base retention") By default, CodeRabbit keeps its own [_knowledge base_](https://docs.coderabbit.ai/integrations/knowledge-base) : a store of metadata about your repositories, your team’s history of pull requests, linked issues, and learnings about how CodeRabbit should tailor its own review behavior to best serve your team. If this long-term knowledge base storage conflicts with your organization’s data-retention policies, then you can disable this feature. For more information, see [Opt out](https://docs.coderabbit.ai/reference/configuration#opt-out) in the configuration reference. ### [​](https://docs.coderabbit.ai/guides/initial-configuration#configure-learnings%E2%80%8B) Configure learnings[​](https://docs.coderabbit.ai/guides/initial-configuration#learnings "Direct link to Configure learnings") CodeRabbit learns your team’s review preferences by letting you [teach it your preferences in plain language during code reviews](https://docs.coderabbit.ai/guides/learnings) . CodeRabbit remembers these preferences, and applies them to subsequent code reviews in the same repository. This setting lets you set the scope of which stored learnings that CodeRabbit should apply to its code reviews. For more information, see [Learnings](https://docs.coderabbit.ai/reference/configuration#learnings) in the configuration reference. [​](https://docs.coderabbit.ai/guides/initial-configuration#tune-the-length-of-code-reviews%E2%80%8B) Tune the length of code reviews[​](https://docs.coderabbit.ai/guides/initial-configuration#content "Direct link to Tune the length of code reviews") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- By default, CodeRabbit writes thorough code reviews with several sub-sections. If you’d rather have CodeRabbit generated shorter reviews then you can change some of the following settings: * [Collapse walkthrough](https://docs.coderabbit.ai/reference/configuration#collapse-walkthrough) : wraps the detailed summary of proposed changes in collapsed-but-expandable container. (Off by default.) * [Changed files summary](https://docs.coderabbit.ai/reference/configuration#changed-files-summary) : lists of files affected by this pull request. * [Sequence diagrams](https://docs.coderabbit.ai/reference/configuration#sequence-diagrams) : includes a visual diagram of object interactions. * [Assess linked issues](https://docs.coderabbit.ai/reference/configuration#assess-linked-issues) : assesses how well the pull request addresses any linked issues. * [Related issues](https://docs.coderabbit.ai/reference/configuration#related-issues) : lists issues found in your issue tracker that might be related to this pull request. * [Related pull requests](https://docs.coderabbit.ai/reference/configuration#realted-prs) : lists pull requests that might be related to this pull request. * [Suggested labels](https://docs.coderabbit.ai/reference/configuration#suggested-labels) : Suggests labels for this pull request. * [Suggested reviewers](https://docs.coderabbit.ai/reference/configuration#suggested-reviewers) : automatically suggest reviewers for PR * [Poem](https://docs.coderabbit.ai/reference/configuration#poem) : generates a short poem about this pull request. [​](https://docs.coderabbit.ai/guides/initial-configuration#adjust-path-specific-coderabbit-behavior%E2%80%8B) Adjust path-specific CodeRabbit behavior[​](https://docs.coderabbit.ai/guides/initial-configuration#path "Direct link to Adjust path-specific CodeRabbit behavior") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You can give CodeRabbit additional instructions for reviewing specific files or locations in your repository, or configure CodeRabbit to disregard certain file paths during code reviews. For an overview about using path-based instructions in CodeRabbit, see [Path-based instructions](https://docs.coderabbit.ai/guides/review-instructions#path-based) . ### [​](https://docs.coderabbit.ai/guides/initial-configuration#add-path-filters%E2%80%8B) Add path filters[​](https://docs.coderabbit.ai/guides/initial-configuration#filters "Direct link to Add path filters") If your repository contains files or locations that CodeRabbit should disregard when preparing code reviews—or you want CodeRabbit to limit its consideration to only certain files—then you can define one or more _path filters_. Adding path filters to a large repository containing a lot of data, generated files, or other non-code content can let CodeRabbit work faster. For example, the following `.coderabbit.yaml` excerpt instructs CodeRabbit to take review context only the contents of directories named `src/` in your repository, while disregarding any individual files with `.bin` or `.csv` extensions. Copy path_filters: - "!**/*.bin" - "!**/*.csv" - "**/src/**" For more information, see [Path filters](https://docs.coderabbit.ai/reference/configuration#path-filters) in the CodeRabbit configuration reference. ### [​](https://docs.coderabbit.ai/guides/initial-configuration#add-general-path-instructions%E2%80%8B) Add general path instructions[​](https://docs.coderabbit.ai/guides/initial-configuration#review-path "Direct link to Add general path instructions") You can set _path instructions_ that provide CodeRabbit with additional review instructions for various files or locations in your repository. Each path instruction specifies a path specification and a set of instructions, the latter of which you express using natural language. For example, to give CodeRabbit review instructions specific to JavaScript and TypeScript files, you can add a section like this to your repository’s `.coderabbit.yaml` file: Copy 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, and sensitive data exposure." For more information, see [Path instructions](https://docs.coderabbit.ai/reference/configuration#path-instructions) in the configuration reference. ### [​](https://docs.coderabbit.ai/guides/initial-configuration#add-documentation-or-unit-test-path-instructions%E2%80%8B) Add documentation or unit-test path instructions[​](https://docs.coderabbit.ai/guides/initial-configuration#doc-path "Direct link to Add documentation or unit-test path instructions") Similar to the general path instructions described by the previous section, you can define path-based instructions that direct CodeRabbit to generate inline documentation or unit tests, with specific instructions associated with different locations or filenames. For more information, see [Docstrings](https://docs.coderabbit.ai/reference/configuration#docstrings) and [Unit tests](https://docs.coderabbit.ai/reference/configuration#unit-tests) in the configuration reference. [​](https://docs.coderabbit.ai/guides/initial-configuration#set-automatic-review-behavior%E2%80%8B) Set Automatic review behavior[​](https://docs.coderabbit.ai/guides/initial-configuration#auto "Direct link to Set Automatic review behavior") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- By default, CodeRabbit automatically generates incremental code reviews for every new or updated pull request made against a repository’s default branch. These settings listed in this section let you tune the behavior. ### [​](https://docs.coderabbit.ai/guides/initial-configuration#configure-incremental-reviews%E2%80%8B) Configure incremental reviews[​](https://docs.coderabbit.ai/guides/initial-configuration#incremental "Direct link to Configure incremental reviews") By default, CodeRabbit generates a new automated review comment every time the branch of an existing pull request gets an additional commit pushed to it. If you want to limit CodeRabbit to posting only an initial automated review for a new pull request, with no automated response to further updates, then you can turn off this incremental-review behavior. If you do turn it off, then you can still [manually request reviews](https://docs.coderabbit.ai/guides/commands#request) . For more information, see [Automatic incremental review](https://docs.coderabbit.ai/reference/configuration#automatic-incremental-review) in the configuration reference. ### [​](https://docs.coderabbit.ai/guides/initial-configuration#restrict-automatic-reviews-to-certain-labels%E2%80%8B) Restrict automatic reviews to certain labels[​](https://docs.coderabbit.ai/guides/initial-configuration#labels "Direct link to Restrict automatic reviews to certain labels") If you want to be choosier about which pull requests CodeRabbit should automatically review, then you can restrict it to review only pull requests that you mark with certain labels. For more information, see [Labels](https://docs.coderabbit.ai/reference/configuration#labels) in the configuration reference. ### [​](https://docs.coderabbit.ai/guides/initial-configuration#automatically-review-more-branches%E2%80%8B) Automatically review more branches[​](https://docs.coderabbit.ai/guides/initial-configuration#branches "Direct link to Automatically review more branches") If you want CodeRabbit to extend its automatic-review attention beyond the default branch of your repository—that is, `main` or `master`, usually—then you can give CodeRabbit a list of other branches that it is allowed to review. For more information, see [Base branches](https://docs.coderabbit.ai/reference/configuration#base-branches) in the configuration reference. [​](https://docs.coderabbit.ai/guides/initial-configuration#configure-tools%E2%80%8B) Configure tools[​](https://docs.coderabbit.ai/guides/initial-configuration#tools "Direct link to Configure tools") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ CodeRabbit has access to dozens of industry-standard open-source tools to help it perform its code reviews. These tools include a variety of linters, security analyzers, and other utilities. For a full list, see [List of supported tools](https://docs.coderabbit.ai/tools/list) . CodeRabbit chooses which tools to apply to a given code review on a case-by-case basis. By default, CodeRabbit considers every tool available to it during code reviews. If you want CodeRabbit to disregard certain tools, then you can disable them. Several tools that CodeRabbit uses also allow you to specify a path to a tool-specific configuration file in your repository. For example, the following `.coderabbit.yaml` excerpt directs CodeRabbit to use configuration files in the repository’s `/pmd-config` directory when using the `pmd` tool: Copy reviews: tools: pmd: enabled: true config_file: /pmd-config/*.yml For more information, see [Tools](https://docs.coderabbit.ai/reference/configuration#tools) in the configuration reference. [​](https://docs.coderabbit.ai/guides/initial-configuration#other-code-review-settings%E2%80%8B) Other code review settings[​](https://docs.coderabbit.ai/guides/initial-configuration#other "Direct link to Other code review settings") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/guides/initial-configuration#adjust-code-review-strictness%E2%80%8B) Adjust code-review strictness[​](https://docs.coderabbit.ai/guides/initial-configuration#profile "Direct link to Adjust code-review strictness") If you want CodeRabbit to apply a much stricter and more nitpicky stance to its code reviews, then you can switch its _profile_ setting from `chill` to `assertive`. CodeRabbit is aware of nitpickier output from the linters and other tools that it applies to code reviews, but includes less of it in its own review comments when the profile is set to `chill`. To have CodeRabbit include more nitpicky tool output in reviews, use the `assertive` profile. For more information, see [Profile](https://docs.coderabbit.ai/reference/configuration#profile) in the configuration reference. ### [​](https://docs.coderabbit.ai/guides/initial-configuration#configure-pull-request-approval%E2%80%8B) Configure pull request approval[​](https://docs.coderabbit.ai/guides/initial-configuration#request-changes "Direct link to Configure pull request approval") By default, CodeRabbit doesn’t mark pull requests as approved after any code review, even if CodeRabbit doesn’t have any further significant changes to suggest. This leaves the job of formal pull request approval entirely up to human reviewers. If you want to allow CodeRabbit to mark pull requests as approved, then you can enable the _request changes workflow_ setting. If you do, then CodeRabbit can approve pull requests after it reviewed a pull request and had all of its comments resolved. This can be useful if you have a workflow that requires several reviewers to approve a pull request before anyone can merge it. For example, if you have configured your repository on your Git platform to require two approvals for any pull request, then activating this CodeRabbit setting lets you merge a pull request after approval from CodeRabbit plus one human reviewer. This can help reduce your team’s code-review load. We recommend a policy of always requiring the approval of at least one human reviewer, even if you allow CodeRabbit to approve pull requests. As with an generative AI technology, CodeRabbit works best as a helpful partner to your team, and not as a replacement for human expertise or judgment. For more information, see [Request Changes Workflow](https://docs.coderabbit.ai/reference/configuration#request-changes-workflow) in the configuration reference. ### [​](https://docs.coderabbit.ai/guides/initial-configuration#configure-chat-based-issue-creation%E2%80%8B) Configure chat-based issue creation[​](https://docs.coderabbit.ai/guides/initial-configuration#chat-issues "Direct link to Configure chat-based issue creation") You can [ask CodeRabbit to create issues for you](https://docs.coderabbit.ai/guides/issue-creation) in the comments of a pull request that it’s reviewing. If you have integrated CodeRabbit with Jira or Linear, then you can tune this behavior a little more, restricting this feature to private repositories—the default setting—or disabling it entirely. For more information, see [Integrations](https://docs.coderabbit.ai/reference/configuration#integrations) in the configuration reference. [​](https://docs.coderabbit.ai/guides/initial-configuration#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/guides/initial-configuration#whats-next "Direct link to What's next") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Setup and configuration best practices](https://docs.coderabbit.ai/guides/setup-best-practices) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/initial-configuration.md) Last updated on **Jul 31, 2025** [Add a configuration file](https://docs.coderabbit.ai/getting-started/configure-coderabbit) [Knowledge base](https://docs.coderabbit.ai/integrations/knowledge-base) Assistant Responses are generated using AI and may contain mistakes. --- # Caching - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Reference Caching On this page * [Security and Privacy​](https://docs.coderabbit.ai/reference/caching#security-and-privacy%E2%80%8B) * [Configuration​](https://docs.coderabbit.ai/reference/caching#configuration%E2%80%8B) [​](https://docs.coderabbit.ai/reference/caching#security-and-privacy%E2%80%8B) Security and Privacy[​](https://docs.coderabbit.ai/reference/caching#security-and-privacy "Direct link to 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 [​](https://docs.coderabbit.ai/reference/caching#configuration%E2%80%8B) Configuration[​](https://docs.coderabbit.ai/reference/caching#configuration "Direct link to 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. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/reference/caching.md) Last updated on **Jul 31, 2025** [SwiftLint](https://docs.coderabbit.ai/tools/swiftlint) [Get support](https://docs.coderabbit.ai/getting-started/support) Assistant Responses are generated using AI and may contain mistakes. --- # Code review best practices - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Best practices Code review best practices On this page * [Recommended code-review workflow​](https://docs.coderabbit.ai/guides/code-review-best-practices#recommended-code-review-workflow%E2%80%8B) * [Managing large changes​](https://docs.coderabbit.ai/guides/code-review-best-practices#managing-large-changes%E2%80%8B) * [Documentation flow​](https://docs.coderabbit.ai/guides/code-review-best-practices#documentation-flow%E2%80%8B) * [Overall tips​](https://docs.coderabbit.ai/guides/code-review-best-practices#overall-tips%E2%80%8B) * [Command response time​](https://docs.coderabbit.ai/guides/code-review-best-practices#command-response-time%E2%80%8B) For more information about working with CodeRabbit through chat, see [Control and manage code reviews](https://docs.coderabbit.ai/guides/commands) . For a CodeRabbit command reference, see [Code review command reference](https://docs.coderabbit.ai/reference/review-commands) . [​](https://docs.coderabbit.ai/guides/code-review-best-practices#recommended-code-review-workflow%E2%80%8B) Recommended code-review workflow[​](https://docs.coderabbit.ai/guides/code-review-best-practices#recommended-code-review-workflow "Direct link to Recommended code-review workflow") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * Start with `@coderabbitai review` for checking new changes. * Use `@coderabbitai full review` when major changes require a fresh perspective. * Generate summaries after significant updates using `@coderabbitai summary`. [​](https://docs.coderabbit.ai/guides/code-review-best-practices#managing-large-changes%E2%80%8B) Managing large changes[​](https://docs.coderabbit.ai/guides/code-review-best-practices#managing-large-changes "Direct link to Managing large changes") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ * Use `@coderabbitai pause` before making multiple commits. * Resume reviews with `@coderabbitai resume` when ready. * Consider `@coderabbitai full review` after substantial changes. [​](https://docs.coderabbit.ai/guides/code-review-best-practices#documentation-flow%E2%80%8B) Documentation flow[​](https://docs.coderabbit.ai/guides/code-review-best-practices#documentation-flow "Direct link to Documentation flow") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * Run `@coderabbitai generate docstrings` after finalizing function implementations. * Learn more about [docstring generation](https://docs.coderabbit.ai/finishing-touches/docstrings) . [​](https://docs.coderabbit.ai/guides/code-review-best-practices#overall-tips%E2%80%8B) Overall tips[​](https://docs.coderabbit.ai/guides/code-review-best-practices#overall-tips "Direct link to Overall tips") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * Commands are case-insensitive (`@coderabbitai REVIEW` works the same as `@coderabbitai review`). * Commands can be issued by anyone with write access to the repository. * Multiple commands can be used in sequence as needed. * Use `@coderabbitai configuration` to export your settings before making changes. [​](https://docs.coderabbit.ai/guides/code-review-best-practices#command-response-time%E2%80%8B) Command response time[​](https://docs.coderabbit.ai/guides/code-review-best-practices#command-response-time "Direct link to Command response time") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * Most commands (pause, resume, ignore) take effect immediately. * Review commands typically complete within a few minutes, depending on PR size. * Docstring generation time varies based on the number of functions. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/code-review-best-practices.md) Last updated on **Jul 31, 2025** [Setup best practices](https://docs.coderabbit.ai/guides/setup-best-practices) [CodeRabbit API](https://docs.coderabbit.ai/external-link-0) Assistant Responses are generated using AI and may contain mistakes. --- # Code Graph Analysis - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Analyze & improve your code Code Graph Analysis On this page * [What is Code Graph Analysis?​](https://docs.coderabbit.ai/integrations/code-graph-analysis#what-is-code-graph-analysis%3F%E2%80%8B) * [How Code Graph Analysis Enhances Your Reviews​](https://docs.coderabbit.ai/integrations/code-graph-analysis#how-code-graph-analysis-enhances-your-reviews%E2%80%8B) * [Key Features​](https://docs.coderabbit.ai/integrations/code-graph-analysis#key-features%E2%80%8B) * [Three Types of Contextual Information​](https://docs.coderabbit.ai/integrations/code-graph-analysis#three-types-of-contextual-information%E2%80%8B) * [Language Support​](https://docs.coderabbit.ai/integrations/code-graph-analysis#language-support%E2%80%8B) * [Availability​](https://docs.coderabbit.ai/integrations/code-graph-analysis#availability%E2%80%8B) [​](https://docs.coderabbit.ai/integrations/code-graph-analysis#what-is-code-graph-analysis%3F%E2%80%8B) What is Code Graph Analysis?[​](https://docs.coderabbit.ai/integrations/code-graph-analysis#what-is-code-graph-analysis "Direct link to What is Code Graph Analysis?") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Code Graph Analysis is an intelligent code analysis feature that enhances your code reviews by automatically mapping relationships between files in your codebase. By understanding how your code connects and interacts, Code Graph provides concrete snippets of context that makes reviews more effective and insightful. [​](https://docs.coderabbit.ai/integrations/code-graph-analysis#how-code-graph-analysis-enhances-your-reviews%E2%80%8B) How Code Graph Analysis Enhances Your Reviews[​](https://docs.coderabbit.ai/integrations/code-graph-analysis#how-code-graph-analysis-enhances-your-reviews "Direct link to How Code Graph Analysis Enhances Your Reviews") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ When reviewing code with CodeRabbit, Code Graph Analysis automatically: * **Maps symbol definitions and references** across your entire codebase * **Analyzes commit history** to identify files that frequently change together * **Builds relationship graphs** showing how different parts of your code connect * **Enriches reviews with contextual information** about related code Code Graph Analysis is also available in the CodeRabbit Chat. CodeRabbit Chat will automatically analyze your codebase with it when the agent deems it necessary. [​](https://docs.coderabbit.ai/integrations/code-graph-analysis#key-features%E2%80%8B) Key Features[​](https://docs.coderabbit.ai/integrations/code-graph-analysis#key-features "Direct link to Key Features") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ ### [​](https://docs.coderabbit.ai/integrations/code-graph-analysis#three-types-of-contextual-information%E2%80%8B) Three Types of Contextual Information[​](https://docs.coderabbit.ai/integrations/code-graph-analysis#three-types-of-contextual-information "Direct link to Three Types of Contextual Information") Code Graph Analysis adds three powerful layers of context to your reviews: 1. **Definition Files**: Files containing definitions that are referenced in the current code 2. **Reference Files**: Files that reference symbols defined in the current code 3. **Related Files**: Files that appear related based on usage patterns and commit history ### [​](https://docs.coderabbit.ai/integrations/code-graph-analysis#language-support%E2%80%8B) Language Support[​](https://docs.coderabbit.ai/integrations/code-graph-analysis#language-support "Direct link to Language Support") Code Graph Analysis works with: * Bash * C * C# * C++ * CSS * Elixir * Go * Java * JavaScript * Kotlin * Lua * PHP * Python * Ruby * Rust * Scala * Swift * TSX * TypeScript [​](https://docs.coderabbit.ai/integrations/code-graph-analysis#availability%E2%80%8B) Availability[​](https://docs.coderabbit.ai/integrations/code-graph-analysis#availability "Direct link to Availability") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Code Graph Analysis is available on the Lite tier and above. * * * Learn more about CodeRabbit’s advanced features at [coderabbit.ai](https://coderabbit.ai/) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/integrations/code-graph-analysis.md) Last updated on **Jul 31, 2025** [CodeRabbit Chat](https://docs.coderabbit.ai/guides/agent_chat) [Generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) Assistant Responses are generated using AI and may contain mistakes. --- # Linear Issue Creation - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Linear Issue Creation On this page * [Linear Issue Creation](https://docs.coderabbit.ai/changelog/linear-issue-creation#linear-issue-creation) ### [​](https://docs.coderabbit.ai/changelog/linear-issue-creation#linear-issue-creation) Linear Issue Creation We have added the ability to create issues directly from AI Code Review Comments allowing developers to convert code review feedback into actionable Linear issues. Assistant Responses are generated using AI and may contain mistakes. --- # SOC 2 Type II Compliance - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation SOC 2 Type II Compliance On this page * [SOC 2 Type II Compliance](https://docs.coderabbit.ai/changelog/soc-2-type-ii-compliance#soc-2-type-ii-compliance) ### [​](https://docs.coderabbit.ai/changelog/soc-2-type-ii-compliance#soc-2-type-ii-compliance) SOC 2 Type II Compliance CodeRabbit is now SOC 2 Type II compliant to ensure top-tier security, availability, integrity, and privacy for our users. Assistant Responses are generated using AI and may contain mistakes. --- # Code review commands - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Reference Code review commands On this page * [Code review flow control​](https://docs.coderabbit.ai/reference/review-commands#code-review-flow-control%E2%80%8B) * [Comment management​](https://docs.coderabbit.ai/reference/review-commands#comment-management%E2%80%8B) * [Documentation commands​](https://docs.coderabbit.ai/reference/review-commands#documentation-commands%E2%80%8B) * [Agentic chat commands​](https://docs.coderabbit.ai/reference/review-commands#agentic-chat-commands%E2%80%8B) * [Help and support​](https://docs.coderabbit.ai/reference/review-commands#help-and-support%E2%80%8B) | 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 | [​](https://docs.coderabbit.ai/reference/review-commands#code-review-flow-control%E2%80%8B) Code review flow control[​](https://docs.coderabbit.ai/reference/review-commands#code-review-flow-control "Direct link to 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 | [​](https://docs.coderabbit.ai/reference/review-commands#comment-management%E2%80%8B) Comment management[​](https://docs.coderabbit.ai/reference/review-commands#comment-management "Direct link to Comment management") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | Command | Description | Use Case | | --- | --- | --- | | `@coderabbitai resolve` | Resolves all CodeRabbit review comments | When you’ve addressed all feedback and want to clean up | [​](https://docs.coderabbit.ai/reference/review-commands#documentation-commands%E2%80%8B) Documentation commands[​](https://docs.coderabbit.ai/reference/review-commands#documentation-commands "Direct link to 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 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 | [​](https://docs.coderabbit.ai/reference/review-commands#agentic-chat-commands%E2%80%8B) Agentic chat commands[​](https://docs.coderabbit.ai/reference/review-commands#agentic-chat-commands "Direct link to 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 | [​](https://docs.coderabbit.ai/reference/review-commands#help-and-support%E2%80%8B) Help and support[​](https://docs.coderabbit.ai/reference/review-commands#help-and-support "Direct link to Help and support") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | Command | Description | Use Case | | --- | --- | --- | | `@coderabbitai help` | Displays available commands and usage info | When you need guidance on using CodeRabbit | [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/reference/review-commands.md) Last updated on **Jul 31, 2025** [CodeRabbit API](https://docs.coderabbit.ai/external-link-0) [Configuration reference](https://docs.coderabbit.ai/reference/configuration) Assistant Responses are generated using AI and may contain mistakes. --- # Customize reports - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Generate reports Customize reports On this page * [Understanding Custom Reports​](https://docs.coderabbit.ai/guides/custom-reports#understanding-custom-reports%E2%80%8B) * [Creating Custom Report Templates​](https://docs.coderabbit.ai/guides/custom-reports#creating-custom-report-templates%E2%80%8B) * [Basic Structure​](https://docs.coderabbit.ai/guides/custom-reports#basic-structure%E2%80%8B) * [Example for different languages​](https://docs.coderabbit.ai/guides/custom-reports#example-for-different-languages%E2%80%8B) * [Available Data Points​](https://docs.coderabbit.ai/guides/custom-reports#available-data-points%E2%80%8B) * [Pull Request Status​](https://docs.coderabbit.ai/guides/custom-reports#pull-request-status%E2%80%8B) * [Basic Information​](https://docs.coderabbit.ai/guides/custom-reports#basic-information%E2%80%8B) * [Summarized PR Details​](https://docs.coderabbit.ai/guides/custom-reports#summarized-pr-details%E2%80%8B) * [Comments​](https://docs.coderabbit.ai/guides/custom-reports#comments%E2%80%8B) * [CI/CD Check Status​](https://docs.coderabbit.ai/guides/custom-reports#ci%2Fcd-check-status%E2%80%8B) * [Formatting Options​](https://docs.coderabbit.ai/guides/custom-reports#formatting-options%E2%80%8B) * [Headers and Titles​](https://docs.coderabbit.ai/guides/custom-reports#headers-and-titles%E2%80%8B) * [Language Support​](https://docs.coderabbit.ai/guides/custom-reports#language-support%E2%80%8B) * [Advanced Features​](https://docs.coderabbit.ai/guides/custom-reports#advanced-features%E2%80%8B) * [Filtering​](https://docs.coderabbit.ai/guides/custom-reports#filtering%E2%80%8B) * [Custom Grouping​](https://docs.coderabbit.ai/guides/custom-reports#custom-grouping%E2%80%8B) * [Optional Data Sources​](https://docs.coderabbit.ai/guides/custom-reports#optional-data-sources%E2%80%8B) * [Bot Comments​](https://docs.coderabbit.ai/guides/custom-reports#bot-comments%E2%80%8B) * [Issues and Tickets​](https://docs.coderabbit.ai/guides/custom-reports#issues-and-tickets%E2%80%8B) * [Remove PRs without a “Score Card/Chart” bot comment​](https://docs.coderabbit.ai/guides/custom-reports#remove-prs-without-a-%E2%80%9Cscore-card%2Fchart%E2%80%9D-bot-comment%E2%80%8B) * [Best Practices​](https://docs.coderabbit.ai/guides/custom-reports#best-practices%E2%80%8B) * [Add Examples for Consistent Formatting​](https://docs.coderabbit.ai/guides/custom-reports#add-examples-for-consistent-formatting%E2%80%8B) * [Example Templates​](https://docs.coderabbit.ai/guides/custom-reports#example-templates%E2%80%8B) * [Executive Summary Template​](https://docs.coderabbit.ai/guides/custom-reports#executive-summary-template%E2%80%8B) * [Technical Deep Dive Template​](https://docs.coderabbit.ai/guides/custom-reports#technical-deep-dive-template%E2%80%8B) * [Advanced Example Templates​](https://docs.coderabbit.ai/guides/custom-reports#advanced-example-templates%E2%80%8B) * [Good Day Release Report​](https://docs.coderabbit.ai/guides/custom-reports#good-day-release-report%E2%80%8B) * [Nato’s Special Report​](https://docs.coderabbit.ai/guides/custom-reports#nato%E2%80%99s-special-report%E2%80%8B) * [Related Resources​](https://docs.coderabbit.ai/guides/custom-reports#related-resources%E2%80%8B) This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. CodeRabbit Pro allows you to create custom reports tailored to your specific needs using a flexible prompt-based system. This guide will help you understand how to create effective custom reports. For a conceptual overview of reports in CodeRabbit, see [Generate reports](https://docs.coderabbit.ai/guides/reports-overview) . [​](https://docs.coderabbit.ai/guides/custom-reports#understanding-custom-reports%E2%80%8B) Understanding Custom Reports[​](https://docs.coderabbit.ai/guides/custom-reports#understanding-custom-reports "Direct link to Understanding Custom Reports") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Custom reports allow you to: * Define exactly what information you want to see * Specify the format and structure of the report * Set custom filtering and grouping rules * Generate reports in different languages [​](https://docs.coderabbit.ai/guides/custom-reports#creating-custom-report-templates%E2%80%8B) Creating Custom Report Templates[​](https://docs.coderabbit.ai/guides/custom-reports#creating-custom-report-templates "Direct link to Creating Custom Report Templates") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/guides/custom-reports#basic-structure%E2%80%8B) Basic Structure[​](https://docs.coderabbit.ai/guides/custom-reports#basic-structure "Direct link to Basic Structure") A custom report template consists of instructions that tell CodeRabbit what information to include and how to present it. Here’s a basic example: Copy Please provide a summary of: - All merged pull requests - Critical bug fixes - Code review discussions Group by: - Repository - Team Format using: - Bullet points for changes - Tables for statistics ### [​](https://docs.coderabbit.ai/guides/custom-reports#example-for-different-languages%E2%80%8B) Example for different languages[​](https://docs.coderabbit.ai/guides/custom-reports#example-for-different-languages "Direct link to Example for different languages") Japanese: Copy レポートを英語ではなく日本語で送信してください。 以下の要約を提供してください： - すべてのプルリクエスト活動 - コードレビューの議論 French: Copy Veuillez envoyer le rapport en français et non en anglais. Veuillez fournir un résumé de : - Toutes les activités de demandes de fusion - Discussions sur la révision de code ### [​](https://docs.coderabbit.ai/guides/custom-reports#available-data-points%E2%80%8B) Available Data Points[​](https://docs.coderabbit.ai/guides/custom-reports#available-data-points "Direct link to Available Data Points") Your custom reports can access the following PR information that you can reference in your prompts: #### [​](https://docs.coderabbit.ai/guides/custom-reports#pull-request-status%E2%80%8B) Pull Request Status[​](https://docs.coderabbit.ai/guides/custom-reports#pull-request-status "Direct link to Pull Request Status") Contained within the `` tag. * `Merged`: boolean (true/false) - Whether the PR has been merged * `Draft`: boolean (true/false) - Whether the PR is in draft state * `State`: string (“open”/“closed”) - Current state of the PR * `Mergeable`: boolean (true/false) - Whether the PR can be merged * `Is stale`: boolean - Whether PR has been inactive for over 168 hours * `PR Stage`: string - The current stage of open PRs in Open or Draft state, can be one of: * “Needs Author Action” - PR requires author attention due to merge conflicts, draft status, or requested changes * “Waiting for Author to Merge” - PR has approvals and is ready for author to merge * “Waiting for Code Reviews” - PR is waiting for reviewers to approve * undefined - PR is not in an open state (is merged or closed) #### [​](https://docs.coderabbit.ai/guides/custom-reports#basic-information%E2%80%8B) Basic Information[​](https://docs.coderabbit.ai/guides/custom-reports#basic-information "Direct link to Basic Information") Contained within the `` tag. * `Pull request number`: number - The PR’s identifier * `Title`: string - PR title * `URL`: string - Link to the PR * `Author name`: string - PR creator’s username * `Created at`: datetime - When the PR was created * `Last activity`: datetime - Most recent activity timestamp * `Closed at`: datetime (if applicable) - When the PR was closed * `Source branch`: string - Source branch name * `Target branch`: string - Target branch name * `Labels`: array of strings - All labels applied to the PR * `Reviewers`: array of strings - Assigned reviewers’ usernames #### [​](https://docs.coderabbit.ai/guides/custom-reports#summarized-pr-details%E2%80%8B) Summarized PR Details[​](https://docs.coderabbit.ai/guides/custom-reports#summarized-pr-details "Direct link to Summarized PR Details") * ``: string - Contains the body of your pull request (aka the PR description at the top of the PR page). * ``: string - Contains a file by file summary of the changes made in the PR in markdown format. This summary is generated by CodeRabbit AI during the PR review process. This includes several sections for each file that was changed: * `filename`: string - The name of the file that was changed. * `AI-generated summary of changes`: markdown - An overall summary of the changes made in the file. * `Alterations to the declarations of exported or public entities`: markdown - A more specific breakdown of the changes made to the file such as exactly what was added, removed, or modified. #### [​](https://docs.coderabbit.ai/guides/custom-reports#comments%E2%80%8B) Comments[​](https://docs.coderabbit.ai/guides/custom-reports#comments "Direct link to Comments") * ``: array of comment objects - Contains all the comments made on the PR. * ``: object - Each indidvidual comment is wrapped in this tag and is an object with the following properties: * ``: string - The username of the comment author. * ``: datetime - The date and time the comment was created. * ``: datetime - The date and time the comment was last updated. * ``: markdown - The content of the comment. #### [​](https://docs.coderabbit.ai/guides/custom-reports#ci%2Fcd-check-status%E2%80%8B) CI/CD Check Status[​](https://docs.coderabbit.ai/guides/custom-reports#cicd-check-status "Direct link to CI/CD Check Status") * ``: array of check objects - Contains all CI/CD checks for the PR. _GitHub Only_. * ``: object - Each individual check is wrapped in this tag and is an object with the following properties: * ``: string - The name of the CI/CD check. * ``: string - The status of the check (e.g., “success”, “failure”, “in\_progress”, “canceled”). * ``: string - The URL to view the detailed results of the check. Here’s an example prompt that uses these data points: Example prompt Copy Use the to guide the content of the summary. Use the format shown in but do not include or refer the example's content in the final summary/report. Generate a summary of each pull request in the following bullet point format: - PR Link: Provide a hyperlink to the pull request from the 'URL:' value - Title: Provide the value of the 'Title:' field - PR State: Provide the state of the PR based on the following conditions: - If 'Merged: true' set 'PR State: 🔀 Merged' - Else If 'Draft: true' set 'PR State: 📝 Draft' - Else If 'State: open' or 'State: active' set 'PR State: 💬 Open' - Else If 'State: closed' or 'State: DECLINED' and 'Merged: false' set 'PR State: 🔒 Closed' - Else set 'PR State: ❓ Unknown' - If the PR is stale, add '⚠️ Stale' at the end of the PR State. - Mergeable (if PR State is not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable' based on the "Mergeable: " value. - PR Stage (if PR State is not 'Merged'): Provide the stage of the PR based on the "PR Stage: " value. - Summary: In under 50 words provide a short summary of the PR. - Comments: In under 50 words provide a short summary of all comments found within , including each comments author username from . If there are no comments available, output 'No comments'. - **PR Link:** [#3001](https://github.com/mygithuborg/myrepo/pull/3001) - **Title:** PR Title - **PR State:** 💬 Open - **Mergeable:** Mergeable - **PR Stage:** Waiting for Code Reviews - **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No comments. - **PR Link:** [#302](https://github.com/mygithuborg/thatrepo/pull/302) - **Title:** PR Title - **PR State:** 💬 Open - **Mergeable:** Mergeable - **PR Stage:** Waiting for Author to Merge - **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No comments. - **PR Link:** [#3](https://github.com/mygithuborg/myotherrepo/pull/3) - **Title:** PR Title - **PR State:** 🔀 Merged - **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No comments. - **PR Link:** [#14](https://github.com/mygithuborg/frontend/pull/14) - **Title:** PR Title - **PR State:** 💬 Open - **Mergeable:** Mergeable - **PR Stage:** Needs Author Action - **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No comments. - **PR Link:** [#13005](https://github.com/mygithuborg/backend/pull/13005) - **Title:** PR Title - **PR State:** 🔀 Merged - **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No comments. - **PR Link:** [#3006](https://github.com/mygithuborg/myrepo/pull/3006) - **Title:** PR Title - **PR State:** 🔀 Merged - **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No comments. - **PR Link:** [#3007](https://github.com/mygithuborg/myrepo/pull/3007) - **Title:** PR Title - **PR State:** 📝 Draft - **Mergeable:** Not Mergeable - **PR Stage:** Needs Author Action - **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No comments. ### [​](https://docs.coderabbit.ai/guides/custom-reports#formatting-options%E2%80%8B) Formatting Options[​](https://docs.coderabbit.ai/guides/custom-reports#formatting-options "Direct link to Formatting Options") CodeRabbit supports markdown formatting in custom reports. You can use: * Headers (`#`, `##`, `###`) * Lists (bullet points and numbered) * Tables * Code blocks * Bold and italic text * Links ### [​](https://docs.coderabbit.ai/guides/custom-reports#headers-and-titles%E2%80%8B) Headers and Titles[​](https://docs.coderabbit.ai/guides/custom-reports#headers-and-titles "Direct link to Headers and Titles") The name you give to each report in the CodeRabbit menu will be used for the first line of any report or the subject for emails. For example if your report is named `Executive Summary Template` then this string will appear on the subject of your emails and start of all message chains. When using the `Preview Report` button in the CodeRabbit menu, the subject will begin with `Preview: `. The reports will also have an overall title describing the report content such as `Pull Request Summary Report (January 2025)`. To change these details of this overall title you should include specific instructions in your custom prompt with examples such as: Copy - Do not add a date to the titles like "Pull Request Summary Report (January 2025)" it should just be "Pull Request Summary Report" ### [​](https://docs.coderabbit.ai/guides/custom-reports#language-support%E2%80%8B) Language Support[​](https://docs.coderabbit.ai/guides/custom-reports#language-support "Direct link to Language Support") You can generate reports in multiple languages by specifying the ISO language code in your template. For example: Copy Language: frPlease provide a summary of:- All pull request activities- Code review discussions [​](https://docs.coderabbit.ai/guides/custom-reports#advanced-features%E2%80%8B) Advanced Features[​](https://docs.coderabbit.ai/guides/custom-reports#advanced-features "Direct link to Advanced Features") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/guides/custom-reports#filtering%E2%80%8B) Filtering[​](https://docs.coderabbit.ai/guides/custom-reports#filtering "Direct link to Filtering") Include specific filtering instructions in your template: Copy Include only:- PRs with "critical" or "bug" labels- Changes to production code- Reviews from senior developersExclude:- Automated commits- Documentation changes- Dependencies updates ### [​](https://docs.coderabbit.ai/guides/custom-reports#custom-grouping%E2%80%8B) Custom Grouping[​](https://docs.coderabbit.ai/guides/custom-reports#custom-grouping "Direct link to Custom Grouping") Organize information using custom grouping rules: Copy Group by:1. Priority (High/Medium/Low)2. Component (Frontend/Backend/Infrastructure)3. Team (Team A/Team B)Within each group, sort by:- Activity date (newest first)- Impact level ### [​](https://docs.coderabbit.ai/guides/custom-reports#optional-data-sources%E2%80%8B) Optional Data Sources[​](https://docs.coderabbit.ai/guides/custom-reports#optional-data-sources "Direct link to Optional Data Sources") You can also include optional data sources in your custom reports. By default, CodeRabbit will not include the following data sources. In a custom report you will see the option to include these data sources by clicking the `Select Optional Data Sources` button. This adds special XML tags to your prompt that allow you to include this data in your report. #### [​](https://docs.coderabbit.ai/guides/custom-reports#bot-comments%E2%80%8B) Bot Comments[​](https://docs.coderabbit.ai/guides/custom-reports#bot-comments "Direct link to Bot Comments") Bot comments are comments made by bots and Coderabbit AI on a PR. To enable bot comments you must include the tag `` in your prompt. These are very similar in structure to regular user comments but with a few key differences: * ``: array of comment objects - Contains all the comments made on the PR. * ``: object - Each individual comment is wrapped in this tag and is an object with the following properties: * ``: string - The username of the comment author. * ``: datetime - The date and time the comment was created. * ``: datetime - The date and time the comment was last updated. * ``: markdown - The content of the comment. #### [​](https://docs.coderabbit.ai/guides/custom-reports#issues-and-tickets%E2%80%8B) Issues and Tickets[​](https://docs.coderabbit.ai/guides/custom-reports#issues-and-tickets "Direct link to Issues and Tickets") Issues and tickets brings in conversations, descriptions, and comments from Jira and Linear as part of your report if the ticket is linked in your PR description. To enable issues and tickets you must include the tag `` in your prompt. * ``: array of issue objects - Contains all the linked issues and tickets. * ``: object - Each individual issue is wrapped in this tag and is an object with the following properties: * ``: string - The title or thread ID of the issue. * ``: string - The URL to the issue. * ``: string - The unique identifier of the issue. * ``: string - The username of who created the issue. * ``: datetime - The date and time the issue was created. * ``: datetime - The date and time the issue was last updated. * ``: markdown - The content/description of the issue. This contains the following sections: * ``: markdown - The description of the issue. * ``: array of comment objects - Contains all the comments made on the issue. #### [​](https://docs.coderabbit.ai/guides/custom-reports#remove-prs-without-a-%E2%80%9Cscore-card%2Fchart%E2%80%9D-bot-comment%E2%80%8B) Remove PRs without a “Score Card/Chart” bot comment[​](https://docs.coderabbit.ai/guides/custom-reports#remove-prs-without-a-score-cardchart-bot-comment "Direct link to Remove PRs without a "Score Card/Chart" bot comment") This option gives you the ability to create a report limited only to pull requests containing a “Score Card” or “Score Chart” bot comment from CodeRabbit or other bots. To enable issues and tickets you must include the tag `` in your prompt. > **IMPORTANT:** This will automatically remove any pull requests from your reports if they do not contain a “Score Card” or “Score Chart” bot comment. Using this option without setting up a flow to create these comments will result in `No new pull request activity in the last XYZ hours` errors. Do not enable this option unless you have asked CodeRabbit to create a “Score Card” through a comment or implemented the “Score Chart” bot comment flow below. For example, you can ask CodeRabbit to check several conditions on a pull request and produce a “Score Chart”:Click to view example User Score Card/Chart Comment: ![Score Card/Chart Trigger Comment Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/score-card-trigger-comment-4e3cfec10d3633fc85ccff5594a3b4c9.png) Copy @coderabbitaiUse the to guide the content of the summary. Use the format shown in <\_example> but do not include or refer to the example's content in the final summary/report.**Instructions:**Generate a weekly code review report for the author of this pull request only following scoring parameters. Calculate the scores and compile the results into a table so that the team-wise average score can be easily determined.**Scoring Parameters:**1. **Basic Code Standards (Score out of 2)** - Avoidance of hard-coded values - No repetition of code (DRY principle)2. **Code Readability (Score out of 2)** - Presence of meaningful comments - Proper variable declaration using `const` and `let`3. **Error Handling (Score out of 4)** - Handling failure scenarios (e.g., try-catch, fallbacks) - Proper loading state implementation (e.g., button click loading states) - Handling edge cases (e.g., checking for undefined or missing values) - Input validation (ensuring correct user inputs)4. **Circle CI Check Validation (Score: 0 or 1)** - `0` → Not Passed - `1` → Passed**Final Score Calculation:**Combine the scores from the parameters above to derive the final code quality score (out of 9).**Output Format:**Provide the final report in a table format with the following columns (use shorthand notations), be sure to include this list at the top above the chart in the "Column Notation" section so users understand what the columns mean:- **User Name (User)**- **Basic Code Standards (BCS) (out of 2)**- **Code Readability (CR) (out of 2)**- **Error Handling (EH) (out of 4)**- **Shopify Theme Check (CI) (out of 1)**- **Final Code Quality Score (FCQS) (out of 9)**<\_example>## Column Notation- **User Name (User)**- **Basic Code Standards (BCS) (out of 2)**- **Code Readability (CR) (out of 2)**- **Error Handling (EH) (out of 4)**- **Shopify Theme Check (CI) (out of 1)**- **Final Code Quality Score (FCQS) (out of 9)**## Score Chart| User | BCS (2) | CR (3) | EH (2) | CI (1) | FCQS (9) || -------- | ------- | ------ | ------ | ------ | -------- || John Doe | 2 | 3 | 2 | 1 | 9 | Then CodeRabbit will reply with a score for you pull request: Click to view resulting Score Card/Chart bot comment: ![CodeRabbit Score Card/Chart Result Comment Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/score-card-result-comment-31b8bfd7aeb8aceece31e01080d1d79c.png) You can then utilize this in a report. We recommend your report looks specifically for these score cards and puts together a unified report:Click to view example Report Prompt when using Score Card/Chart: ![Report Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/score-card-report-result-52aa6c8ba74f34ebc7541b90bc3ca510.png)![Where to put this prompt](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/assets/images/where-score-report-prompt-go-0afce31800cc6b547530f6e53def5dd7.png)Prompt Example: Copy Use the to guide the content of the summary. Use the format shown in but do not include or refer to the example's content in the final summary/report.**Instructions:**Locate the score chart comment in the . There will be a single comment with data on these fields:- **User Name (User)**- **Basic Code Standards (BCS) (out of 2)**- **Code Readability (CR) (out of 2)**- **Error Handling (EH) (out of 4)**- **Shopify Theme Check (CI) (out of 1)**- **Final Code Quality Score (FCQS) (out of 9)**These details may also be in the form of a chart such as:## Score Chart| User | BCS (2) | CR (3) | EH (2) | CI (1) | FCQS (9) || -------- | ------- | ------ | ------ | ------ | -------- || John Doe | 2 | 3 | 2 | 1 | 9 |You will create a new chart averaging all the values from various pull requests for each author. Only include pull requests with a `Score Chart`. Do not invent or create score charts if none exist.## Column Notation- **User Name (User)**- **Basic Code Standards (BCS) (out of 2)**- **Code Readability (CR) (out of 2)**- **Error Handling (EH) (out of 4)**- **Shopify Theme Check (CI) (out of 1)**- **Final Code Quality Score (FCQS) (out of 9)**## Score Chart| User | BCS (2) | CR (3) | EH (2) | CI (1) | FCQS (9) | PR URL || -------- | ------- | ------ | ------ | ------ | -------- | ------ || John Doe | 2 | 3 | 2 | 1 | 9 | URL || Alex Foo | 2 | 3 | 2 | 1 | 9 | URL | **Best Practices for Score Cards/Charts:** * The reporting bot only has access to your comments and summary (like a project manager) if you want to make a report looking for these score card/chart comments make sure the reviewer does this ahead of time. * Only include checks for very specific scenarios, such as a specific check failing or using tabs vs spaces. * Do not use general rules without explaining specifically what they mean. If you add “Insure the pull request follows development best practices” you must define what “development best practices” actually mean or the AI will guess. * Make one point for each specific check and make sure its a True/False condition. * Instead of manually commenting on pull requests, you can use the [GitHub Actions Bot](https://github.com/marketplace/actions/create-or-update-comment) to automatically comment on pull requests and trigger CodeRabbit score card/chart comments by including `@coderabbitai` in the comment. [​](https://docs.coderabbit.ai/guides/custom-reports#best-practices%E2%80%8B) Best Practices[​](https://docs.coderabbit.ai/guides/custom-reports#best-practices "Direct link to Best Practices") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. **Be Specific** * Clearly define what should be included/excluded * Use precise language to avoid ambiguity * Specify exact metrics you want to track 2. **Structure Matters** * Start with high-level summaries * Use consistent grouping patterns * Include clear section breaks 3. **Keep it Relevant** * Focus on actionable information * Avoid redundant data points * Consider your audience’s needs 4. **Optimize Readability** * Use appropriate formatting * Include visual breaks * Maintain consistent styling 5. **Use Examples** * Include “do this” and “don’t do this” examples (especially for titles) * Demonstrate proper formatting patterns * Show concrete use cases for different report types * Help maintain consistency across teams * Avoid ambiguity in report generation ### [​](https://docs.coderabbit.ai/guides/custom-reports#add-examples-for-consistent-formatting%E2%80%8B) Add Examples for Consistent Formatting[​](https://docs.coderabbit.ai/guides/custom-reports#add-examples-for-consistent-formatting "Direct link to Add Examples for Consistent Formatting") Try to use `` and `` tag blocks to keep consistency across reports: Copy Use the to guide the content of the summary. Use the format shown in but do not include or refer the example's content in the final summary/report.Generate release notes with the following sections:- Summary: A high-level summary of the overall change instead of specific files within 100 words.- Changes: A bullet point list of all the significant changes made in this release.Significant changes include new features, bug fixes, and other notable changes.Use a single sentence for each change without headings or categorization.Do not include changes from PRs that have not been merged.Don't show changes that are too insignificant and don't affect the end-user.Use a single level of bullet points for each change.Don't add links to the PRs.Do not add a list of pull requests.Do not show a random release date, version, etc. if they are not known.## Summary[Summary of the release]## Changes- [Summary of the change 1]- [Summary of the change 2]- [Summary of the change 3]- ...- [Summary of the change N] [​](https://docs.coderabbit.ai/guides/custom-reports#example-templates%E2%80%8B) Example Templates[​](https://docs.coderabbit.ai/guides/custom-reports#example-templates "Direct link to Example Templates") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/guides/custom-reports#executive-summary-template%E2%80%8B) Executive Summary Template[​](https://docs.coderabbit.ai/guides/custom-reports#executive-summary-template "Direct link to Executive Summary Template") Copy Provide a high-level overview:1. Key metrics: - Total PRs merged - Average review time - Code quality scores2. Notable achievements3. Blocking issues4. Resource allocationFormat:- Use tables for metrics- Bullet points for achievements- Clear headers for sections ### [​](https://docs.coderabbit.ai/guides/custom-reports#technical-deep-dive-template%E2%80%8B) Technical Deep Dive Template[​](https://docs.coderabbit.ai/guides/custom-reports#technical-deep-dive-template "Direct link to Technical Deep Dive Template") Copy Generate a detailed technical report:1. Code changes: - Architecture updates - API modifications - Database changes2. Testing coverage3. Performance impacts4. Security considerationsInclude:- Links to significant PRs- Code snippets for major changes- Technical debt analysis [​](https://docs.coderabbit.ai/guides/custom-reports#advanced-example-templates%E2%80%8B) Advanced Example Templates[​](https://docs.coderabbit.ai/guides/custom-reports#advanced-example-templates "Direct link to Advanced Example Templates") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Heres a more advanced example of a custom report template: ### [​](https://docs.coderabbit.ai/guides/custom-reports#good-day-release-report%E2%80%8B) **Good Day Release Report**[​](https://docs.coderabbit.ai/guides/custom-reports#good-day-release-report "Direct link to good-day-release-report") Copy **GPT Specialization:**This GPT specializes in summarizing software release notes and optional summary paragraphs into a consistent, clear, and concise format. The goal is to streamline the presentation of release notes, making them easy to understand for a general audience. It prioritizes clarity, brevity, and coherence while highlighting important updates without unnecessary jargon.**Release Note Structure:**1. **Release Notes Organization** The items in the release notes may not be in the desired order. It is crucial to group similar items together meaningfully. Review the list after the release notes are created and reorder items within each heading based on relevance. Use **PRODUCT FEATURE GROUPS** to understand which items are related.2. **General Release Note Guidelines** - The title should be: `GoodDay Release v${versionNumber}`3. **Release Note Line Items** - Reword individual release lines to maintain a consistent tone (happy and fun) - Use past tense for descriptions - Items in the 🧼 Fixes group should begin with "Fixed" - Consolidate duplicate or closely related items, and list the associated GitHub pull requests as a comma-delimited list at the end (e.g., GH-123, GH-456) - Add links to Github App for each PR4. **GitHub App Links** - each pr mentioned should include hyperlinking to the pull request such as [coderabbitai/mono/pull/2614](https://github.com/coderabbitai/mono/pull/2614)5. **Grouping Release Note Line Items** - Replace any emoji in the provided content with the appropriate **RELEASE NOTE GROUP** - Order the **RELEASE NOTE GROUP** according to the structure below6. **Release Note Groups** - 🚀 **Features**: New capabilities or enhancements - 🧼 **Fixes**: Bug fixes or problem resolutions - 🧰 **Maintenance**: Documentation, cleanup, or technical changes - 📚 **Other**: Anything else7. **PR Label Uses** - Omit any PRs with the label `skip-changelog` - Use the labels from related pull requests to group items together - Map PR labels to release note groups using the table below: | RELEASE NOTE GROUP | LABELS | |--------------------|-----------------| | 🚀 Features | feature, enhancement | | 🧼 Fixes | bug, fix | | 🧰 Maintenance | design, docs | | 📚 Other | other, tech |8. **Final Checks** - Verify that the number of items matches the number of PRs included - Ensure the PR links match the PR number and reflect the content of the changes ### [​](https://docs.coderabbit.ai/guides/custom-reports#nato%E2%80%99s-special-report%E2%80%8B) **Nato’s Special Report**[​](https://docs.coderabbit.ai/guides/custom-reports#natos-special-report "Direct link to natos-special-report") Copy Generate a report of all pull requests in the following format:- As the first paragraph, start with "🟣" if merged, "⚫" if draft, "🟢" if open, "🔴" if closed - On the same line, add the PR title in bold (and only the title; don't put anything else in bold after that) - On the same line, add the PR browser link (do not use an api link) - On the same line, add the last activity date in the format "Day Month Year, Hour:Minute AM/PM (Timezone)" in italic (don't put anything else in italic after that and make sure it's not bold)- Make a new bullet-point list of high-level changes in the PR - Start each change with a gitmoji followed by a very terse one-liner to mention at a high level what the change does and to what part of the application it applies to - Do not start with verbose non-speak such as "The pull request enhances" or "This PR introduces". Keep it terse and straight to the point. Start change descriptions with a verb - Do not end with justifications or reasons for the changes such as "... enhancing type safety". Stick to the facts, do not make up the outcome of a change - Limit to the 4 most relevant changes - Examples: "✨ Add a rotating tagline on the home page", "🔧 Add func-style to ESLint", "📝 Add download badge to `README.md`", "✅ Add unit tests for comment trees", "👷 Create a pipeline to publish to npmjs.org", "🐛 Fix comment submission in posts", "📄 License under AGPL-3.0-or-later", "📱 Change post view for mobile", "💄 Make sidebar links blue", "🩹 Fix unfollow button", "🔒️ Limit login cookies to a specific subdomain", "🥅 Handle errors when commenting in a post", "🙈 Stop ignoring `.env` and start ignoring `.env.local` and `.env.*.local`", "⬆️ Update lemmy-js-client to v0.19.4", "🏷️ Define interfaces for pull request events", "🔐 Add environment variables for Bitbucket Server", "🚚 Rename exported client instances in test files", "🏷️ Add type alias `EventKey` and its type guard `isEventKey`", "🏗️ Aggregate exports for pull request events in an index file"- Start the next paragraph with "Blockers:" in bold - Summarize any issues preventing the PR from progressing - Some examples: "Waiting for merge", "Waiting for review", "Failing CI/CD", "Needs more tests", "Needs rebase", "@username is waiting for a response", etc. - If the PR is stale, note it here- Do not add a "Report" heading- Make sure there is one empty line between each paragraphThese are the available emojis and the type of change they represent. Do not using any other emoji. Make sure the change corresponds to the gitmoji.🎨: Improve structure / format of the code.⚡️: Improve performance.🔥: Remove code or files.🐛: Fix a bug.🚑️: Critical hotfix.✨: Introduce new features.📝: Add or update documentation.🚀: Deploy stuff.💄: Add or update the UI and style files.🎉: Begin a project.✅: Add, update, or pass tests.🔒️: Fix security or privacy issues.🔐: Add or update secrets.🔖: Release / Version tags.🚨: Fix compiler / linter warnings.🚧: Work in progress.💚: Fix CI Build.⬇️: Downgrade dependencies.⬆️: Upgrade dependencies.📌: Pin dependencies to specific versions.👷: Add or update CI build system.📈: Add or update analytics or track code.♻️: Refactor code.➕: Add a dependency.➖: Remove a dependency.🔧: Add or update configuration files.🔨: Add or update development scripts.🌐: Internationalization and localization.✏️: Fix typos.💩: Write bad code that needs to be improved.⏪️: Revert changes.🔀: Merge branches.📦️: Add or update compiled files or packages.👽️: Update code due to external API changes.🚚: Move or rename resources (e.g.: files, paths, routes).📄: Add or update license.💥: Introduce breaking changes.🍱: Add or update assets.♿️: Improve accessibility.💡: Add or update comments in source code.🍻: Write code drunkenly.💬: Add or update text and literals.🗃️: Perform database related changes.🔊: Add or update logs.🔇: Remove logs.👥: Add or update contributor(s).🚸: Improve user experience / usability.🏗️: Make architectural changes.📱: Work on responsive design.🤡: Mock things.🥚: Add or update an easter egg.🙈: Add or update a .gitignore file.📸: Add or update snapshots.⚗️: Perform experiments.🔍️: Improve SEO.🏷️: Add or update types.🌱: Add or update seed files.🚩: Add, update, or remove feature flags.🥅: Catch errors.💫: Add or update animations and transitions.🗑️: Deprecate code that needs to be cleaned up.🛂: Work on code related to authorization, roles and permissions.🩹: Simple fix for a non-critical issue.🧐: Data exploration/inspection.⚰️: Remove dead code.🧪: Add a failing test.👔: Add or update business logic.🩺: Add or update healthcheck.🧱: Infrastructure related changes.🧑‍💻: Improve developer experience.💸: Add sponsorships or money related infrastructure.🧵: Add or update code related to multithreading or concurrency.🦺: Add or update code related to validation. [​](https://docs.coderabbit.ai/guides/custom-reports#related-resources%E2%80%8B) Related Resources[​](https://docs.coderabbit.ai/guides/custom-reports#related-resources "Direct link to Related Resources") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Schedule reports](https://docs.coderabbit.ai/guides/scheduled-reports) * [Generate reports on demand](https://docs.coderabbit.ai/guides/ondemand-reports) * [API Documentation](https://api.coderabbit.ai/api/swagger/) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/custom-reports.md) Last updated on **Jul 31, 2025** [Generate reports on demand](https://docs.coderabbit.ai/guides/ondemand-reports) [Setup best practices](https://docs.coderabbit.ai/guides/setup-best-practices) Assistant Responses are generated using AI and may contain mistakes. --- # New Static Analysis Tools - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation New Static Analysis Tools On this page * [New Static Analysis Tools](https://docs.coderabbit.ai/changelog/new-static-analysis-tools#new-static-analysis-tools) ### [​](https://docs.coderabbit.ai/changelog/new-static-analysis-tools#new-static-analysis-tools) New Static Analysis Tools We’ve expanded our static analysis capabilities with two new tools: * **Oxlint**: A high-performance JavaScript/TypeScript linter written in Rust. * **Prisma Lint**: A dedicated linter for Prisma schema files to help enforce consistent conventions and best practices. Both tools can be configured through their respective config files or through CodeRabbit’s settings page. See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details. Assistant Responses are generated using AI and may contain mistakes. --- # Multiple Features Release - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Multiple Features Release On this page * [Multiple Features Release](https://docs.coderabbit.ai/changelog/multiple-features-release#multiple-features-release) * [Learnings](https://docs.coderabbit.ai/changelog/multiple-features-release#learnings) * [Codebase Verification](https://docs.coderabbit.ai/changelog/multiple-features-release#codebase-verification) * [Jira and Linear Integrations](https://docs.coderabbit.ai/changelog/multiple-features-release#jira-and-linear-integrations) * [Related Issues](https://docs.coderabbit.ai/changelog/multiple-features-release#related-issues) ### [​](https://docs.coderabbit.ai/changelog/multiple-features-release#multiple-features-release) Multiple Features Release #### [​](https://docs.coderabbit.ai/changelog/multiple-features-release#learnings) Learnings CodeRabbit can now learn from your conversations to fine-tune your reviews. If you encounter inaccurate feedback or something not relevant to your codebase, just let the bot know, and it will remember the context for the future. We understand that coding practices and standards evolve. Using the chat, you can inform the bot, and it will remove any existing learnings that are no longer relevant. This feature does not work if you have opted out of data storage. #### [​](https://docs.coderabbit.ai/changelog/multiple-features-release#codebase-verification) Codebase Verification Verifies the reference of the changes on the overall codebase and identifies missing changes. #### [​](https://docs.coderabbit.ai/changelog/multiple-features-release#jira-and-linear-integrations) Jira and Linear Integrations You can now integrate Jira and Linear with CodeRabbit to provide additional context when reviewing pull requests. If you use either of these systems, we highly recommend enabling this integration for a more seamless experience. Stay tuned—more integrations are coming soon! #### [​](https://docs.coderabbit.ai/changelog/multiple-features-release#related-issues) Related Issues Identifies all issues affected by the code changes. This helps understand the impact on the overall product. It also assists in identifying duplicate issues or the impact on any other existing issues. This feature is unavailable for users who have opted out of data collection. Assistant Responses are generated using AI and may contain mistakes. --- # GitLab - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported Git platforms GitLab On this page * [GitLab Access Tokens](https://docs.coderabbit.ai/platforms/gitlab-com#gitlab-access-tokens) * [Personal Access Token](https://docs.coderabbit.ai/platforms/gitlab-com#personal-access-token) * [Recommendations](https://docs.coderabbit.ai/platforms/gitlab-com#recommendations) * [Key Points to Remember](https://docs.coderabbit.ai/platforms/gitlab-com#key-points-to-remember) * [Generating a Personal Access Token](https://docs.coderabbit.ai/platforms/gitlab-com#generating-a-personal-access-token) * [Group Access Token](https://docs.coderabbit.ai/platforms/gitlab-com#group-access-token) * [Generating a Group Access Token](https://docs.coderabbit.ai/platforms/gitlab-com#generating-a-group-access-token) * [Where to Provide CodeRabbit the Access Token](https://docs.coderabbit.ai/platforms/gitlab-com#where-to-provide-coderabbit-the-access-token) * [Installing CodeRabbit into your GitLab Repositories](https://docs.coderabbit.ai/platforms/gitlab-com#installing-coderabbit-into-your-gitlab-repositories) * [Troubleshooting](https://docs.coderabbit.ai/platforms/gitlab-com#troubleshooting) 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. [​](https://docs.coderabbit.ai/platforms/gitlab-com#gitlab-access-tokens) 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. ### [​](https://docs.coderabbit.ai/platforms/gitlab-com#personal-access-token) 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. ![GitLab user modal choice](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/img/integrations/gitlab_user_choice.png) 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. ![GitLab organization user modal\ choice](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/img/integrations/gitlab_organization_user.png) #### [​](https://docs.coderabbit.ai/platforms/gitlab-com#recommendations) 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](https://docs.coderabbit.ai/assets/files/logo-def6275252a64c350c5b7ffb7c1e3d6c.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. #### [​](https://docs.coderabbit.ai/platforms/gitlab-com#key-points-to-remember) 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. #### [​](https://docs.coderabbit.ai/platforms/gitlab-com#generating-a-personal-access-token) 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. ![GitLab personal access token configuration page](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/img/integrations/admin-access-token.png) * * * ### [​](https://docs.coderabbit.ai/platforms/gitlab-com#group-access-token) 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. By default, GitLab restricts this option to users on the Premium or Ultimate tiers. #### [​](https://docs.coderabbit.ai/platforms/gitlab-com#generating-a-group-access-token) 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. Group Access Tokens create bot users with generic GitLab-generated usernames (like `group_63_bot_5753...`). If you prefer a more descriptive username for your CodeRabbit bot, you can customize it using the [GitLab API](https://docs.gitlab.com/api/users/#modify-a-user) .You can find the bot’s user ID through the CodeRabbit UI if connected, or by visiting the bot user’s profile from your Group Members page in GitLab. ### [​](https://docs.coderabbit.ai/platforms/gitlab-com#where-to-provide-coderabbit-the-access-token) 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. * * * ### [​](https://docs.coderabbit.ai/platforms/gitlab-com#installing-coderabbit-into-your-gitlab-repositories) 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**. ![GitLab Repo Install Modal](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/img/integrations/gitlab-repo-install.png) The webhook `https://coderabbit.ai/gitlabHandler` will now be installed for the projects selected. ![GitLab Webhook Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/img/integrations/gitlab-webhook.png) ### [​](https://docs.coderabbit.ai/platforms/gitlab-com#troubleshooting) Troubleshooting 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. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/platforms/gitlab-com.mdx) Last updated on **Jul 31, 2025** [GitHub Enterprise Server](https://docs.coderabbit.ai/platforms/github-enterprise-server) [On-prem GitLab](https://docs.coderabbit.ai/platforms/self-hosted-gitlab) Assistant Responses are generated using AI and may contain mistakes. --- # Azure DevOps - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported Git platforms Azure DevOps On this page * [Prerequisites​](https://docs.coderabbit.ai/platforms/azure-devops#prerequisites%E2%80%8B) * [Integration Instructions​](https://docs.coderabbit.ai/platforms/azure-devops#integration-instructions%E2%80%8B) * [How it works​](https://docs.coderabbit.ai/platforms/azure-devops#how-it-works%E2%80%8B) * [Azure DevOps Personal Access Tokens​](https://docs.coderabbit.ai/platforms/azure-devops#azure-devops-personal-access-tokens%E2%80%8B) * [Recommendations​](https://docs.coderabbit.ai/platforms/azure-devops#recommendations%E2%80%8B) * [Key Points to Remember​](https://docs.coderabbit.ai/platforms/azure-devops#key-points-to-remember%E2%80%8B) * [Generating a Personal Access Token​](https://docs.coderabbit.ai/platforms/azure-devops#generating-a-personal-access-token%E2%80%8B) [​](https://docs.coderabbit.ai/platforms/azure-devops#prerequisites%E2%80%8B) Prerequisites[​](https://docs.coderabbit.ai/platforms/azure-devops#prerequisites "Direct link to Prerequisites") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * An active Azure DevOps account. * Use of organizational email addresses is required; personal email addresses are not supported for this integration. [​](https://docs.coderabbit.ai/platforms/azure-devops#integration-instructions%E2%80%8B) Integration Instructions[​](https://docs.coderabbit.ai/platforms/azure-devops#integration-instructions "Direct link to Integration Instructions") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Log in to the CodeRabbitAI application. 2. After logging in, you will be redirected to a page displaying Microsoft Apps consent requests. Please forward these requests to your administrator for approval. If you are an administrator, you may approve the applications directly. If not, please contact your administrator to request approval for the applications. ![CodeRabbit admin consent page for Azure DevOps integration](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/azure_apps_consent_page-0c1b13cf62abe69feff9d0efff1ae384.png) 3. Once your administrator has approved the applications, click “Continue.” 4. You will be redirected to the “Onboarding” page, where you can select the organization you wish to integrate with. 5. On the “Azure DevOps User” page, enter your Personal Access Token for Azure DevOps. ![CodeRabbit azure devOps integration settings page](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/azure_devops_user_page-cca2f1057e479afcdc11a605bc063472.png) 6. To install CodeRabbit on a repository, toggle the switch on the “Repositories” page. [​](https://docs.coderabbit.ai/platforms/azure-devops#how-it-works%E2%80%8B) How it works[​](https://docs.coderabbit.ai/platforms/azure-devops#how-it-works "Direct link to How it works") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- For the CodeRabbit app to post reviews on merge requests, it needs to interact with the Azure DevOps API, which requires a Personal Access Token. This token can be generated by creating a Personal Access Token from one of your existing users. You can create a new user in Azure DevOps and generate a Personal Access Token for that user, following [our recommendations](https://docs.coderabbit.ai/platforms/azure-devops#recommendations) . [​](https://docs.coderabbit.ai/platforms/azure-devops#azure-devops-personal-access-tokens%E2%80%8B) Azure DevOps Personal Access Tokens[​](https://docs.coderabbit.ai/platforms/azure-devops#azure-devops-personal-access-tokens "Direct link to Azure DevOps Personal Access Tokens") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ To interact with the Azure DevOps API, a **Personal Access Token** is required. This token can be generated 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 add the Personal Access Token. ![CodeRabbit azure devOps integration modal](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/azure_personal_access_token_add-ffbefdeb94883745377d71337ab98a45.png) ### [​](https://docs.coderabbit.ai/platforms/azure-devops#recommendations%E2%80%8B) Recommendations[​](https://docs.coderabbit.ai/platforms/azure-devops#recommendations "Direct link to 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](https://docs.coderabbit.ai/assets/files/logo-144a28a895bdf0158c57d2cb016780d8.png "download") . ### [​](https://docs.coderabbit.ai/platforms/azure-devops#key-points-to-remember%E2%80%8B) Key Points to Remember[​](https://docs.coderabbit.ai/platforms/azure-devops#key-points-to-remember "Direct link to 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 “AzureDevOps User” page in the sidebar. * Add the new token and click save. ### [​](https://docs.coderabbit.ai/platforms/azure-devops#generating-a-personal-access-token%E2%80%8B) Generating a Personal Access Token[​](https://docs.coderabbit.ai/platforms/azure-devops#generating-a-personal-access-token "Direct link to Generating a Personal Access Token") Azure DevOps provides an option to generate a personal access token for a user. Follow these steps to generate the token: 1. Log in as the user intended for CodeRabbit reviews. 2. Next to your avatar on the headers right side is a settings icon, click it. 3. Choose “Personal Access Tokens” 4. Click “New Token” 5. Select the organization you want to use the token with or select “All accessible organizations.” 6. Enter a name and an expiry date for the token. 7. Grant **Read, write, & manage** access to “Work Items” and “Code”. CodeRabbit needs these permissions to post code reviews on pull requests. 8. If you subscribe to CodeRabbit Pro, then you can also grant **Read** access to “Build” for pipeline failure remediation. 9. Click “Create” ![CodeRabbit azure devOps personal access token creation form](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/azure-access-token-178518378ab665a6ee7877d90bd46c06.png) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/platforms/azure-devops.md) Last updated on **Jul 31, 2025** [On-prem GitLab](https://docs.coderabbit.ai/platforms/self-hosted-gitlab) [Bitbucket Cloud](https://docs.coderabbit.ai/platforms/bitbucket-cloud) Assistant Responses are generated using AI and may contain mistakes. --- # Bitbucket Cloud - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported Git platforms Bitbucket Cloud On this page * [Configure API Token​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#configure-api-token%E2%80%8B) * [Recommendations​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#recommendations%E2%80%8B) * [Key Points to Remember​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#key-points-to-remember%E2%80%8B) * [Generating an API token​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#generating-an-api-token%E2%80%8B) * [Where to Provide CodeRabbit the API Token​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#where-to-provide-coderabbit-the-api-token%E2%80%8B) * [Installing CodeRabbit into your Bitbucket Repositories​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#installing-coderabbit-into-your-bitbucket-repositories%E2%80%8B) * [Troubleshooting​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#troubleshooting%E2%80%8B) 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. [​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#configure-api-token%E2%80%8B) Configure API Token[​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#configure-api-token "Direct link to Configure API Token") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 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. 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 API token to allow access. During the installation process, CodeRabbit will automatically configure the required webhook for seamless integration. If you wish to change the review user, you must provide the API 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. ### [​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#recommendations%E2%80%8B) Recommendations[​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#recommendations "Direct link to 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](https://docs.coderabbit.ai/assets/files/logo-def6275252a64c350c5b7ffb7c1e3d6c.svg "download") . * **Developer Access** Ensure the service account user has developer access to the projects that you wish to install CodeRabbit on. #### [​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#key-points-to-remember%E2%80%8B) Key Points to Remember[​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#key-points-to-remember "Direct link to Key Points to Remember") * Code reviews will be attributed to the owner of the API token. #### [​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#generating-an-api-token%E2%80%8B) Generating an API token[​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#generating-an-api-token "Direct link to Generating an API token") Bitbucket provides an option to generate an API 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. Go to [API Tokens](https://id.atlassian.com/manage-profile/security/api-tokens) . 3. Click **Create API token with scopes**. 4. Enter a name easily recognizable for this API token usage and an expiration date based on your plan of using the product. 5. On next step select **Bitbucket** 6. Ensure the following scopes are selected: * read:account * read:user:bitbucket * write:issue:bitbucket * read:issue:bitbucket * read:workspace:bitbucket * admin:project:bitbucket * write:webhook:bitbucket * read:webhook:bitbucket * read:pipeline:bitbucket * read:runner:bitbucket * read:repository:bitbucket * write:repository:bitbucket * read:pullrequest:bitbucket * write:pullrequest:bitbucket 7. Click **Create** 8. Note down the API token as it will only be displayed once. ### [​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#where-to-provide-coderabbit-the-api-token%E2%80%8B) Where to Provide CodeRabbit the API Token[​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#where-to-provide-coderabbit-the-api-token "Direct link to Where to Provide CodeRabbit the API Token") By default, if no API 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 **Bitbucket User** tab on the sidebar. Once entering the API 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. * * * ### [​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#installing-coderabbit-into-your-bitbucket-repositories%E2%80%8B) Installing CodeRabbit into your Bitbucket Repositories[​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#installing-coderabbit-into-your-bitbucket-repositories "Direct link to 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**. ![Bitbucket Repo Install Modal](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/img/integrations/gitlab-repo-install.png) The webhook `https://coderabbit.ai/bitbucketHandler` will now be installed for the projects selected. ![Bitbucket Webhook Example](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/img/integrations/bitbucket-webhook.png) ### [​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#troubleshooting%E2%80%8B) Troubleshooting[​](https://docs.coderabbit.ai/platforms/bitbucket-cloud#troubleshooting "Direct link to Troubleshooting") 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 API Token is properly configured. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/platforms/bitbucket-cloud.md) Last updated on **Jul 31, 2025** [Azure DevOps](https://docs.coderabbit.ai/platforms/azure-devops) [Add organizations](https://docs.coderabbit.ai/getting-started/adding-organizations) Assistant Responses are generated using AI and may contain mistakes. --- # On-prem GitLab - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported Git platforms On-prem GitLab On this page * [Step 1: Getting Started](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#step-1%3A-getting-started) * [Step 2: Enter your Self-Managed GitLab URL](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#step-2%3A-enter-your-self-managed-gitlab-url) * [Step 3: Onboarding Manual or Automated](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#step-3%3A-onboarding-manual-or-automated) * [1\. Automated onboarding](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#1-automated-onboarding) * [Why do we need the Admin Access Token?](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#why-do-we-need-the-admin-access-token%3F) * [2\. Manual onboarding](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#2-manual-onboarding) * [Creating CodeRabbit user](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#creating-coderabbit-user) * [Creating OAuth2 application](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#creating-oauth2-application) * [Generating Personal Access token](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#generating-personal-access-token) * [Step 4: Paste the details and click submit](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#step-4%3A-paste-the-details-and-click-submit) * [Step 5: Whitelist CodeRabbit IP address](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#step-5%3A-whitelist-coderabbit-ip-address) To initiate the integration, we require specific information. This is essential for the initial setup of CodeRabbit within your domain. Once this setup is complete, you can log in directly using the OAuth2 flow. CodeRabbit supports GitLab `16.x` and above. Version `15.x` may experience unexpected issues such as review comments not being posted or the sign-up process not working at all. While we won’t block the integration, we recommend upgrading your GitLab instance to obtain the intended experience. ### [​](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#step-1%3A-getting-started) **Step 1: Getting Started** **Visit CodeRabbit:** Visit our [Login](https://app.coderabbit.ai/login?free-trial) page and select Self-Hosted GitLab ![CodeRabbit login](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/login-self-hosted-gitlab-34542f78a7edb731c7dc0d07e9145088.png) ### [​](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#step-2%3A-enter-your-self-managed-gitlab-url) Step 2: Enter your Self-Managed GitLab URL On this page, enter the URL of your self-managed GitLab instance and click submit. Once, you submit, we check our database for a record of your organization and if we find an existing one, we are starting the login process. ![Self-hosted Gitlab enterprise connection page](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/self-hosted-gitlab-host-url-cd6401db765c1fb24f1faf9c5880fbe9.png) If the self-managed GitLab instance is not found, we initiate the onboarding process, which can be either manual or automated. ### [​](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#step-3%3A-onboarding-manual-or-automated) **Step 3: Onboarding Manual or Automated** #### [​](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#1-automated-onboarding) 1\. Automated onboarding ![Self-managed GitLab connection page](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/automated-onboarding-def5b25271299f245653c9912d5335cf.png) #### [​](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#why-do-we-need-the-admin-access-token%3F) **Why do we need the Admin Access Token?** Admin access token is required to set up a new CodeRabbit bot user within your self-managed instance. The token is needed only once during the initial setup process. Once the token is generated, you can set its minimum expiration period. This is the standard approach used by other products in this category. This is not automatically installing the CodeRabbit app across all projects. You will add CodeRabbit manually on the projects you wish, as the next step. #### [​](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#2-manual-onboarding) 2\. Manual onboarding For the manual onboarding process we need to create the [CodeRabbit user](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#creating-coderabbit-user) and the [OAuth2 GitLab application](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#creating-oauth2-application) . ![Self-managed GitLab connection page](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/manual-onboarding-cbcc14b5298275dad4d9484ae7bb0201.png) #### [​](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#creating-coderabbit-user) **Creating CodeRabbit user** This feature will work with any user from your organization, but we strongly suggest creating a dedicated user called **CodeRabbitAI**. This ensures clarify about which user is used for our application and allows for better fine-grained access control. To create users in GitLab, log in with an instance admin account and follow the steps provided in the [GitLab documentation](https://docs.gitlab.com/ee/user/profile/account/create_accounts.html#create-users-in-admin-area) . After the user is created, you can retrieve the **User ID** from that user’s profile and generate an [**access token**](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#generating-personal-access-token) . The access token is used to post reviews on merge requests. If you prefer, you can create a Group Access Token which will create a dedicated user on your behalf. For more information, see [Group Access Token](https://docs.coderabbit.ai/platforms/gitlab-com#group-access-token) We recommend using the CodeRabbit [logo](https://docs.coderabbit.ai/assets/files/logo-144a28a895bdf0158c57d2cb016780d8.png) as the profile picture to ensures easy recognition. #### [​](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#creating-oauth2-application) **Creating OAuth2 application** For self-managed GitLab, we recommend creating an instance-wide application unless you want the reviews to be limited to a single group or user. Please follow the steps outlined in the [GitLab documentation](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-an-instance-wide-application) for creating the application. Requirements: 1. Scopes: `api read_user email openid` 2. Callback URL: `https://app.coderabbit.ai/login` #### [​](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#generating-personal-access-token) **Generating Personal Access token** GitLab offers an option to generate a personal access token for adding a new user and setting up the application in the self-managed instance. To generate the token, please follow the process outlined below: 1. Login to your self-hosted instance. For [automated onboarding](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#1-automated-onboarding) ensure you have admin rights. 2. On the left sidebar, select your avatar. 3. Select Edit profile. 4. On the left sidebar, select Access Tokens. 5. Select Add new token. 6. Enter a name and expiry date for the token. We need this for the initial setup, so the minimum expiry time is sufficient. 7. If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date. 8. Make sure, you select the scopes: `api read_api read_user` 9. Select Create personal access token. 10. Please note down this token as this will be visible one time only ![GitLab personal access token configuration page](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/admin-access-token-af3409806464ede4a0ca595ae6d55cb5.png) ### [​](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#step-4%3A-paste-the-details-and-click-submit) **Step 4: Paste the details and click submit** * Submit the form. * We will handle the setup process for you. * On subsequent visits, your setup will be automatically detected, allowing for direct login. ![CodeRabbit authentication options page](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/self-hosted-page-2a7e05c97d521f766915edb8223b2dd9.png) ### [​](https://docs.coderabbit.ai/platforms/self-hosted-gitlab#step-5%3A-whitelist-coderabbit-ip-address) **Step 5: Whitelist CodeRabbit IP address** 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 [\[email protected\]](https://docs.coderabbit.ai/cdn-cgi/l/email-protection#bfcccacfcfd0cdcbffdcd0dbdacddeddddd6cb91ded6) if you are interested. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/platforms/self-hosted-gitlab.md) Last updated on **Jul 31, 2025** [GitLab](https://docs.coderabbit.ai/platforms/gitlab-com) [Azure DevOps](https://docs.coderabbit.ai/platforms/azure-devops) Assistant Responses are generated using AI and may contain mistakes. --- # New Features and Improvements - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation New Features and Improvements On this page * [New Features and Improvements](https://docs.coderabbit.ai/changelog/new-features-and-improvements-1#new-features-and-improvements) * [Sequence Diagrams](https://docs.coderabbit.ai/changelog/new-features-and-improvements-1#sequence-diagrams) * [Auto-Generate PR Titles](https://docs.coderabbit.ai/changelog/new-features-and-improvements-1#auto-generate-pr-titles) * [New Commands](https://docs.coderabbit.ai/changelog/new-features-and-improvements-1#new-commands) * [Improved Handling of Closed PRs](https://docs.coderabbit.ai/changelog/new-features-and-improvements-1#improved-handling-of-closed-prs) ### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements-1#new-features-and-improvements) New Features and Improvements #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements-1#sequence-diagrams) Sequence Diagrams CodeRabbit now generates sequence diagrams for code changes, providing reviewers with a clear visualization of the control flow for improved understanding. #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements-1#auto-generate-pr-titles) Auto-Generate PR Titles A new option, `auto_title_placeholder`, is now available and defaults to `@coderabbitai` title. This feature allows users to set a placeholder title, enabling CodeRabbit to automatically generate an appropriate title when the review process begins. #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements-1#new-commands) New Commands We have introduced new commands for interacting with CodeRabbit, detailed under the “Tips” section of a review walkthrough: * `@coderabbitai full review`: Conducts a full review from scratch, covering all files again * `@coderabbitai summary`: Regenerates the summary of the PR * `@coderabbitai configuration`: Displays the current CodeRabbit configuration for the repository #### [​](https://docs.coderabbit.ai/changelog/new-features-and-improvements-1#improved-handling-of-closed-prs) Improved Handling of Closed PRs We have been observing that many PRs get closed quickly and CodeRabbit continues to review them. PRs get closed quickly for various reasons - changes are too small, the author is confident (perhaps, overly?), or the changes were unnecessary. With this improvement, we now stop the review process midway if we detect that the PR has been closed. Assistant Responses are generated using AI and may contain mistakes. --- # Path-Based Review Instructions - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Path-Based Review Instructions On this page * [Path-Based Review Instructions](https://docs.coderabbit.ai/changelog/path-based-review-instructions#path-based-review-instructions) ### [​](https://docs.coderabbit.ai/changelog/path-based-review-instructions#path-based-review-instructions) Path-Based Review Instructions This section explains how to add custom code review instructions for the entire project or specific file paths in your project using glob patterns. Developers can provide tailored review guidelines based on the file paths. These instructions are needed only if you want the reviewer to follow specific instructions besides the standard review. Adding file path prompts allows developers to specify custom instructions for different parts of the codebase. For example, you may want to enforce style guide by file types or directories. Sample Usage: Copy path: **/*.js instructions: Review the javascript code against the google javascript style guide and point out any mismatches Copy path: tests/**.* instructions: Review the following unit test code written using the Mocha test library. Ensure that: The code adheres to best practices associated with Mocha. Descriptive test names are used to clearly convey the intent of each test. > Note: > > * Paths accept glob patterns > * Instructions generally work well for specific additional instructions. However, they are not that effective if you are instructing AI not to do something > * Test the review feedback on pull requests and tailor as necessary Assistant Responses are generated using AI and may contain mistakes. --- # GitHub - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported Git platforms GitHub On this page * [Before you begin​](https://docs.coderabbit.ai/platforms/github-com#before-you-begin%E2%80%8B) * [Authorize CodeRabbit with your GitHub account​](https://docs.coderabbit.ai/platforms/github-com#authorize-coderabbit-with-your-github-account%E2%80%8B) * [Allow CodeRabbit to access your repositories​](https://docs.coderabbit.ai/platforms/github-com#allow-coderabbit-to-access-your-repositories%E2%80%8B) * [Overview of required permissions​](https://docs.coderabbit.ai/platforms/github-com#overview-of-required-permissions%E2%80%8B) * [Grant required permissions​](https://docs.coderabbit.ai/platforms/github-com#grant-required-permissions%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/platforms/github-com#what%E2%80%99s-next%E2%80%8B) For an overview of how CodeRabbit integrates with Git platforms, see [Add CodeRabbit to your repository](https://docs.coderabbit.ai/platforms) . For a hands-on tutorial with CodeRabbit performing code reviews on a live GitHub repository that you create, see [Quickstart](https://docs.coderabbit.ai/getting-started/quickstart) . [​](https://docs.coderabbit.ai/platforms/github-com#before-you-begin%E2%80%8B) Before you begin[​](https://docs.coderabbit.ai/platforms/github-com#before-you-begin "Direct link to Before you begin") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You need to have a GitHub account, and ownership-level permissions of at least one repository associated with that account. If you want to authorize CodeRabbit to write code reviews for a repository contained in a GitHub organization, then you need ownership-level permission with that organization, as well. [​](https://docs.coderabbit.ai/platforms/github-com#authorize-coderabbit-with-your-github-account%E2%80%8B) Authorize CodeRabbit with your GitHub account[​](https://docs.coderabbit.ai/platforms/github-com#authorize-coderabbit-with-your-github-account "Direct link to Authorize CodeRabbit with your GitHub account") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Before you can use CodeRabbit with GitHub, you need to authorize CodeRabbit with your GitHub account. To do this, follow these steps: 1. Visit [the CodeRabbit login page](https://app.coderabbit.ai/login) . 2. Click **Login with GitHub**. Your browser navigates to GitHub.com. 3. If GitHub prompts to sign in to your GitHub account before continuing, then enter your GitHub login credentials as you normally would. Otherwise, continue to the next step. 4. GitHub displays a summary of the information that CodeRabbit needs in order to integrate with your GitHub account. This includes read-only access to the following: * Organizations and teams that are associated with your GitHub account. * Email addresses that are associated with your GitHub account. To allow CodeRabbit access to this information, click **Authorize coderabbitai**. After you complete these steps, your browser navigates to the CodeRabbit web interface. Now that you’ve integrated CodeRabbit with your GitHub account, you need to give CodeRabbit additional permissions to work with your code repositories. To do this, see the next section. [​](https://docs.coderabbit.ai/platforms/github-com#allow-coderabbit-to-access-your-repositories%E2%80%8B) Allow CodeRabbit to access your repositories[​](https://docs.coderabbit.ai/platforms/github-com#allow-coderabbit-to-access-your-repositories "Direct link to Allow CodeRabbit to access your repositories") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Even after you’ve integrated CodeRabbit with your GitHub account, you need to separately grant CodeRabbit the permissions that it needs to post code reviews and create pull requests in your repositories. You need to authorize CodeRabbit separately for each GitHub organization whose repositories you want it to work with. You can give CodeRabbit permission to work with all of the repositories associated with a GitHub organization, or limit its access to a select list. ### [​](https://docs.coderabbit.ai/platforms/github-com#overview-of-required-permissions%E2%80%8B) Overview of required permissions[​](https://docs.coderabbit.ai/platforms/github-com#overview-of-required-permissions "Direct link to Overview of required permissions") CodeRabbit requires the following permissions to work with your repositories: * Read-only access to actions, checks, discussions, members, and metadata. * Read-and-write access to code, commit statuses, issues, and pull requests. CodeRabbit requests read and write access to your repository in order for its code review, issue management, and pull request generation features to work. CodeRabbit never stores your code. For more information, see [the CodeRabbit Trust Center](https://trust.coderabbit.ai/) . ### [​](https://docs.coderabbit.ai/platforms/github-com#grant-required-permissions%E2%80%8B) Grant required permissions[​](https://docs.coderabbit.ai/platforms/github-com#grant-required-permissions "Direct link to Grant required permissions") To give CodeRabbit access to one or more of your repositories, follow these steps: 1. Visit [the CodeRabbit web interface](https://app.coderabbit.ai/settings/repositories) . 2. Make sure that the correct GitHub organization for the repository is displayed at the top of the web interface. To change the organization, click **Change Organization** and select a different organization from the list. If the repositories that you want to add are associated directly with your GitHub account, and not a separate organization, then select your account name as the organization. If the organization containing the repository doesn’t appear in the list, then you might need to refresh the list of organizations that CodeRabbit has associated with your GitHub account. For more information, see [Add organizations](https://docs.coderabbit.ai/getting-started/adding-organizations) . 3. Click the **Add Repositories** button. Your browser navigates to GitHub.com. If the selected organization has no repositories registered with CodeRabbit, then your browser displays a CodeRabbit permissions dialog for setting up a new integration. Proceed to the next step. Otherwise, your browser displays a GitHub settings page for your organization’s existing CodeRabbit integration. Scroll down to the section titled **Repository access**, and then proceed to the next step. 4. Select which repositories you’d like to allow CodeRabbit to write code reviews for. To give CodeRabbit access to all repositories in the organization, select **All repositories**. This also automatically grants CodeRabbit access to all repositories added to the organization in the future. To give CodeRabbit access to specific, limited list of repositories, select **Only select repositories**, and then choose repositories from the list. You can change this setting later. 5. Click the button at the bottom of the form, which has one of the following labels, depending upon context: * **Install & Authorize**, if this organization has no repositories integrated with CodeRabbit, and you are an owner of this organization. * **Save**, if this organization already has repositories integrated with CodeRabbit 6. If you are integrating an organization with CodeRabbit for the first time, then your browser navigates back to the CodeRabbit web interface. Otherwise, your browser remains on your GitHub settings page, and you can manually navigate [back to the CodeRabbit web interface](https://app.coderabbit.ai/settings/repositories) . [​](https://docs.coderabbit.ai/platforms/github-com#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/platforms/github-com#whats-next "Direct link to What's next") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Set your repository preferences](https://docs.coderabbit.ai/guides/repository-settings) * [Review pull requests](https://docs.coderabbit.ai/guides/code-review-overview) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/platforms/github-com.md) Last updated on **Jul 31, 2025** [Overview](https://docs.coderabbit.ai/platforms/overview) [GitHub Enterprise Server](https://docs.coderabbit.ai/platforms/github-enterprise-server) Assistant Responses are generated using AI and may contain mistakes. --- # Overview - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Add CodeRabbit to your repository Overview On this page * [Use CodeRabbit with Git platforms​](https://docs.coderabbit.ai/platforms/overview#use-coderabbit-with-git-platforms%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/platforms/overview#what%E2%80%99s-next%E2%80%8B) [​](https://docs.coderabbit.ai/platforms/overview#use-coderabbit-with-git-platforms%E2%80%8B) Use CodeRabbit with Git platforms[​](https://docs.coderabbit.ai/platforms/overview#use-coderabbit-with-git-platforms "Direct link to Use CodeRabbit with Git platforms") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- CodeRabbit integrates with the following Git platforms: * [GitHub.com](https://docs.coderabbit.ai/platforms/github-com) * [GitHub Enterprise Server](https://docs.coderabbit.ai/platforms/github-enterprise-server) * [GitLab.com](https://docs.coderabbit.ai/platforms/gitlab-com) * [Self-managed GitLab](https://docs.coderabbit.ai/platforms/self-hosted-gitlab) * [Azure DevOps](https://docs.coderabbit.ai/platforms/azure-devops) * [BitBucket Cloud](https://docs.coderabbit.ai/platforms/bitbucket-cloud) * [BitBucket Data Center](https://docs.coderabbit.ai/self-hosted/bitbucket) CodeRabbit also offers a self-hosted option available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](https://docs.coderabbit.ai/cdn-cgi/l/email-protection#c4b7a5a8a1b784a7aba0a1b6a5a6a6adb0eaa5ad) to learn more about the CodeRabbit Enterprise plan. The exact steps for each platform are outlined in the pages linked above. That said, integrating any Git platform with CodeRabbit follows this general pattern: 1. Log into CodeRabbit using your Git platform account. 2. Add the organizations containing the repositories that you want CodeRabbit to work with. You generally need ownership-level permissions with these organizations. (Different Git platforms might call their organizations different things, such as “groups” in GitLab and “workspaces” in BitBucket.) 3. Create a dedicated CodeRabbit service account on your Git platform, if needed. We handle this step for you on some platforms, such as GitHub.com. 4. Grant CodeRabbit the permissions that it needs to work with one or more of the repositories that you have ownership-level access to. After you finish integrating CodeRabbit with one or more repositories, you can [start using CodeRabbit immediately](https://docs.coderabbit.ai/guides/code-review-overview) using its default configuration, which automatically reviews or summarizes new pull requests. You can also [customize CodeRabbit’s configuration](https://docs.coderabbit.ai/guides/configuration-overview) to suit your team’s needs. [​](https://docs.coderabbit.ai/platforms/overview#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/platforms/overview#whats-next "Direct link to What's next") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Integrate CodeRabbit with GitHub.com](https://docs.coderabbit.ai/platforms/github-com) * [Integrate CodeRabbit with GitHub Enterprise Server](https://docs.coderabbit.ai/platforms/github-enterprise-server) * [Integrate CodeRabbit with GitLab.com](https://docs.coderabbit.ai/platforms/gitlab-com) * [Integrate CodeRabbit with Self-managed GitLab](https://docs.coderabbit.ai/platforms/self-hosted-gitlab) * [Integrate CodeRabbit with Azure DevOps](https://docs.coderabbit.ai/platforms/azure-devops) * [Integrate CodeRabbit with BitBucket Cloud](https://docs.coderabbit.ai/platforms/bitbucket-cloud) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/platforms/platforms.md) Last updated on **Jul 31, 2025** [Quickstart](https://docs.coderabbit.ai/getting-started/quickstart) [GitHub](https://docs.coderabbit.ai/platforms/github-com) Assistant Responses are generated using AI and may contain mistakes. --- # GitHub Enterprise Server - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported Git platforms GitHub Enterprise Server On this page * [Step 1: Getting Started​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-1%3A-getting-started%E2%80%8B) * [Step 2: GitHub OAuth App​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-2%3A-github-oauth-app%E2%80%8B) * [Step 3: GitHub App​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-3%3A-github-app%E2%80%8B) * [Step 4: CodeRabbit UI Onboarding​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-4%3A-coderabbit-ui-onboarding%E2%80%8B) * [Step 5: Install the GitHub App​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-5%3A-install-the-github-app%E2%80%8B) * [Step 6: Whitelist CodeRabbit IP address​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-6%3A-whitelist-coderabbit-ip-address%E2%80%8B) * [FAQ​](https://docs.coderabbit.ai/platforms/github-enterprise-server#faq%E2%80%8B) * [Who should create the OAuth App and GitHub App?​](https://docs.coderabbit.ai/platforms/github-enterprise-server#who-should-create-the-oauth-app-and-github-app%3F%E2%80%8B) * [I see an error when trying to log in to CodeRabbit. What should I do?​](https://docs.coderabbit.ai/platforms/github-enterprise-server#i-see-an-error-when-trying-to-log-in-to-coderabbit-what-should-i-do%3F%E2%80%8B) This page is for GitHub Enterprise Server (Self-Hosted) users only. If you’re using `github.com`, [log in to CodeRabbit](https://app.coderabbit.ai/) and add your repositories from there This page guides you through the process of integrating your Self-Managed GitHub with CodeRabbit. To initiate the integration, we require specific information. This is essential for the initial setup of CodeRabbit within your domain. Once this setup is complete, you can log in directly. ### [​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-1%3A-getting-started%E2%80%8B) **Step 1: Getting Started**[​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-1-getting-started "Direct link to step-1-getting-started") **Visit CodeRabbit:** Visit our [Login](https://app.coderabbit.ai/login?free-trial) page and select Self-Hosted GitHub ![CodeRabbit login page](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/login-self-hosted-github-8cee6b0f0cf32ccc3debec2b2f4b4bf2.png) On this page, enter the URL of your self-managed GitHub instance and click submit. Once, you submit, we check our database for a record of your organization and if we find an existing one, we will start the login process. ![Self-hosted gitHub enterprise connection page for CodeRabbit](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/self-hosted-github-host-url-53103045459a115d12f02cdf4a909903.png) If the self-managed GitHub instance is not found, you will be required to enter more details for the onboarding. ### [​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-2%3A-github-oauth-app%E2%80%8B) **Step 2: GitHub OAuth App**[​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-2-github-oauth-app "Direct link to step-2-github-oauth-app") Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the steps below to [create an OAuth App](https://docs.github.com/en/enterprise-server@latest/apps/oauth-apps/building-oauth-apps/creating-an-oauth-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**. 3. In the left sidebar, click **Developer settings** > **OAuth Apps**. 4. Click **New OAuth App**. 5. Set the following fields: * **Application name**: `CodeRabbit OAuth` * **Homepage URL**: `https://coderabbit.ai` * **Application description**: `OAuth application for signing into CodeRabbit` * **Authorization callback URL**: `https://app.coderabbit.ai/login` 6. Click **Register application**. ![GitHub Create OAuth App](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/github-create-oauth-app-077c7106af8e90d18d94020117ddda56.png) Once the OAuth App has been created, click on **Generate a new client secret** under the ‘Client secrets’ section and copy the secret as it will be visible once only Keep the following details handy: * Client ID * Client secret ![GitHub OAuth Client ID & Secret](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/github-oauth-client-id-secret-d66f1e5a02405a6db2e45fbfdc552f74.png) ### [​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-3%3A-github-app%E2%80%8B) **Step 3: GitHub App**[​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-3-github-app "Direct link to step-3-github-app") Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the 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**. 3. In the left sidebar, click **Developer settings** > **GitHub Apps** 4. Click **New GitHub App**. 5. Set the following fields: * **GitHub App name**: `CodeRabbit` * **Description**: `GitHub App for CodeRabbit` * **Homepage URL**: `https://coderabbit.ai` * **Callback URL**: `https://app.coderabbit.ai/login` * **Request user authorization (OAuth) during installation**: `true` * **Webhook Active**: `true` * **Webhook URL**: `https://app.coderabbit.ai/githubHandler` * **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 * **Pull requests**: Read and write * **Organization permissions**: * **Members**: Read-only * **Events**: * Meta * Issue comment * Issues * Label * Public * Pull request * Pull request review * Pull request review comment * 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** under the ‘Client secrets’ section and copy the secret as it will be visible once only. Scroll down and click on **Generate a private key** under the ‘Private keys’ section and download the PEM file. Keep the following details handy: * App ID * Client ID * Client secret * Webhook secret * Private key ![GitHub App Client ID & Secret](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/platforms/assets/images/github-app-client-id-secret-fe5cb86d1444d714f2e02edacf7896e4.png) We recommend using the CodeRabbit [logo](https://docs.coderabbit.ai/assets/files/logo-144a28a895bdf0158c57d2cb016780d8.png) as the profile picture to ensures easy recognition. ### [​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-4%3A-coderabbit-ui-onboarding%E2%80%8B) **Step 4: CodeRabbit UI Onboarding**[​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-4-coderabbit-ui-onboarding "Direct link to step-4-coderabbit-ui-onboarding") Submit the details that were accumulated in previous steps: * Host URL of your GitHub instance * OAuth Client ID * OAuth Client Secret * GitHub App ID * GitHub App Client ID * GitHub App Client Secret * GitHub App Webhook Secret * GitHub App Private Key Click on Submit and the login process will be initiated. On subsequent visits, your setup will be automatically detected, allowing for direct login. ### [​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-5%3A-install-the-github-app%E2%80%8B) **Step 5: Install the GitHub App**[​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-5-install-the-github-app "Direct link to step-5-install-the-github-app") Navigate to the GitHub App that was created from your GitHub Enterprise Server (self-hosted) instance and click on the **Install App** tab. Then, install the GitHub App to your organization(s). If you performed this step before Step 4, the installation event likely will have failed, and you will need to re-send the installation event. Navigate to the **Advanced** tab in the GitHub App and click on the **Redeliver** button for the failed `installation.created` event. ### [​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-6%3A-whitelist-coderabbit-ip-address%E2%80%8B) **Step 6: Whitelist CodeRabbit IP address**[​](https://docs.coderabbit.ai/platforms/github-enterprise-server#step-6-whitelist-coderabbit-ip-address "Direct link to step-6-whitelist-coderabbit-ip-address") 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 [\[email protected\]](https://docs.coderabbit.ai/cdn-cgi/l/email-protection#fc8f898c8c938e88bc9f9398998e9d9e9e9588d29d95) if you are interested. ### [​](https://docs.coderabbit.ai/platforms/github-enterprise-server#faq%E2%80%8B) **FAQ**[​](https://docs.coderabbit.ai/platforms/github-enterprise-server#faq "Direct link to faq") #### [​](https://docs.coderabbit.ai/platforms/github-enterprise-server#who-should-create-the-oauth-app-and-github-app%3F%E2%80%8B) Who should create the OAuth App and GitHub App?[​](https://docs.coderabbit.ai/platforms/github-enterprise-server#who-should-create-the-oauth-app-and-github-app "Direct link to 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. #### [​](https://docs.coderabbit.ai/platforms/github-enterprise-server#i-see-an-error-when-trying-to-log-in-to-coderabbit-what-should-i-do%3F%E2%80%8B) I see an error when trying to log in to CodeRabbit. What should I do?[​](https://docs.coderabbit.ai/platforms/github-enterprise-server#i-see-an-error-when-trying-to-log-in-to-coderabbit-what-should-i-do "Direct link to 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. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/platforms/github-enterprise-server.md) Last updated on **Jul 31, 2025** [GitHub](https://docs.coderabbit.ai/platforms/github-com) [GitLab](https://docs.coderabbit.ai/platforms/gitlab-com) Assistant Responses are generated using AI and may contain mistakes. --- # Linters & security analysis tools - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Configure Linters & security analysis tools On this page * [Enabling/Disabling Tools](https://docs.coderabbit.ai/tools/index#enabling%2Fdisabling-tools) * [Customizing Tools](https://docs.coderabbit.ai/tools/index#customizing-tools) * [Checking Tool Output](https://docs.coderabbit.ai/tools/index#checking-tool-output) * [What’s next](https://docs.coderabbit.ai/tools/index#what%E2%80%99s-next) For a complete list of tools that CodeRabbit supports, see [supported tools](https://docs.coderabbit.ai/tools/list) . This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. CodeRabbit supports various linters and security analysis tools to improve the code review process. The output of these tools is used to enhance the feedback provided by CodeRabbit, making it possible to provide 1-click fixes for common issues. All tool runs are done in a secure sandboxed execution environment. [​](https://docs.coderabbit.ai/tools/index#enabling%2Fdisabling-tools) Enabling/Disabling Tools -------------------------------------------------------------------------------------------------- You can enable or disable tools by setting `reviews.tools..enabled` in your project’s `.coderabbit.yaml` file or setting the “Review → Tools → Tool → Enabled” field in CodeRabbit’s settings page. [​](https://docs.coderabbit.ai/tools/index#customizing-tools) Customizing Tools ---------------------------------------------------------------------------------- CodeRabbit supports customizing the strictness of tools by setting `reviews.profile` in your project’s `.coderabbit.yaml` file or setting the “Review → Profile” field in CodeRabbit’s settings page. The following profiles are available: * `Chill` - Yields less feedback, that may be considered lenient. * `Assertive` - Yields more feedback, that may be considered nit-picky. Apart from the overall profile, you can also configure each tool by providing a path to a configuration file (specific to the tool) in your project. This would allow you to further customize the tool’s behavior, by enabling/disabling specific rules, setting rule severity, etc. [​](https://docs.coderabbit.ai/tools/index#checking-tool-output) Checking Tool Output ---------------------------------------------------------------------------------------- When a tool is enabled, CodeRabbit will run it on your change request and attach the output under “Review details” comment in the change request. The output will be displayed in a structured format, with information on the file, line number, and the issue detected. For example: Copy Ruff fib.py 21-21: f-string without any placeholders Remove extraneous f prefix (F541) [​](https://docs.coderabbit.ai/tools/index#what%E2%80%99s-next) What’s next ------------------------------------------------------------------------------ * For a complete list of tools that CodeRabbit supports, see [Supported tools](https://docs.coderabbit.ai/tools/list) . [Review instructions](https://docs.coderabbit.ai/guides/review-instructions) [Manage your subscription](https://docs.coderabbit.ai/getting-started/subscription-management) Assistant Responses are generated using AI and may contain mistakes. --- # Configuration file template - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Reference Configuration file template If used as-is as a `.coderabbit.yaml` file, then this template sets the default, recommended values for [all CodeRabbit repository options](https://docs.coderabbit.ai/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](https://docs.coderabbit.ai/getting-started/configure-coderabbit) . For a general overview of CodeRabbit configuration, see [Configure CodeRabbit](https://docs.coderabbit.ai/guides/configuration-overview) . Config template Copy # 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: "" [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/reference/yaml-template.md) Last updated on **Jul 31, 2025** [Configuration reference](https://docs.coderabbit.ai/reference/configuration) [List of supported tools](https://docs.coderabbit.ai/tools/list) Assistant Responses are generated using AI and may contain mistakes. --- # Why CodeRabbit? - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Resources Why CodeRabbit? On this page * [CodeRabbit is AI-Powered](https://docs.coderabbit.ai/overview/why-coderabbit#coderabbit-is-ai-powered) * [CodeRabbit is Context-Aware](https://docs.coderabbit.ai/overview/why-coderabbit#coderabbit-is-context-aware) * [CodeRabbit is Adaptive](https://docs.coderabbit.ai/overview/why-coderabbit#coderabbit-is-adaptive) * [Real-World Example: Performance Optimization](https://docs.coderabbit.ai/overview/why-coderabbit#real-world-example%3A-performance-optimization) * [How CodeRabbit Adapts](https://docs.coderabbit.ai/overview/why-coderabbit#how-coderabbit-adapts) * [CodeRabbit is Integrated](https://docs.coderabbit.ai/overview/why-coderabbit#coderabbit-is-integrated) * [Tool Comparison](https://docs.coderabbit.ai/overview/why-coderabbit#tool-comparison) * [Impact on Your Workflow](https://docs.coderabbit.ai/overview/why-coderabbit#impact-on-your-workflow) * [Start Reviewing Code in Seconds](https://docs.coderabbit.ai/overview/why-coderabbit#start-reviewing-code-in-seconds) * [Three Steps to Better Code Reviews](https://docs.coderabbit.ai/overview/why-coderabbit#three-steps-to-better-code-reviews) * [What You’ll Get](https://docs.coderabbit.ai/overview/why-coderabbit#what-you%E2%80%99ll-get) * [Quick Configuration Examples](https://docs.coderabbit.ai/overview/why-coderabbit#quick-configuration-examples) * [See the Difference](https://docs.coderabbit.ai/overview/why-coderabbit#see-the-difference) * **To build the best code review experience in the tech** > This continues to be our core mission. It was clear to us then, as it is now, that development workflows are becoming increasingly complex — and teams need intelligent automation to maintain quality while moving fast. * **In an ever-evolving tech space, we believe AI-powered code review is the future** > Just like Git revolutionized version control and CI/CD transformed deployments, we believe AI-assisted code review will become the standard for quality assurance. * **An insight that modern code review can be reimagined** We call this approach _contextual analysis_, which allows us to understand not just the code changes, but their implications across your entire codebase. This enables us to provide insights about: * Security vulnerabilities * Performance impacts * Architectural changes * Best practices * Knowledge sharing * **The conviction that our AI can provide a better Developer Experience (DevX)** Features such as: * Instant analysis * On-demand Reports * Review Instructions * CodeRabbit Commands * PR summary on the fly * Visual diagrams * Docstrings generation * Custom review rules > All these features improve the developer experience by reducing review time, maintaining consistency, and sharing knowledge effectively across teams. These are CodeRabbit’s foundational principles, but given the many _code review tools_ available today, let’s explore why **you** should choose CodeRabbit: * * * [​](https://docs.coderabbit.ai/overview/why-coderabbit#coderabbit-is-ai-powered) CodeRabbit is AI-Powered ============================================================================================================ 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](https://docs.coderabbit.ai/tools) > . 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. [​](https://docs.coderabbit.ai/overview/why-coderabbit#coderabbit-is-context-aware) CodeRabbit is Context-Aware ------------------------------------------------------------------------------------------------------------------ An AI architecture built for understanding, reliability, and efficiency 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. ![CodeRabbit Review comment on a Auth Flow](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/overview/assets/images/why-cr-auth-flow-cors-ebcb721dafe154abd970bfb2ac587329.png "CodeRabbit Code Review Comment") CodeRabbit’s AI can detect potential issues that would only surface in production, saving costly debugging time later. [​](https://docs.coderabbit.ai/overview/why-coderabbit#coderabbit-is-adaptive) 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. ### [​](https://docs.coderabbit.ai/overview/why-coderabbit#real-world-example%3A-performance-optimization) Real-World Example: Performance Optimization Here’s a real example of how CodeRabbit identifies opportunities for performance improvement: * Before - Sequential Processing * After - Batch Processing Copy const createdTools = await Promise.all( tools.map(async (tool) => { return prisma.tool.create({ data: { name: tool.name, description: tool.description, headline: tool.headline, features: tool.features, logo: tool.name, categories: tool.categories || [], tags: tool.tags || [], stars: tool.stars || 0, forks: tool.forks || 0, lastUpdated: new Date(), websiteUrl: tool.websiteUrl, githubUrl: tool?.githubUrl, documentation: tool?.documentation }, }); }) ); The current implementation processes each tool creation sequentially. Consider using Prisma’s `createMany` for better performance. This batch operation can significantly reduce database round trips and improve overall execution time.[View Example PR](https://github.com/tyaga001/devtoolsacademy/pull/44) ### [​](https://docs.coderabbit.ai/overview/why-coderabbit#how-coderabbit-adapts) How CodeRabbit Adapts When suggesting improvements, CodeRabbit: 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 ![CodeRabbit Learnings](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/overview/assets/images/why-cr-learnings-a0273c68f2214d44c08a03b99775c4f1.png "How CodeRabbit learns and remembers org standards") 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. [​](https://docs.coderabbit.ai/overview/why-coderabbit#coderabbit-is-integrated) CodeRabbit is Integrated ------------------------------------------------------------------------------------------------------------ Seamless integration with your existing workflow. CodeRabbit combines insights from multiple specialized tools into a single, coherent review: Security -------- Semgrep, Checkov Style ----- ESLint, Prettier Performance ----------- Lighthouse Dependencies ------------ Dependabot But instead of flooding you with alerts, CodeRabbit provides curated, actionable feedback. [​](https://docs.coderabbit.ai/overview/why-coderabbit#tool-comparison) Tool Comparison ------------------------------------------------------------------------------------------ * CodeRabbit * Traditional Tools * ✅ Most comprehensive and detailed code analysis * ✅ Committable Suggestion * ✅ Context-aware feedback * ✅ Adaptive learning * ✅ Strong data protection policies * ✅ Chat capabilities with detailed explanations [​](https://docs.coderabbit.ai/overview/why-coderabbit#impact-on-your-workflow) Impact on Your Workflow ---------------------------------------------------------------------------------------------------------- When a developer opens a pull request, CodeRabbit comes into action: 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 CodeRabbit is built for production environments with: * SOC 2 Type II certification * GDPR compliance * Zero data retention * Self-hosted options [​](https://docs.coderabbit.ai/overview/why-coderabbit#start-reviewing-code-in-seconds) Start Reviewing Code in Seconds -------------------------------------------------------------------------------------------------------------------------- > 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. ### [​](https://docs.coderabbit.ai/overview/why-coderabbit#three-steps-to-better-code-reviews) Three Steps to Better Code Reviews 1. **Sign in** with [GitHub](https://docs.coderabbit.ai/platforms/github-com) , [GitLab](https://docs.coderabbit.ai/platforms/gitlab-com) , or [Azure DevOps](https://docs.coderabbit.ai/platforms/azure-devops) 2. Select and add repositories in CodeRabbit dashboard 3. That’s it. You’re good to go. CodeRabbit starts analyzing your first pull request immediately - no complex configuration needed. ### [​](https://docs.coderabbit.ai/overview/why-coderabbit#what-you%E2%80%99ll-get) What You’ll Get 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 ### [​](https://docs.coderabbit.ai/overview/why-coderabbit#quick-configuration-examples) Quick Configuration Examples * GitHub Copy # Example GitHub Reviews https://github.com/appsmithorg/appsmith/pull/38270 https://github.com/tyaga001/devtoolsacademy/pull/44 https://github.com/openreplay/openreplay/pull/1858 # Browse All Reviews https://github.com/search?q=coderabbitai&type=pullrequests Need help? read [quickstart](https://docs.coderabbit.ai/getting-started/quickstart) or ask a question in [Discord community](https://discord.gg/coderabbit) , and team is here to help. [​](https://docs.coderabbit.ai/overview/why-coderabbit#see-the-difference) See the Difference ------------------------------------------------------------------------------------------------ Try CodeRabbit on your next pull request. Experience how AI-powered code review can: * Reduce review time by up to 90% * Catch bugs before they reach production * Share knowledge across your team * Maintain consistent code quality > Start reading more about the custom [code review instructions](https://docs.coderabbit.ai/guides/review-instructions) > or how CodeRabbit verify issues using [knowledge bases](https://docs.coderabbit.ai/integrations/knowledge-base) > like Linear and Jira. 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. [Sign Up Free](https://app.coderabbit.ai/login?free-trial) | [Join Discord](https://discord.gg/coderabbit) [On-prem CodeRabbit & Bitbucket Datacenter](https://docs.coderabbit.ai/self-hosted/bitbucket) [FAQs](https://docs.coderabbit.ai/faq) Assistant Responses are generated using AI and may contain mistakes. --- # Introduction - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Introduction On this page * [Core features​](https://docs.coderabbit.ai/home#core-features%E2%80%8B) * [Seamless workflow integration​](https://docs.coderabbit.ai/home#seamless-workflow-integration%E2%80%8B) * [Customizable review preferences​](https://docs.coderabbit.ai/home#customizable-review-preferences%E2%80%8B) * [Git platform integration​](https://docs.coderabbit.ai/home#git-platform-integration%E2%80%8B) * [Issue-management integration​](https://docs.coderabbit.ai/home#issue-management-integration%E2%80%8B) * [Data privacy and security​](https://docs.coderabbit.ai/home#data-privacy-and-security%E2%80%8B) * [Flexible pricing, free for public repositories​](https://docs.coderabbit.ai/home#flexible-pricing%2C-free-for-public-repositories%E2%80%8B) * [Review local changes from within VSCode​](https://docs.coderabbit.ai/home#review-local-changes-from-within-vscode%E2%80%8B) * [What’s next​](https://docs.coderabbit.ai/home#what%E2%80%99s-next%E2%80%8B) **CodeRabbit** is an AI-powered code reviewer that delivers context-aware feedback on pull requests within minutes, reducing the time and effort needed for manual code reviews. It complements manual reviews by providing a fresh perspective and catching issues that manual reviews often miss, enhancing the overall review quality. Developers can interact directly with the CodeRabbit bot within their existing Git platform’s pull request interface to add context, ask questions, or even have the bot generate code. Over time, CodeRabbit learns from user input and improves its suggestions. [YouTube video player](https://www.youtube.com/embed/3SyUOSebG7E?si=i0oT9RAnH0PW81lY) [​](https://docs.coderabbit.ai/home#core-features%E2%80%8B) Core features[​](https://docs.coderabbit.ai/home#core-features "Direct link to Core features") -------------------------------------------------------------------------------------------------------------------------------------------------------------- Core CodeRabbit features include the following: * Integrates rapidly with popular Git platforms and workflows. * Applies dozens of open-source, industry-standard code analyzers to every commit. * Implements code reviews as familiar pull-request comments. * Works with contributors through natural-language conversation in comments. * Learns and adapts to your team’s code style and review preferences. * Provides an observability dashboard of code-contribution activity. * Practices strong privacy and security, with no retention of analyzed code. * Offers free use for public repositories, and flexible pricing for private codebases. [​](https://docs.coderabbit.ai/home#seamless-workflow-integration%E2%80%8B) Seamless workflow integration[​](https://docs.coderabbit.ai/home#seamless-workflow-integration "Direct link to Seamless workflow integration") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ CodeRabbit shares its reviews as comments attached to pull requests, using the same Git platform that your team already uses. Further commits in the same pull review prompt CodeRabbit to make further reviews, using the earlier reviews as context. Each time that it performs a code review, CodeRabbit runs the relevant code changes through [an array of industry-standard code linters, security analyzers, and other tools](https://docs.coderabbit.ai/tools) . CodeRabbit synthesizes the output of these tools into its reviews, offering a high-level analysis that can suggest areas for further focus and improvement. Your team can have conversations with CodeRabbit about its reviews by replying to it with follow-up comments on pull requests, asking it questions or making observations about the review using natural language. CodeRabbit continues the conversation appropriately, offering further insights about the code changes, or adjusting its own review style based on feedback. ### [​](https://docs.coderabbit.ai/home#customizable-review-preferences%E2%80%8B) Customizable review preferences[​](https://docs.coderabbit.ai/home#customizable-review-preferences "Direct link to Customizable review preferences") As you interact with CodeRabbit through chat, it learns the review preferences of your team, and applies them to all future reviews on a given repository. For example, if CodeRabbit uses a linter to suggest that your pull request use four-space indentations, but your team uses a two-space indentation style, then you can reply to CodeRabbit’s pull-request comment to tell it exactly that. CodeRabbit acknowledges your feedback and adjusts all of its subsequent reviews with that repository appropriately. For a video introduction to this feature, see [CodeRabbit Learnings](https://www.youtube.com/watch?v=Yu0cmmOYA-U) . If you need to fine-tune CodeRabbit’s behavior beyond this, then you can [add a CodeRabbit-specific configuration file](https://docs.coderabbit.ai/getting-started/configure-coderabbit) to your repository, or use the CodeRabbit web UI to set further preferences. This file can include [path-based instructions](https://docs.coderabbit.ai/guides/review-instructions) for how CodeRabbit should review different files within your codebase. No matter how you tune and customize CodeRabbit, its default settings make it useful out of the box, able to meaningfully review pull requests within minutes of its introduction to a repository. ### [​](https://docs.coderabbit.ai/home#git-platform-integration%E2%80%8B) Git platform integration[​](https://docs.coderabbit.ai/home#git-platform-integration "Direct link to Git platform integration") CodeRabbit integrates in just a few clicks with many popular Git platforms: * GitHub, GitHub Enterprise Cloud, GitHub Enterprise Server, * GitLab, GitLab Self-Managed * Azure DevOps * Bitbucket Cloud For more information, see [Supported Git Platforms](https://docs.coderabbit.ai/platforms) . ### [​](https://docs.coderabbit.ai/home#issue-management-integration%E2%80%8B) Issue-management integration[​](https://docs.coderabbit.ai/home#issue-management-integration "Direct link to Issue-management integration") You can integrate CodeRabbit with issue-management platforms. This lets you ask CodeRabbit to create tickets during code reviews, or chat with CodeRabbit about your code from within issue comments. Compatible platforms include the following: * GitHub Issues * GitLab Issues * Jira * Linear For more information, see [Issue Creation](https://docs.coderabbit.ai/guides/issue-creation) and [Issue Chat](https://docs.coderabbit.ai/guides/issue-chat) . [​](https://docs.coderabbit.ai/home#data-privacy-and-security%E2%80%8B) Data privacy and security[​](https://docs.coderabbit.ai/home#data-privacy-and-security "Direct link to Data privacy and security") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 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 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. * Our data collection and storage practices comply with SOC 2 and GDPR standards. For more information about how we protect your data, see [the CodeRabbit Trust Center](https://trust.coderabbit.ai/) . [​](https://docs.coderabbit.ai/home#flexible-pricing%2C-free-for-public-repositories%E2%80%8B) Flexible pricing, free for public repositories[​](https://docs.coderabbit.ai/home#flexible-pricing-free-for-public-repositories "Direct link to Flexible pricing, free for public repositories") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Public repositories can use the Pro tier of CodeRabbit at no charge, including all of the code-review features described on this page. Rate limits might apply. 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) . [​](https://docs.coderabbit.ai/home#review-local-changes-from-within-vscode%E2%80%8B) Review local changes from within VSCode[​](https://docs.coderabbit.ai/home#review-local-changes-from-within-vscode "Direct link to 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](https://docs.coderabbit.ai/code-editors) . [​](https://docs.coderabbit.ai/home#what%E2%80%99s-next%E2%80%8B) What’s next[​](https://docs.coderabbit.ai/home#whats-next "Direct link to What's next") ------------------------------------------------------------------------------------------------------------------------------------------------------------- * [Quickstart](https://docs.coderabbit.ai/getting-started/quickstart) lets you experience your first CodeRabbit code review first-hand. * [Review local changes](https://docs.coderabbit.ai/code-editors) guides you through installing and using a subset of CodeRabbit features directly from your code editor. * [Why CodeRabbit?](https://docs.coderabbit.ai/overview/why-coderabbit) dives further into the philosophies and technologies that drive CodeRabbit. [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/overview/introduction.md) Last updated on **Jul 31, 2025** Assistant Responses are generated using AI and may contain mistakes. --- # On-prem CodeRabbit & Azure DevOps - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Self-host CodeRabbit On-prem CodeRabbit & Azure DevOps The self-hosted option is only available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](https://docs.coderabbit.ai/cdn-cgi/l/email-protection#2d5e4c41485e6d4e4249485f4c4f4f4459034c44) to learn more about the CodeRabbit Enterprise plan. [​](https://docs.coderabbit.ai/self-hosted/azure-devops#create-an-azure-devops-user%E2%80%8B) Create an Azure DevOps User[​](https://docs.coderabbit.ai/self-hosted/azure-devops#create-an-azure-devops-user "Direct link to 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](https://docs.coderabbit.ai/assets/files/logo-144a28a895bdf0158c57d2cb016780d8.png) as the profile picture to ensures easy recognition. [​](https://docs.coderabbit.ai/self-hosted/azure-devops#add-user-to-projects%E2%80%8B) Add User to Projects[​](https://docs.coderabbit.ai/self-hosted/azure-devops#add-user-to-projects "Direct link to 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. [​](https://docs.coderabbit.ai/self-hosted/azure-devops#create-a-personal-access-token-for-coderabbit-user%E2%80%8B) Create a Personal Access Token for CodeRabbit user[​](https://docs.coderabbit.ai/self-hosted/azure-devops#create-a-personal-access-token-for-coderabbit-user "Direct link to 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 `AZURE_DEVOPS_BOT_TOKEN`. **Necessary Scopes**: * `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. [​](https://docs.coderabbit.ai/self-hosted/azure-devops#add-the-necessary-webhooks-to-each-project%E2%80%8B) Add the necessary webhooks to each project[​](https://docs.coderabbit.ai/self-hosted/azure-devops#add-the-necessary-webhooks-to-each-project "Direct link to Add the necessary webhooks to each project") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. **Navigate to project’s Service Hooks Page**: Go to the service hooks configuration page in the desired Azure DevOps project. 2. **Add the following webhooks:** 1. Pull request created 2. Pull request updated 3. Pull request commented on 3. **Add Webhook URL**: Enter the URL pointing to the CodeRabbit service, followed by `/azure_webhooks` (e.g., `http://127.0.0.1:8080/azure_webhooks`) for each webhook. [​](https://docs.coderabbit.ai/self-hosted/azure-devops#prepare-an-env-file%E2%80%8B) Prepare an `.env` file[​](https://docs.coderabbit.ai/self-hosted/azure-devops#prepare-an-env-file "Direct link to prepare-an-env-file") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Create an `.env` file with the following content: .env Copy # 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 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= 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= # optionally, use cross-region inference to access models in other regions # if this is set to `true`, CodeRabbit will access models from `us`, `eu`, or `ap` regions based on the AWS_REGION value. AWS_USE_CROSS_REGION_INFERENCE=[] TEMP_PATH=/cache SELF_HOSTED=azure-devops AZURE_DEVOPS_BOT_TOKEN= AZURE_DEVOPS_BOT_USERNAME= CODERABBIT_LICENSE_KEY= CODERABBIT_API_KEY= ENABLE_METRICS=[true] # CodeRabbit - KNOWLEDGE BASE # # Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI. OBJECT_STORE_URI=[] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc. ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features. ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing. ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing. ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing. ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing. ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing. JIRA_HOST=[] JIRA_PAT=[] LINEAR_PAT=[] ENABLE_WEB_SEARCH=[true] PERPLEXITY_API_KEY=[] YAML_CONFIG=[] * If you are using Azure OpenAI, verify that the model deployment names are in the .env file. * Values marked with \[\] are not optional to provide. * You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys. * `YAML_CONFIG` is an optional configuration file that can be used to customize CodeRabbit’s behavior at the deployment level. It takes the same format as the [CodeRabbit YAML configuration](https://docs.coderabbit.ai/getting-started/configure-coderabbit) file. It requires the entire YAML file to be in an escaped string format, for example, `YAML_CONFIG="key1: value1\nkey2: value2"`. You can use [Escape YAML](https://escapeyaml.dev/) to generate the escaped string. [​](https://docs.coderabbit.ai/self-hosted/azure-devops#pull-the-coderabbit-docker-image%E2%80%8B) Pull the CodeRabbit Docker image[​](https://docs.coderabbit.ai/self-hosted/azure-devops#pull-the-coderabbit-docker-image "Direct link to Pull the CodeRabbit Docker image") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Authenticate and pull the Docker image using the provided credentials file: Copy cat coderabbit.json | docker login -u _json_key --password-stdin us-docker.pkg.dev docker pull /coderabbit-agent:latest ### [​](https://docs.coderabbit.ai/self-hosted/azure-devops#verify-the-image-is-up-%E2%80%8B) Verify the image is up [​](https://docs.coderabbit.ai/self-hosted/azure-devops#verify-the-image-is-up "Direct link to Verify the image is up") You can query `/health` endpoint to verify that the `coderabbit-agent` service is up and running. Copy curl 127.0.0.1:8080/health [​](https://docs.coderabbit.ai/self-hosted/azure-devops#host-the-image-%E2%80%8B) Host the image [​](https://docs.coderabbit.ai/self-hosted/azure-devops#host-the-image "Direct link to 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: Copy docker run --env-file .env --publish 127.0.0.1:8080:8080 /coderabbit-agent:latest [On-prem CodeRabbit & GitLab](https://docs.coderabbit.ai/self-hosted/gitlab) [On-prem CodeRabbit & Bitbucket Datacenter](https://docs.coderabbit.ai/self-hosted/bitbucket) Assistant Responses are generated using AI and may contain mistakes. --- # On-prem CodeRabbit & GitHub - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Self-host CodeRabbit On-prem CodeRabbit & GitHub The self-hosted option is only available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](https://docs.coderabbit.ai/cdn-cgi/l/email-protection#4132202d243201222e25243320232328356f2028) to learn more about the CodeRabbit Enterprise plan. [​](https://docs.coderabbit.ai/self-hosted/github#create-a-github-app%E2%80%8B) Create a GitHub App[​](https://docs.coderabbit.ai/self-hosted/github#create-a-github-app "Direct link to Create a GitHub App") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Set the following Repository permissions: * Checks: Read-only * Contents: Read and write * Commit statuses: Read and write * Discussions: Read-only * Issues: Read & write * Metadata: Read-only * Pull requests: Read & write * Actions: Read-only Set the following Organization permissions: * Members: Read-only Set the following events: * Meta * Issue comment * Issues * Label * Public * Pull request * Pull request review * Pull request review comment * Pull request review thread * Push * Release We recommend using the CodeRabbit [logo](https://docs.coderabbit.ai/assets/files/logo-144a28a895bdf0158c57d2cb016780d8.png) as the profile picture to ensures easy recognition. [​](https://docs.coderabbit.ai/self-hosted/github#gather-information-from-the-github-app%E2%80%8B) Gather information from the GitHub App[​](https://docs.coderabbit.ai/self-hosted/github#gather-information-from-the-github-app "Direct link to Gather information from the GitHub App") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * App ID * Client ID * Client Secret * Webhook Secret [​](https://docs.coderabbit.ai/self-hosted/github#prepare-an-env-file%E2%80%8B) Prepare an `.env` file[​](https://docs.coderabbit.ai/self-hosted/github#prepare-an-env-file "Direct link to prepare-an-env-file") --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- .env Copy # 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 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= 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= # optionally, use cross-region inference to access models in other regions # if this is set to `true`, CodeRabbit will access models from `us`, `eu`, or `ap` regions based on the AWS_REGION value. AWS_USE_CROSS_REGION_INFERENCE=[] # if using Anthropic LLM_PROVIDER=anthropic LLM_TIMEOUT=360000 ANTHROPIC_API_KEYS= ANTHROPIC_BASE_URL=[] TEMP_PATH=/cache SELF_HOSTED=github GH_WEBHOOK_SECRET= GITHUB_HOSTNAME=[] GITHUB_APP_CLIENT_ID= GITHUB_APP_CLIENT_SECRET= GITHUB_APP_ID= GITHUB_APP_PEM_FILE= CODERABBIT_LICENSE_KEY= CODERABBIT_API_KEY= ENABLE_METRICS=[true] # CodeRabbit - KNOWLEDGE BASE # # Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI. OBJECT_STORE_URI=[] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc. ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features. ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing. ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing. ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing. ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing. ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing. JIRA_HOST=[] JIRA_PAT=[] LINEAR_PAT=[] ENABLE_WEB_SEARCH=[true] PERPLEXITY_API_KEY=[] YAML_CONFIG=[] * If you are using Azure OpenAI, verify that the model deployment names are in the .env file. * Values marked with \[\] are optional to provide. * 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. * When `ENABLE_LEARNINGS` is set to `true`, CodeRabbit will use `CODERABBIT_API_KEY` to store learnings on our servers. * `YAML_CONFIG` is an optional configuration file that can be used to customize CodeRabbit’s behavior at the deployment level. It takes the same format as the [CodeRabbit YAML configuration](https://docs.coderabbit.ai/getting-started/configure-coderabbit) file. It requires the entire YAML file to be in an escaped string format, for example, `YAML_CONFIG="key1: value1\nkey2: value2"`. You can use [Escape YAML](https://escapeyaml.dev/) to generate the escaped string. [​](https://docs.coderabbit.ai/self-hosted/github#pull-the-coderabbit-docker-image%E2%80%8B) Pull the CodeRabbit Docker image[​](https://docs.coderabbit.ai/self-hosted/github#pull-the-coderabbit-docker-image "Direct link to Pull the CodeRabbit Docker image") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Using the credentials file shared with you, first authenticate and then pull the image. Copy cat coderabbit.json | docker login -u _json_key --password-stdin us-docker.pkg.dev docker pull /coderabbit-agent:latest [​](https://docs.coderabbit.ai/self-hosted/github#host-the-image%E2%80%8B) Host the image[​](https://docs.coderabbit.ai/self-hosted/github#host-the-image "Direct link to Host the image") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You can choose to host it on a server, serverless function, or a container environment and expose the port “8080”. Run the Docker image with the equivalent of the following command on the platform of your choice, replacing the “.env” file with the path to your “.env” file: Copy docker run --env-file .env --publish 127.0.0.1:8080:8080 /coderabbit-agent:latest ### [​](https://docs.coderabbit.ai/self-hosted/github#verify-the-image-is-up%E2%80%8B) Verify the image is up[​](https://docs.coderabbit.ai/self-hosted/github#verify-the-image-is-up "Direct link to Verify the image is up") You can query `/health` endpoint to verify that the `coderabbit-agent` service is up and running. Copy curl 127.0.0.1:8080/health [​](https://docs.coderabbit.ai/self-hosted/github#install-the-github-app%E2%80%8B) Install the GitHub App[​](https://docs.coderabbit.ai/self-hosted/github#install-the-github-app "Direct link to Install the GitHub App") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ You can install the GitHub App on your GitHub organization or user account and point the Webhook URL to the hosted CodeRabbit instance, for example, `http://127.0.0.1:8080/github_webhooks`. GitHub will send events to the CodeRabbit instance. [Get support](https://docs.coderabbit.ai/getting-started/support) [On-prem CodeRabbit & GitLab](https://docs.coderabbit.ai/self-hosted/gitlab) Assistant Responses are generated using AI and may contain mistakes. --- # Configure third-party tool use - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Configure third-party tool use On this page * [Enabling/Disabling Tools](https://docs.coderabbit.ai/tools/tools#enabling%2Fdisabling-tools) * [Customizing Tools](https://docs.coderabbit.ai/tools/tools#customizing-tools) * [Checking Tool Output](https://docs.coderabbit.ai/tools/tools#checking-tool-output) * [What’s next](https://docs.coderabbit.ai/tools/tools#what%E2%80%99s-next) 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](https://docs.coderabbit.ai/tools/list) . CodeRabbit supports various linters and security analysis tools to improve the code review process. The output of these tools is used to enhance the feedback provided by CodeRabbit, making it possible to provide 1-click fixes for common issues. All tool runs are done in a secure sandboxed execution environment. [​](https://docs.coderabbit.ai/tools/tools#enabling%2Fdisabling-tools) Enabling/Disabling Tools -------------------------------------------------------------------------------------------------- You can enable or disable tools by setting `reviews.tools..enabled` in your project’s `.coderabbit.yaml` file or setting the “Review → Tools → Tool → Enabled” field in CodeRabbit’s settings page. [​](https://docs.coderabbit.ai/tools/tools#customizing-tools) Customizing Tools ---------------------------------------------------------------------------------- CodeRabbit supports customizing the strictness of tools by setting `reviews.profile` in your project’s `.coderabbit.yaml` file or setting the “Review → Profile” field in CodeRabbit’s settings page. The following profiles are available: * `Chill` - Yields less feedback, that may be considered lenient. * `Assertive` - Yields more feedback, that may be considered nit-picky. Apart from the overall profile, you can also configure each tool by providing a path to a configuration file (specific to the tool) in your project. This would allow you to further customize the tool’s behavior, by enabling/disabling specific rules, setting rule severity, etc. [​](https://docs.coderabbit.ai/tools/tools#checking-tool-output) Checking Tool Output ---------------------------------------------------------------------------------------- When a tool is enabled, CodeRabbit will run it on your change request and attach the output under “Review details” comment in the change request. The output will be displayed in a structured format, with information on the file, line number, and the issue detected. For example: Copy Ruff fib.py 21-21: f-string without any placeholders Remove extraneous f prefix (F541) [​](https://docs.coderabbit.ai/tools/tools#what%E2%80%99s-next) What’s next ------------------------------------------------------------------------------ * For a complete list of tools that CodeRabbit supports, see [Supported tools](https://docs.coderabbit.ai/tools/list) . Assistant Responses are generated using AI and may contain mistakes. --- # Introduction - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Introduction On this page * [Core features](https://docs.coderabbit.ai/overview/introduction-old#core-features) * [Workflow integration](https://docs.coderabbit.ai/overview/introduction-old#workflow-integration) * [Customizable review preferences](https://docs.coderabbit.ai/overview/introduction-old#customizable-review-preferences) * [Git platform integration](https://docs.coderabbit.ai/overview/introduction-old#git-platform-integration) * [Issue-management integration](https://docs.coderabbit.ai/overview/introduction-old#issue-management-integration) * [Data privacy and security](https://docs.coderabbit.ai/overview/introduction-old#data-privacy-and-security) * [Flexible pricing, free for public repositories](https://docs.coderabbit.ai/overview/introduction-old#flexible-pricing%2C-free-for-public-repositories) * [Review local changes from within VSCode](https://docs.coderabbit.ai/overview/introduction-old#review-local-changes-from-within-vscode) * [What’s next](https://docs.coderabbit.ai/overview/introduction-old#what%E2%80%99s-next) This page provides a conceptual introduction to CodeRabbit. For a hands-on tutorial, see [Quickstart](https://docs.coderabbit.ai/getting-started/quickstart) . **CodeRabbit** is an AI-powered code reviewer that delivers context-aware feedback on pull requests within minutes, reducing the time and effort needed for manual code reviews. It complements manual reviews by providing a fresh perspective and catching issues that manual reviews often miss, enhancing the overall review quality. Developers can interact directly with the CodeRabbit bot within their existing Git platform’s pull request interface to add context, ask questions, or even have the bot generate code. Over time, CodeRabbit learns from user input and improves its suggestions. [​](https://docs.coderabbit.ai/overview/introduction-old#core-features) Core features ---------------------------------------------------------------------------------------- Core CodeRabbit features include the following: Git platforms ------------- Integrates rapidly with popular Git platforms and workflows. 40+ linters ----------- Applies dozens of open-source, industry-standard code analyzers to every commit. AI code reviews --------------- Implements code reviews as familiar pull-request comments. Chat ---- Works with contributors through natural-language conversation in comments. Learnings --------- Learns and adapts to your team’s code style and review preferences. Reporting --------- Provides an observability dashboard of code-contribution activity. [​](https://docs.coderabbit.ai/overview/introduction-old#workflow-integration) Workflow integration ------------------------------------------------------------------------------------------------------ CodeRabbit shares its reviews as comments attached to pull requests, using the same Git platform that your team already uses. Further commits in the same pull review prompt CodeRabbit to make further reviews, using the earlier reviews as context. Each time that it performs a code review, CodeRabbit runs the relevant code changes through [an array of industry-standard code linters, security analyzers, and other tools](https://docs.coderabbit.ai/tools) . CodeRabbit synthesizes the output of these tools into its reviews, offering a high-level analysis that can suggest areas for further focus and improvement. Your team can have conversations with CodeRabbit about its reviews by replying to it with follow-up comments on pull requests, asking it questions or making observations about the review using natural language. CodeRabbit continues the conversation appropriately, offering further insights about the code changes, or adjusting its own review style based on feedback. ### [​](https://docs.coderabbit.ai/overview/introduction-old#customizable-review-preferences) Customizable review preferences As you interact with CodeRabbit through chat, it learns the review preferences of your team, and applies them to all future reviews on a given repository. For example, if CodeRabbit uses a linter to suggest that your pull request use four-space indentations, but your team uses a two-space indentation style, then you can reply to CodeRabbit’s pull-request comment to tell it exactly that. CodeRabbit acknowledges your feedback and adjusts all of its subsequent reviews with that repository appropriately. For a video introduction to this feature, see [CodeRabbit Learnings](https://www.youtube.com/watch?v=Yu0cmmOYA-U) . If you need to fine-tune CodeRabbit’s behavior beyond this, then you can [add a CodeRabbit-specific configuration file](https://docs.coderabbit.ai/getting-started/configure-coderabbit) to your repository, or use the CodeRabbit web UI to set further preferences. This file can include [path-based instructions](https://docs.coderabbit.ai/guides/review-instructions) for how CodeRabbit should review different files within your codebase. No matter how you tune and customize CodeRabbit, its default settings make it useful out of the box, able to meaningfully review pull requests within minutes of its introduction to a repository. ### [​](https://docs.coderabbit.ai/overview/introduction-old#git-platform-integration) Git platform integration CodeRabbit integrates in just a few clicks with many popular Git platforms: * GitHub, GitHub Enterprise Cloud, GitHub Enterprise Server, * GitLab, GitLab Self-Managed * Azure DevOps * Bitbucket Cloud For more information, see [Supported Git Platforms](https://docs.coderabbit.ai/platforms) . CodeRabbit also offers a self-hosted option available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](https://docs.coderabbit.ai/cdn-cgi/l/email-protection#c4b7a5a8a1b784a7aba0a1b6a5a6a6adb0eaa5ad) to learn more about the CodeRabbit Enterprise plan. ### [​](https://docs.coderabbit.ai/overview/introduction-old#issue-management-integration) Issue-management integration You can integrate CodeRabbit with issue-management platforms. This lets you ask CodeRabbit to create tickets during code reviews, or chat with CodeRabbit about your code from within issue comments. Compatible platforms include the following: * GitHub Issues * GitLab Issues * Jira * Linear For more information, see [Issue Creation](https://docs.coderabbit.ai/guides/issue-creation) and [Issue Chat](https://docs.coderabbit.ai/guides/issue-chat) . [​](https://docs.coderabbit.ai/overview/introduction-old#data-privacy-and-security) Data privacy and security ---------------------------------------------------------------------------------------------------------------- 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 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. * Our data collection and storage practices comply with SOC 2 and GDPR standards. For more information about how we protect your data, see [the CodeRabbit Trust Center](https://trust.coderabbit.ai/) . [​](https://docs.coderabbit.ai/overview/introduction-old#flexible-pricing%2C-free-for-public-repositories) Flexible pricing, free for public repositories ------------------------------------------------------------------------------------------------------------------------------------------------------------ Public repositories can use the Pro tier of CodeRabbit at no charge, including all of the code-review features described on this page. Rate limits might apply. 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) . [​](https://docs.coderabbit.ai/overview/introduction-old#review-local-changes-from-within-vscode) 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](https://docs.coderabbit.ai/code-editors) . [​](https://docs.coderabbit.ai/overview/introduction-old#what%E2%80%99s-next) What’s next -------------------------------------------------------------------------------------------- * [Quickstart](https://docs.coderabbit.ai/getting-started/quickstart) lets you experience your first CodeRabbit code review first-hand. * [Review local changes](https://docs.coderabbit.ai/code-editors) guides you through installing and using a subset of CodeRabbit features directly from your code editor. * [Why CodeRabbit?](https://docs.coderabbit.ai/overview/why-coderabbit) dives further into the philosophies and technologies that drive CodeRabbit. Assistant Responses are generated using AI and may contain mistakes. --- # Review instructions - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Configure Review instructions On this page * [Path-based instructions​](https://docs.coderabbit.ai/guides/review-instructions#path-based-instructions%E2%80%8B) * [Default Blocked Paths​](https://docs.coderabbit.ai/guides/review-instructions#default-blocked-paths%E2%80%8B) * [Sample Usage​](https://docs.coderabbit.ai/guides/review-instructions#sample-usage%E2%80%8B) * [Abstract Syntax Tree (AST) based instructions​](https://docs.coderabbit.ai/guides/review-instructions#abstract-syntax-tree-ast-based-instructions%E2%80%8B) * [The rule object​](https://docs.coderabbit.ai/guides/review-instructions#the-rule-object%E2%80%8B) * [Rule Categories​](https://docs.coderabbit.ai/guides/review-instructions#rule-categories%E2%80%8B) * [Atomic rule​](https://docs.coderabbit.ai/guides/review-instructions#atomic-rule%E2%80%8B) * [Relational rule​](https://docs.coderabbit.ai/guides/review-instructions#relational-rule%E2%80%8B) * [Composite rule​](https://docs.coderabbit.ai/guides/review-instructions#composite-rule%E2%80%8B) * [Reusing rule as utility​](https://docs.coderabbit.ai/guides/review-instructions#reusing-rule-as-utility%E2%80%8B) * [Local utility rule​](https://docs.coderabbit.ai/guides/review-instructions#local-utility-rule%E2%80%8B) * [Global utility rule​](https://docs.coderabbit.ai/guides/review-instructions#global-utility-rule%E2%80%8B) * [Packages​](https://docs.coderabbit.ai/guides/review-instructions#packages%E2%80%8B) * [Using custom package​](https://docs.coderabbit.ai/guides/review-instructions#using-custom-package%E2%80%8B) * [Multiple Languages Support​](https://docs.coderabbit.ai/guides/review-instructions#multiple-languages-support%E2%80%8B) * [JavaScript​](https://docs.coderabbit.ai/guides/review-instructions#javascript%E2%80%8B) * [C​](https://docs.coderabbit.ai/guides/review-instructions#c%E2%80%8B) You can also create code guidelines using the [Code Guidelines](https://docs.coderabbit.ai/guides/code-guidelines) feature. Code guidelines automatically follow rules set by coding agents like Cursor, Claude, Roo and more. You can also use Code Guidelines to create custom code review instructions. [​](https://docs.coderabbit.ai/guides/review-instructions#path-based-instructions%E2%80%8B) Path-based instructions[​](https://docs.coderabbit.ai/guides/review-instructions#path-based "Direct link to Path-based instructions") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This section explains how to add custom code review instructions for the entire project or specific file paths in your project using glob patterns. Developers can provide tailored review guidelines based on the file paths. These instructions are needed only if you want CodeRabbit to follow specific instructions besides the standard review. > For example, you may want to enforce a style guide by file types or directories. ### [​](https://docs.coderabbit.ai/guides/review-instructions#default-blocked-paths%E2%80%8B) Default Blocked Paths[​](https://docs.coderabbit.ai/guides/review-instructions#default-blocked-paths "Direct link to Default Blocked Paths") By default, CodeRabbit blocks certain file paths and extensions from being reviewed. If you want CodeRabbit to review any of these blocked paths, you can explicitly include them in your Path Filters configuration. View complete list of default blocked paths The following paths are blocked by default, grouped by category: #### [​](https://docs.coderabbit.ai/guides/review-instructions#build-and-dependency-directories%E2%80%8B) Build and Dependency Directories[​](https://docs.coderabbit.ai/guides/review-instructions#build-and-dependency-directories "Direct link to Build and Dependency Directories") | Path Pattern | Description | | --- | --- | | `!**/dist/**` | Build output directory | | `!**/node_modules/**` | Node.js dependencies | | `!**/.svelte-kit/**` | SvelteKit build directory | | `!**/.webpack/**` | Webpack build directory | | `!**/.yarn/**` | Yarn cache directory | | `!**/.docusaurus/**` | Docusaurus build directory | | `!**/.temp/**` | Temporary files directory | | `!**/.cache/**` | Cache directory | | `!**/.next/**` | Next.js build directory | | `!**/.nuxt/**` | Nuxt.js build directory | #### [​](https://docs.coderabbit.ai/guides/review-instructions#lock-files%E2%80%8B) Lock Files[​](https://docs.coderabbit.ai/guides/review-instructions#lock-files "Direct link to Lock Files") | Path Pattern | Description | | --- | --- | | `!**/package-lock.json` | npm lock file | | `!**/yarn.lock` | Yarn lock file | | `!**/pnpm-lock.yaml` | pnpm lock file | | `!**/bun.lockb` | Bun lock file | | `!**/*.lock` | Generic lock files | #### [​](https://docs.coderabbit.ai/guides/review-instructions#generated-code%E2%80%8B) Generated Code[​](https://docs.coderabbit.ai/guides/review-instructions#generated-code "Direct link to Generated Code") | Path Pattern | Description | | --- | --- | | `!**/generated/**` | Generated code directory | | `!**/@generated/**` | Generated code directory (alternative) | | `!**/__generated__/**` | Generated code directory (alternative) | | `!**/__generated/**` | Generated code directory (alternative) | | `!**/_generated/**` | Generated code directory (alternative) | | `!**/gen/**` | Generated code directory (alternative) | | `!**/@gen/**` | Generated code directory (alternative) | | `!**/__gen__/**` | Generated code directory (alternative) | | `!**/__gen/**` | Generated code directory (alternative) | | `!**/_gen/**` | Generated code directory (alternative) | #### [​](https://docs.coderabbit.ai/guides/review-instructions#binary-and-compiled-files%E2%80%8B) Binary and Compiled Files[​](https://docs.coderabbit.ai/guides/review-instructions#binary-and-compiled-files "Direct link to Binary and Compiled Files") | Path Pattern | Description | | --- | --- | | `!**/*.app` | Application bundle | | `!**/*.bin` | Binary file | | `!**/*.class` | Java compiled class | | `!**/*.dll` | Windows dynamic library | | `!**/*.dylib` | macOS dynamic library | | `!**/*.exe` | Windows executable | | `!**/*.o` | Object file | | `!**/*.so` | Shared object file | | `!**/*.wasm` | WebAssembly file | #### [​](https://docs.coderabbit.ai/guides/review-instructions#archives-and-compressed-files%E2%80%8B) Archives and Compressed Files[​](https://docs.coderabbit.ai/guides/review-instructions#archives-and-compressed-files "Direct link to Archives and Compressed Files") | Path Pattern | Description | | --- | --- | | `!**/*.bz2` | Bzip2 archive | | `!**/*.gz` | Gzip archive | | `!**/*.xz` | XZ archive | | `!**/*.zip` | ZIP archive | | `!**/*.7z` | 7-Zip archive | | `!**/*.rar` | RAR archive | | `!**/*.zst` | Zstandard archive | | `!**/*.tar` | TAR archive | | `!**/*.jar` | Java archive | | `!**/*.war` | Web application archive | | `!**/*.nar` | NAR archive | #### [​](https://docs.coderabbit.ai/guides/review-instructions#media-files%E2%80%8B) Media Files[​](https://docs.coderabbit.ai/guides/review-instructions#media-files "Direct link to Media Files") | Path Pattern | Description | | --- | --- | | `!**/*.mp3` | MP3 audio | | `!**/*.wav` | WAV audio | | `!**/*.wma` | WMA audio | | `!**/*.mp4` | MP4 video | | `!**/*.avi` | AVI video | | `!**/*.mkv` | MKV video | | `!**/*.wmv` | WMV video | | `!**/*.m4a` | M4A audio | | `!**/*.m4v` | M4V video | | `!**/*.3gp` | 3GP video | | `!**/*.3g2` | 3G2 video | | `!**/*.rm` | RealMedia video | | `!**/*.mov` | QuickTime video | | `!**/*.flv` | Flash video | | `!**/*.swf` | Flash animation | | `!**/*.flac` | FLAC audio | | `!**/*.ogg` | OGG audio | #### [​](https://docs.coderabbit.ai/guides/review-instructions#images-and-fonts%E2%80%8B) Images and Fonts[​](https://docs.coderabbit.ai/guides/review-instructions#images-and-fonts "Direct link to Images and Fonts") | Path Pattern | Description | | --- | --- | | `!**/*.ico` | Icon file | | `!**/*.svg` | SVG image | | `!**/*.jpeg` | JPEG image | | `!**/*.jpg` | JPEG image | | `!**/*.png` | PNG image | | `!**/*.gif` | GIF image | | `!**/*.bmp` | BMP image | | `!**/*.tiff` | TIFF image | | `!**/*.webm` | WebM image | | `!**/*.ttf` | TrueType font | | `!**/*.otf` | OpenType font | | `!**/*.woff` | Web Open Font Format | | `!**/*.woff2` | Web Open Font Format 2 | | `!**/*.eot` | Embedded OpenType font | #### [​](https://docs.coderabbit.ai/guides/review-instructions#documents-and-data-files%E2%80%8B) Documents and Data Files[​](https://docs.coderabbit.ai/guides/review-instructions#documents-and-data-files "Direct link to Documents and Data Files") | Path Pattern | Description | | --- | --- | | `!**/*.pdf` | PDF document | | `!**/*.doc` | Word document | | `!**/*.docx` | Word document | | `!**/*.xls` | Excel spreadsheet | | `!**/*.xlsx` | Excel spreadsheet | | `!**/*.ppt` | PowerPoint presentation | | `!**/*.pptx` | PowerPoint presentation | | `!**/*.csv` | CSV data file | | `!**/*.tsv` | TSV data file | | `!**/*.dat` | Data file | | `!**/*.db` | Database file | | `!**/*.parquet` | Parquet data file | #### [​](https://docs.coderabbit.ai/guides/review-instructions#development-and-system-files%E2%80%8B) Development and System Files[​](https://docs.coderabbit.ai/guides/review-instructions#development-and-system-files "Direct link to Development and System Files") | Path Pattern | Description | | --- | --- | | `!**/tags` | Tags file | | `!**/.tags` | Tags file | | `!**/TAGS` | Tags file | | `!**/.TAGS` | Tags file | | `!**/.DS_Store` | macOS system file | | `!**/.cscope.files` | Cscope files | | `!**/.cscope.out` | Cscope output | | `!**/.cscope.in.out` | Cscope input/output | | `!**/.cscope.po.out` | Cscope output | | `!**/*.log` | Log file | | `!**/*.map` | Source map | | `!**/*.out` | Output file | | `!**/*.sum` | Checksum file | | `!**/*.work` | Work file | | `!**/*.md5sum` | MD5 checksum file | #### [​](https://docs.coderabbit.ai/guides/review-instructions#game-and-3d-assets%E2%80%8B) Game and 3D Assets[​](https://docs.coderabbit.ai/guides/review-instructions#game-and-3d-assets "Direct link to Game and 3D Assets") | Path Pattern | Description | | --- | --- | | `!**/*.tga` | Targa image | | `!**/*.dds` | DirectDraw surface | | `!**/*.psd` | Photoshop document | | `!**/*.fbx` | FBX 3D model | | `!**/*.obj` | OBJ 3D model | | `!**/*.blend` | Blender file | | `!**/*.dae` | COLLADA 3D model | | `!**/*.gltf` | GL Transmission Format | | `!**/*.hlsl` | HLSL shader | | `!**/*.glsl` | GLSL shader | | `!**/*.unity` | Unity scene | | `!**/*.umap` | Unreal map | | `!**/*.prefab` | Unity prefab | | `!**/*.mat` | Material file | | `!**/*.shader` | Shader file | | `!**/*.shadergraph` | Shader graph | | `!**/*.sav` | Save file | | `!**/*.scene` | Scene file | | `!**/*.asset` | Asset file | #### [​](https://docs.coderabbit.ai/guides/review-instructions#python-specific-files%E2%80%8B) Python-specific Files[​](https://docs.coderabbit.ai/guides/review-instructions#python-specific-files "Direct link to Python-specific Files") | Path Pattern | Description | | --- | --- | | `!**/*.pyc` | Python compiled file | | `!**/*.pyd` | Python dynamic module | | `!**/*.pyo` | Python optimized file | | `!**/*.pkl` | Python pickle file | | `!**/*.pickle` | Python pickle file | #### [​](https://docs.coderabbit.ai/guides/review-instructions#go-specific-files%E2%80%8B) Go-specific Files[​](https://docs.coderabbit.ai/guides/review-instructions#go-specific-files "Direct link to Go-specific Files") | Path Pattern | Description | | --- | --- | | `!**/*.pb.go` | Protocol buffer Go file | | `!**/*.pb.gw.go` | Protocol buffer gateway Go file | #### [​](https://docs.coderabbit.ai/guides/review-instructions#terraform-files%E2%80%8B) Terraform Files[​](https://docs.coderabbit.ai/guides/review-instructions#terraform-files "Direct link to Terraform Files") | Path Pattern | Description | | --- | --- | | `!**/*.tfstate` | Terraform state file | | `!**/*.tfstate.backup` | Terraform state backup | #### [​](https://docs.coderabbit.ai/guides/review-instructions#minified-files%E2%80%8B) Minified Files[​](https://docs.coderabbit.ai/guides/review-instructions#minified-files "Direct link to Minified Files") | Path Pattern | Description | | --- | --- | | `!**/*.min.js` | Minified JavaScript | | `!**/*.min.js.map` | Minified JavaScript source map | | `!**/*.min.js.css` | Minified CSS | You can also edit your path filters directly in the UI by navigating to: **Configuration** > **Review** > **Settings** > **Path Filters** ![CircleCI Integration](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/img/guides/path-filters.png) ### [​](https://docs.coderabbit.ai/guides/review-instructions#sample-usage%E2%80%8B) Sample Usage[​](https://docs.coderabbit.ai/guides/review-instructions#sample-usage "Direct link to Sample Usage") Paths accept glob patterns. See the [minimatch](https://github.com/isaacs/minimatch) documentation for more information. Copy #... reviews: #... path_instructions: - path: "**/*.js" instructions: | Review the JavaScript code against the Google JavaScript style guide and point out any mismatches - path: "tests/**.*" instructions: | Review the following unit test code written using the Mocha test library. Ensure that: - The code adheres to best practices associated with Mocha. - Descriptive test names are used to clearly convey the intent of each test. [​](https://docs.coderabbit.ai/guides/review-instructions#abstract-syntax-tree-ast-based-instructions%E2%80%8B) Abstract Syntax Tree (AST) based instructions[​](https://docs.coderabbit.ai/guides/review-instructions#ast-based "Direct link to Abstract Syntax Tree (AST) based instructions") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. CodeRabbit offers review instructions based on Abstract Syntax Tree (AST) patterns. Under the hood, CodeRabbit uses [`ast-grep`](https://ast-grep.github.io/) to power this feature. `ast-grep` is written in Rust and uses the tree-sitter parser to generate the AST for popular languages. `ast-grep` is written and maintained by [Herrington Darkholme](https://twitter.com/hd_nvim) . `ast-grep` Playground is quite effective in designing and testing AST rules on source code snippets. You can access the playground [here](https://ast-grep.github.io/playground.html) . The additional context provided by this feature is only available during the automated code review process, and it’s not available in the chat.Moreover, this feature is only recommended for advanced users as there is a learning curve involved. **Deep dive into AST patterns and `ast-grep` rules** * Abstract Syntax Tree (AST) [Wikipedia article](https://en.wikipedia.org/wiki/Abstract_syntax_tree) * `ast-grep` [official documentation](https://ast-grep.github.io/guide/rule-config.html) for detailed guides. This section explains how to add custom code review instructions using `ast-grep` rules. `ast-grep` is a tool used for searching code using abstract syntax trees (AST) patterns. By default, you can add `ast-grep` rules by following these steps: 1. Create a directory that keeps all the `ast-grep` rules in your project directory. 2. Add individual `.yaml` files for each `ast-grep` rule within the newly created directory. 3. Ensure that each `.yaml` file contains the necessary `ast-grep` rule configurations. 4. Ensure that all rules contain a `message` property that will be used during the review process. 5. Add the rules’ directory to the `.coderabbit.yml` file under `tools.ast-grep` configuration. 6. Optionally, you can add `packages` property to the configuration to specify the packages that should be installed before running the `ast-grep` tool. Please read the `packages` section for detailed information. Copy #... reviews: #... tools: ast-grep: essential_rules: true # option to enable essential security rules rule_dirs: - "custom-name" packages: - "myorg/myawesomepackage" # custom package name following the format organization/repository #... ### [​](https://docs.coderabbit.ai/guides/review-instructions#the-rule-object%E2%80%8B) The rule object[​](https://docs.coderabbit.ai/guides/review-instructions#the-rule-object "Direct link to The rule object") Rule object is the core concept of `ast-grep` rule system and every other feature is built on top of it. Below is the full list of fields in a rule object. Every rule field is optional and can be omitted, but at least one field should be present in a rule. A node will match a rule if and only if it satisfies all fields in the rule object. Copy rule: # atomic rule pattern: "search.pattern" kind: "tree_sitter_node_kind" regex: "rust|regex" # relational rule inside: { pattern: "sub.rule" } has: { kind: "sub_rule" } follows: { regex: "can|use|any" } precedes: { kind: "multi_keys", pattern: "in.sub" } # composite rule all: [{ pattern: "match.all" }, { kind: "match_all" }] any: [{ pattern: "match.any" }, { kind: "match_any" }] not: { pattern: "not.this" } matches: "utility-rule" ### [​](https://docs.coderabbit.ai/guides/review-instructions#rule-categories%E2%80%8B) Rule Categories[​](https://docs.coderabbit.ai/guides/review-instructions#rule-categories "Direct link to Rule Categories") To summarize the rule object fields above, we have three categories of rules: * **Atomic Rule:** the most basic rule that checks if AST nodes matches. * **Relational Rule:** rules that check if a node is surrounded by another node. * **Composite Rule:** rules that combine sub-rules together using logical operators. These three categories of rules can be composed together to create more complex rules. The rule object is inspired by the CSS selectors but with more composability and expressiveness. Thinking about how selectors in CSS works can help you understand the rule object! > Read `ast-grep` > [documentation](https://ast-grep.github.io/guide/rule-config.html) > for detailed guides. #### [​](https://docs.coderabbit.ai/guides/review-instructions#atomic-rule%E2%80%8B) Atomic rule[​](https://docs.coderabbit.ai/guides/review-instructions#atomic-rule "Direct link to Atomic rule") Atomic rule defines the most basic matching rule that determines whether one syntax node matches the rule or not. There are three kinds of atomic rule: `pattern`, `kind` and `regex`. > Official documentation guide on [Atomic Rule](https://ast-grep.github.io/guide/rule-config/atomic-rule.html) #### [​](https://docs.coderabbit.ai/guides/review-instructions#relational-rule%E2%80%8B) Relational rule[​](https://docs.coderabbit.ai/guides/review-instructions#relational-rule "Direct link to Relational rule") A relational rule defines the relationship between two syntax nodes. There are four kinds of relational rule: `inside`, `has`, `follows` and `precedes`. All four relational rules accept a sub-rule object as their value. The sub-rule will match the surrounding node, while the relational rule itself will match the target node. > Official documentation guide on [Relational Rule](https://ast-grep.github.io/guide/rule-config/relational-rule.html) Copy rule: pattern: await $PROMISE inside: kind: for_in_statement stopBy: end #### [​](https://docs.coderabbit.ai/guides/review-instructions#composite-rule%E2%80%8B) Composite rule[​](https://docs.coderabbit.ai/guides/review-instructions#composite-rule "Direct link to Composite rule") A composite rule defines the logical relationship between multiple sub-rules. There are three kinds of composite rule: `all`, `any` and `not`. **`all`** The `all` rule matches if all sub-rules match. Copy rule: all: - pattern: console.log('Hello World'); - kind: expression_statement **`any`** `any` rule matches if any sub-rule matches. Copy rule: any: - pattern: var a = $A - pattern: const a = $A - pattern: let a = $A **`not`** `not` applies negation to a sub-rule. It matches if the sub-rule does not match. Copy rule: pattern: console.log($GREETING) not: pattern: console.log('Hello World') > Official documentation guide on [Composite Rule](https://ast-grep.github.io/guide/rule-config/composite-rule.html) ### [​](https://docs.coderabbit.ai/guides/review-instructions#reusing-rule-as-utility%E2%80%8B) Reusing rule as utility[​](https://docs.coderabbit.ai/guides/review-instructions#reusing-rule-as-utility "Direct link to Reusing rule as utility") `ast-grep` chooses to use YAML for rule representation. While this decision makes writing rules easier, it does impose some limitations on the rule authoring. One of the limitations is that rule objects cannot be reused. #### [​](https://docs.coderabbit.ai/guides/review-instructions#local-utility-rule%E2%80%8B) Local utility rule[​](https://docs.coderabbit.ai/guides/review-instructions#local-utility-rule "Direct link to Local utility rule") Local utility rules are defined in the utils field of the config file. Utils is a string-keyed dictionary. For example, the following config file defines a local utility rule `is-literal`: Copy utils: is-literal: any: - kind: string - kind: number - kind: boolean rule: matches: is-literal #### [​](https://docs.coderabbit.ai/guides/review-instructions#global-utility-rule%E2%80%8B) Global utility rule[​](https://docs.coderabbit.ai/guides/review-instructions#global-utility-rule "Direct link to Global utility rule") Global utility rules are defined in a separate file. But they are available across all rule configurations in the project. To create global utility rules, you need to have the `rules` directory created on the root of your project and another `utils` directory inside the root of your project. Copy my-awesome-project # project root |- rules # rule directory | |- my-rule.yml |- utils # utils directory | |- is-literal.yml > Also, you need to add the `rules` and `utils` directories to the `.coderabbit.yml` file under `tools.ast-grep` configuration. The rules can also be inside a package. If you have a package that contains rules, you can add the package name to the `packages` field in the `.coderabbit.yml` file. Copy #... reviews: #... tools: ast-grep: essential_rules: true rule_dirs: - "rules" util_dirs: - "utils" packages: - "my-awesome-org/my-awesome-package" # public repository that contains ast-grep rules #... Copy # is-literal.yml id: is-literal language: TypeScript rule: any: - kind: "false" - kind: undefined - kind: "null" - kind: "true" - kind: regex - kind: number - kind: string > Official documentation guide on [Utility Rule](https://ast-grep.github.io/guide/rule-config/utility-rule.html) ### [​](https://docs.coderabbit.ai/guides/review-instructions#packages%E2%80%8B) Packages[​](https://docs.coderabbit.ai/guides/review-instructions#packages "Direct link to Packages") A package is what allows you to share rules across multiple projects. Essentially, a package is a collection of `ast-grep` rules. CodeRabbit provides a set of packages that you can use out of the box. You can also create your own packages and share them with the community or just use them within your organization. Packages provided by CodeRabbit are: * `ast-grep-essentials`: A set of essential security rules. Because we value security, this package gets its own property in the `.coderabbit.yml` file, to make it easier to install and not overwrite. Check the [package repository](https://github.com/coderabbitai/ast-grep-essentials) for more information. To use a package, you need to add the package name to the `packages` field in the `.coderabbit.yml` file. Copy #... reviews: #... tools: ast-grep: essential_rules: true packages: # list of packages to install, in future coderabbit will provide a set of packages, beside the essentials one. - "my-awesome-org/my-awesome-package" # custom package name following the format organization/repository #... #### [​](https://docs.coderabbit.ai/guides/review-instructions#using-custom-package%E2%80%8B) Using custom package[​](https://docs.coderabbit.ai/guides/review-instructions#using-custom-package "Direct link to Using custom package") Let’s say that you have a public repository that contains `ast-grep` rules. You can add the package name to the `packages` field in the `.coderabbit.yml` file. Requirements for a package: * It should be a public repository * It contains rules that follow the `ast-grep` rule format * It has the following folder structure: Copy my-awesome-project # project root |- rules # rule directory | |- my-rule.yml |- utils # utils directory | |- is-literal.yml `rules` and `utils` directories are keywords, and it should be the same. Inside each directory, the structure is up to you. You can also have any other root directories or files beside the two shown above. * Name should be in the format `organization/repository` Copy #... reviews: #... tools: ast-grep: packages: - "my-awesome-org/my-awesome-package" #... ### [​](https://docs.coderabbit.ai/guides/review-instructions#multiple-languages-support%E2%80%8B) Multiple Languages Support[​](https://docs.coderabbit.ai/guides/review-instructions#multiple-languages-support "Direct link to Multiple Languages Support") CodeRabbit supports multiple programming languages for defining `ast-grep` rules. * JavaScript * Typescript * C# * Golang * Java * Kotlin * Rust * Python * C Below are examples of `ast-grep` rules in different languages: #### [​](https://docs.coderabbit.ai/guides/review-instructions#javascript%E2%80%8B) JavaScript[​](https://docs.coderabbit.ai/guides/review-instructions#javascript "Direct link to JavaScript") ##### Importing files without an extension is not allowed[​](https://docs.coderabbit.ai/guides/review-instructions#importing-files-without-an-extension-is-not-allowed "Direct link to Importing files without an extension is not allowed") Copy id: find-import-file language: js message: "Importing files without an extension is not allowed" rule: regex: "/[^.]+[^/]$" kind: string_fragment any: - inside: stopBy: end kind: import_statement - inside: stopBy: end kind: call_expression has: field: function regex: "^import$" ##### No console.log allowed except `console.error` on the catch block[​](https://docs.coderabbit.ai/guides/review-instructions#no-consolelog-allowed-except-consoleerror-on-the-catch-block "Direct link to no-consolelog-allowed-except-consoleerror-on-the-catch-block") Copy id: no-console-except-error language: typescript message: "No console.log allowed except console.error on the catch block" rule: any: - pattern: console.error($$$) not: inside: kind: catch_clause stopBy: end - pattern: console.$METHOD($$$) constraints: METHOD: regex: "log|debug|warn" #### [​](https://docs.coderabbit.ai/guides/review-instructions#c%E2%80%8B) C[​](https://docs.coderabbit.ai/guides/review-instructions#c "Direct link to C") In C, there is no built-in support for object-oriented programming, but some programmers use structs and function pointers to simulate classes and methods. However, this style can have some drawbacks, such as: * Extra memory allocation and reallocation for the struct and the function pointer. * Indirection overhead when calling the function pointer. A possible alternative is to use a plain function call with the struct pointer as the first argument. Copy id: method_receiver language: c rule: pattern: $R.$METHOD($$$ARGS) transform: MAYBE_COMMA: replace: source: $$$ARGS replace: "^.+" by: ", " fix: $METHOD(&$R$MAYBE_COMMA$$$ARGS) [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/review-instructions.md) Last updated on **Jul 31, 2025** [Integrate MCP servers](https://docs.coderabbit.ai/context-enrichment/mcp-server-integrations) [Linters & security analysis tools](https://docs.coderabbit.ai/tools) Assistant Responses are generated using AI and may contain mistakes. --- # FAQs - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Resources FAQs On this page * [General Questions](https://docs.coderabbit.ai/faq#general-questions) * [How to trigger a CodeRabbit Review?](https://docs.coderabbit.ai/faq#how-to-trigger-a-coderabbit-review%3F) * [How to run a review from my IDE?](https://docs.coderabbit.ai/faq#how-to-run-a-review-from-my-ide%3F) * [How to install CodeRabbit?](https://docs.coderabbit.ai/faq#how-to-install-coderabbit%3F) * [How accurate is CodeRabbit?](https://docs.coderabbit.ai/faq#how-accurate-is-coderabbit%3F) * [Language Support](https://docs.coderabbit.ai/faq#language-support) * [What’s the difference between CodeRabbit Code Reviews and CodeRabbit Reports?](https://docs.coderabbit.ai/faq#what%E2%80%99s-the-difference-between-coderabbit-code-reviews-and-coderabbit-reports%3F) * [CodeRabbit Code Reviews](https://docs.coderabbit.ai/faq#coderabbit-code-reviews) * [CodeRabbit Reports](https://docs.coderabbit.ai/faq#coderabbit-reports) * [Data Security](https://docs.coderabbit.ai/faq#data-security) * [Organization Management](https://docs.coderabbit.ai/faq#organization-management) * [Comparison with Other Tools](https://docs.coderabbit.ai/faq#comparison-with-other-tools) * [vs AI Code Generators](https://docs.coderabbit.ai/faq#vs-ai-code-generators) * [vs Traditional Review Tools](https://docs.coderabbit.ai/faq#vs-traditional-review-tools) * [Usage and Configuration](https://docs.coderabbit.ai/faq#usage-and-configuration) * [When Does CodeRabbit Review PRs?](https://docs.coderabbit.ai/faq#when-does-coderabbit-review-prs%3F) * [Customization Options](https://docs.coderabbit.ai/faq#customization-options) * [How to Add or Update Your Billing Email](https://docs.coderabbit.ai/faq#how-to-add-or-update-your-billing-email) * [Usage and Configuration](https://docs.coderabbit.ai/faq#usage-and-configuration-2) * [Access & Permissions](https://docs.coderabbit.ai/faq#access-%26-permissions) * [Interaction Guide](https://docs.coderabbit.ai/faq#interaction-guide) * [Usage Limits](https://docs.coderabbit.ai/faq#usage-limits) * [Integration Guide](https://docs.coderabbit.ai/faq#integration-guide) * [Prerequisites](https://docs.coderabbit.ai/faq#prerequisites) * [Quick Setup](https://docs.coderabbit.ai/faq#quick-setup) * [Unable to View Repositories in GitLab](https://docs.coderabbit.ai/faq#unable-to-view-repositories-in-gitlab) * [Unable to Enable Repositories in GitLab](https://docs.coderabbit.ai/faq#unable-to-enable-repositories-in-gitlab) * [Account Management](https://docs.coderabbit.ai/faq#account-management) * [How to troubleshoot CodeRabbit not functioning on certain repositories?](https://docs.coderabbit.ai/faq#how-to-troubleshoot-coderabbit-not-functioning-on-certain-repositories%3F) * [How do I delete my CodeRabbit account?](https://docs.coderabbit.ai/faq#how-do-i-delete-my-coderabbit-account%3F) [​](https://docs.coderabbit.ai/faq#general-questions) General Questions -------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/faq#how-to-trigger-a-coderabbit-review%3F) How to trigger a CodeRabbit Review? Once installed, CodeRabbit automatically triggers a review when a pull request is opened against the main branch of any repository. We automatically detect the name of the primary branch (whether this be master, main, dev, etc). This branch restriction can be customized in your settings. You can also manually trigger a review at any time by commenting on a pull request with one of these commands (see [Commands](https://docs.coderabbit.ai/guides/commands.md) for full list): * `@coderabbitai review` - Triggers a standard review * `@coderabbitai full review` - Triggers a comprehensive review ### [​](https://docs.coderabbit.ai/faq#how-to-run-a-review-from-my-ide%3F) How to run a review from my IDE? You can trigger CodeRabbit reviews directly from your IDE using our editor plugins: * [VSCode Extension](https://docs.coderabbit.ai/guides/about-vscode.md) - For VSCode, Cursor or Windsurf users These plugins allow you to request reviews without leaving your development environment. See the individual plugin documentation for installation and usage instructions. ### [​](https://docs.coderabbit.ai/faq#how-to-install-coderabbit%3F) How to install CodeRabbit? View step by step instructions depending on your platform: * GitHub * GitLab * Bitbucket * Azure DevOps See our [GitHub App installation guide](https://docs.coderabbit.ai/platforms/github-com.md) for step-by-step instructions. ### [​](https://docs.coderabbit.ai/faq#how-accurate-is-coderabbit%3F) How accurate is CodeRabbit? > CodeRabbit demonstrates high accuracy in code reviews based on early adoption results. While 100% accuracy isn’t guaranteed due to AI’s evolving nature, our technology continuously improves through: * Regular model updates * Enhanced pattern recognition * Growing language support * Refined code analysis ### [​](https://docs.coderabbit.ai/faq#language-support) Language Support CodeRabbit works with all programming languages, with varying proficiency based on: * Language popularity * Available training data * Community usage patterns ### [​](https://docs.coderabbit.ai/faq#what%E2%80%99s-the-difference-between-coderabbit-code-reviews-and-coderabbit-reports%3F) What’s the difference between CodeRabbit Code Reviews and CodeRabbit Reports? CodeRabbit offers two distinct features that serve different roles in your development workflow: #### [​](https://docs.coderabbit.ai/faq#coderabbit-code-reviews) CodeRabbit Code Reviews **Role**: Developer, QA, and Code Reviewer **Access Level**: Full code access with comprehensive analysis capabilities **Key Features:** * **Complete Toolchain**: Runs all available analysis tools on your codebase * **Static Analysis**: Can execute shell commands and perform deep static analysis against your codebase * **Direct Code Access**: Has full access to code in issues and pull requests * **Interactive Chat**: Provides chat features for real-time collaboration and questions * **Comprehensive Review**: Analyzes code quality, security, performance, and best practices * **Actionable Feedback**: Provides specific, line-by-line suggestions and improvements * **Comment Interaction**: Engages with users through comments in pull requests and issues for clarifications and discussions * **Available in All Tiers**: All features are available across Free, Lite, and Pro plans #### [​](https://docs.coderabbit.ai/faq#coderabbit-reports) CodeRabbit Reports **Role**: Project Manager and Communication Hub **Access Level**: Summary-only access without direct code interaction **Key Features:** * **Summary Generation**: Creates convenient, formatted summaries of all your recent pull requests * **Customizable Prompts**: Allows you to select or create your own summarization templates * **High-Level Overview**: Focuses on project progress and changes without code details * **Comment Analysis**: Reads and summarizes existing comments and discussions * **No Code Access**: Operates only on summaries and metadata, not the actual codebase * **Communication Tool**: Designed for stakeholders who need updates without technical details * **Multi-Channel Delivery**: Sends reports through various communication channels: * Email notifications * Slack integration * Discord webhooks * Microsoft Teams updates * **Pro Plan Exclusive**: Reports feature is available only in the Pro plan tier **In Summary:** * **Code Reviews** = Technical analysis with full code access for developers * **Reports** = High-level summaries with no code access for project management ### [​](https://docs.coderabbit.ai/faq#data-security) Data Security * Code Storage * Training Data * Complete data isolation * Caching of encrypted code and dependency archives for faster reviews * Code indexing in which we store vector representations of code for efficient code base context * Both caching and code indexing can be disabled which means we store nothing post-review ### [​](https://docs.coderabbit.ai/faq#organization-management) Organization Management Switch between organizations easily: 1. Click organization name (top-left corner) 2. Select desired organization 3. Access organization-specific settings ![Organization Switcher](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/assets/images/cr_support_orgs_light-3e7ca94d81cc0f66f3fd51d7b850c22f.png%23gh-light-mode-only) ![Organization Switcher](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/assets/images/cr_support_orgs_dark-53bdce884b1b6085ed1c2e3d719d5c7f.png%23gh-dark-mode-only) ### [​](https://docs.coderabbit.ai/faq#comparison-with-other-tools) Comparison with Other Tools > Code reviews remain essential, whether the code is written by a human or a bot. This is mainly because the perspective of the reviewer differs from that of the code generator, whether human or machine. This distinction is precisely why human peer reviews have been effective for so long. While AI-powered code-generation tools like GitHub Copilot hold immense potential, it’s important to recognize that these generators are still in their early stages and may not be equipped to auto-generate meaningful code for moderately complex applications. #### [​](https://docs.coderabbit.ai/faq#vs-ai-code-generators) vs AI Code Generators * Provides review perspective different from code generation * Complements tools like GitHub Copilot * Focuses on code quality and best practices #### [​](https://docs.coderabbit.ai/faq#vs-traditional-review-tools) vs Traditional Review Tools * Context-aware feedback * Actionable suggestions * Direct commit capabilities * AI-powered intent understanding [​](https://docs.coderabbit.ai/faq#usage-and-configuration) Usage and Configuration -------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/faq#when-does-coderabbit-review-prs%3F) When Does CodeRabbit Review PRs? * ✅ **New PRs**: Automatic review when created * ✅ **New Commits**: Automatic review when pushed to any PR * ⚡ **Older PRs**: Use `@coderabbitai review` to trigger manually ![CodeRabbit- Full-Review](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/assets/images/full-review-cb8972e79cad8e9c787f5954ea9d4fe7.png) ### [​](https://docs.coderabbit.ai/faq#customization-options) Customization Options #### [​](https://docs.coderabbit.ai/faq#how-to-add-or-update-your-billing-email) How to Add or Update Your Billing Email To add or update your billing email, navigate to the Subscription page and select Manage Subscription > **Billing Address**. Enter your email address in the Email field and click Update to save your changes. ### [​](https://docs.coderabbit.ai/faq#usage-and-configuration-2) Usage and Configuration * **Language Settings**: Configure review language in repository settings * **Review Rules**: Customize via [review instructions](https://docs.coderabbit.ai/guides/review-instructions.md) * **Branch Selection**: Default branch reviews enabled by default (configurable) ### [​](https://docs.coderabbit.ai/faq#access-%26-permissions) Access & Permissions * Minimal repository access required * Review permissions during installation * Individual developer support available ### [​](https://docs.coderabbit.ai/faq#interaction-guide) Interaction Guide Interact with CodeRabbit by: 1. Replying directly to CodeRabbit comments 2. Tagging `@coderabbitai` in PR discussions 3. Adding review comments for specific lines 4. Customize via [review instructions](https://docs.coderabbit.ai/guides/review-instructions.md) When team members are active in PRs, use `@coderabbitai` to engage the bot. ### [​](https://docs.coderabbit.ai/faq#usage-limits) Usage Limits In-trial and open-source plans have lower rate limits than the paid plan. In all cases, we re-allow further reviews/conversations after a brief timeout. The following limits are enforced _per developer_: | Feature | Free Plan | Trial Plan | OSS Plan | Pro/Lite Plan | | --- | --- | --- | --- | --- | | Files per hour | 200/hour | 200/hour | 200/hour | 400/hour | | Files per PR | 100 | 100 | 100 | 200 | | Reviews per hour | 3 back-to-back, then 2/hour (Summary only) | 4 back-to-back, then 3/hour | 3 back-to-back, then 2/hour | 5 back-to-back, then 4/hour | | Reviews per hour (IDE Extension) | 1/hour | 5/hour (Pro trial), 1/hour(Other) | 1/hour | 5/hour (Pro), 1/hour(Lite) | | Chat | N/A | 25 back-to-back, then 50/hour | 10 back-to-back, then 25/hour | 25 back-to-back, then 50/hour | [​](https://docs.coderabbit.ai/faq#integration-guide) Integration Guide -------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/faq#prerequisites) Prerequisites * Organization admin access * Domain allowlist (GitLab: add `coderabbit.ai`) * Default branch configuration ### [​](https://docs.coderabbit.ai/faq#quick-setup) Quick Setup 1. Sign up at [coderabbit.ai](https://coderabbit.ai/) using your GitHub account 2. Add your repository through the dashboard 3. That’s it. CodeRabbit will automatically start reviewing your PRs Visit our [Support](https://docs.coderabbit.ai/getting-started/support.md) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit) . #### [​](https://docs.coderabbit.ai/faq#unable-to-view-repositories-in-gitlab) Unable to View Repositories in GitLab If you cannot view repositories in the CodeRabbit UI, please ensure that you are added as a Developer in the primary group for GitLab Cloud or in the first level group for Self-Hosted GitLab. #### [​](https://docs.coderabbit.ai/faq#unable-to-enable-repositories-in-gitlab) Unable to Enable Repositories in GitLab If you’re having trouble enabling the GitLab Repositories toggle, confirm that you have Maintainer access in the primary group for GitLab Cloud or in the first level group for Self-Hosted GitLab. [​](https://docs.coderabbit.ai/faq#account-management) Account Management ---------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/faq#how-to-troubleshoot-coderabbit-not-functioning-on-certain-repositories%3F) How to troubleshoot CodeRabbit not functioning on certain repositories? If CodeRabbit is not functioning on certain repositories, it is likely due to the repository not being accessible to CodeRabbit and you must reinstall the GitHub App or GitLab Integration. To troubleshoot this issue, please attempt to reinstall the GitHub App or GitLab Integration by following the steps below: * General Instructions * GitHub * GitLab 1. Confirm that the author of a pull request has an active seat in CodeRabbit. If not please provide a seat to the user under [Subscription](https://coderabbit.ai/settings/subscription) page to enable CodeRabbit for the user. Then have the user close/reopen a new pull request for the change to see coderabbit active on the new user. ![Seat Assignment](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/assets/images/seat-assignment-98e8a00ddfc2f85c4a359fa552cabfa5.png) 2. Please insure if not selecting all repositories, that you have added all repositories that you would like to enable to the selected list in the app configuration. 3. If the repository is not in the list, you do not have to uninstall and reinstall the CodeRabbit App. Please add it to the list. ![Select Repos](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/faq/select-repos.png) ### [​](https://docs.coderabbit.ai/faq#how-do-i-delete-my-coderabbit-account%3F) How do I delete my CodeRabbit account? :::danger Irreversible Account Deletion Deleting your CodeRabbit account is permanent and cannot be undone. This action will permanently erase: * Organization and Repository data * AI Bot learnings and insights * Subscriptions and billing information * All settings and configurations * Reports and recurring reports * Third-party service integrations ::: * Account Deletion Steps * GitHub Cleanup * GitLab Cleanup * Azure DevOps Cleanup * Bitbucket Cleanup 1. Sign into your CodeRabbit account 2. Navigate to the **Subscription** page 3. Click the orange **Delete Account** button 4. Review the deletion confirmation modal 5. Type “delete” to confirm 6. Complete platform-specific cleanup steps below The Delete Account button is only visible to admin users. A confirmation modal will appear explaining the consequences of account deletion. You can expand each section for detailed information: ![Delete Account](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/assets/images/delete_account_light-2bcb3e5d11fa451bb09886d1a92bf1e6.png%23gh-light-mode-only) ![Delete Account](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/assets/images/delete_account_dark-6fc261bfaca1e44fb57deb15f62c3fe5.png%23gh-dark-mode-only) The platform-specific cleanup steps are necessary to completely remove CodeRabbit access. Without completing these steps: * CodeRabbit may retain some platform permissions * Signing back in will recreate minimal account data [Why CodeRabbit?](https://docs.coderabbit.ai/overview/why-coderabbit) [Early Access Program](https://docs.coderabbit.ai/early-access) Assistant Responses are generated using AI and may contain mistakes. --- # On-prem CodeRabbit & GitLab - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Self-host CodeRabbit On-prem CodeRabbit & GitLab The self-hosted option is only available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](https://docs.coderabbit.ai/cdn-cgi/l/email-protection#c4b7a5a8a1b784a7aba0a1b6a5a6a6adb0eaa5ad) to learn more about the CodeRabbit Enterprise plan. [​](https://docs.coderabbit.ai/self-hosted/gitlab#create-a-gitlab-user) Create a GitLab 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](https://docs.coderabbit.ai/assets/files/logo-144a28a895bdf0158c57d2cb016780d8.png) as the profile picture to ensure easy recognition. [​](https://docs.coderabbit.ai/self-hosted/gitlab#add-user-to-projects) Add User to Projects ----------------------------------------------------------------------------------------------- Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with at least `Developer` access. [​](https://docs.coderabbit.ai/self-hosted/gitlab#create-a-personal-access-token-for-coderabbit-user) 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 `GITLAB_BOT_TOKEN`. **Necessary Scopes**: * `api` Consult official CodeRabbitAI documentation for a detailed [guide](https://docs.coderabbit.ai/integrations/self-hosted-gitlab#generating-personal-access-token) on creating personal access tokens. [​](https://docs.coderabbit.ai/self-hosted/gitlab#add-a-webhook-to-each-project) Add a webhook to each project ----------------------------------------------------------------------------------------------------------------- 1. **Navigate to Add Webhook Page**: Go to the webhook configuration page in the desired GitLab project. 2. **Add Webhook URL**: Enter the URL pointing to the CodeRabbit service, followed by `/gitlab_webhooks` (e.g., `http://127.0.0.1:8080/gitlab_webhooks`). 3. **Generate and Save Secret Token**: Generate a secret token, add it to the webhook, and store it securely. This will be needed for the `.env` file as `GITLAB_WEBHOOK_SECRET` (you can use a single secret token for all projects). 4. **Select triggers**: * Push events * Comments * Issues events * Merge request events [​](https://docs.coderabbit.ai/self-hosted/gitlab#add-webhook-using-a-script) Add Webhook Using a Script ----------------------------------------------------------------------------------------------------------- We have a convenient [script](https://docs.coderabbit.ai/assets/files/gitlab-webhook-3cb095d588075e6822197221f22d00d4.sh) to help you add webhooks to a project or all projects under a group in a GitLab instance. Copy # Make sure the script is executable: chmod +x gitlab-webhook.sh Example usage: Copy # PAT example (header auto-detected) export GITLAB_TOKEN="glpat-xxxxx" ./gitlab-add-webhook.sh \ -h "gitlab.example.com" -u "http:///gitlab_webhooks" \ -s "mySecret" -p 42 # PAT example (explicit header) ./gitlab-add-webhook.sh \ -h "gitlab.example.com" -u "http:///gitlab_webhooks" \ -s "mySecret" -g "mygroup/mysubgroup/myproject" \ -t "glpat-xxxxx" \ -A "PRIVATE-TOKEN" # OAuth token with explicit header ./gitlab-add-webhook.sh \ -h "gitlab.example.com" -u "http:///gitlab_webhooks" \ -s "mySecret" -g "company/backend" \ -t "eyJhbGciOi..." \ -A "Authorization: Bearer" [​](https://docs.coderabbit.ai/self-hosted/gitlab#prepare-a-env-file) Prepare a `.env` file ---------------------------------------------------------------------------------------------- Create a `.env` file with the following content: .env Copy # 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 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= 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= # optionally, use cross-region inference to access models in other regions # if this is set to `true`, CodeRabbit will access models from `us`, `eu`, or `ap` regions based on the AWS_REGION value. AWS_USE_CROSS_REGION_INFERENCE=[] # if using Anthropic LLM_PROVIDER=anthropic LLM_TIMEOUT=360000 ANTHROPIC_API_KEYS= ANTHROPIC_BASE_URL=[] TEMP_PATH=/cache 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= CODERABBIT_API_KEY= ENABLE_METRICS=[true] # CodeRabbit - KNOWLEDGE BASE ## Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI. OBJECT_STORE_URI=[] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc. ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features. ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing. ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing. ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing. ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing. ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing. JIRA_HOST=[] JIRA_PAT=[] LINEAR_PAT=[] ENABLE_WEB_SEARCH=[true] PERPLEXITY_API_KEY=[] YAML_CONFIG=[] * If you are using Azure OpenAI, verify that the model deployment names are in the .env file. * Values marked with \[\] are not optional to provide. * You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys. * `YAML_CONFIG` is an optional configuration file that can be used to customize CodeRabbit’s behavior at the deployment level. It takes the same format as the [CodeRabbit YAML configuration](https://docs.coderabbit.ai/getting-started/configure-coderabbit) file. It requires the entire YAML file to be in an escaped string format, for example, `YAML_CONFIG="key1: value1\nkey2: value2"`. You can use [Escape YAML](https://escapeyaml.dev/) to generate the escaped string. [​](https://docs.coderabbit.ai/self-hosted/gitlab#pull-the-coderabbit-docker-image-%E2%80%8B) Pull the CodeRabbit Docker image [​](https://docs.coderabbit.ai/self-hosted/gitlab#pull-the-coderabbit-docker-image "Direct link to Pull the CodeRabbit Docker image") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Authenticate and pull the Docker image using the provided credentials file: Copy cat coderabbit.json | docker login -u _json_key --password-stdin us-docker.pkg.dev docker pull /coderabbit-agent:latest [​](https://docs.coderabbit.ai/self-hosted/gitlab#host-the-image-%E2%80%8B) Host the image [​](https://docs.coderabbit.ai/self-hosted/gitlab#host-the-image "Direct link to 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: Copy docker run --env-file .env --publish 127.0.0.1:8080:8080 /coderabbit-agent:latest ### [​](https://docs.coderabbit.ai/self-hosted/gitlab#verify-the-image-is-up-%E2%80%8B) Verify the image is up [​](https://docs.coderabbit.ai/self-hosted/gitlab#verify-the-image-is-up "Direct link to Verify the image is up") You can query `/health` endpoint to verify that the coderabbit-agent service is up and running. Copy curl 127.0.0.1:8080/health [On-prem CodeRabbit & GitHub](https://docs.coderabbit.ai/self-hosted/github) [On-prem CodeRabbit & Azure DevOps](https://docs.coderabbit.ai/self-hosted/azure-devops) Assistant Responses are generated using AI and may contain mistakes. --- # Unit Test Generation, Early Access - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Unit Test Generation, Early Access On this page * [Unit Test Generation, Early Access](https://docs.coderabbit.ai/changelog/unit-test-generation-early-access#unit-test-generation%2C-early-access) ### [​](https://docs.coderabbit.ai/changelog/unit-test-generation-early-access#unit-test-generation%2C-early-access) Unit Test Generation, Early Access We’re excited to announce that our new unit test generation feature is now available in early access! CodeRabbit can now automatically generate unit tests for your code changes. Key capabilities: * **Intelligent Test Generation**: Automatically creates unit tests that cover edge cases, error scenarios, and core functionality * **Context-Aware**: Generates tests that understand your existing codebase patterns and testing conventions * **One-Click Integration**: Simply comment `@coderabbitai generate unit tests` on any pull request or specific file, or click on the checkbox available in the walkthrough comment for Early Access customers. You can customize the generated tests to fit your specific requirements. Assistant Responses are generated using AI and may contain mistakes. --- # Integrate with Git platforms - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Integrate with Git platforms On this page * [GitHub​](https://docs.coderabbit.ai/platforms/index#github%E2%80%8B) * [GitLab​](https://docs.coderabbit.ai/platforms/index#gitlab%E2%80%8B) * [Azure DevOps​](https://docs.coderabbit.ai/platforms/index#azure-devops%E2%80%8B) * [Bitbucket​](https://docs.coderabbit.ai/platforms/index#bitbucket%E2%80%8B) [​](https://docs.coderabbit.ai/platforms/index#github%E2%80%8B) GitHub[​](https://docs.coderabbit.ai/platforms/index#github "Direct link to GitHub") -------------------------------------------------------------------------------------------------------------------------------------------------------- | Host | Support | | --- | --- | | GitHub.com | [Supported](https://docs.coderabbit.ai/platforms/github-com) | | GitHub Enterprise Server | [Supported](https://docs.coderabbit.ai/platforms/github-enterprise-server) | [​](https://docs.coderabbit.ai/platforms/index#gitlab%E2%80%8B) GitLab[​](https://docs.coderabbit.ai/platforms/index#gitlab "Direct link to GitLab") -------------------------------------------------------------------------------------------------------------------------------------------------------- | Host | Support | | --- | --- | | GitLab.com | [Supported](https://docs.coderabbit.ai/platforms/gitlab-com) | | GitLab Self Managed | [Supported](https://docs.coderabbit.ai/platforms/self-hosted-gitlab) | [​](https://docs.coderabbit.ai/platforms/index#azure-devops%E2%80%8B) Azure DevOps[​](https://docs.coderabbit.ai/platforms/index#azure-devops "Direct link to Azure DevOps") -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | Host | Support | | --- | --- | | Azure DevOps | [Supported](https://docs.coderabbit.ai/platforms/azure-devops) | [​](https://docs.coderabbit.ai/platforms/index#bitbucket%E2%80%8B) Bitbucket[​](https://docs.coderabbit.ai/platforms/index#bitbucket "Direct link to Bitbucket") -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | Host | Support | | --- | --- | | Bitbucket Datacenter | [Supported](https://docs.coderabbit.ai/self-hosted/bitbucket) | | Bitbucket Cloud | [Supported](https://docs.coderabbit.ai/platforms/bitbucket-cloud) | [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/platforms/platforms.md) Last updated on **Jul 24, 2025** Assistant Responses are generated using AI and may contain mistakes. --- # Configuration reference - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Reference Configuration reference On this page * [How to use this reference](https://docs.coderabbit.ai/reference/configuration#how-to-use-this-reference) * [Global Settings](https://docs.coderabbit.ai/reference/configuration#global-settings) * [Data retention](https://docs.coderabbit.ai/reference/configuration#data-retention) * [Early Access](https://docs.coderabbit.ai/reference/configuration#early-access) * [Enable Free Tier](https://docs.coderabbit.ai/reference/configuration#enable-free-tier) * [Language](https://docs.coderabbit.ai/reference/configuration#language) * [Tone Instructions](https://docs.coderabbit.ai/reference/configuration#tone-instructions) * [Review](https://docs.coderabbit.ai/reference/configuration#review) * [Basic Review Settings](https://docs.coderabbit.ai/reference/configuration#basic-review-settings) * [Abort On Close](https://docs.coderabbit.ai/reference/configuration#abort-on-close) * [Assess Linked Issues](https://docs.coderabbit.ai/reference/configuration#assess-linked-issues) * [Auto Apply Labels](https://docs.coderabbit.ai/reference/configuration#auto-apply-labels) * [Auto Assign Reviewers](https://docs.coderabbit.ai/reference/configuration#auto-assign-reviewers) * [Auto Title Instructions](https://docs.coderabbit.ai/reference/configuration#auto-title-instructions) * [Auto Title Placeholder](https://docs.coderabbit.ai/reference/configuration#auto-title-placeholder) * [Changed Files Summary](https://docs.coderabbit.ai/reference/configuration#changed-files-summary) * [Collapse Walkthrough](https://docs.coderabbit.ai/reference/configuration#collapse-walkthrough) * [Commit Status](https://docs.coderabbit.ai/reference/configuration#commit-status) * [Disable Cache](https://docs.coderabbit.ai/reference/configuration#disable-cache) * [Fail Commit Status](https://docs.coderabbit.ai/reference/configuration#fail-commit-status) * [High Level Summary](https://docs.coderabbit.ai/reference/configuration#high-level-summary) * [High Level Summary In Walkthrough](https://docs.coderabbit.ai/reference/configuration#high-level-summary-in-walkthrough) * [High Level Summary Placeholder](https://docs.coderabbit.ai/reference/configuration#high-level-summary-placeholder) * [Labeling Instructions](https://docs.coderabbit.ai/reference/configuration#labeling-instructions) * [Path Filters](https://docs.coderabbit.ai/reference/configuration#path-filters) * [Path Instructions](https://docs.coderabbit.ai/reference/configuration#path-instructions) * [Poem](https://docs.coderabbit.ai/reference/configuration#poem) * [Profile](https://docs.coderabbit.ai/reference/configuration#profile) * [Related Issues](https://docs.coderabbit.ai/reference/configuration#related-issues) * [Related PRs](https://docs.coderabbit.ai/reference/configuration#related-prs) * [Request Changes Workflow](https://docs.coderabbit.ai/reference/configuration#request-changes-workflow) * [Review Status](https://docs.coderabbit.ai/reference/configuration#review-status) * [Sequence Diagrams](https://docs.coderabbit.ai/reference/configuration#sequence-diagrams) * [Suggested Labels](https://docs.coderabbit.ai/reference/configuration#suggested-labels) * [Suggested Reviewers](https://docs.coderabbit.ai/reference/configuration#suggested-reviewers) * [Automatic Review](https://docs.coderabbit.ai/reference/configuration#automatic-review) * [Enable Automatic Review](https://docs.coderabbit.ai/reference/configuration#enable-automatic-review) * [Automatic Incremental Review](https://docs.coderabbit.ai/reference/configuration#automatic-incremental-review) * [Base Branches](https://docs.coderabbit.ai/reference/configuration#base-branches) * [Drafts](https://docs.coderabbit.ai/reference/configuration#drafts) * [Ignore Title Keywords](https://docs.coderabbit.ai/reference/configuration#ignore-title-keywords) * [Labels](https://docs.coderabbit.ai/reference/configuration#labels) * [Finishing Touches](https://docs.coderabbit.ai/reference/configuration#finishing-touches) * [Docstrings](https://docs.coderabbit.ai/reference/configuration#docstrings) * [Unit Tests](https://docs.coderabbit.ai/reference/configuration#unit-tests) * [Chat](https://docs.coderabbit.ai/reference/configuration#chat) * [Auto Reply](https://docs.coderabbit.ai/reference/configuration#auto-reply) * [Integrations](https://docs.coderabbit.ai/reference/configuration#integrations) * [Jira](https://docs.coderabbit.ai/reference/configuration#jira) * [Linear](https://docs.coderabbit.ai/reference/configuration#linear) * [Knowledge Base](https://docs.coderabbit.ai/reference/configuration#knowledge-base) * [Basic settings](https://docs.coderabbit.ai/reference/configuration#basic-settings) * [Opt Out](https://docs.coderabbit.ai/reference/configuration#opt-out) * [Pull Requests](https://docs.coderabbit.ai/reference/configuration#pull-requests) * [Web Search](https://docs.coderabbit.ai/reference/configuration#web-search) * [Issues](https://docs.coderabbit.ai/reference/configuration#issues) * [Jira](https://docs.coderabbit.ai/reference/configuration#jira-2) * [Enable Jira](https://docs.coderabbit.ai/reference/configuration#enable-jira) * [Project Keys](https://docs.coderabbit.ai/reference/configuration#project-keys) * [Learnings](https://docs.coderabbit.ai/reference/configuration#learnings) * [Linear](https://docs.coderabbit.ai/reference/configuration#linear-2) * [Enable Linear](https://docs.coderabbit.ai/reference/configuration#enable-linear) * [Team Keys](https://docs.coderabbit.ai/reference/configuration#team-keys) * [Code Generation](https://docs.coderabbit.ai/reference/configuration#code-generation) * [Code Generation Language](https://docs.coderabbit.ai/reference/configuration#code-generation-language) * [Docstring Path Instructions](https://docs.coderabbit.ai/reference/configuration#docstring-path-instructions) * [Unit Test Path Instructions](https://docs.coderabbit.ai/reference/configuration#unit-test-path-instructions) * [Tools](https://docs.coderabbit.ai/reference/configuration#tools) * [actionlint](https://docs.coderabbit.ai/reference/configuration#actionlint) * [Enable actionlint](https://docs.coderabbit.ai/reference/configuration#enable-actionlint) * [ast-grep](https://docs.coderabbit.ai/reference/configuration#ast-grep) * [Essential Rules](https://docs.coderabbit.ai/reference/configuration#essential-rules) * [Packages](https://docs.coderabbit.ai/reference/configuration#packages) * [Rule Dirs](https://docs.coderabbit.ai/reference/configuration#rule-dirs) * [Util Dirs](https://docs.coderabbit.ai/reference/configuration#util-dirs) * [Biome](https://docs.coderabbit.ai/reference/configuration#biome) * [Enable Biome](https://docs.coderabbit.ai/reference/configuration#enable-biome) * [Brakeman](https://docs.coderabbit.ai/reference/configuration#brakeman) * [Enable Brakeman](https://docs.coderabbit.ai/reference/configuration#enable-brakeman) * [Buf](https://docs.coderabbit.ai/reference/configuration#buf) * [Enable Buf](https://docs.coderabbit.ai/reference/configuration#enable-buf) * [checkmake](https://docs.coderabbit.ai/reference/configuration#checkmake) * [Enable checkmake](https://docs.coderabbit.ai/reference/configuration#enable-checkmake) * [Checkov](https://docs.coderabbit.ai/reference/configuration#checkov) * [Enable Checkov](https://docs.coderabbit.ai/reference/configuration#enable-checkov) * [CircleCI](https://docs.coderabbit.ai/reference/configuration#circleci) * [Enable CircleCI](https://docs.coderabbit.ai/reference/configuration#enable-circleci) * [Clippy](https://docs.coderabbit.ai/reference/configuration#clippy) * [Enable Clippy](https://docs.coderabbit.ai/reference/configuration#enable-clippy) * [Cppcheck](https://docs.coderabbit.ai/reference/configuration#cppcheck) * [Enable Cppcheck](https://docs.coderabbit.ai/reference/configuration#enable-cppcheck) * [detekt](https://docs.coderabbit.ai/reference/configuration#detekt) * [Enable detekt](https://docs.coderabbit.ai/reference/configuration#enable-detekt) * [Config File](https://docs.coderabbit.ai/reference/configuration#config-file) * [dotenv-linter](https://docs.coderabbit.ai/reference/configuration#dotenv-linter) * [Enable dotenv-linter](https://docs.coderabbit.ai/reference/configuration#enable-dotenv-linter) * [ESLint](https://docs.coderabbit.ai/reference/configuration#eslint) * [Enable ESLint](https://docs.coderabbit.ai/reference/configuration#enable-eslint) * [Flake8](https://docs.coderabbit.ai/reference/configuration#flake8) * [Enable Flake8](https://docs.coderabbit.ai/reference/configuration#enable-flake8) * [GitHub Checks](https://docs.coderabbit.ai/reference/configuration#github-checks) * [Enable GitHub Checks](https://docs.coderabbit.ai/reference/configuration#enable-github-checks) * [Timeout Ms](https://docs.coderabbit.ai/reference/configuration#timeout-ms) * [Gitleaks](https://docs.coderabbit.ai/reference/configuration#gitleaks) * [Enable Gitleaks](https://docs.coderabbit.ai/reference/configuration#enable-gitleaks) * [golangci-lint](https://docs.coderabbit.ai/reference/configuration#golangci-lint) * [Enable golangci-lint](https://docs.coderabbit.ai/reference/configuration#enable-golangci-lint) * [Config File](https://docs.coderabbit.ai/reference/configuration#config-file-2) * [Hadolint](https://docs.coderabbit.ai/reference/configuration#hadolint) * [Enable Hadolint](https://docs.coderabbit.ai/reference/configuration#enable-hadolint) * [HTMLHint](https://docs.coderabbit.ai/reference/configuration#htmlhint) * [Enable HTMLHint](https://docs.coderabbit.ai/reference/configuration#enable-htmlhint) * [Config File](https://docs.coderabbit.ai/reference/configuration#config-file-3) * [LanguageTool](https://docs.coderabbit.ai/reference/configuration#languagetool) * [Disabled Categories](https://docs.coderabbit.ai/reference/configuration#disabled-categories) * [Disabled Rules](https://docs.coderabbit.ai/reference/configuration#disabled-rules) * [Enable LanguageTool](https://docs.coderabbit.ai/reference/configuration#enable-languagetool) * [Enabled Categories](https://docs.coderabbit.ai/reference/configuration#enabled-categories) * [Enabled Only](https://docs.coderabbit.ai/reference/configuration#enabled-only) * [Enabled Rules](https://docs.coderabbit.ai/reference/configuration#enabled-rules) * [Level](https://docs.coderabbit.ai/reference/configuration#level) * [Luacheck](https://docs.coderabbit.ai/reference/configuration#luacheck) * [Enable Luacheck](https://docs.coderabbit.ai/reference/configuration#enable-luacheck) * [markdownlint](https://docs.coderabbit.ai/reference/configuration#markdownlint) * [Enable markdownlint](https://docs.coderabbit.ai/reference/configuration#enable-markdownlint) * [Oxlint](https://docs.coderabbit.ai/reference/configuration#oxlint) * [Enable Oxlint](https://docs.coderabbit.ai/reference/configuration#enable-oxlint) * [PHPStan](https://docs.coderabbit.ai/reference/configuration#phpstan) * [Enable PHPStan](https://docs.coderabbit.ai/reference/configuration#enable-phpstan) * [Level](https://docs.coderabbit.ai/reference/configuration#level-2) * [PMD](https://docs.coderabbit.ai/reference/configuration#pmd) * [Enable PMD](https://docs.coderabbit.ai/reference/configuration#enable-pmd) * [Config File](https://docs.coderabbit.ai/reference/configuration#config-file-4) * [PHPMD](https://docs.coderabbit.ai/reference/configuration#phpmd) * [Enable PHPMD](https://docs.coderabbit.ai/reference/configuration#enable-phpmd) * [PHPCS](https://docs.coderabbit.ai/reference/configuration#phpcs) * [Enable PHPCS](https://docs.coderabbit.ai/reference/configuration#enable-phpcs) * [Prisma Schema Linting](https://docs.coderabbit.ai/reference/configuration#prisma-schema-linting) * [Enable Prisma Schema Linting](https://docs.coderabbit.ai/reference/configuration#enable-prisma-schema-linting) * [Pylint](https://docs.coderabbit.ai/reference/configuration#pylint) * [Enable Pylint](https://docs.coderabbit.ai/reference/configuration#enable-pylint) * [Regal](https://docs.coderabbit.ai/reference/configuration#regal) * [Enable Regal](https://docs.coderabbit.ai/reference/configuration#enable-regal) * [RuboCop](https://docs.coderabbit.ai/reference/configuration#rubocop) * [Enable RuboCop](https://docs.coderabbit.ai/reference/configuration#enable-rubocop) * [Ruff](https://docs.coderabbit.ai/reference/configuration#ruff) * [Enable Ruff](https://docs.coderabbit.ai/reference/configuration#enable-ruff) * [Semgrep](https://docs.coderabbit.ai/reference/configuration#semgrep) * [Enable Semgrep](https://docs.coderabbit.ai/reference/configuration#enable-semgrep) * [Config File](https://docs.coderabbit.ai/reference/configuration#config-file-5) * [ShellCheck](https://docs.coderabbit.ai/reference/configuration#shellcheck) * [Enable ShellCheck](https://docs.coderabbit.ai/reference/configuration#enable-shellcheck) * [Shopify Theme Check](https://docs.coderabbit.ai/reference/configuration#shopify-theme-check) * [Enable Shopify Theme Check](https://docs.coderabbit.ai/reference/configuration#enable-shopify-theme-check) * [SQLFluff](https://docs.coderabbit.ai/reference/configuration#sqlfluff) * [Enable SQLFluff](https://docs.coderabbit.ai/reference/configuration#enable-sqlfluff) * [SwiftLint](https://docs.coderabbit.ai/reference/configuration#swiftlint) * [Enable SwiftLint](https://docs.coderabbit.ai/reference/configuration#enable-swiftlint) * [Config File](https://docs.coderabbit.ai/reference/configuration#config-file-6) * [YAMLlint](https://docs.coderabbit.ai/reference/configuration#yamllint) * [Enable YAMLlint](https://docs.coderabbit.ai/reference/configuration#enable-yamllint) 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](https://docs.coderabbit.ai/guides/configuration-overview) . [​](https://docs.coderabbit.ai/reference/configuration#how-to-use-this-reference) How to use this reference -------------------------------------------------------------------------------------------------------------- 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](https://docs.coderabbit.ai/guides/organization-settings) and [repository settings](https://docs.coderabbit.ai/guides/repository-settings) . * The **coderabbit.yaml** tab displays information about the field’s location and datatype in [your repository’s `.coderabbit.yaml` file](https://docs.coderabbit.ai/getting-started/configure-coderabbit) . [​](https://docs.coderabbit.ai/reference/configuration#global-settings) Global Settings ------------------------------------------------------------------------------------------ ### [​](https://docs.coderabbit.ai/reference/configuration#data-retention) Data retention * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | General > Data Retention | | **Default** | true | 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. ### [​](https://docs.coderabbit.ai/reference/configuration#early-access) Early Access * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | General > Early Access | | **Default** | false | If enabled, then CodeRabbit lets you use early-access features in your code reviews. ### [​](https://docs.coderabbit.ai/reference/configuration#enable-free-tier) Enable Free Tier * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | General > Enable Free Tier | | **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) . ### [​](https://docs.coderabbit.ai/reference/configuration#language) Language * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | General > Language | | **Default** | en-US | Defines the written language that CodeRabbit presents its review comments in. Defaults to U.S. English. ### [​](https://docs.coderabbit.ai/reference/configuration#tone-instructions) Tone Instructions * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | General > Tone Instructions | | **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.` [​](https://docs.coderabbit.ai/reference/configuration#review) Review ------------------------------------------------------------------------ ### [​](https://docs.coderabbit.ai/reference/configuration#basic-review-settings) Basic Review Settings #### [​](https://docs.coderabbit.ai/reference/configuration#abort-on-close) Abort On Close * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Abort On Close | | **Default** | true | Abort the in-progress review if the pull request is closed or merged. #### [​](https://docs.coderabbit.ai/reference/configuration#assess-linked-issues) Assess Linked Issues * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Assess Linked Issues | | **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 management system of GitHub or GitLab. * You have integrated CodeRabbit with an external issue manager. For more information, see [Integrate issue tracking](https://docs.coderabbit.ai/integrations/issue-integrations) and [Let CodeRabbit read your issue tracker](https://docs.coderabbit.ai/guides/setup-best-practices#issues) . #### [​](https://docs.coderabbit.ai/reference/configuration#auto-apply-labels) Auto Apply Labels * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Auto Apply Labels | | **Default** | false | Automatically apply the suggested labels to the PR/MR. #### [​](https://docs.coderabbit.ai/reference/configuration#auto-assign-reviewers) Auto Assign Reviewers * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Auto Assign Reviewers | | **Default** | false | Automatically assign suggested reviewers to the pull request #### [​](https://docs.coderabbit.ai/reference/configuration#auto-title-instructions) Auto Title Instructions * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Auto Title Instructions | | **Default** | | Custom instructions for auto-generating the PR/MR title. #### [​](https://docs.coderabbit.ai/reference/configuration#auto-title-placeholder) Auto Title Placeholder * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Auto Title Placeholder | | **Default** | @coderabbitai | Add this keyword in the PR/MR title to auto-generate the title. #### [​](https://docs.coderabbit.ai/reference/configuration#changed-files-summary) Changed Files Summary * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Changed Files Summary | | **Default** | true | Generate a summary of the changed files in the walkthrough. #### [​](https://docs.coderabbit.ai/reference/configuration#collapse-walkthrough) Collapse Walkthrough * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Collapse Walkthrough | | **Default** | false | Generate walkthrough in a markdown collapsible section. #### [​](https://docs.coderabbit.ai/reference/configuration#commit-status) Commit Status * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Commit Status | | **Default** | true | Set the commit status to ‘pending’ when the review is in progress and ‘success’ when it is complete. #### [​](https://docs.coderabbit.ai/reference/configuration#disable-cache) Disable Cache * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Disable Cache | | **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 repository for up to seven days after its most recent code review. This cache lets CodeRabbit save time and effort in between subsequent reviews of the same repository. For more information, see [Caching](https://docs.coderabbit.ai/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) . The [Data Retention](https://docs.coderabbit.ai/reference/configuration#data-retention) setting overrides this one. If you disable all data retention, then your repositories won’t keep a cache. #### [​](https://docs.coderabbit.ai/reference/configuration#fail-commit-status) Fail Commit Status * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Fail Commit Status | | **Default** | false | Set the commit status to ‘failure’ when the PR cannot be reviewed by CodeRabbit for any reason. #### [​](https://docs.coderabbit.ai/reference/configuration#high-level-summary) High Level Summary * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > High Level Summary | | **Default** | true | Generate a high level summary of the changes in the PR/MR description. #### [​](https://docs.coderabbit.ai/reference/configuration#high-level-summary-in-walkthrough) High Level Summary In Walkthrough * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > High Level Summary In Walkthrough | | **Default** | false | Include the high level summary in the walkthrough comment. #### [​](https://docs.coderabbit.ai/reference/configuration#high-level-summary-placeholder) High Level Summary Placeholder * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > High Level Summary Placeholder | | **Default** | @coderabbitai summary | Placeholder in the PR/MR description that gets replaced with the high level summary. #### [​](https://docs.coderabbit.ai/reference/configuration#labeling-instructions) Labeling Instructions * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Labeling Instructions | | **Default** | _Empty array_ | 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. #### [​](https://docs.coderabbit.ai/reference/configuration#path-filters) Path Filters * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Path Filters | | **Default** | _Empty array_ | 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: Copy src/** !**/*.{bin,csv} 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) . #### [​](https://docs.coderabbit.ai/reference/configuration#path-instructions) Path Instructions * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Path Instructions | | **Default** | _Empty array_ | Path instructions are additional sets of instructions, expressed in natural language, that you provide to CodeRabbit for reviewing certain files in your repository. You associate each set of instructions 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 repository’s `src` directory: * Example path settings: Web UI * Example path settings: coderabbit.yaml ![An example path instruction](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/reference/path-instructions.png) For further examples of path instructions specific to various programming languages, see [the `awesome-coderabbit` public repository](https://github.com/coderabbitai/awesome-coderabbit/tree/main/configs) . #### [​](https://docs.coderabbit.ai/reference/configuration#poem) Poem * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Poem | | **Default** | true | Generate a poem in the walkthrough comment. #### [​](https://docs.coderabbit.ai/reference/configuration#profile) Profile * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Profile | | **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. #### [​](https://docs.coderabbit.ai/reference/configuration#related-issues) Related Issues * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Related Issues | | **Default** | true | Include possibly related issues in the walkthrough. #### [​](https://docs.coderabbit.ai/reference/configuration#related-prs) Related PRs * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Related PRs | | **Default** | true | Include possibly related pull requests in the walkthrough. #### [​](https://docs.coderabbit.ai/reference/configuration#request-changes-workflow) Request Changes Workflow * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Request Changes Workflow | | **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. #### [​](https://docs.coderabbit.ai/reference/configuration#review-status) Review Status * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Review Status | | **Default** | true | Post review details on each review. Additionally, post a review status when a review is skipped in certain cases. #### [​](https://docs.coderabbit.ai/reference/configuration#sequence-diagrams) Sequence Diagrams * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Sequence Diagrams | | **Default** | true | Generate sequence diagrams in the walkthrough. #### [​](https://docs.coderabbit.ai/reference/configuration#suggested-labels) Suggested Labels * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Suggested Labels | | **Default** | true | Suggest labels based on the changes in the pull request in the walkthrough. #### [​](https://docs.coderabbit.ai/reference/configuration#suggested-reviewers) Suggested Reviewers * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Settings > Suggested Reviewers | | **Default** | true | Suggest reviewers based on the changes in the pull request in the walkthrough. ### [​](https://docs.coderabbit.ai/reference/configuration#automatic-review) Automatic Review #### [​](https://docs.coderabbit.ai/reference/configuration#enable-automatic-review) Enable Automatic Review * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Auto Review > Automatic Review | | **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](https://docs.coderabbit.ai/guides/code-review-overview#review) . Disabling this setting also effectively disables all of the other settings listed in this section. #### [​](https://docs.coderabbit.ai/reference/configuration#automatic-incremental-review) Automatic Incremental Review * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Auto Review > Automatic Incremental Review | | **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](https://docs.coderabbit.ai/guides/code-review-overview#review) . We recommend leaving this option enabled. #### [​](https://docs.coderabbit.ai/reference/configuration#base-branches) Base Branches * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Auto Review > Base Branches | | **Default** | _Empty array_ | A list of branches that CodeRabbit performs automatic code reviews on, other than the repository’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. #### [​](https://docs.coderabbit.ai/reference/configuration#drafts) Drafts * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Auto Review > Drafts | | **Default** | false | If defined, then CodeRabbit automatically reviews pull requests marked as a draft in your Git platform. #### [​](https://docs.coderabbit.ai/reference/configuration#ignore-title-keywords) Ignore Title Keywords * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Auto Review > Ignore Title Keywords | | **Default** | _Empty array_ | Ignore reviewing if the title of the pull request contains any of these keywords (case-insensitive). #### [​](https://docs.coderabbit.ai/reference/configuration#labels) Labels * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Auto Review > Labels | | **Default** | _Empty array_ | 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](https://docs.coderabbit.ai/guides/code-review-overview#review) . ### [​](https://docs.coderabbit.ai/reference/configuration#finishing-touches) Finishing Touches #### [​](https://docs.coderabbit.ai/reference/configuration#docstrings) Docstrings * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Finishing Touches > Docstrings | | **Default** | true | If enabled, then CodeRabbit can generate inline documentation for functions added in a pull request. For more information, see [Docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) . #### [​](https://docs.coderabbit.ai/reference/configuration#unit-tests) Unit Tests * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Finishing Touches > Unit Tests | | **Default** | true | If enabled, then CodeRabbit can generate unit tests for code added in a pull request. For more information, see [Unit Test Generation](https://docs.coderabbit.ai/finishing-touches/unit-test-generation) . [​](https://docs.coderabbit.ai/reference/configuration#chat) Chat -------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/reference/configuration#auto-reply) Auto Reply * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Chat > Auto Reply | | **Default** | true | Enable the bot to reply automatically without requiring the user to tag it. ### [​](https://docs.coderabbit.ai/reference/configuration#integrations) Integrations ### [​](https://docs.coderabbit.ai/reference/configuration#jira) Jira * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Chat > Jira | | **Default** | auto | Enable the Jira integration for opening issues, etc. ‘auto’ disables the integration for public repositories. ### [​](https://docs.coderabbit.ai/reference/configuration#linear) Linear * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Chat > Linear | | **Default** | auto | Enable the Linear integration for opening issues, etc. ‘auto’ disables the integration for public repositories. [​](https://docs.coderabbit.ai/reference/configuration#knowledge-base) Knowledge Base ---------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/reference/configuration#basic-settings) Basic settings #### [​](https://docs.coderabbit.ai/reference/configuration#opt-out) Opt Out * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Knowledge Base > Opt Out | | **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. #### [​](https://docs.coderabbit.ai/reference/configuration#pull-requests) Pull Requests * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Knowledge Base > Pull Requests | | **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. #### [​](https://docs.coderabbit.ai/reference/configuration#web-search) Web Search * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Knowledge Base > Web Search | | **Default** | true | Enable the web search integration. ### [​](https://docs.coderabbit.ai/reference/configuration#issues) Issues * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Knowledge Base > Issues | | **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. ### [​](https://docs.coderabbit.ai/reference/configuration#jira-2) Jira #### [​](https://docs.coderabbit.ai/reference/configuration#enable-jira) Enable Jira * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Knowledge Base > Jira | | **Default** | auto | Enable the Jira knowledge base integration. ‘auto’ disables the integration for public repositories. #### [​](https://docs.coderabbit.ai/reference/configuration#project-keys) Project Keys * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Knowledge Base > Project Keys | | **Default** | _Empty array_ | Specify the Jira project keys to use for the knowledge base. ### [​](https://docs.coderabbit.ai/reference/configuration#learnings) Learnings * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Knowledge Base > Learnings | | **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. ### [​](https://docs.coderabbit.ai/reference/configuration#linear-2) Linear #### [​](https://docs.coderabbit.ai/reference/configuration#enable-linear) Enable Linear * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Knowledge Base > Linear | | **Default** | auto | Enable the Linear knowledge base integration. ‘auto’ disables the integration for public repositories. #### [​](https://docs.coderabbit.ai/reference/configuration#team-keys) Team Keys * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Knowledge Base > Team Keys | | **Default** | _Empty array_ | Specify the Linear team keys (identifiers) to use for the knowledge base. E.g. ‘ENG’ [​](https://docs.coderabbit.ai/reference/configuration#code-generation) Code Generation ------------------------------------------------------------------------------------------ ### [​](https://docs.coderabbit.ai/reference/configuration#code-generation-language) Code Generation Language * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Code Generation > Language | | **Default** | en-US | Set the language for docstrings by using the corresponding ISO language code. ### [​](https://docs.coderabbit.ai/reference/configuration#docstring-path-instructions) Docstring Path Instructions * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Code Generation > Path Instructions | | **Default** | _Empty array_ | Provide additional guidelines for docstring generation based on file paths. ### [​](https://docs.coderabbit.ai/reference/configuration#unit-test-path-instructions) Unit Test Path Instructions * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Code Generation > Unit Test Generation | | **Default** | _Empty array_ | Provide additional guidelines for unit test generation based on file paths. [​](https://docs.coderabbit.ai/reference/configuration#tools) Tools ---------------------------------------------------------------------- CodeRabbit integrates with various third-party tools for enhanced code analysis. ### [​](https://docs.coderabbit.ai/reference/configuration#actionlint) actionlint actionlint is a static checker for GitHub Actions workflow files. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-actionlint) Enable actionlint * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable actionlint | | **Default** | true | is a static checker for GitHub Actions workflow files. ### [​](https://docs.coderabbit.ai/reference/configuration#ast-grep) 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 #### [​](https://docs.coderabbit.ai/reference/configuration#essential-rules) Essential Rules * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > ast-grep > Essential Rules | | **Default** | true | Use ast-grep essentials package. #### [​](https://docs.coderabbit.ai/reference/configuration#packages) Packages * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > ast-grep > Packages | | **Default** | _Empty array_ | Predefined packages to be used. #### [​](https://docs.coderabbit.ai/reference/configuration#rule-dirs) Rule Dirs * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > ast-grep > Rule Dirs | | **Default** | _Empty array_ | List of rules directories. #### [​](https://docs.coderabbit.ai/reference/configuration#util-dirs) Util Dirs * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > ast-grep > Util Dirs | | **Default** | _Empty array_ | List of utils directories. ### [​](https://docs.coderabbit.ai/reference/configuration#biome) Biome Biome is a fast formatter, linter, and analyzer for web projects. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-biome) Enable Biome * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Biome | | **Default** | true | Biome is a fast formatter, linter, and analyzer for web projects. ### [​](https://docs.coderabbit.ai/reference/configuration#brakeman) Brakeman Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. | v7.0.2 #### [​](https://docs.coderabbit.ai/reference/configuration#enable-brakeman) Enable Brakeman * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Brakeman | | **Default** | true | Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. ### [​](https://docs.coderabbit.ai/reference/configuration#buf) Buf Buf offers linting for Protobuf files. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-buf) Enable Buf * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Buf | | **Default** | true | Buf offers linting for Protobuf files. ### [​](https://docs.coderabbit.ai/reference/configuration#checkmake) checkmake checkmake is a linter for Makefiles. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-checkmake) Enable checkmake * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable checkmake | | **Default** | true | checkmake is a linter for Makefiles. ### [​](https://docs.coderabbit.ai/reference/configuration#checkov) Checkov Checkov is a static code analysis tool for infrastructure-as-code files. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-checkov) Enable Checkov * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Checkov | | **Default** | true | Checkov is a static code analysis tool for infrastructure-as-code files. ### [​](https://docs.coderabbit.ai/reference/configuration#circleci) CircleCI CircleCI tool is a static checker for CircleCI config files. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-circleci) Enable CircleCI * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable CircleCI | | **Default** | true | CircleCI tool is a static checker for CircleCI config files. ### [​](https://docs.coderabbit.ai/reference/configuration#clippy) Clippy Clippy is a collection of lints to catch common mistakes and improve your Rust code. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-clippy) Enable Clippy * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Clippy | | **Default** | true | Clippy is a collection of lints to catch common mistakes and improve your Rust code. ### [​](https://docs.coderabbit.ai/reference/configuration#cppcheck) Cppcheck Cppcheck is a static code analysis tool for the C and C++ programming languages. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-cppcheck) Enable Cppcheck * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Cppcheck | | **Default** | true | Cppcheck is a static code analysis tool for the C and C++ programming languages. ### [​](https://docs.coderabbit.ai/reference/configuration#detekt) detekt Detekt is a static code analysis tool for Kotlin files. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-detekt) Enable detekt * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > detekt > Enable | | **Default** | true | Enable detekt. #### [​](https://docs.coderabbit.ai/reference/configuration#config-file) Config File * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > detekt > Config File | | **Default** | _No default_ | Optional path to the detekt configuration file relative to the repository. ### [​](https://docs.coderabbit.ai/reference/configuration#dotenv-linter) dotenv-linter dotenv-linter is a tool for checking and fixing .env files for problems and best practices #### [​](https://docs.coderabbit.ai/reference/configuration#enable-dotenv-linter) Enable dotenv-linter * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable dotenv-linter | | **Default** | true | dotenv-linter is a tool for checking and fixing .env files for problems and best practices ### [​](https://docs.coderabbit.ai/reference/configuration#eslint) ESLint ESLint is a static code analysis tool for JavaScript files. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-eslint) Enable ESLint * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable ESLint | | **Default** | true | ESLint is a static code analysis tool for JavaScript files. ### [​](https://docs.coderabbit.ai/reference/configuration#flake8) Flake8 Flake8 is a static code analysis tool for Python files. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-flake8) Enable Flake8 * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Flake8 > Enable | | **Default** | true | Flake8 is a static code analysis tool for Python files. ### [​](https://docs.coderabbit.ai/reference/configuration#github-checks) GitHub Checks GitHub Checks integration configuration. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-github-checks) Enable GitHub Checks * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > GitHub Checks > Enable | | **Default** | true | Enable integration, defaults to true #### [​](https://docs.coderabbit.ai/reference/configuration#timeout-ms) Timeout Ms * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > GitHub Checks > Timeout Ms | | **Default** | 90000 | Time in milliseconds to wait for all GitHub Checks to conclude. ### [​](https://docs.coderabbit.ai/reference/configuration#gitleaks) Gitleaks Gitleaks is a secret scanner. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-gitleaks) Enable Gitleaks * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Gitleaks | | **Default** | true | Gitleaks is a secret scanner. ### [​](https://docs.coderabbit.ai/reference/configuration#golangci-lint) golangci-lint golangci-lint is a fast linters runner for Go. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-golangci-lint) Enable golangci-lint * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > golangci-lint > Enable | | **Default** | true | Enable golangci-lint. #### [​](https://docs.coderabbit.ai/reference/configuration#config-file-2) Config File * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > golangci-lint > Config File | | **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’. ### [​](https://docs.coderabbit.ai/reference/configuration#hadolint) Hadolint Hadolint is a Dockerfile linter. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-hadolint) Enable Hadolint * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Hadolint | | **Default** | true | Hadolint is a Dockerfile linter. ### [​](https://docs.coderabbit.ai/reference/configuration#htmlhint) HTMLHint HTMLHint is a static code analysis tool for HTML files. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-htmlhint) Enable HTMLHint * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > HTMLHint > Enable | | **Default** | true | Enable HTMLHint. #### [​](https://docs.coderabbit.ai/reference/configuration#config-file-3) Config File * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > HTMLHint > Config File | | **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’. ### [​](https://docs.coderabbit.ai/reference/configuration#languagetool) LanguageTool LanguageTool is a style and grammar checker for 30+ languages. #### [​](https://docs.coderabbit.ai/reference/configuration#disabled-categories) Disabled Categories * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > LanguageTool > Disabled Categories | | **Default** | _Empty array_ | IDs of categories to be disabled. Note: TYPOS, TYPOGRAPHY, and CASING are always disabled. #### [​](https://docs.coderabbit.ai/reference/configuration#disabled-rules) Disabled Rules * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > LanguageTool > Disabled Rules | | **Default** | _Empty array_ | IDs of rules to be disabled. Note: EN\_UNPAIRED\_BRACKETS, and EN\_UNPAIRED\_QUOTES are always disabled. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-languagetool) Enable LanguageTool * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > LanguageTool > Enable | | **Default** | true | Enable LanguageTool #### [​](https://docs.coderabbit.ai/reference/configuration#enabled-categories) Enabled Categories * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > LanguageTool > Enabled Categories | | **Default** | _Empty array_ | IDs of categories to be enabled. #### [​](https://docs.coderabbit.ai/reference/configuration#enabled-only) Enabled Only * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > LanguageTool > Enabled Only | | **Default** | false | Only the rules and categories whose IDs are specified with ‘enabledRules’ or ‘enabledCategories’ are enabled. #### [​](https://docs.coderabbit.ai/reference/configuration#enabled-rules) Enabled Rules * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > LanguageTool > Enabled Rules | | **Default** | _Empty array_ | IDs of rules to be enabled. The rule won’t run unless ‘level’ is set to a level that activates the rule. #### [​](https://docs.coderabbit.ai/reference/configuration#level) Level * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > LanguageTool > Level | | **Default** | default | If set to ‘picky’, additional rules will be activated, i.e. rules that you might only find useful when checking formal text. ### [​](https://docs.coderabbit.ai/reference/configuration#luacheck) Luacheck Configuration for Lua code linting to ensure code quality #### [​](https://docs.coderabbit.ai/reference/configuration#enable-luacheck) Enable Luacheck * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Luacheck | | **Default** | true | Luacheck helps maintain consistent and error-free Lua code ### [​](https://docs.coderabbit.ai/reference/configuration#markdownlint) markdownlint markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-markdownlint) Enable markdownlint * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable markdownlint | | **Default** | true | markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files. ### [​](https://docs.coderabbit.ai/reference/configuration#oxlint) Oxlint Oxlint is a JavaScript/TypeScript linter for OXC written in Rust. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-oxlint) Enable Oxlint * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Oxlint | | **Default** | true | Oxlint is a JavaScript/TypeScript linter for OXC written in Rust. ### [​](https://docs.coderabbit.ai/reference/configuration#phpstan) PHPStan PHPStan is a tool to analyze PHP code. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-phpstan) Enable PHPStan * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > PHPStan > Enable | | **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. #### [​](https://docs.coderabbit.ai/reference/configuration#level-2) Level * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > PHPStan > Level | | **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. ### [​](https://docs.coderabbit.ai/reference/configuration#pmd) PMD PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-pmd) Enable PMD * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > PMD > Enable | | **Default** | true | Enable PMD. #### [​](https://docs.coderabbit.ai/reference/configuration#config-file-4) Config File * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > PMD > Config File | | **Default** | _No default_ | Optional path to the PMD configuration file relative to the repository. ### [​](https://docs.coderabbit.ai/reference/configuration#phpmd) PHPMD PHPMD is a static code analysis tool for PHP files. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-phpmd) Enable PHPMD * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable PHPMD | | **Default** | true | PHPMD is a static code analysis tool for PHP files. ### [​](https://docs.coderabbit.ai/reference/configuration#phpcs) PHPCS PHPCS is a static code analysis and coding-standard checker for PHP (plus JS/CSS) files. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-phpcs) Enable PHPCS * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable PHPCS | | **Default** | true | PHPCS is a static code analysis tool for PHP, JavaScript and CSS files. ### [​](https://docs.coderabbit.ai/reference/configuration#prisma-schema-linting) Prisma Schema Linting Configuration for Prisma Schema linting to ensure schema file quality #### [​](https://docs.coderabbit.ai/reference/configuration#enable-prisma-schema-linting) Enable Prisma Schema Linting * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Prisma Schema Linting | | **Default** | true | Prisma Schema linting helps maintain consistent and error-free schema files ### [​](https://docs.coderabbit.ai/reference/configuration#pylint) Pylint Pylint is a Python static code analysis tool. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-pylint) Enable Pylint * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Pylint | | **Default** | true | Pylint is a Python static code analysis tool. ### [​](https://docs.coderabbit.ai/reference/configuration#regal) Regal Regal is a linter and language server for Rego. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-regal) Enable Regal * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Regal | | **Default** | true | Regal is a linter and language server for Rego. ### [​](https://docs.coderabbit.ai/reference/configuration#rubocop) RuboCop RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-rubocop) Enable RuboCop * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable RuboCop | | **Default** | true | RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. ### [​](https://docs.coderabbit.ai/reference/configuration#ruff) Ruff Ruff is a Python linter and code formatter. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-ruff) Enable Ruff * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Ruff | | **Default** | true | Ruff is a Python linter and code formatter. ### [​](https://docs.coderabbit.ai/reference/configuration#semgrep) Semgrep Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-semgrep) Enable Semgrep * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Semgrep > Enable | | **Default** | true | Enable Semgrep. #### [​](https://docs.coderabbit.ai/reference/configuration#config-file-5) Config File * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Semgrep > Config File | | **Default** | _No default_ | Optional path to the Semgrep configuration file relative to the repository. ### [​](https://docs.coderabbit.ai/reference/configuration#shellcheck) ShellCheck ShellCheck is a static analysis tool that finds bugs in your shell scripts. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-shellcheck) Enable ShellCheck * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable ShellCheck | | **Default** | true | ShellCheck is a static analysis tool that finds bugs in your shell. ### [​](https://docs.coderabbit.ai/reference/configuration#shopify-theme-check) Shopify Theme Check Configuration for Shopify Theme Check to ensure theme quality and best practices #### [​](https://docs.coderabbit.ai/reference/configuration#enable-shopify-theme-check) Enable Shopify Theme Check * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable Shopify Theme Check | | **Default** | true | A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices ### [​](https://docs.coderabbit.ai/reference/configuration#sqlfluff) SQLFluff SQLFluff is an open source, dialect-flexible and configurable SQL linter. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-sqlfluff) Enable SQLFluff * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable SQLFluff | | **Default** | true | SQLFluff is an open source, dialect-flexible and configurable SQL linter. ### [​](https://docs.coderabbit.ai/reference/configuration#swiftlint) SwiftLint SwiftLint integration configuration object. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-swiftlint) Enable SwiftLint * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > SwiftLint > Enable | | **Default** | true | Enable SwiftLint. #### [​](https://docs.coderabbit.ai/reference/configuration#config-file-6) Config File * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > SwiftLint > Config File | | **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’. ### [​](https://docs.coderabbit.ai/reference/configuration#yamllint) YAMLlint YAMLlint is a linter for YAML files. #### [​](https://docs.coderabbit.ai/reference/configuration#enable-yamllint) Enable YAMLlint * Web UI * .coderabbit.yaml | | | | --- | --- | | **Location** | Review > Tools > Enable YAMLlint | | **Default** | true | YAMLlint is a linter for YAML files. [Code review commands](https://docs.coderabbit.ai/reference/review-commands) [Configuration file template](https://docs.coderabbit.ai/reference/yaml-template) Assistant Responses are generated using AI and may contain mistakes. --- # On-prem CodeRabbit & Bitbucket Datacenter - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Self-host CodeRabbit On-prem CodeRabbit & Bitbucket Datacenter The self-hosted option is only available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](https://docs.coderabbit.ai/cdn-cgi/l/email-protection#1b687a777e685b78747f7e697a7979726f357a72) to learn more about the CodeRabbit Enterprise plan. [​](https://docs.coderabbit.ai/self-hosted/bitbucket#create-a-bitbucket-user%E2%80%8B) Create a Bitbucket User[​](https://docs.coderabbit.ai/self-hosted/bitbucket#create-a-bitbucket-user "Direct link to 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](https://docs.coderabbit.ai/assets/files/logo-144a28a895bdf0158c57d2cb016780d8.png) as the profile picture to ensures easy recognition. [​](https://docs.coderabbit.ai/self-hosted/bitbucket#add-user-to-projects%E2%80%8B) Add User to Projects[​](https://docs.coderabbit.ai/self-hosted/bitbucket#add-user-to-projects "Direct link to 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 [​](https://docs.coderabbit.ai/self-hosted/bitbucket#create-a-personal-access-token-for-coderabbit-user%E2%80%8B) Create a Personal Access Token for CodeRabbit user[​](https://docs.coderabbit.ai/self-hosted/bitbucket#create-a-personal-access-token-for-coderabbit-user "Direct link to 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`. [​](https://docs.coderabbit.ai/self-hosted/bitbucket#add-a-webhook-to-each-project%E2%80%8B) Add a webhook to each project[​](https://docs.coderabbit.ai/self-hosted/bitbucket#add-a-webhook-to-each-project "Direct link to 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`). [​](https://docs.coderabbit.ai/self-hosted/bitbucket#prepare-a-env-file%E2%80%8B) Prepare a `.env` file[​](https://docs.coderabbit.ai/self-hosted/bitbucket#prepare-a-env-file "Direct link to prepare-a-env-file") ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Create a `.env` file with the following content: .env Copy # 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 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= 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= # optionally, use cross-region inference to access models in other regions # if this is set to `true`, CodeRabbit will access models from `us`, `eu`, or `ap` regions based on the AWS_REGION value. AWS_USE_CROSS_REGION_INFERENCE=[] # 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] # CodeRabbit - KNOWLEDGE BASE # # Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI. OBJECT_STORE_URI=[] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc. ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features. ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing. ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing. ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing. ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing. ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing. JIRA_HOST=[] JIRA_PAT=[] LINEAR_PAT=[] ENABLE_WEB_SEARCH=[true] PERPLEXITY_API_KEY=[] YAML_CONFIG=[] * 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. * `YAML_CONFIG` is an optional configuration file that can be used to customize CodeRabbit’s behavior at the deployment level. It takes the same format as the [CodeRabbit YAML configuration](https://docs.coderabbit.ai/getting-started/configure-coderabbit) file. It requires the entire YAML file to be in an escaped string format, for example, `YAML_CONFIG="key1: value1\nkey2: value2"`. You can use [Escape YAML](https://escapeyaml.dev/) to generate the escaped string. [​](https://docs.coderabbit.ai/self-hosted/bitbucket#pull-the-coderabbit-docker-image%E2%80%8B) Pull the CodeRabbit Docker image[​](https://docs.coderabbit.ai/self-hosted/bitbucket#pull-the-coderabbit-docker-image "Direct link to Pull the CodeRabbit Docker image") ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Authenticate and pull the Docker image using the provided credentials file: Copy 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 [​](https://docs.coderabbit.ai/self-hosted/bitbucket#host-the-image-%E2%80%8B) Host the image [​](https://docs.coderabbit.ai/self-hosted/bitbucket#host-the-image "Direct link to 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: Copy docker run --env-file .env --publish 127.0.0.1:8080:8080 us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest ### [​](https://docs.coderabbit.ai/self-hosted/bitbucket#verify-the-image-is-up-%E2%80%8B) Verify the image is up [​](https://docs.coderabbit.ai/self-hosted/bitbucket#verify-the-image-is-up "Direct link to Verify the image is up") You can query `/health` endpoint to verify that the `coderabbit-agent` service is up and running. Copy curl 127.0.0.1:8080/health [On-prem CodeRabbit & Azure DevOps](https://docs.coderabbit.ai/self-hosted/azure-devops) [Why CodeRabbit?](https://docs.coderabbit.ai/overview/why-coderabbit) Assistant Responses are generated using AI and may contain mistakes. --- # Biome - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Biome On this page * [Files](https://docs.coderabbit.ai/tools/biome#files) * [Configuration](https://docs.coderabbit.ai/tools/biome#configuration) * [Links](https://docs.coderabbit.ai/tools/biome#links) [Biome](https://biomejs.dev/) is a linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS. [​](https://docs.coderabbit.ai/tools/biome#files) Files ---------------------------------------------------------- Biome will run on files with the following extensions: * `.js` * `.ts` * `.cjs` * `.mjs` * `.d.cts` * `.d.mts` * `.jsx` * `.tsx` * `.json` * `.jsonc` * `.css` [​](https://docs.coderabbit.ai/tools/biome#configuration) Configuration -------------------------------------------------------------------------- Biome supports the following config files: * `biome.jsonc` * `biome.json` CodeRabbit will use the default settings based on the profile selected if no config file is found. [​](https://docs.coderabbit.ai/tools/biome#links) Links ---------------------------------------------------------- * [Biome Configuration](https://biomejs.dev/reference/configuration/) [actionlint](https://docs.coderabbit.ai/tools/actionlint) [Brakeman](https://docs.coderabbit.ai/tools/brakeman) Assistant Responses are generated using AI and may contain mistakes. --- # actionlint - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools actionlint On this page * [Files](https://docs.coderabbit.ai/tools/actionlint#files) * [Configuration](https://docs.coderabbit.ai/tools/actionlint#configuration) * [Links](https://docs.coderabbit.ai/tools/actionlint#links) [`actionlint`](https://github.com/rhysd/actionlint/) is a static checker for GitHub Actions workflow files. [​](https://docs.coderabbit.ai/tools/actionlint#files) Files --------------------------------------------------------------- We look for `GitHub Action` files specifically in the following directory: * `.github/workflows/**/*.yml` * `.github/workflows/**/*.yaml"` [​](https://docs.coderabbit.ai/tools/actionlint#configuration) Configuration ------------------------------------------------------------------------------- CodeRabbit will use the default configuration. [​](https://docs.coderabbit.ai/tools/actionlint#links) Links --------------------------------------------------------------- * [`actionlint` Configuration](https://github.com/rhysd/actionlint/blob/main/docs/config.md/) [List of supported tools](https://docs.coderabbit.ai/tools/list) [Biome](https://docs.coderabbit.ai/tools/biome) Assistant Responses are generated using AI and may contain mistakes. --- # Brakeman - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Brakeman On this page * [Supported Files](https://docs.coderabbit.ai/tools/brakeman#supported-files) * [Features](https://docs.coderabbit.ai/tools/brakeman#features) * [Links](https://docs.coderabbit.ai/tools/brakeman#links) [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. [​](https://docs.coderabbit.ai/tools/brakeman#supported-files) Supported Files --------------------------------------------------------------------------------- Brakeman will run on files with the following extensions: * `Gemfile` * `*.rb` * `*.erb` [​](https://docs.coderabbit.ai/tools/brakeman#features) 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 [​](https://docs.coderabbit.ai/tools/brakeman#links) 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/) [Biome](https://docs.coderabbit.ai/tools/biome) [Buf](https://docs.coderabbit.ai/tools/buf) Assistant Responses are generated using AI and may contain mistakes. --- # Buf - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Buf On this page * [Files](https://docs.coderabbit.ai/tools/buf#files) * [Configuration](https://docs.coderabbit.ai/tools/buf#configuration) * [Chill](https://docs.coderabbit.ai/tools/buf#chill) * [Assertive](https://docs.coderabbit.ai/tools/buf#assertive) * [Links](https://docs.coderabbit.ai/tools/buf#links) [Buf](https://buf.build/) offers linting for Protobuf files. [​](https://docs.coderabbit.ai/tools/buf#files) Files -------------------------------------------------------- Buf will run on files with the following extensions: * `.proto` [​](https://docs.coderabbit.ai/tools/buf#configuration) Configuration ------------------------------------------------------------------------ Buf uses a YAML style configuration file. We look for the following file anywhere in the repository: * `buf.yaml` If no config file is found, CodeRabbit will consider the following categories of strictness based on the profile selected: ### [​](https://docs.coderabbit.ai/tools/buf#chill) Chill * `MINIMAL` ### [​](https://docs.coderabbit.ai/tools/buf#assertive) Assertive * `BASIC` [​](https://docs.coderabbit.ai/tools/buf#links) Links -------------------------------------------------------- * [Buf Configuration](https://buf.build/docs/configuration/v2/buf-yaml#lint) [Brakeman](https://docs.coderabbit.ai/tools/brakeman) [Checkmake](https://docs.coderabbit.ai/tools/checkmake) Assistant Responses are generated using AI and may contain mistakes. --- # golangci-lint - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools golangci-lint On this page * [Files](https://docs.coderabbit.ai/tools/golangci-lint#files) * [Configuration](https://docs.coderabbit.ai/tools/golangci-lint#configuration) * [Links](https://docs.coderabbit.ai/tools/golangci-lint#links) [golangci-lint](https://golangci-lint.run/) is a fast Go linters runner. [​](https://docs.coderabbit.ai/tools/golangci-lint#files) Files ------------------------------------------------------------------ golangci-lint will run on files with the following extensions: * `.go` * `go.mod` [​](https://docs.coderabbit.ai/tools/golangci-lint#configuration) Configuration ---------------------------------------------------------------------------------- golangci-lint supports the following config files: * User-defined config file set at `reviews.tools.golangci-lint.config_file` in your project’s `.coderabbit.yaml` file or setting the “Review → Tools → golangci-lint → Config File” field in CodeRabbit’s settings page. * `.golangci.yml` * `.golangci.yaml` * `.golangci.toml` * `.golangci.json` [​](https://docs.coderabbit.ai/tools/golangci-lint#links) Links ------------------------------------------------------------------ * [golangci-lint Configuration](https://golangci-lint.run/usage/configuration/) [Gitleaks](https://docs.coderabbit.ai/tools/gitleaks) [Hadolint](https://docs.coderabbit.ai/tools/hadolint) Assistant Responses are generated using AI and may contain mistakes. --- # Checkmake - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Checkmake On this page * [Files](https://docs.coderabbit.ai/tools/checkmake#files) * [Configuration](https://docs.coderabbit.ai/tools/checkmake#configuration) * [Links](https://docs.coderabbit.ai/tools/checkmake#links) [Checkmake](https://github.com/mrtazz/checkmake) is a linter for Makefiles. [​](https://docs.coderabbit.ai/tools/checkmake#files) Files -------------------------------------------------------------- Checkmake will run checks against any `Makefile`. [​](https://docs.coderabbit.ai/tools/checkmake#configuration) 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. [​](https://docs.coderabbit.ai/tools/checkmake#links) Links -------------------------------------------------------------- * [Checkmake Configuration](https://github.com/mrtazz/checkmake#configuration) [Buf](https://docs.coderabbit.ai/tools/buf) [Checkov](https://docs.coderabbit.ai/tools/checkov) Assistant Responses are generated using AI and may contain mistakes. --- # Dotenv Linter - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Dotenv Linter On this page * [Files](https://docs.coderabbit.ai/tools/dotenv#files) * [Features](https://docs.coderabbit.ai/tools/dotenv#features) * [Links](https://docs.coderabbit.ai/tools/dotenv#links) [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. [​](https://docs.coderabbit.ai/tools/dotenv#files) Files ----------------------------------------------------------- Dotenv Linter will run on files with the following patterns: * `**/.env` * `**/.env.*` We will not run against files that do not start with `.env` (e.g., `test.env`). However `.env.dev` or `.env.local` is fine. Dotenv Linter does not require configuration to run and automatically anlysises `.env` files. If no configuration file is found, it will use default settings. [​](https://docs.coderabbit.ai/tools/dotenv#features) Features ----------------------------------------------------------------- Dotenv Linter can detect: * Key duplication * Missing values * Incorrect formatting * Invalid characters * And many more issues [​](https://docs.coderabbit.ai/tools/dotenv#links) Links ----------------------------------------------------------- * [Dotenv Linter GitHub Repository](https://github.com/dotenv-linter/dotenv-linter) [detekt](https://docs.coderabbit.ai/tools/detekt) [ESLint](https://docs.coderabbit.ai/tools/eslint) Assistant Responses are generated using AI and may contain mistakes. --- # CircleCI - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools CircleCI On this page * [Files](https://docs.coderabbit.ai/tools/circleci#files) * [Configuration](https://docs.coderabbit.ai/tools/circleci#configuration) * [Links](https://docs.coderabbit.ai/tools/circleci#links) [CircleCI](https://circleci.com/) is a static checker and validator for circleci config files. [​](https://docs.coderabbit.ai/tools/circleci#files) Files ------------------------------------------------------------- We look for `CircleCI Configuration` files specifically in the following directory: * `.circleci/config.yml` * `.circleci/config.yaml` [​](https://docs.coderabbit.ai/tools/circleci#configuration) Configuration ----------------------------------------------------------------------------- CodeRabbit will use the default configuration. [​](https://docs.coderabbit.ai/tools/circleci#links) Links ------------------------------------------------------------- * [CircleCI Configuration](https://circleci.com/docs/configuration-reference/) [Checkov](https://docs.coderabbit.ai/tools/checkov) [Clippy](https://docs.coderabbit.ai/tools/clippy) Assistant Responses are generated using AI and may contain mistakes. --- # Checkov - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Checkov On this page * [Files](https://docs.coderabbit.ai/tools/checkov#files) * [Configuration](https://docs.coderabbit.ai/tools/checkov#configuration) * [Chill](https://docs.coderabbit.ai/tools/checkov#chill) * [Assertive](https://docs.coderabbit.ai/tools/checkov#assertive) * [Links](https://docs.coderabbit.ai/tools/checkov#links) [Checkov](https://www.checkov.io/) is a static code analysis tool for scanning Infrastructure as Code (IaC) files for misconfigurations. [​](https://docs.coderabbit.ai/tools/checkov#files) Files ------------------------------------------------------------ Checkov will run on files with the following files and extensions: * `.tf` * `.yml` * `.yaml` * `.json` * `.template` * `.bicep` * `.hcl` * `bower.json` * `build.gradle` * `build.gradle.kts` * `go.sum` * `gradle.properties` * `METADATA` * `npm-shrinkwrap.json` * `package.json` * `package-lock.json` * `pom.xml` * `requirements.txt` * `Dockerfile` * `.dockerfile` * `Dockerfile.*` * `.csproj` * `yarn.lock` * `Gemfile` * `Gemfile.lock` * `go.mod` * `paket.dependencies` * `paket.lock` * `packages.config` * `composer.json` * `composer.lock` [​](https://docs.coderabbit.ai/tools/checkov#configuration) Configuration ---------------------------------------------------------------------------- CodeRabbit will include on the following severity levels based on the profile selected: ### [​](https://docs.coderabbit.ai/tools/checkov#chill) Chill * `HIGH` * `CRITICAL` ### [​](https://docs.coderabbit.ai/tools/checkov#assertive) Assertive * `MEDIUM` * `HIGH` * `CRITICAL` [​](https://docs.coderabbit.ai/tools/checkov#links) Links ------------------------------------------------------------ * [Checkov All Resource Scans](https://www.checkov.io/5.Policy%20Index/all.html) [Checkmake](https://docs.coderabbit.ai/tools/checkmake) [CircleCI](https://docs.coderabbit.ai/tools/circleci) Assistant Responses are generated using AI and may contain mistakes. --- # Regal - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Regal On this page * [Files](https://docs.coderabbit.ai/tools/regal#files) * [Configuration](https://docs.coderabbit.ai/tools/regal#configuration) * [Links](https://docs.coderabbit.ai/tools/regal#links) [Regal](https://docs.styra.com/regal/) is a linter and language server for Rego, the language of [Open Policy Agent](http://openpolicyagent.org/) (OPA). [​](https://docs.coderabbit.ai/tools/regal#files) Files ---------------------------------------------------------- Regal will run on files with the following extensions: * `.rego` [​](https://docs.coderabbit.ai/tools/regal#configuration) Configuration -------------------------------------------------------------------------- Regal uses a YAML configuration file located at `.regal/config.yaml`. CodeRabbit will use the default settings based on the profile selected if no configuration file is found. [​](https://docs.coderabbit.ai/tools/regal#links) Links ---------------------------------------------------------- * [Regal Configuration](https://docs.styra.com/regal#configuration) [Pylint](https://docs.coderabbit.ai/tools/pylint) [RuboCop](https://docs.coderabbit.ai/tools/rubocop) Assistant Responses are generated using AI and may contain mistakes. --- # Shopify CLI - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Shopify CLI On this page * [Requirements](https://docs.coderabbit.ai/tools/shopify-cli#requirements) * [File Types](https://docs.coderabbit.ai/tools/shopify-cli#file-types) * [Configuration Files](https://docs.coderabbit.ai/tools/shopify-cli#configuration-files) * [Directory Structure](https://docs.coderabbit.ai/tools/shopify-cli#directory-structure) * [Validation Rules](https://docs.coderabbit.ai/tools/shopify-cli#validation-rules) * [Theme Validation](https://docs.coderabbit.ai/tools/shopify-cli#theme-validation) * [App Validation](https://docs.coderabbit.ai/tools/shopify-cli#app-validation) * [Common Issues](https://docs.coderabbit.ai/tools/shopify-cli#common-issues) * [Links](https://docs.coderabbit.ai/tools/shopify-cli#links) [Shopify CLI](https://github.com/Shopify/cli) is a command-line tool that helps you build Shopify apps, themes, and custom storefronts. It provides functionality for initializing, building, developing, and deploying Shopify projects. [​](https://docs.coderabbit.ai/tools/shopify-cli#requirements) Requirements ------------------------------------------------------------------------------ The tool only runs when the following conditions are met: ### [​](https://docs.coderabbit.ai/tools/shopify-cli#file-types) File Types * Only processes pull requests changing `*.liquid` files ### [​](https://docs.coderabbit.ai/tools/shopify-cli#configuration-files) Configuration Files * Requires either `.theme-check.yml` or `.theme-check.yaml` configuration file in the project root ### [​](https://docs.coderabbit.ai/tools/shopify-cli#directory-structure) Directory Structure * Requires the standard Shopify theme directory structure at the project root: * `assets/` * `config/` * `layout/` * `locales/` * `sections/` * `snippets/` * `templates/` If any of these requirements are not met, the tool will not run. [​](https://docs.coderabbit.ai/tools/shopify-cli#validation-rules) Validation Rules -------------------------------------------------------------------------------------- The tool checks for: ### [​](https://docs.coderabbit.ai/tools/shopify-cli#theme-validation) Theme Validation * Liquid syntax errors * Theme requirements compliance * Asset organization * Performance best practices * Accessibility standards ### [​](https://docs.coderabbit.ai/tools/shopify-cli#app-validation) App Validation * App extension configuration * Function implementation * API version compatibility * Security best practices [​](https://docs.coderabbit.ai/tools/shopify-cli#common-issues) Common Issues -------------------------------------------------------------------------------- The tool helps identify and fix: 1. Theme Issues: * Invalid Liquid syntax * Missing required templates * Performance bottlenecks * Accessibility violations 2. App Issues: * Invalid API usage * Missing dependencies * Configuration errors * Security vulnerabilities [​](https://docs.coderabbit.ai/tools/shopify-cli#links) Links ---------------------------------------------------------------- * [Shopify CLI GitHub Repository](https://github.com/Shopify/cli) * [Shopify CLI Theme Documentation](https://shopify.dev/docs/api/shopify-cli/theme) * [Shopify CLI App Documentation](https://shopify.dev/docs/apps/tools/cli) * [Theme Development Requirements](https://shopify.dev/docs/themes/store/requirements) [ShellCheck](https://docs.coderabbit.ai/tools/shellcheck) [SQLFluff](https://docs.coderabbit.ai/tools/sqlfluff) Assistant Responses are generated using AI and may contain mistakes. --- # ShellCheck - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools ShellCheck On this page * [Files](https://docs.coderabbit.ai/tools/shellcheck#files) * [Configuration](https://docs.coderabbit.ai/tools/shellcheck#configuration) * [Chill](https://docs.coderabbit.ai/tools/shellcheck#chill) * [Assertive](https://docs.coderabbit.ai/tools/shellcheck#assertive) * [Links](https://docs.coderabbit.ai/tools/shellcheck#links) [ShellCheck](https://www.shellcheck.net/) is a linter for shell scripts. [​](https://docs.coderabbit.ai/tools/shellcheck#files) Files --------------------------------------------------------------- ShellCheck will run on files with the following extensions: * `.sh` * `.bash` * `.ksh` * `.dash` [​](https://docs.coderabbit.ai/tools/shellcheck#configuration) Configuration ------------------------------------------------------------------------------- CodeRabbit will use the following settings based on the profile selected: ### [​](https://docs.coderabbit.ai/tools/shellcheck#chill) Chill Copy --severity=warning ### [​](https://docs.coderabbit.ai/tools/shellcheck#assertive) Assertive Copy --severity=style [​](https://docs.coderabbit.ai/tools/shellcheck#links) Links --------------------------------------------------------------- * [ShellCheck Wiki](https://www.shellcheck.net/wiki/) [Semgrep](https://docs.coderabbit.ai/tools/semgrep) [Shopify CLI](https://docs.coderabbit.ai/tools/shopify-cli) Assistant Responses are generated using AI and may contain mistakes. --- # SwiftLint - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools SwiftLint On this page * [Files](https://docs.coderabbit.ai/tools/swiftlint#files) * [Configuration](https://docs.coderabbit.ai/tools/swiftlint#configuration) * [Links](https://docs.coderabbit.ai/tools/swiftlint#links) [SwiftLint](https://realm.github.io/SwiftLint/) is a linter for Swift. [​](https://docs.coderabbit.ai/tools/swiftlint#files) Files -------------------------------------------------------------- SwiftLint will run on files with the following extensions: * `.swift` [​](https://docs.coderabbit.ai/tools/swiftlint#configuration) Configuration ------------------------------------------------------------------------------ SwiftLint supports the following config files: * User-defined config file set at `reviews.tools.swiftlint.config_file` in your project’s `.coderabbit.yaml` file or setting the “Review → Tools → SwiftLint → Config File” field in CodeRabbit’s settings page. * `.swiftlint.yaml` * `.swiftlint.yml` CodeRabbit will use the default settings if no config file is found. [​](https://docs.coderabbit.ai/tools/swiftlint#links) Links -------------------------------------------------------------- * [SwiftLint Configuration](https://github.com/realm/SwiftLint?tab=readme-ov-file#configuration) [SQLFluff](https://docs.coderabbit.ai/tools/sqlfluff) [Caching](https://docs.coderabbit.ai/reference/caching) Assistant Responses are generated using AI and may contain mistakes. --- # SQLFluff - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools SQLFluff On this page * [Files](https://docs.coderabbit.ai/tools/sqlfluff#files) * [Configuration](https://docs.coderabbit.ai/tools/sqlfluff#configuration) * [Links](https://docs.coderabbit.ai/tools/sqlfluff#links) [SQLFluff](https://github.com/sqlfluff/sqlfluff) is a SQL linter and auto-formatter for standardizing SQL code. [​](https://docs.coderabbit.ai/tools/sqlfluff#files) Files ------------------------------------------------------------- SQLFluff will run on files with the following extensions: * `.sql` [​](https://docs.coderabbit.ai/tools/sqlfluff#configuration) Configuration ----------------------------------------------------------------------------- SQLFluff supports the following config files: * User-defined config file set at `reviews.tools.sqlfluff.config_file` in your project’s `.coderabbit.yaml` file or setting the “Review → Tools → SQLFluff → Config File” field in CodeRabbit’s settings page. * `setup.cfg` * `tox.ini` * `pep8.ini` * `.sqlfluff` * `pyproject.toml` CodeRabbit will only run SQLFluff if your repository contains a SQLFluff config file. This config must use one of the default file names listed above, or you must define the path to this file in the `.coderabbit.yaml` or config UI. [​](https://docs.coderabbit.ai/tools/sqlfluff#links) Links ------------------------------------------------------------- * [SQLFluff Configuration](https://docs.sqlfluff.com/en/stable/configuration.html) * [SQLFluff Rules Reference](https://docs.sqlfluff.com/en/stable/rules.html) [Shopify CLI](https://docs.coderabbit.ai/tools/shopify-cli) [SwiftLint](https://docs.coderabbit.ai/tools/swiftlint) Assistant Responses are generated using AI and may contain mistakes. --- # Hadolint - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Hadolint On this page * [Files](https://docs.coderabbit.ai/tools/hadolint#files) * [Configuration](https://docs.coderabbit.ai/tools/hadolint#configuration) * [Chill](https://docs.coderabbit.ai/tools/hadolint#chill) * [Assertive](https://docs.coderabbit.ai/tools/hadolint#assertive) * [Links](https://docs.coderabbit.ai/tools/hadolint#links) [Hadolint](https://github.com/hadolint/hadolint) is a Dockerfile linter. [​](https://docs.coderabbit.ai/tools/hadolint#files) Files ------------------------------------------------------------- Hadolint will run on files with the following file names: * `Dockerfile` * `*.dockerfile` * `Dockerfile.*` [​](https://docs.coderabbit.ai/tools/hadolint#configuration) Configuration ----------------------------------------------------------------------------- Hadolint supports the following config files: * `.hadolint.yaml` CodeRabbit will ignore the following severity levels if no config file is found: ### [​](https://docs.coderabbit.ai/tools/hadolint#chill) Chill * `none` * `ignore` * `style` * `info` * `warning` ### [​](https://docs.coderabbit.ai/tools/hadolint#assertive) Assertive * `none` * `ignore` * `style` [​](https://docs.coderabbit.ai/tools/hadolint#links) Links ------------------------------------------------------------- * [Hadolint Configuration](https://github.com/hadolint/hadolint?tab=readme-ov-file#configure) [golangci-lint](https://docs.coderabbit.ai/tools/golangci-lint) [HTMLHint](https://docs.coderabbit.ai/tools/htmlhint) Assistant Responses are generated using AI and may contain mistakes. --- # PMD - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools PMD On this page * [Files](https://docs.coderabbit.ai/tools/pmd#files) * [Configuration](https://docs.coderabbit.ai/tools/pmd#configuration) * [Links](https://docs.coderabbit.ai/tools/pmd#links) [PMD](https://pmd.github.io/) is an extensible multilanguage static code analyzer. It’s mainly concerned with Java. [​](https://docs.coderabbit.ai/tools/pmd#files) Files -------------------------------------------------------- PMD will run on files with the following extensions: * `.java` [​](https://docs.coderabbit.ai/tools/pmd#configuration) Configuration ------------------------------------------------------------------------ PMD uses an XML configuration file. PMD supports the following config files: * User-defined config file set at `reviews.tools.pmd.config_file` in your project’s `.coderabbit.yaml` file or setting the “Review → Tools → PMD → Config File” field in CodeRabbit’s settings page. * If no user-defined config file is found, we look for the following config file in the repo: * `ruleset.xml` [​](https://docs.coderabbit.ai/tools/pmd#links) Links -------------------------------------------------------- * [PMD Configuring rules](https://pmd.github.io/pmd/pmd_userdocs_configuring_rules.html) [Pipeline Failure Remediation](https://docs.coderabbit.ai/tools/pipeline-remediation) [Prisma Lint](https://docs.coderabbit.ai/tools/prisma-lint) Assistant Responses are generated using AI and may contain mistakes. --- # Oxlint - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Oxlint On this page * [Supported Files](https://docs.coderabbit.ai/tools/oxlint#supported-files) * [Configuration](https://docs.coderabbit.ai/tools/oxlint#configuration) * [Links](https://docs.coderabbit.ai/tools/oxlint#links) [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. [​](https://docs.coderabbit.ai/tools/oxlint#supported-files) Supported Files ------------------------------------------------------------------------------- Oxlint will run on files with the following extensions: * `.js` * `.mjs` * `.cjs` * `.jsx` * `.ts` * `.mts` * `.cts` * `.tsx` * `.vue` * `.astro` * `.svelte` [​](https://docs.coderabbit.ai/tools/oxlint#configuration) Configuration --------------------------------------------------------------------------- Oxlint supports the following configuration file: * `.oxlintrc.json` 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.Oxlint does not require configuration to run if Biome is disabled and Oxlint is enabled. [​](https://docs.coderabbit.ai/tools/oxlint#links) Links ----------------------------------------------------------- * [Oxlint GitHub Repository](https://github.com/oxc-project/oxc/releases/) * [Oxlint Website](https://oxc.rs/docs/guide/usage/linter) [OSV-Scanner](https://docs.coderabbit.ai/tools/osv-scanner) [PHPCS](https://docs.coderabbit.ai/tools/phpcs) Assistant Responses are generated using AI and may contain mistakes. --- # RuboCop - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools RuboCop On this page * [Files](https://docs.coderabbit.ai/tools/rubocop#files) * [Configuration](https://docs.coderabbit.ai/tools/rubocop#configuration) * [Links](https://docs.coderabbit.ai/tools/rubocop#links) [RuboCop](https://rubocop.org/) A Ruby static code analyzer and formatter, based on the community Ruby style guide. [​](https://docs.coderabbit.ai/tools/rubocop#files) Files ------------------------------------------------------------ RuboCop will run on the following files and extensions: * `.rb` * `.arb` * `.axlsx` * `.builder` * `.fcgi` * `.gemfile` * `.gemspec` * `.god` * `.jb` * `.jbuilder` * `.mspec` * `.opal` * `.pluginspec` * `.podspec` * `.rabl` * `.rake` * `.rbuild` * `.rbw` * `.rbx` * `.ru` * `.ruby` * `.schema` * `.spec` * `.thor` * `.watchr` * `.irbrc` * `.pryrc` * `.simplecov` * `buildfile` * `Appraisals` * `Berksfile` * `Brewfile` * `Buildfile` * `Capfile` * `Cheffile` * `Dangerfile` * `Deliverfile` * `Fastfile` * `Fastfile` * `Gemfile` * `Guardfile` * `Jarfile` * `Mavenfile` * `Podfile` * `Puppetfile` * `Rakefile` * `rakefile` * `Schemafile` * `Snapfile` * `Steepfile` * `Thorfile` * `Vagabondfile` * `Vagrantfile` [​](https://docs.coderabbit.ai/tools/rubocop#configuration) Configuration ---------------------------------------------------------------------------- RuboCop uses a YAML style configuration file. We look for the following files anywhere in the repository: * `.rubocop.yml` * `.rubocop.yaml` CodeRabbit will use the default settings based on the profile selected if no config file is found. [​](https://docs.coderabbit.ai/tools/rubocop#links) Links ------------------------------------------------------------ * [RuboCop Configuration](https://docs.rubocop.org/rubocop/1.65/configuration.html/) [Regal](https://docs.coderabbit.ai/tools/regal) [Ruff](https://docs.coderabbit.ai/tools/ruff) Assistant Responses are generated using AI and may contain mistakes. --- # LanguageTool - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools LanguageTool On this page * [Files](https://docs.coderabbit.ai/tools/languagetool#files) * [Configuration](https://docs.coderabbit.ai/tools/languagetool#configuration) * [Links](https://docs.coderabbit.ai/tools/languagetool#links) [LanguageTool](https://github.com/languagetool-org/languagetool) is a style and grammar checker. [​](https://docs.coderabbit.ai/tools/languagetool#files) Files ----------------------------------------------------------------- LanguageTool will run on files with the following extensions: * `.md` * `.mdx` * `.markdown` * `.txt` [​](https://docs.coderabbit.ai/tools/languagetool#configuration) Configuration --------------------------------------------------------------------------------- LanguageTool’s style and grammar check depends on the language selected in CodeRabbit’s configuration. You can set the language by setting the `language` field in your project’s `.coderabbit.yaml` file or setting the “Review Language” field in CodeRabbit’s settings page. CodeRabbit allows further configuring LanguageTool by setting specific rules and categories to be enabled/disabled. This can be done under the `reviews.tools.languagetool` field in your project’s `.coderabbit.yaml` file or setting the various options under “Review → Tools → LanguageTool” in CodeRabbit’s settings page. The following options are available: * `enabled` - Enable or disable LanguageTool. * `enabled_rules` - Enable specific rules. * `disabled_rules` - Disable specific rules. * `enabled_categories` - Enable specific categories. * `disabled_categories` - Disable specific categories. * `enabled_only`\- Enable only the rules and categories of IDs are specified with ‘enabledRules’ or ‘enabledCategories’. * `level` - Set the level of feedback to be provided by LanguageTool. The following levels are available: * `default` - Provides feedback on common issues. * `picky` - Provides feedback on more issues, rules that you might only find useful when checking formal text. [​](https://docs.coderabbit.ai/tools/languagetool#links) Links ----------------------------------------------------------------- * [LanguageTool Rules](https://community.languagetool.org/rule/list?lang=en) [HTMLHint](https://docs.coderabbit.ai/tools/htmlhint) [Luacheck](https://docs.coderabbit.ai/tools/luacheck) Assistant Responses are generated using AI and may contain mistakes. --- # PHPStan - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools PHPStan On this page * [Files](https://docs.coderabbit.ai/tools/phpstan#files) * [Configuration](https://docs.coderabbit.ai/tools/phpstan#configuration) * [Links](https://docs.coderabbit.ai/tools/phpstan#links) [PHPStan](https://phpstan.org/) is a static analysis tool for PHP. [​](https://docs.coderabbit.ai/tools/phpstan#files) Files ------------------------------------------------------------ PHPStan will run on files with the following extensions: * `.php` [​](https://docs.coderabbit.ai/tools/phpstan#configuration) Configuration ---------------------------------------------------------------------------- PHPStan supports the following config files: * `phpstan.neon` * `phpstan.neon.dist` * `phpstan.dist.neon` CodeRabbit will not run PHPStan if no config file is found. [​](https://docs.coderabbit.ai/tools/phpstan#links) Links ------------------------------------------------------------ * [PHPStan Configuration](https://phpstan.org/config-reference) [PHPMD](https://docs.coderabbit.ai/tools/phpmd) [Pipeline Failure Remediation](https://docs.coderabbit.ai/tools/pipeline-remediation) Assistant Responses are generated using AI and may contain mistakes. --- # Clippy - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Clippy On this page * [Supported Files](https://docs.coderabbit.ai/tools/clippy#supported-files) * [Configuration](https://docs.coderabbit.ai/tools/clippy#configuration) * [Features](https://docs.coderabbit.ai/tools/clippy#features) * [Links](https://docs.coderabbit.ai/tools/clippy#links) [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. [​](https://docs.coderabbit.ai/tools/clippy#supported-files) Supported Files ------------------------------------------------------------------------------- Clippy will run on files with the following extensions: * `*.rs` [​](https://docs.coderabbit.ai/tools/clippy#configuration) Configuration --------------------------------------------------------------------------- Clippy supports the following configuration files: * `clippy.toml` * `.clippy.toml` Clippy does not require configuration to run. If no configuration file is found, it will use default settings.A Cargo.toml is required. [​](https://docs.coderabbit.ai/tools/clippy#features) 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 [​](https://docs.coderabbit.ai/tools/clippy#links) 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) [CircleCI](https://docs.coderabbit.ai/tools/circleci) [Cppcheck](https://docs.coderabbit.ai/tools/cppcheck) Assistant Responses are generated using AI and may contain mistakes. --- # PHPMD - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools PHPMD On this page * [Files](https://docs.coderabbit.ai/tools/phpmd#files) * [Features](https://docs.coderabbit.ai/tools/phpmd#features) * [Review Mode Behavior](https://docs.coderabbit.ai/tools/phpmd#review-mode-behavior) * [Links](https://docs.coderabbit.ai/tools/phpmd#links) [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. [​](https://docs.coderabbit.ai/tools/phpmd#files) Files ---------------------------------------------------------- PHPMD will run on files with the following extensions: * `.php` [​](https://docs.coderabbit.ai/tools/phpmd#features) 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 ### [​](https://docs.coderabbit.ai/tools/phpmd#review-mode-behavior) 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`) [​](https://docs.coderabbit.ai/tools/phpmd#links) 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) [PHPCS](https://docs.coderabbit.ai/tools/phpcs) [PHPStan](https://docs.coderabbit.ai/tools/phpstan) Assistant Responses are generated using AI and may contain mistakes. --- # Prisma Lint - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Prisma Lint On this page * [Files](https://docs.coderabbit.ai/tools/prisma-lint#files) * [Configuration](https://docs.coderabbit.ai/tools/prisma-lint#configuration) * [Rule Configuration](https://docs.coderabbit.ai/tools/prisma-lint#rule-configuration) * [Links](https://docs.coderabbit.ai/tools/prisma-lint#links) [Prisma Lint](https://github.com/loop-payments/prisma-lint) is a linter for Prisma schema files that helps enforce consistent conventions and best practices in your Prisma schemas. [​](https://docs.coderabbit.ai/tools/prisma-lint#files) Files ---------------------------------------------------------------- Prisma Lint will run on files with the following extensions: * `.prisma` [​](https://docs.coderabbit.ai/tools/prisma-lint#configuration) Configuration -------------------------------------------------------------------------------- Prisma Lint supports the following config files: * `.prismalintrc.json` * `.prismalintrc` * `.prismalintrc.js` * `.prismalintrc.yaml` * `.prismalintrc.yml` * `prismalint.config.js` * User-defined config file set at `reviews.tools.prismalint.config_file` in your project’s `.coderabbit.yaml` file or setting the “Review → Tools → Prisma Lint → Config File” field in CodeRabbit’s settings page. By default, Prisma Lint looks for schema files at `prisma/schema.prisma`. If you have a custom schema path specified in the `prisma.schema` field within `package.json`, that will be used instead. [​](https://docs.coderabbit.ai/tools/prisma-lint#rule-configuration) Rule Configuration ------------------------------------------------------------------------------------------ Rules can be configured in your `.prismalintrc.json` file. See the [Prisma Lint Rules Documentation](https://github.com/loop-payments/prisma-lint/blob/main/RULES.md) for more information on the available rules and their configuration options. [​](https://docs.coderabbit.ai/tools/prisma-lint#links) Links ---------------------------------------------------------------- * [Prisma Lint GitHub Repository](https://github.com/loop-payments/prisma-lint) * [Prisma Lint Rules Documentation](https://github.com/loop-payments/prisma-lint/blob/main/RULES.md) [PMD](https://docs.coderabbit.ai/tools/pmd) [Pylint](https://docs.coderabbit.ai/tools/pylint) Assistant Responses are generated using AI and may contain mistakes. --- # Pipeline Failure Remediation - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Pipeline Failure Remediation On this page * [Overview](https://docs.coderabbit.ai/tools/pipeline-remediation#overview) * [Example Remediations](https://docs.coderabbit.ai/tools/pipeline-remediation#example-remediations) * [Docker Build Issues](https://docs.coderabbit.ai/tools/pipeline-remediation#docker-build-issues) * [Java Build & Testing](https://docs.coderabbit.ai/tools/pipeline-remediation#java-build-%26-testing) * [Kubernetes Deployments](https://docs.coderabbit.ai/tools/pipeline-remediation#kubernetes-deployments) * [NPM Package Management](https://docs.coderabbit.ai/tools/pipeline-remediation#npm-package-management) * [Python Environment](https://docs.coderabbit.ai/tools/pipeline-remediation#python-environment) * [Security Scanning](https://docs.coderabbit.ai/tools/pipeline-remediation#security-scanning) * [Terraform and Infrastructure as Code](https://docs.coderabbit.ai/tools/pipeline-remediation#terraform-and-infrastructure-as-code) * [Supported Platforms](https://docs.coderabbit.ai/tools/pipeline-remediation#supported-platforms) * [GitHub Actions](https://docs.coderabbit.ai/tools/pipeline-remediation#github-actions) * [GitLab CI/CD](https://docs.coderabbit.ai/tools/pipeline-remediation#gitlab-ci%2Fcd) * [CircleCI](https://docs.coderabbit.ai/tools/pipeline-remediation#circleci) * [Azure DevOps Pipelines](https://docs.coderabbit.ai/tools/pipeline-remediation#azure-devops-pipelines) * [Common Use Cases](https://docs.coderabbit.ai/tools/pipeline-remediation#common-use-cases) * [Build Failures](https://docs.coderabbit.ai/tools/pipeline-remediation#build-failures) * [Infrastructure as Code](https://docs.coderabbit.ai/tools/pipeline-remediation#infrastructure-as-code) * [Security Pipeline Integration](https://docs.coderabbit.ai/tools/pipeline-remediation#security-pipeline-integration) * [Testing Failures](https://docs.coderabbit.ai/tools/pipeline-remediation#testing-failures) * [How It Works](https://docs.coderabbit.ai/tools/pipeline-remediation#how-it-works) * [Best Practices](https://docs.coderabbit.ai/tools/pipeline-remediation#best-practices) * [Links](https://docs.coderabbit.ai/tools/pipeline-remediation#links) [​](https://docs.coderabbit.ai/tools/pipeline-remediation#overview) Overview ------------------------------------------------------------------------------- Are pipeline failures holding up your pull requests? Is your latest code failing to build and digging through the failure logs is an absolute nightmare? CodeRabbit’s Pipeline Failure Remediation tool automatically detects and fixes build failures across your CI/CD pipelines. Our intelligent AI system analyzes pipeline failures in real-time, providing inline comments and actionable suggestions to quickly resolve issues. We support multiple CI/CD platforms and integrate with popular security scanning tools to provide comprehensive remediation guidance. [​](https://docs.coderabbit.ai/tools/pipeline-remediation#example-remediations) Example Remediations ------------------------------------------------------------------------------------------------------- With CodeRabbit CI/CD Pipeline Remediation, you have coderabbit automatically review the output of any tooling you desire. Here are some examples of the types of common issues we can help you fix: ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#docker-build-issues) Docker Build Issues * Missing build dependencies * Base image compatibility * Multi-stage build optimization * Cache utilization improvements ![Docker Build Remediation](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/img/tools/docker-build-cicd.png) ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#java-build-%26-testing) Java Build & Testing * Maven/Gradle dependency conflicts * Compilation errors * Test failures * Memory allocation issues ![Java Build Remediation](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/img/tools/java-cicd.png) ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#kubernetes-deployments) Kubernetes Deployments * Service configuration validation * Resource allocation optimization * Network policy fixes * Security context remediation ![Kubernetes Configuration](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/img/tools/kubernetes-cicd.png) ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#npm-package-management) NPM Package Management * Package resolution conflicts * Version compatibility issues * Security vulnerability patches * Build script optimization ![NPM Dependencies](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/img/tools/npm-cicd.png) ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#python-environment) Python Environment * Package dependency resolution * Virtual environment setup * Test framework configuration * Code style compliance ![Python Build Issues](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/img/tools/python-cicd.png) ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#security-scanning) Security Scanning * SAST finding remediation * Code injection prevention * Security best practices * Compliance validation ![Security Scan Results](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/img/tools/semgrep-cicd.png) ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#terraform-and-infrastructure-as-code) Terraform and Infrastructure as Code * Resource configuration validation * State management issues * Provider compatibility * Security group optimization ![Terraform Configuration](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/img/tools/terraform-cicd.png) [​](https://docs.coderabbit.ai/tools/pipeline-remediation#supported-platforms) Supported Platforms ----------------------------------------------------------------------------------------------------- ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#github-actions) GitHub Actions * Automatic detection of workflow failures * Inline fixes for common build issues * Integration with GitHub Checks * Support for custom actions and workflows ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#gitlab-ci%2Fcd) 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 ![GitLab CI/CD](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/img/tools/gitlab-cicd.png) ![GitLab Security Integration](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/img/tools/gitlab-advanced-security.png) ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#circleci) CircleCI * CircleCI Pipeline failure analysis * Job-level error analysis * Configuration validation * Dependency resolution ![CircleCI Integration](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/img/tools/circle-cicd.png) ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#azure-devops-pipelines) 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 ![Azure DevOps Integration](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/img/tools/az-devops-pipeline.png) [​](https://docs.coderabbit.ai/tools/pipeline-remediation#common-use-cases) Common Use Cases ----------------------------------------------------------------------------------------------- Our tool handles a wide range of pipeline failures including: ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#build-failures) Build Failures * Docker build issues * Node.js dependency conflicts * Java compilation errors * Python package resolution * Go module management ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#infrastructure-as-code) Infrastructure as Code * Kubernetes manifest validation * Terraform template errors * CloudFormation stack issues * Ansible playbook failures ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#security-pipeline-integration) Security Pipeline Integration * SAST finding remediation * DAST vulnerability fixes * Dependency scanning * Container security ### [​](https://docs.coderabbit.ai/tools/pipeline-remediation#testing-failures) Testing Failures * Unit test failures * Integration test errors * End-to-end test issues * Performance test threshold violations [​](https://docs.coderabbit.ai/tools/pipeline-remediation#how-it-works) 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 [​](https://docs.coderabbit.ai/tools/pipeline-remediation#best-practices) 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 [​](https://docs.coderabbit.ai/tools/pipeline-remediation#links) 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) [PHPStan](https://docs.coderabbit.ai/tools/phpstan) [PMD](https://docs.coderabbit.ai/tools/pmd) Assistant Responses are generated using AI and may contain mistakes. --- # Luacheck - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Luacheck On this page * [Supported Files](https://docs.coderabbit.ai/tools/luacheck#supported-files) * [Configuration](https://docs.coderabbit.ai/tools/luacheck#configuration) * [Features](https://docs.coderabbit.ai/tools/luacheck#features) * [Links](https://docs.coderabbit.ai/tools/luacheck#links) [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. [​](https://docs.coderabbit.ai/tools/luacheck#supported-files) Supported Files --------------------------------------------------------------------------------- Luacheck will run on files with the following extensions: * `.lua` [​](https://docs.coderabbit.ai/tools/luacheck#configuration) Configuration ----------------------------------------------------------------------------- Luacheck supports the following configuration files: * `.luacheckrc` * `luacheckrc` * `.luacheckrc.lua` * `luacheckrc.lua` Luacheck does not require configuration to run. If no configuration file is found, it will use default settings. [​](https://docs.coderabbit.ai/tools/luacheck#features) Features ------------------------------------------------------------------- Luacheck can detect: * Usage of undefined global variables * Unused variables and values * Accessing uninitialized variables * Unreachable code * And many more issues [​](https://docs.coderabbit.ai/tools/luacheck#links) Links ------------------------------------------------------------- * [Luacheck GitHub Repository](https://github.com/mpeterv/luacheck) * [Luacheck Documentation](https://luacheck.readthedocs.io/) [LanguageTool](https://docs.coderabbit.ai/tools/languagetool) [markdownlint](https://docs.coderabbit.ai/tools/markdownlint) Assistant Responses are generated using AI and may contain mistakes. --- # detekt - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools detekt On this page * [Files](https://docs.coderabbit.ai/tools/detekt#files) * [Configuration](https://docs.coderabbit.ai/tools/detekt#configuration) * [Links](https://docs.coderabbit.ai/tools/detekt#links) [`detekt`](https://detekt.dev/) is a static code analysis tool specifically designed for Kotlin projects [​](https://docs.coderabbit.ai/tools/detekt#files) Files ----------------------------------------------------------- `detekt` will run on files with the following extensions: * `.kt` * `.kts` [​](https://docs.coderabbit.ai/tools/detekt#configuration) Configuration --------------------------------------------------------------------------- `detekt` uses a YAML style configuration file. `detekt` supports the following config files: * User-defined config file set at `reviews.tools.detekt.config_file` in your project’s `.coderabbit.yaml` file or setting the “Review → Tools → `detekt` → Config File” field in CodeRabbit’s settings page. [​](https://docs.coderabbit.ai/tools/detekt#links) Links ----------------------------------------------------------- * [`detekt` Configuration](https://detekt.dev/docs/introduction/configurations/) [Cppcheck](https://docs.coderabbit.ai/tools/cppcheck) [Dotenv Linter](https://docs.coderabbit.ai/tools/dotenv) Assistant Responses are generated using AI and may contain mistakes. --- # markdownlint - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools markdownlint On this page * [Files](https://docs.coderabbit.ai/tools/markdownlint#files) * [Configuration](https://docs.coderabbit.ai/tools/markdownlint#configuration) * [Links](https://docs.coderabbit.ai/tools/markdownlint#links) [`markdownlint-cli2`](https://github.com/DavidAnson/markdownlint) is a linter for Markdown. [​](https://docs.coderabbit.ai/tools/markdownlint#files) Files ----------------------------------------------------------------- Markdownlint will run on files with the following extensions: * `.md` * `.markdown` [​](https://docs.coderabbit.ai/tools/markdownlint#configuration) Configuration --------------------------------------------------------------------------------- `markdownlint-cli2` supports the following config files: * `.markdownlint.jsonc` * `.markdownlint.json` * `.markdownlint.yaml` * `.markdownlint.yml` CodeRabbit will use the default settings based on the profile selected if no config file is found. [​](https://docs.coderabbit.ai/tools/markdownlint#links) Links ----------------------------------------------------------------- * [`markdownlint-cli2` Configuration](https://github.com/DavidAnson/markdownlint?tab=readme-ov-file#configuration) [Luacheck](https://docs.coderabbit.ai/tools/luacheck) [OSV-Scanner](https://docs.coderabbit.ai/tools/osv-scanner) Assistant Responses are generated using AI and may contain mistakes. --- # ESLint - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools ESLint On this page * [Files](https://docs.coderabbit.ai/tools/eslint#files) * [Configuration](https://docs.coderabbit.ai/tools/eslint#configuration) [ESLint](https://eslint.org/) is a linter for JavaScript, TypeScript, JSX, TSX, CSS, etc. [​](https://docs.coderabbit.ai/tools/eslint#files) Files ----------------------------------------------------------- ESLint will run on files with the following extensions: * `.js` * `.ts` * `.cjs` * `.mjs` * `.d.cts` * `.d.mts` * `.jsx` * `.tsx` * `.css` * `.vue` * `.svelte` * `.astro` [​](https://docs.coderabbit.ai/tools/eslint#configuration) Configuration --------------------------------------------------------------------------- * ESLint configuration is read from the repository and is used as is. No additional configuration is required. * Please ensure that all ESLint dependencies are defined in your `package.json` file(s). * Yarn and PNPM workspaces are supported. * Private ESLint plugins or configurations are not supported at the moment. Please reach out to us on Discord if you would like us to add support for this. * For `@typescript-eslint`, linting with type information at the moment. The [type checking rules](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/disable-type-checked.ts) are disabled. * For `eslint-plugin-import`, the following rules are disabled: * `import/no-unresolved` * For the `eslint-plugin-n`, the following rules are disabled: * `n/no-missing-import` * `n/no-missing-require` * For the `eslint-plugin-node`, the following rules are disabled: * `node/no-missing-import` * `node/no-missing-require` [Dotenv Linter](https://docs.coderabbit.ai/tools/dotenv) [Flake8](https://docs.coderabbit.ai/tools/flake8) Assistant Responses are generated using AI and may contain mistakes. --- # Pylint - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Pylint On this page * [Supported Files](https://docs.coderabbit.ai/tools/pylint#supported-files) * [Configuration](https://docs.coderabbit.ai/tools/pylint#configuration) * [Features](https://docs.coderabbit.ai/tools/pylint#features) * [Links](https://docs.coderabbit.ai/tools/pylint#links) [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. [​](https://docs.coderabbit.ai/tools/pylint#supported-files) Supported Files ------------------------------------------------------------------------------- Pylint will run on files with the following extensions: * `*.py` * `.ipynb` (using nbqa) [​](https://docs.coderabbit.ai/tools/pylint#configuration) Configuration --------------------------------------------------------------------------- Pylint supports the following config files: * `.pylintrc` * `pylintrc` * `.pylintrc.toml` * `pylintrc.toml` CodeRabbit will not run Pylint if no config file is found. [​](https://docs.coderabbit.ai/tools/pylint#features) 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 [​](https://docs.coderabbit.ai/tools/pylint#links) 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) [Prisma Lint](https://docs.coderabbit.ai/tools/prisma-lint) [Regal](https://docs.coderabbit.ai/tools/regal) Assistant Responses are generated using AI and may contain mistakes. --- # List of supported tools - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools List of supported 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](https://docs.coderabbit.ai/tools) . | Technology | Tools | Category | | --- | --- | --- | | All | [Gitleaks](https://docs.coderabbit.ai/tools/gitleaks)
, [OSV-Scanner](https://docs.coderabbit.ai/tools/osv-scanner)
, [Pipeline Remediation](https://docs.coderabbit.ai/tools/pipeline-remediation) | Code Security, CI/CD | | Azure DevOps Pipelines | [Pipeline Remediation](https://docs.coderabbit.ai/tools/pipeline-remediation) | CI/CD Failure Remediation | | CircleCI | [CircleCI](https://docs.coderabbit.ai/tools/circleci)
, [Pipeline Remediation](https://docs.coderabbit.ai/tools/pipeline-remediation) | Configuration Validation, CI/CD Failure Remediation | | CloudFormation | [Checkov](https://docs.coderabbit.ai/tools/checkov) | Code Security | | Cppcheck | [Cppcheck](https://docs.coderabbit.ai/tools/cppcheck) | Code Quality | | CSS | [Biome](https://docs.coderabbit.ai/tools/biome) | Code Quality | | Docker | [Hadolint](https://docs.coderabbit.ai/tools/hadolint)
, [Checkov](https://docs.coderabbit.ai/tools/checkov) | Code Quality, Code Security | | Environment Files (.env) | [Dotenv Linter](https://docs.coderabbit.ai/tools/dotenv) | Code Quality | | GitHub Actions | [actionlint](https://docs.coderabbit.ai/tools/actionlint)
, [Pipeline Remediation](https://docs.coderabbit.ai/tools/pipeline-remediation) | Code Quality, CI/CD Failure Remediation | | GitLab Pipelines | [Pipeline Remediation](https://docs.coderabbit.ai/tools/pipeline-remediation) | CI/CD Failure Remediation | | Go | [golangci-lint](https://docs.coderabbit.ai/tools/golangci-lint) | Code Quality | | Helm | [Checkov](https://docs.coderabbit.ai/tools/checkov) | Code Security | | HTML | [HTMLHint](https://docs.coderabbit.ai/tools/htmlhint) | Code Quality | | Javascript | [Biome](https://docs.coderabbit.ai/tools/biome)
, [oxlint](https://docs.coderabbit.ai/tools/oxlint) | Code Quality | | JSON, JSONC | [Biome](https://docs.coderabbit.ai/tools/biome) | Code Quality | | JSX | [Biome](https://docs.coderabbit.ai/tools/biome)
, [oxlint](https://docs.coderabbit.ai/tools/oxlint) | Code Quality | | Kotlin | [detekt](https://docs.coderabbit.ai/tools/detekt) | Code Quality | | Kubernetes | [Checkov](https://docs.coderabbit.ai/tools/checkov) | Code Security | | Lua | [Luacheck](https://docs.coderabbit.ai/tools/luacheck) | Code Quality | | Makefile | [Checkmake](https://docs.coderabbit.ai/tools/checkmake) | Code Quality | | Markdown | [markdownlint](https://docs.coderabbit.ai/tools/markdownlint)
, [LanguageTool](https://docs.coderabbit.ai/tools/languagetool) | Code Quality, Grammar Checking | | PHP | [PHPStan](https://docs.coderabbit.ai/tools/phpstan)
, [PHPMD](https://docs.coderabbit.ai/tools/phpmd)
, [PHPCS](https://docs.coderabbit.ai/tools/phpcs) | Code Quality | | Plaintext | [LanguageTool](https://docs.coderabbit.ai/tools/languagetool) | Grammar and Spell Checking | | Java | [PMD](https://docs.coderabbit.ai/tools/pmd) | Code Quality | | Protobuf | [Buf](https://docs.coderabbit.ai/tools/buf) | Code Quality | | Python | [Ruff](https://docs.coderabbit.ai/tools/ruff)
, [Pylint](https://docs.coderabbit.ai/tools/pylint)
, [Flake8](https://docs.coderabbit.ai/tools/flake8) | Code Quality | | Jupyter Notebooks | [Ruff](https://docs.coderabbit.ai/tools/ruff)
, [Pylint](https://docs.coderabbit.ai/tools/pylint)
, [Flake8](https://docs.coderabbit.ai/tools/flake8) | Code Quality | | Regal | [Regal](https://docs.coderabbit.ai/tools/regal) | Code Quality | | Ruby | [RuboCop](https://docs.coderabbit.ai/tools/rubocop)
, [Brakeman](https://docs.coderabbit.ai/tools/brakeman) | Code Quality, Code Security | | Rust | [Clippy](https://docs.coderabbit.ai/tools/clippy) | Code Quality | | Semgrep | [Semgrep](https://docs.coderabbit.ai/tools/semgrep) | Code Security | | Shell (sh, bash, ksh, dash) | [ShellCheck](https://docs.coderabbit.ai/tools/shellcheck) | Code Quality | | Shopify | [Shopify CLI](https://docs.coderabbit.ai/tools/shopify-cli) | Code Quality | | SQL | [SQLFluff](https://docs.coderabbit.ai/tools/sqlfluff) | Code Quality | | Swift | [SwiftLint](https://docs.coderabbit.ai/tools/swiftlint) | Code Quality | | Terraform | [Checkov](https://docs.coderabbit.ai/tools/checkov) | Code Security | | TSX | [Biome](https://docs.coderabbit.ai/tools/biome)
, [oxlint](https://docs.coderabbit.ai/tools/oxlint) | Code Quality | | Typescript | [Biome](https://docs.coderabbit.ai/tools/biome)
, [oxlint](https://docs.coderabbit.ai/tools/oxlint) | Code Quality | | YAML | [YAMLlint](https://docs.coderabbit.ai/tools/yamllint) | Code Quality | | Prisma | [Prisma Lint](https://docs.coderabbit.ai/tools/prisma-lint) | Code Quality | [Configuration file template](https://docs.coderabbit.ai/reference/yaml-template) [actionlint](https://docs.coderabbit.ai/tools/actionlint) Assistant Responses are generated using AI and may contain mistakes. --- # OSV-Scanner - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools OSV-Scanner On this page * [Configuration](https://docs.coderabbit.ai/tools/osv-scanner#configuration) * [Links](https://docs.coderabbit.ai/tools/osv-scanner#links) [OSV-Scanner](https://github.com/google/osv-scanner) is Google’s vulnerability scanner that identifies vulnerabilities in your project’s dependencies using the [OSV.dev](https://osv.dev/) database. [​](https://docs.coderabbit.ai/tools/osv-scanner#configuration) Configuration -------------------------------------------------------------------------------- OSV-Scanner requires an `osv-scanner.toml` configuration file to run. CodeRabbit will only run OSV-Scanner if your repository contains an `osv-scanner.toml` configuration file. [​](https://docs.coderabbit.ai/tools/osv-scanner#links) Links ---------------------------------------------------------------- * [OSV-Scanner GitHub Repository](https://github.com/google/osv-scanner) * [OSV-Scanner Documentation](https://google.github.io/osv-scanner/) * [OSV.dev Database](https://osv.dev/) [markdownlint](https://docs.coderabbit.ai/tools/markdownlint) [Oxlint](https://docs.coderabbit.ai/tools/oxlint) Assistant Responses are generated using AI and may contain mistakes. --- # Gitleaks - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Gitleaks On this page * [Files](https://docs.coderabbit.ai/tools/gitleaks#files) * [Configuration](https://docs.coderabbit.ai/tools/gitleaks#configuration) * [Links](https://docs.coderabbit.ai/tools/gitleaks#links) [Gitleaks](https://gitleaks.io/) is a secret-scanner. [​](https://docs.coderabbit.ai/tools/gitleaks#files) Files ------------------------------------------------------------- Gitleaks will run on all files. [​](https://docs.coderabbit.ai/tools/gitleaks#configuration) Configuration ----------------------------------------------------------------------------- Gitleaks supports the following config files: * `gitleaks.toml` [​](https://docs.coderabbit.ai/tools/gitleaks#links) Links ------------------------------------------------------------- * [Gitleaks Configuration](https://github.com/gitleaks/gitleaks#configuration) [Flake8](https://docs.coderabbit.ai/tools/flake8) [golangci-lint](https://docs.coderabbit.ai/tools/golangci-lint) Assistant Responses are generated using AI and may contain mistakes. --- # Flake8 - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Flake8 On this page * [Supported Files](https://docs.coderabbit.ai/tools/flake8#supported-files) * [Configuration](https://docs.coderabbit.ai/tools/flake8#configuration) * [Features](https://docs.coderabbit.ai/tools/flake8#features) * [Links](https://docs.coderabbit.ai/tools/flake8#links) [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. [​](https://docs.coderabbit.ai/tools/flake8#supported-files) Supported Files ------------------------------------------------------------------------------- Flake8 will run on files with the following extensions: * `*.py` * `*.ipynb` (using nbqa) [​](https://docs.coderabbit.ai/tools/flake8#configuration) Configuration --------------------------------------------------------------------------- Flake8 supports the following config files: * `.flake8` CodeRabbit will not run Flake8 if no config file is found. [​](https://docs.coderabbit.ai/tools/flake8#features) 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 [​](https://docs.coderabbit.ai/tools/flake8#links) 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) [ESLint](https://docs.coderabbit.ai/tools/eslint) [Gitleaks](https://docs.coderabbit.ai/tools/gitleaks) Assistant Responses are generated using AI and may contain mistakes. --- # Semgrep - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Semgrep On this page * [Configuration](https://docs.coderabbit.ai/tools/semgrep#configuration) * [Links](https://docs.coderabbit.ai/tools/semgrep#links) * [Files](https://docs.coderabbit.ai/tools/semgrep#files) [Semgrep](https://github.com/semgrep/semgrep) is an open-source static analysis tool designed to scan code for security vulnerabilities and code quality issues. [​](https://docs.coderabbit.ai/tools/semgrep#configuration) Configuration ---------------------------------------------------------------------------- Semgrep uses a YAML style configuration file. By default, we will automatically use the following files if any are set in the root directory of your repository. * `semgrep.yml` or `semgrep.yaml` * `semgrep.config.yml` or `semgrep.config.yaml` Semgrep supports the following config files: * User-defined config file set at `reviews.tools.semgrep.config_file` in your project’s `.coderabbit.yaml` file or setting the “Review → Tools → Semgrep → Config File” field in CodeRabbit’s settings page. Due to licensing, CodeRabbit does not ship with the [community-created Semgrep rules](https://github.com/returntocorp/semgrep-rules) . CodeRabbit will only run Semgrep if your repository contains a Semgrep config file. This config must use the default file names, or you must define the path to this file in the `.coderabbit.yaml` or config UI. [​](https://docs.coderabbit.ai/tools/semgrep#links) Links ------------------------------------------------------------ * [Semgrep CLI Reference](https://semgrep.dev/docs/cli-reference) * [Writing Semgrep Rules for Config Files](https://semgrep.dev/docs/running-rules) [​](https://docs.coderabbit.ai/tools/semgrep#files) Files ------------------------------------------------------------ Semgrep will run on the following files types: * C/C++ * C# * Go * Java * JavaScript * Kotlin * Python * TypeScript * Ruby * Rust * JSX * PHP * Scala * Swift * Terraform * JSON [Ruff](https://docs.coderabbit.ai/tools/ruff) [ShellCheck](https://docs.coderabbit.ai/tools/shellcheck) Assistant Responses are generated using AI and may contain mistakes. --- # HTMLHint - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools HTMLHint On this page * [Files](https://docs.coderabbit.ai/tools/htmlhint#files) * [Configuration](https://docs.coderabbit.ai/tools/htmlhint#configuration) * [Links](https://docs.coderabbit.ai/tools/htmlhint#links) [HTMLHint](https://htmlhint.com/) is a static code analysis tool for HTML. [​](https://docs.coderabbit.ai/tools/htmlhint#files) Files ------------------------------------------------------------- HTMLHint will run checks against `*.html` files. [​](https://docs.coderabbit.ai/tools/htmlhint#configuration) 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. [​](https://docs.coderabbit.ai/tools/htmlhint#links) Links ------------------------------------------------------------- * [HTMLHint Configuration](https://htmlhint.com/docs/user-guide/getting-started) [Hadolint](https://docs.coderabbit.ai/tools/hadolint) [LanguageTool](https://docs.coderabbit.ai/tools/languagetool) Assistant Responses are generated using AI and may contain mistakes. --- # PHPCS - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools PHPCS On this page * [Files](https://docs.coderabbit.ai/tools/phpcs#files) * [Features](https://docs.coderabbit.ai/tools/phpcs#features) * [Popular Standards](https://docs.coderabbit.ai/tools/phpcs#popular-standards) * [Configuration](https://docs.coderabbit.ai/tools/phpcs#configuration) * [Links](https://docs.coderabbit.ai/tools/phpcs#links) [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. [​](https://docs.coderabbit.ai/tools/phpcs#files) Files ---------------------------------------------------------- PHPCS will run on files with the following extensions: * `.php` [​](https://docs.coderabbit.ai/tools/phpcs#features) 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 [​](https://docs.coderabbit.ai/tools/phpcs#popular-standards) 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 [​](https://docs.coderabbit.ai/tools/phpcs#configuration) 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. [​](https://docs.coderabbit.ai/tools/phpcs#links) 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) [Oxlint](https://docs.coderabbit.ai/tools/oxlint) [PHPMD](https://docs.coderabbit.ai/tools/phpmd) Assistant Responses are generated using AI and may contain mistakes. --- # Ruff - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Ruff On this page * [Files](https://docs.coderabbit.ai/tools/ruff#files) * [Configuration](https://docs.coderabbit.ai/tools/ruff#configuration) * [Links](https://docs.coderabbit.ai/tools/ruff#links) [Ruff](https://docs.astral.sh/ruff/) is a linter for Python or Jupiter Notebooks. [​](https://docs.coderabbit.ai/tools/ruff#files) Files --------------------------------------------------------- Ruff will run on files with the following extensions: * `.py` * `.ipynb` (using nbqa) [​](https://docs.coderabbit.ai/tools/ruff#configuration) Configuration ------------------------------------------------------------------------- Ruff supports the following config files: * `pyproject.toml` * `ruff.toml` * `.ruff.toml` CodeRabbit will use the default settings based on the profile selected if no config file is found. [​](https://docs.coderabbit.ai/tools/ruff#links) Links --------------------------------------------------------- * [Ruff Configuration](https://docs.astral.sh/ruff/configuration/) * [nbqa Documentation](https://github.com/nbQA-dev/nbQA) [RuboCop](https://docs.coderabbit.ai/tools/rubocop) [Semgrep](https://docs.coderabbit.ai/tools/semgrep) Assistant Responses are generated using AI and may contain mistakes. --- # Cppcheck - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Supported tools Cppcheck On this page * [Files](https://docs.coderabbit.ai/tools/cppcheck#files) * [Configuration](https://docs.coderabbit.ai/tools/cppcheck#configuration) * [Chill](https://docs.coderabbit.ai/tools/cppcheck#chill) * [Assertive](https://docs.coderabbit.ai/tools/cppcheck#assertive) * [Links](https://docs.coderabbit.ai/tools/cppcheck#links) [Cppcheck](https://cppcheck.sourceforge.io/) is a static code analysis tool for the C and C++ programming languages. [​](https://docs.coderabbit.ai/tools/cppcheck#files) Files ------------------------------------------------------------- Cppcheck will run on files with the following extensions: * `.cpp` * `.cxx` * `.cc` * `.c` * `.tpp` * `.txx` [​](https://docs.coderabbit.ai/tools/cppcheck#configuration) Configuration ----------------------------------------------------------------------------- CodeRabbit will use the following settings based on the profile selected: ### [​](https://docs.coderabbit.ai/tools/cppcheck#chill) Chill Copy --disable=warning,style,information,portability,unusedFunction ### [​](https://docs.coderabbit.ai/tools/cppcheck#assertive) Assertive Copy --disable=warning,style,information CodeRabbit will use the default settings based on the profile selected if no config file is found. [​](https://docs.coderabbit.ai/tools/cppcheck#links) Links ------------------------------------------------------------- * [Cppcheck Configuration](https://sourceforge.net/p/cppcheck/wiki/ListOfChecks/) [Clippy](https://docs.coderabbit.ai/tools/clippy) [detekt](https://docs.coderabbit.ai/tools/detekt) Assistant Responses are generated using AI and may contain mistakes. --- # Linters & security analysis tools - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Configure Linters & security analysis tools On this page * [Enabling/Disabling Tools](https://docs.coderabbit.ai/tools#enabling%2Fdisabling-tools) * [Customizing Tools](https://docs.coderabbit.ai/tools#customizing-tools) * [Checking Tool Output](https://docs.coderabbit.ai/tools#checking-tool-output) * [What’s next](https://docs.coderabbit.ai/tools#what%E2%80%99s-next) For a complete list of tools that CodeRabbit supports, see [supported tools](https://docs.coderabbit.ai/tools/list) . This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. CodeRabbit supports various linters and security analysis tools to improve the code review process. The output of these tools is used to enhance the feedback provided by CodeRabbit, making it possible to provide 1-click fixes for common issues. All tool runs are done in a secure sandboxed execution environment. [​](https://docs.coderabbit.ai/tools#enabling%2Fdisabling-tools) Enabling/Disabling Tools -------------------------------------------------------------------------------------------- You can enable or disable tools by setting `reviews.tools..enabled` in your project’s `.coderabbit.yaml` file or setting the “Review → Tools → Tool → Enabled” field in CodeRabbit’s settings page. [​](https://docs.coderabbit.ai/tools#customizing-tools) Customizing Tools ---------------------------------------------------------------------------- CodeRabbit supports customizing the strictness of tools by setting `reviews.profile` in your project’s `.coderabbit.yaml` file or setting the “Review → Profile” field in CodeRabbit’s settings page. The following profiles are available: * `Chill` - Yields less feedback, that may be considered lenient. * `Assertive` - Yields more feedback, that may be considered nit-picky. Apart from the overall profile, you can also configure each tool by providing a path to a configuration file (specific to the tool) in your project. This would allow you to further customize the tool’s behavior, by enabling/disabling specific rules, setting rule severity, etc. [​](https://docs.coderabbit.ai/tools#checking-tool-output) Checking Tool Output ---------------------------------------------------------------------------------- When a tool is enabled, CodeRabbit will run it on your change request and attach the output under “Review details” comment in the change request. The output will be displayed in a structured format, with information on the file, line number, and the issue detected. For example: Copy Ruff fib.py 21-21: f-string without any placeholders Remove extraneous f prefix (F541) [​](https://docs.coderabbit.ai/tools#what%E2%80%99s-next) What’s next ------------------------------------------------------------------------ * For a complete list of tools that CodeRabbit supports, see [Supported tools](https://docs.coderabbit.ai/tools/list) . [Review instructions](https://docs.coderabbit.ai/guides/review-instructions) [Manage your subscription](https://docs.coderabbit.ai/getting-started/subscription-management) Assistant Responses are generated using AI and may contain mistakes. --- # Integrate with Git platforms - CodeRabbit [CodeRabbit home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/coderabbit-logo-dark.svg)](https://coderabbit.ai/) Search... ⌘K Search... Navigation Integrate with Git platforms On this page * [GitHub​](https://docs.coderabbit.ai/platforms#github%E2%80%8B) * [GitLab​](https://docs.coderabbit.ai/platforms#gitlab%E2%80%8B) * [Azure DevOps​](https://docs.coderabbit.ai/platforms#azure-devops%E2%80%8B) * [Bitbucket​](https://docs.coderabbit.ai/platforms#bitbucket%E2%80%8B) [​](https://docs.coderabbit.ai/platforms#github%E2%80%8B) GitHub[​](https://docs.coderabbit.ai/platforms#github "Direct link to GitHub") -------------------------------------------------------------------------------------------------------------------------------------------- | Host | Support | | --- | --- | | GitHub.com | [Supported](https://docs.coderabbit.ai/platforms/github-com) | | GitHub Enterprise Server | [Supported](https://docs.coderabbit.ai/platforms/github-enterprise-server) | [​](https://docs.coderabbit.ai/platforms#gitlab%E2%80%8B) GitLab[​](https://docs.coderabbit.ai/platforms#gitlab "Direct link to GitLab") -------------------------------------------------------------------------------------------------------------------------------------------- | Host | Support | | --- | --- | | GitLab.com | [Supported](https://docs.coderabbit.ai/platforms/gitlab-com) | | GitLab Self Managed | [Supported](https://docs.coderabbit.ai/platforms/self-hosted-gitlab) | [​](https://docs.coderabbit.ai/platforms#azure-devops%E2%80%8B) Azure DevOps[​](https://docs.coderabbit.ai/platforms#azure-devops "Direct link to Azure DevOps") -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | Host | Support | | --- | --- | | Azure DevOps | [Supported](https://docs.coderabbit.ai/platforms/azure-devops) | [​](https://docs.coderabbit.ai/platforms#bitbucket%E2%80%8B) Bitbucket[​](https://docs.coderabbit.ai/platforms#bitbucket "Direct link to Bitbucket") -------------------------------------------------------------------------------------------------------------------------------------------------------- | Host | Support | | --- | --- | | Bitbucket Datacenter | [Supported](https://docs.coderabbit.ai/self-hosted/bitbucket) | | Bitbucket Cloud | [Supported](https://docs.coderabbit.ai/platforms/bitbucket-cloud) | [Edit this page](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/platforms/platforms.md) Last updated on **Jul 24, 2025** Assistant Responses are generated using AI and may contain mistakes. --- # Unknown \# GitHub > This is a step-by-step guide to integrate CodeRabbit with your hosted GitHub repositories. For an overview of how CodeRabbit integrates with Git platforms, see \[Add CodeRabbit to your repository\](/platforms). For a hands-on tutorial with CodeRabbit performing code reviews on a live GitHub repository that you create, see \[Quickstart\](/getting-started/quickstart). ## Before you begin\[​\](#before-you-begin "Direct link to Before you begin") You need to have a GitHub account, and ownership-level permissions of at least one repository associated with that account. If you want to authorize CodeRabbit to write code reviews for a repository contained in a GitHub organization, then you need ownership-level permission with that organization, as well. ## Authorize CodeRabbit with your GitHub account\[​\](#authorize-coderabbit-with-your-github-account "Direct link to Authorize CodeRabbit with your GitHub account") Before you can use CodeRabbit with GitHub, you need to authorize CodeRabbit with your GitHub account. To do this, follow these steps: 1. Visit \[the CodeRabbit login page\](https://app.coderabbit.ai/login). 2. Click \*\*Login with GitHub\*\*. Your browser navigates to GitHub.com. 3. If GitHub prompts to sign in to your GitHub account before continuing, then enter your GitHub login credentials as you normally would. Otherwise, continue to the next step. 4. GitHub displays a summary of the information that CodeRabbit needs in order to integrate with your GitHub account. This includes read-only access to the following: \* Organizations and teams that are associated with your GitHub account. \* Email addresses that are associated with your GitHub account. To allow CodeRabbit access to this information, click \*\*Authorize coderabbitai\*\*. After you complete these steps, your browser navigates to the CodeRabbit web interface. Now that you've integrated CodeRabbit with your GitHub account, you need to give CodeRabbit additional permissions to work with your code repositories. To do this, see the next section. ## Allow CodeRabbit to access your repositories\[​\](#allow-coderabbit-to-access-your-repositories "Direct link to Allow CodeRabbit to access your repositories") Even after you've integrated CodeRabbit with your GitHub account, you need to separately grant CodeRabbit the permissions that it needs to post code reviews and create pull requests in your repositories. You need to authorize CodeRabbit separately for each GitHub organization whose repositories you want it to work with. You can give CodeRabbit permission to work with all of the repositories associated with a GitHub organization, or limit its access to a select list. ### Overview of required permissions\[​\](#overview-of-required-permissions "Direct link to Overview of required permissions") CodeRabbit requires the following permissions to work with your repositories: \* Read-only access to actions, checks, discussions, members, and metadata. \* Read-and-write access to code, commit statuses, issues, and pull requests. CodeRabbit requests read and write access to your repository in order for its code review, issue management, and pull request generation features to work. CodeRabbit never stores your code. For more information, see \[the CodeRabbit Trust Center\](https://trust.coderabbit.ai). \### Grant required permissions\[​\](#grant-required-permissions "Direct link to Grant required permissions") To give CodeRabbit access to one or more of your repositories, follow these steps: 1. Visit \[the CodeRabbit web interface\](https://app.coderabbit.ai/settings/repositories). 2. Make sure that the correct GitHub organization for the repository is displayed at the top of the web interface. To change the organization, click \*\*Change Organization\*\* and select a different organization from the list. If the repositories that you want to add are associated directly with your GitHub account, and not a separate organization, then select your account name as the organization. If the organization containing the repository doesn't appear in the list, then you might need to refresh the list of organizations that CodeRabbit has associated with your GitHub account. For more information, see \[Add organizations\](/getting-started/adding-organizations). 3. Click the \*\*Add Repositories\*\* button. Your browser navigates to GitHub.com. If the selected organization has no repositories registered with CodeRabbit, then your browser displays a CodeRabbit permissions dialog for setting up a new integration. Proceed to the next step. Otherwise, your browser displays a GitHub settings page for your organization's existing CodeRabbit integration. Scroll down to the section titled \*\*Repository access\*\*, and then proceed to the next step. 4. Select which repositories you'd like to allow CodeRabbit to write code reviews for. To give CodeRabbit access to all repositories in the organization, select \*\*All repositories\*\*. This also automatically grants CodeRabbit access to all repositories added to the organization in the future. To give CodeRabbit access to specific, limited list of repositories, select \*\*Only select repositories\*\*, and then choose repositories from the list. You can change this setting later. 5\. Click the button at the bottom of the form, which has one of the following labels, depending upon context: \* \*\*Install & Authorize\*\*, if this organization has no repositories integrated with CodeRabbit, and you are an owner of this organization. \* \*\*Save\*\*, if this organization already has repositories integrated with CodeRabbit 6. If you are integrating an organization with CodeRabbit for the first time, then your browser navigates back to the CodeRabbit web interface. Otherwise, your browser remains on your GitHub settings page, and you can manually navigate \[back to the CodeRabbit web interface\](https://app.coderabbit.ai/settings/repositories). ## What's next\[​\](#whats-next "Direct link to What's next") \* \[Set your repository preferences\](/guides/repository-settings) \* \[Review pull requests\](/guides/code-review-overview) \[Edit this page\](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/platforms/github-com.md) Last updated on \*\*Jul 31, 2025\*\* --- # Unknown \# Review instructions > The guide explains how to add custom review instructions for the entire project. You can also create code guidelines using the \[Code Guidelines\](/guides/code-guidelines) feature. Code guidelines automatically follow rules set by coding agents like Cursor, Claude, Roo and more. You can also use Code Guidelines to create custom code review instructions. \## Path-based instructions\[​\](#path-based "Direct link to Path-based instructions") This section explains how to add custom code review instructions for the entire project or specific file paths in your project using glob patterns. Developers can provide tailored review guidelines based on the file paths. These instructions are needed only if you want CodeRabbit to follow specific instructions besides the standard review. > For example, you may want to enforce a style guide by file types or directories. ### Default Blocked Paths\[​\](#default-blocked-paths "Direct link to Default Blocked Paths") By default, CodeRabbit blocks certain file paths and extensions from being reviewed. If you want CodeRabbit to review any of these blocked paths, you can explicitly include them in your Path Filters configuration. The following paths are blocked by default, grouped by category: #### Build and Dependency Directories\[​\](#build-and-dependency-directories "Direct link to Build and Dependency Directories") | Path Pattern | Description | | --------------------- | -------------------------- | | \`!\*\*/dist/\*\*\` | Build output directory | | \`!\*\*/node\_modules/\*\*\` | Node.js dependencies | | \`!\*\*/.svelte-kit/\*\*\` | SvelteKit build directory | | \`!\*\*/.webpack/\*\*\` | Webpack build directory | | \`!\*\*/.yarn/\*\*\` | Yarn cache directory | | \`!\*\*/.docusaurus/\*\*\` | Docusaurus build directory | | \`!\*\*/.temp/\*\*\` | Temporary files directory | | \`!\*\*/.cache/\*\*\` | Cache directory | | \`!\*\*/.next/\*\*\` | Next.js build directory | | \`!\*\*/.nuxt/\*\*\` | Nuxt.js build directory | #### Lock Files\[​\](#lock-files "Direct link to Lock Files") | Path Pattern | Description | | ----------------------- | ------------------ | | \`!\*\*/package-lock.json\` | npm lock file | | \`!\*\*/yarn.lock\` | Yarn lock file | | \`!\*\*/pnpm-lock.yaml\` | pnpm lock file | | \`!\*\*/bun.lockb\` | Bun lock file | | \`!\*\*/\*.lock\` | Generic lock files | #### Generated Code\[​\](#generated-code "Direct link to Generated Code") | Path Pattern | Description | | ---------------------- | -------------------------------------- | | \`!\*\*/generated/\*\*\` | Generated code directory | | \`!\*\*/@generated/\*\*\` | Generated code directory (alternative) | | \`!\*\*/\_\_generated\_\_/\*\*\` | Generated code directory (alternative) | | \`!\*\*/\_\_generated/\*\*\` | Generated code directory (alternative) | | \`!\*\*/\_generated/\*\*\` | Generated code directory (alternative) | | \`!\*\*/gen/\*\*\` | Generated code directory (alternative) | | \`!\*\*/@gen/\*\*\` | Generated code directory (alternative) | | \`!\*\*/\_\_gen\_\_/\*\*\` | Generated code directory (alternative) | | \`!\*\*/\_\_gen/\*\*\` | Generated code directory (alternative) | | \`!\*\*/\_gen/\*\*\` | Generated code directory (alternative) | #### Binary and Compiled Files\[​\](#binary-and-compiled-files "Direct link to Binary and Compiled Files") | Path Pattern | Description | | ------------- | ----------------------- | | \`!\*\*/\*.app\` | Application bundle | | \`!\*\*/\*.bin\` | Binary file | | \`!\*\*/\*.class\` | Java compiled class | | \`!\*\*/\*.dll\` | Windows dynamic library | | \`!\*\*/\*.dylib\` | macOS dynamic library | | \`!\*\*/\*.exe\` | Windows executable | | \`!\*\*/\*.o\` | Object file | | \`!\*\*/\*.so\` | Shared object file | | \`!\*\*/\*.wasm\` | WebAssembly file | #### Archives and Compressed Files\[​\](#archives-and-compressed-files "Direct link to Archives and Compressed Files") | Path Pattern | Description | | ------------ | ----------------------- | | \`!\*\*/\*.bz2\` | Bzip2 archive | | \`!\*\*/\*.gz\` | Gzip archive | | \`!\*\*/\*.xz\` | XZ archive | | \`!\*\*/\*.zip\` | ZIP archive | | \`!\*\*/\*.7z\` | 7-Zip archive | | \`!\*\*/\*.rar\` | RAR archive | | \`!\*\*/\*.zst\` | Zstandard archive | | \`!\*\*/\*.tar\` | TAR archive | | \`!\*\*/\*.jar\` | Java archive | | \`!\*\*/\*.war\` | Web application archive | | \`!\*\*/\*.nar\` | NAR archive | #### Media Files\[​\](#media-files "Direct link to Media Files") | Path Pattern | Description | | ------------ | --------------- | | \`!\*\*/\*.mp3\` | MP3 audio | | \`!\*\*/\*.wav\` | WAV audio | | \`!\*\*/\*.wma\` | WMA audio | | \`!\*\*/\*.mp4\` | MP4 video | | \`!\*\*/\*.avi\` | AVI video | | \`!\*\*/\*.mkv\` | MKV video | | \`!\*\*/\*.wmv\` | WMV video | | \`!\*\*/\*.m4a\` | M4A audio | | \`!\*\*/\*.m4v\` | M4V video | | \`!\*\*/\*.3gp\` | 3GP video | | \`!\*\*/\*.3g2\` | 3G2 video | | \`!\*\*/\*.rm\` | RealMedia video | | \`!\*\*/\*.mov\` | QuickTime video | | \`!\*\*/\*.flv\` | Flash video | | \`!\*\*/\*.swf\` | Flash animation | | \`!\*\*/\*.flac\` | FLAC audio | | \`!\*\*/\*.ogg\` | OGG audio | #### Images and Fonts\[​\](#images-and-fonts "Direct link to Images and Fonts") | Path Pattern | Description | | ------------- | ---------------------- | | \`!\*\*/\*.ico\` | Icon file | | \`!\*\*/\*.svg\` | SVG image | | \`!\*\*/\*.jpeg\` | JPEG image | | \`!\*\*/\*.jpg\` | JPEG image | | \`!\*\*/\*.png\` | PNG image | | \`!\*\*/\*.gif\` | GIF image | | \`!\*\*/\*.bmp\` | BMP image | | \`!\*\*/\*.tiff\` | TIFF image | | \`!\*\*/\*.webm\` | WebM image | | \`!\*\*/\*.ttf\` | TrueType font | | \`!\*\*/\*.otf\` | OpenType font | | \`!\*\*/\*.woff\` | Web Open Font Format | | \`!\*\*/\*.woff2\` | Web Open Font Format 2 | | \`!\*\*/\*.eot\` | Embedded OpenType font | #### Documents and Data Files\[​\](#documents-and-data-files "Direct link to Documents and Data Files") | Path Pattern | Description | | --------------- | ----------------------- | | \`!\*\*/\*.pdf\` | PDF document | | \`!\*\*/\*.doc\` | Word document | | \`!\*\*/\*.docx\` | Word document | | \`!\*\*/\*.xls\` | Excel spreadsheet | | \`!\*\*/\*.xlsx\` | Excel spreadsheet | | \`!\*\*/\*.ppt\` | PowerPoint presentation | | \`!\*\*/\*.pptx\` | PowerPoint presentation | | \`!\*\*/\*.csv\` | CSV data file | | \`!\*\*/\*.tsv\` | TSV data file | | \`!\*\*/\*.dat\` | Data file | | \`!\*\*/\*.db\` | Database file | | \`!\*\*/\*.parquet\` | Parquet data file | #### Development and System Files\[​\](#development-and-system-files "Direct link to Development and System Files") | Path Pattern | Description | | -------------------- | ------------------- | | \`!\*\*/tags\` | Tags file | | \`!\*\*/.tags\` | Tags file | | \`!\*\*/TAGS\` | Tags file | | \`!\*\*/.TAGS\` | Tags file | | \`!\*\*/.DS\_Store\` | macOS system file | | \`!\*\*/.cscope.files\` | Cscope files | | \`!\*\*/.cscope.out\` | Cscope output | | \`!\*\*/.cscope.in.out\` | Cscope input/output | | \`!\*\*/.cscope.po.out\` | Cscope output | | \`!\*\*/\*.log\` | Log file | | \`!\*\*/\*.map\` | Source map | | \`!\*\*/\*.out\` | Output file | | \`!\*\*/\*.sum\` | Checksum file | | \`!\*\*/\*.work\` | Work file | | \`!\*\*/\*.md5sum\` | MD5 checksum file | #### Game and 3D Assets\[​\](#game-and-3d-assets "Direct link to Game and 3D Assets") | Path Pattern | Description | | ------------------- | ---------------------- | | \`!\*\*/\*.tga\` | Targa image | | \`!\*\*/\*.dds\` | DirectDraw surface | | \`!\*\*/\*.psd\` | Photoshop document | | \`!\*\*/\*.fbx\` | FBX 3D model | | \`!\*\*/\*.obj\` | OBJ 3D model | | \`!\*\*/\*.blend\` | Blender file | | \`!\*\*/\*.dae\` | COLLADA 3D model | | \`!\*\*/\*.gltf\` | GL Transmission Format | | \`!\*\*/\*.hlsl\` | HLSL shader | | \`!\*\*/\*.glsl\` | GLSL shader | | \`!\*\*/\*.unity\` | Unity scene | | \`!\*\*/\*.umap\` | Unreal map | | \`!\*\*/\*.prefab\` | Unity prefab | | \`!\*\*/\*.mat\` | Material file | | \`!\*\*/\*.shader\` | Shader file | | \`!\*\*/\*.shadergraph\` | Shader graph | | \`!\*\*/\*.sav\` | Save file | | \`!\*\*/\*.scene\` | Scene file | | \`!\*\*/\*.asset\` | Asset file | #### Python-specific Files\[​\](#python-specific-files "Direct link to Python-specific Files") | Path Pattern | Description | | -------------- | --------------------- | | \`!\*\*/\*.pyc\` | Python compiled file | | \`!\*\*/\*.pyd\` | Python dynamic module | | \`!\*\*/\*.pyo\` | Python optimized file | | \`!\*\*/\*.pkl\` | Python pickle file | | \`!\*\*/\*.pickle\` | Python pickle file | #### Go-specific Files\[​\](#go-specific-files "Direct link to Go-specific Files") | Path Pattern | Description | | ---------------- | ------------------------------- | | \`!\*\*/\*.pb.go\` | Protocol buffer Go file | | \`!\*\*/\*.pb.gw.go\` | Protocol buffer gateway Go file | #### Terraform Files\[​\](#terraform-files "Direct link to Terraform Files") | Path Pattern | Description | | ---------------------- | ---------------------- | | \`!\*\*/\*.tfstate\` | Terraform state file | | \`!\*\*/\*.tfstate.backup\` | Terraform state backup | #### Minified Files\[​\](#minified-files "Direct link to Minified Files") | Path Pattern | Description | | ------------------ | ------------------------------ | | \`!\*\*/\*.min.js\` | Minified JavaScript | | \`!\*\*/\*.min.js.map\` | Minified JavaScript source map | | \`!\*\*/\*.min.js.css\` | Minified CSS | You can also edit your path filters directly in the UI by navigating to: \*\*Configuration\*\* > \*\*Review\*\* > \*\*Settings\*\* > \*\*Path Filters\*\* !\[CircleCI Integration\](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/guides/img/guides/path-filters.png) ### Sample Usage\[​\](#sample-usage "Direct link to Sample Usage") Paths accept glob patterns. See the \[minimatch\](https://github.com/isaacs/minimatch) documentation for more information. \`\`\`yaml wrap #... reviews: #... path\_instructions: - path: "\*\*/\*.js" instructions: | Review the JavaScript code against the Google JavaScript style guide and point out any mismatches - path: "tests/\*\*.\*" instructions: | Review the following unit test code written using the Mocha test library. Ensure that: - The code adheres to best practices associated with Mocha. - Descriptive test names are used to clearly convey the intent of each test. \`\`\` ## Abstract Syntax Tree (AST) based instructions\[​\](#ast-based "Direct link to Abstract Syntax Tree (AST) based instructions") This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our \[pricing page\](https://www.coderabbit.ai/pricing) for more information about our plans and features. CodeRabbit offers review instructions based on Abstract Syntax Tree (AST) patterns. Under the hood, CodeRabbit uses \[\`ast-grep\`\](https://ast-grep.github.io) to power this feature. \`ast-grep\` is written in Rust and uses the tree-sitter parser to generate the AST for popular languages. \`ast-grep\` is written and maintained by \[Herrington Darkholme\](https://twitter.com/hd\_nvim). \`ast-grep\` Playground is quite effective in designing and testing AST rules on source code snippets. You can access the playground \[here\](https://ast-grep.github.io/playground.html). The additional context provided by this feature is only available during the automated code review process, and it's not available in the chat. Moreover, this feature is only recommended for advanced users as there is a learning curve involved. \*\*Deep dive into AST patterns and \`ast-grep\` rules\*\* \* Abstract Syntax Tree (AST) \[Wikipedia article\](https://en.wikipedia.org/wiki/Abstract\_syntax\_tree) \* \`ast-grep\` \[official documentation\](https://ast-grep.github.io/guide/rule-config.html) for detailed guides. This section explains how to add custom code review instructions using \`ast-grep\` rules. \`ast-grep\` is a tool used for searching code using abstract syntax trees (AST) patterns. By default, you can add \`ast-grep\` rules by following these steps: 1. Create a directory that keeps all the \`ast-grep\` rules in your project directory. 2. Add individual \`.yaml\` files for each \`ast-grep\` rule within the newly created directory. 3. Ensure that each \`.yaml\` file contains the necessary \`ast-grep\` rule configurations. 4. Ensure that all rules contain a \`message\` property that will be used during the review process. 5. Add the rules' directory to the \`.coderabbit.yml\` file under \`tools.ast-grep\` configuration. 6. Optionally, you can add \`packages\` property to the configuration to specify the packages that should be installed before running the \`ast-grep\` tool. Please read the \`packages\` section for detailed information. \`\`\`yaml #... reviews: #... tools: ast-grep: essential\_rules: true # option to enable essential security rules rule\_dirs: - "custom-name" packages: - "myorg/myawesomepackage" # custom package name following the format organization/repository #... \`\`\` ### The rule object\[​\](#the-rule-object "Direct link to The rule object") Rule object is the core concept of \`ast-grep\` rule system and every other feature is built on top of it. Below is the full list of fields in a rule object. Every rule field is optional and can be omitted, but at least one field should be present in a rule. A node will match a rule if and only if it satisfies all fields in the rule object. \`\`\`yaml rule: # atomic rule pattern: "search.pattern" kind: "tree\_sitter\_node\_kind" regex: "rust|regex" # relational rule inside: { pattern: "sub.rule" } has: { kind: "sub\_rule" } follows: { regex: "can|use|any" } precedes: { kind: "multi\_keys", pattern: "in.sub" } # composite rule all: \[{ pattern: "match.all" }, { kind: "match\_all" }\] any: \[{ pattern: "match.any" }, { kind: "match\_any" }\] not: { pattern: "not.this" } matches: "utility-rule" \`\`\` ### Rule Categories\[​\](#rule-categories "Direct link to Rule Categories") To summarize the rule object fields above, we have three categories of rules: \* \*\*Atomic Rule:\*\* the most basic rule that checks if AST nodes matches. \* \*\*Relational Rule:\*\* rules that check if a node is surrounded by another node. \* \*\*Composite Rule:\*\* rules that combine sub-rules together using logical operators. These three categories of rules can be composed together to create more complex rules. The rule object is inspired by the CSS selectors but with more composability and expressiveness. Thinking about how selectors in CSS works can help you understand the rule object! > Read \`ast-grep\` > \[documentation\](https://ast-grep.github.io/guide/rule-config.html) for detailed guides. #### Atomic rule\[​\](#atomic-rule "Direct link to Atomic rule") Atomic rule defines the most basic matching rule that determines whether one syntax node matches the rule or not. There are three kinds of atomic rule: \`pattern\`, \`kind\` and \`regex\`. > Official documentation guide on \[Atomic Rule\](https://ast-grep.github.io/guide/rule-config/atomic-rule.html) #### Relational rule\[​\](#relational-rule "Direct link to Relational rule") A relational rule defines the relationship between two syntax nodes. There are four kinds of relational rule: \`inside\`, \`has\`, \`follows\` and \`precedes\`. All four relational rules accept a sub-rule object as their value. The sub-rule will match the surrounding node, while the relational rule itself will match the target node. > Official documentation guide on \[Relational Rule\](https://ast-grep.github.io/guide/rule-config/relational-rule.html) \`\`\`yaml rule: pattern: await $PROMISE inside: kind: for\_in\_statement stopBy: end \`\`\` #### Composite rule\[​\](#composite-rule "Direct link to Composite rule") A composite rule defines the logical relationship between multiple sub-rules. There are three kinds of composite rule: \`all\`, \`any\` and \`not\`. \*\*\`all\`\*\* The \`all\` rule matches if all sub-rules match. \`\`\`yaml rule: all: - pattern: console.log('Hello World'); - kind: expression\_statement \`\`\` \*\*\`any\`\*\* \`any\` rule matches if any sub-rule matches. \`\`\`yaml rule: any: - pattern: var a = $A - pattern: const a = $A - pattern: let a = $A \`\`\` \*\*\`not\`\*\* \`not\` applies negation to a sub-rule. It matches if the sub-rule does not match. \`\`\`yaml rule: pattern: console.log($GREETING) not: pattern: console.log('Hello World') \`\`\` > Official documentation guide on \[Composite Rule\](https://ast-grep.github.io/guide/rule-config/composite-rule.html) ### Reusing rule as utility\[​\](#reusing-rule-as-utility "Direct link to Reusing rule as utility") \`ast-grep\` chooses to use YAML for rule representation. While this decision makes writing rules easier, it does impose some limitations on the rule authoring. One of the limitations is that rule objects cannot be reused. #### Local utility rule\[​\](#local-utility-rule "Direct link to Local utility rule") Local utility rules are defined in the utils field of the config file. Utils is a string-keyed dictionary. For example, the following config file defines a local utility rule \`is-literal\`: \`\`\`yaml utils: is-literal: any: - kind: string - kind: number - kind: boolean rule: matches: is-literal \`\`\` #### Global utility rule\[​\](#global-utility-rule "Direct link to Global utility rule") Global utility rules are defined in a separate file. But they are available across all rule configurations in the project. To create global utility rules, you need to have the \`rules\` directory created on the root of your project and another \`utils\` directory inside the root of your project. \`\`\`yaml my-awesome-project # project root |- rules # rule directory | |- my-rule.yml |- utils # utils directory | |- is-literal.yml \`\`\` > Also, you need to add the \`rules\` and \`utils\` directories to the \`.coderabbit.yml\` file under \`tools.ast-grep\` configuration. The rules can also be inside a package. If you have a package that contains rules, you can add the package name to the \`packages\` field in the \`.coderabbit.yml\` file. \`\`\`yaml #... reviews: #... tools: ast-grep: essential\_rules: true rule\_dirs: - "rules" util\_dirs: - "utils" packages: - "my-awesome-org/my-awesome-package" # public repository that contains ast-grep rules #... \`\`\` \`\`\`yaml # is-literal.yml id: is-literal language: TypeScript rule: any: - kind: "false" - kind: undefined - kind: "null" - kind: "true" - kind: regex - kind: number - kind: string \`\`\` > Official documentation guide on \[Utility Rule\](https://ast-grep.github.io/guide/rule-config/utility-rule.html) ### Packages\[​\](#packages "Direct link to Packages") A package is what allows you to share rules across multiple projects. Essentially, a package is a collection of \`ast-grep\` rules. CodeRabbit provides a set of packages that you can use out of the box. You can also create your own packages and share them with the community or just use them within your organization. Packages provided by CodeRabbit are: \* \`ast-grep-essentials\`: A set of essential security rules. Because we value security, this package gets its own property in the \`.coderabbit.yml\` file, to make it easier to install and not overwrite. Check the \[package repository\](https://github.com/coderabbitai/ast-grep-essentials) for more information. To use a package, you need to add the package name to the \`packages\` field in the \`.coderabbit.yml\` file. \`\`\`yaml #... reviews: #... tools: ast-grep: essential\_rules: true packages: # list of packages to install, in future coderabbit will provide a set of packages, beside the essentials one. - "my-awesome-org/my-awesome-package" # custom package name following the format organization/repository #... \`\`\` #### Using custom package\[​\](#using-custom-package "Direct link to Using custom package") Let's say that you have a public repository that contains \`ast-grep\` rules. You can add the package name to the \`packages\` field in the \`.coderabbit.yml\` file. Requirements for a package: \* It should be a public repository \* It contains rules that follow the \`ast-grep\` rule format \* It has the following folder structure: \`\`\`text my-awesome-project # project root |- rules # rule directory | |- my-rule.yml |- utils # utils directory | |- is-literal.yml \`\`\` \`rules\` and \`utils\` directories are keywords, and it should be the same. Inside each directory, the structure is up to you. You can also have any other root directories or files beside the two shown above. \* Name should be in the format \`organization/repository\` \`\`\`yaml #... reviews: #... tools: ast-grep: packages: - "my-awesome-org/my-awesome-package" #... \`\`\` ### Multiple Languages Support\[​\](#multiple-languages-support "Direct link to Multiple Languages Support") CodeRabbit supports multiple programming languages for defining \`ast-grep\` rules. \* JavaScript \* Typescript \* C# \* Golang \* Java \* Kotlin \* Rust \* Python \* C Below are examples of \`ast-grep\` rules in different languages: #### JavaScript\[​\](#javascript "Direct link to JavaScript") ##### Importing files without an extension is not allowed\[​\](#importing-files-without-an-extension-is-not-allowed "Direct link to Importing files without an extension is not allowed") \`\`\`yaml id: find-import-file language: js message: "Importing files without an extension is not allowed" rule: regex: "/\[^.\]+\[^/\]$" kind: string\_fragment any: - inside: stopBy: end kind: import\_statement - inside: stopBy: end kind: call\_expression has: field: function regex: "^import$" \`\`\` ##### No console.log allowed except \`console.error\` on the catch block\[​\](#no-consolelog-allowed-except-consoleerror-on-the-catch-block "Direct link to no-consolelog-allowed-except-consoleerror-on-the-catch-block") \`\`\`yaml id: no-console-except-error language: typescript message: "No console.log allowed except console.error on the catch block" rule: any: - pattern: console.error($$$) not: inside: kind: catch\_clause stopBy: end - pattern: console.$METHOD($$$) constraints: METHOD: regex: "log|debug|warn" \`\`\` #### C\[​\](#c "Direct link to C") In C, there is no built-in support for object-oriented programming, but some programmers use structs and function pointers to simulate classes and methods. However, this style can have some drawbacks, such as: \* Extra memory allocation and reallocation for the struct and the function pointer. \* Indirection overhead when calling the function pointer. A possible alternative is to use a plain function call with the struct pointer as the first argument. \`\`\`yaml id: method\_receiver language: c rule: pattern: $R.$METHOD($$$ARGS) transform: MAYBE\_COMMA: replace: source: $$$ARGS replace: "^.+" by: ", " fix: $METHOD(&$R$MAYBE\_COMMA$$$ARGS) \`\`\` \[Edit this page\](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/review-instructions.md) Last updated on \*\*Jul 31, 2025\*\* --- # Unknown \# Control and manage code reviews > This page is about issuing direct commands to CodeRabbit during code reviews. For a general overview of performing code reviews with CodeRabbit, see . You can control CodeRabbit's behavior with a specific pull request by mentioning the username of its bot, \`@coderabbitai\`, alongside keywords in comments or the pull request description, as specified by the next sections of this page. For a complete CodeRabbit command reference, see \[Code review command reference\](/reference/review-commands). ## Control automatic code reviews\[​\](#flow "Direct link to Control automatic code reviews") By default, CodeRabbit automatically reviews every new pull request created in your repository. It updates its review with comments whenever the pull request has new commits pushed to it. The following sections show you how to tell CodeRabbit to modify this behavior with a specific pull request, such as pausing reviews, or resolving open comments. For more information about permanently configuring the behavior of CodeRabbit on your repository, see \[Add a configuration file\](/getting-started/configure-coderabbit). ### Pause and resume automatic code reviews\[​\](#pause-resume "Direct link to Pause and resume automatic code reviews") You can tell CodeRabbit to pause its automatic reviews of a pull request. If you do, then you can still manually request CodeRabbit to review changes using the commands listed on \[Code review command reference\](/reference/review-commands). To pause automated reviews of a pull request, post the following comment to the pull request: \`\`\` @coderabbitai pause \`\`\` To resume automated reviews after pausing them, post the following comment to the pull request: \`\`\` @coderabbitai resume \`\`\` ### Disable automatic code reviews\[​\](#ignore "Direct link to Disable automatic code reviews") To disable automatic code reviews for a pull request, add the following line anywhere in the pull request description: \`\`\` @coderabbitai ignore \`\`\` As long as that text remains in the description, CodeRabbit will not automatically review any commits associated with that pull request. You can still \[chat with CodeRabbit\](/guides/agent\_chat) and issue other commands in the pull request comments. To enable automatic reviews on that pull request, delete "\`@coderabbitai ignore\`" from the pull request description. CodeRabbit commences automatic reviews starting with the next commit made to the branch under review. ## Manually request code reviews\[​\](#request "Direct link to Manually request code reviews") You can ask CodeRabbit to perform a code review at any time. This can be useful when you have paused automated code reviews. Manually requested reviews have two types: \* A \*full review\* disregards any comments that CodeRabbit has already made on this pull request, and generates a complete review of the entire pull request. \* An \*incremental review\* takes all comments that CodeRabbit has made since its most recent full review into consideration, and generates a review of only the new changes. To manually request a full review, post the following comment to the pull request: \`\`\` @coderabbitai full review \`\`\` To manually request an incremental review, post the following comment to the pull request: \`\`\` @coderabbitai review \`\`\` ## Resolve comments\[​\](#resolve "Direct link to Resolve comments") To have CodeRabbit mark all of its previous comments as resolved, post the following comment to the pull request: \`\`\` @coderabbitai resolve \`\`\` ## Update information about the pull request\[​\](#update "Direct link to Update information about the pull request") The commands in this section request CodeRabbit to generate and post updated information about the pull request itself. ### Update the summary text\[​\](#summary "Direct link to Update the summary text") To have CodeRabbit update the generated summary of the branch’s proposed changes to the pull request’s description, post the following comment: \`\`\` @coderabbitai summary \`\`\` CodeRabbit updates the summary text to the description under the heading "Summary by CodeRabbit". ### Diagram the pull request history\[​\](#diagram "Direct link to Diagram the pull request history") To have CodeRabbit post a comment that contains a sequence diagram which visualizes the history of the pull request under review, post the following comment: \`\`\` @coderabbitai generate sequence diagram \`\`\` ## Get information about CodeRabbit\[​\](#info "Direct link to Get information about CodeRabbit") The commands in this section request CodeRabbit to display its own configuration or documentation. ### Display current configuration\[​\](#config "Direct link to Display current configuration") To have CodeRabbit post a comment listing out its current configuration with your repository, post the following comment to the pull request: \`\`\` @coderabbitai configuration \`\`\` ### Display a quick-reference guide\[​\](#help "Direct link to Display a quick-reference guide") To have CodeRabbit post a comment to the pull request with a quick-reference guide to its own commands and other features, post the following comment to the pull request: \`\`\` @coderabbitai help \`\`\` ## What's next\[​\](#whats-next "Direct link to What's next") \* \[Generate code improvements\](/guides/generate-improvements) \* \[Best practices\](/guides/code-review-best-practices) \* \[Troubleshooting\](/guides/code-review-troubleshooting) \[Edit this page\](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/guides/commands.md) Last updated on \*\*Jul 31, 2025\*\* --- # Unknown \# Get support > Welcome to CodeRabbit Support. Please refer to the following sections for contacting our support team. Our support team will respond back as soon as possible. ## Discord Server\[​\](#discord-server "Direct link to Discord Server") All CodeRabbit users have access to the \[CodeRabbit Discord Server\](https://discord.gg/coderabbit), where you can ask questions or see what others are doing with CodeRabbit. You will find CodeRabbit users and members of the CodeRabbit team actively engaged. ## Support Tickets\[​\](#support-tickets "Direct link to Support Tickets") For assistance from our support team, click the help icon located in the bottom right corner of the \[CodeRabbit UI\](https://app.coderabbit.ai/login?free-trial). This will open a chat window where you can submit your support ticket. Complete the support ticket by providing your name, email, a description of your issue, and attaching any necessary files. If you are reporting a bug, please provide the GitHub or GitLab organization name. !\[How to Open a Support Ticket-CodeRabbit \](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/cr\_support\_help\_light-d2c0c157c2b4a0a1fe14f7c3e9b8502f.png) !\[How to Open a Support Ticket-CodeRabbit \](https://mintlify.s3.us-west-1.amazonaws.com/coderabbit/images/getting-started/assets/images/cr\_support\_help\_dark-cd6c55cd5175a560881bce1ffe3a3d8f.png) If you are a paying user and cannot access the support ticket form in the CodeRabbit UI for some reason, you can contact CodeRabbit support at the following email address: \[\\\[email protected\\\]\](/cdn-cgi/l/email-protection#5b282e2b2b34292f1b38343f3e293a3939322f753a32). \## Customer Responsibilities\[​\](#customer-responsibilities "Direct link to Customer Responsibilities") > To ensure efficient resolution of issues, customers are expected to 1. Provide detailed information about the issue. 2. Cooperate with the Support team during troubleshooting. 3. Utilize available self-service resources/docs for basic inquiries. ## Etiquette\[​\](#etiquette "Direct link to Etiquette") Regardless of the method or location through which CodeRabbit provides Support, communication should be professional and respectful. Any communication that is deemed objectionable by CodeRabbit staff is not tolerated. This includes but is not limited to any communication that is abusive or contains profane language. > CodeRabbit reserves the right to terminate Support Services in the event of any such objectionable communication. To see more common issues faced by CodeRabbit users, visit our \[FAQ section\](/faq) for detailed answers and solutions to frequently encountered problems. \[Edit this page\](https://github.com/coderabbitai/coderabbit-docs/edit/main/docs/getting-started/support.md) Last updated on \*\*Jul 31, 2025\*\* ---