# CodeRabbit

- [Agentic Change Management](https://docs.coderabbit.ai/index.md): Review, prioritize, understand, and secure agent-generated changes with CodeRabbit.
- [The System Behind Every Review Comment](https://docs.coderabbit.ai/overview/architecture.md): CodeRabbit Architecture | How CodeRabbit works internally
- [Pull Request Reviews](https://docs.coderabbit.ai/overview/pull-request-review.md): Within moments of opening a pull request, CodeRabbit analyzes your code with multiple AI models and provides actionable feedback, catching issues that are easy to miss in manual reviews.
- [Code reviews in IDE and CLI](https://docs.coderabbit.ai/overview/ide-cli-review.md): Review your code in IDE or CLI before pushing it to the repo
- [CodeRabbit Plan](https://docs.coderabbit.ai/overview/coderabbit-plan.md): Turn ideas, issues, PRDs, and designs into precise Coding Plans grounded in your codebase, then hand them off to any coding agent.
- [CodeRabbit Agent for Slack](https://docs.coderabbit.ai/overview/slack-agent.md): Bring AI-powered investigation, planning, and code editing into your Slack workspace: with shared context, persistent knowledge, and governed access.
- [Quickstart](https://docs.coderabbit.ai/getting-started/quickstart.md): Get CodeRabbit up and running in 2 minutes. Connect your repositories and start receiving AI-powered code reviews and Coding Plans.
- [Hands-on guide](https://docs.coderabbit.ai/guide/index.md): A step-by-step walkthrough of CodeRabbit's core features using a test repository
- [Repository setup](https://docs.coderabbit.ai/guide/repository.md): Set up a GitHub test repository and integrate CodeRabbit for automated code reviews
- [Code Review](https://docs.coderabbit.ai/guide/code-review.md): Experience CodeRabbit's automated code review by creating your first pull request
- [Interactive code review chat](https://docs.coderabbit.ai/guide/chat.md): Learn how to interact with CodeRabbit through conversations and get clarifications on its feedback
- [Improvements](https://docs.coderabbit.ai/guide/improvements.md): Learn how to use CodeRabbit commands to automatically generate code improvements
- [You're Ready to Ship Better Code!](https://docs.coderabbit.ai/guide/complete.md): Congratulations! You've completed the CodeRabbit hands-on guide and experienced AI-powered code reviews firsthand
- [Triage](https://docs.coderabbit.ai/triage/index.md): Prioritize your PR queue by value and risk, surface the changes that need attention, and route each pull request to the right reviewer.
- [Triage prioritization](https://docs.coderabbit.ai/triage/prioritization.md): Learn how Triage combines review state, activity, risk, effort, and dependency context to rank pull requests and recommend the next action.
- [Overview](https://docs.coderabbit.ai/guides/code-review-overview.md): Discover how CodeRabbit transforms your development workflow with AI-powered code reviews that provide instant, comprehensive feedback on every pull request.
- [PR Summaries](https://docs.coderabbit.ai/pr-reviews/summaries.md): Every time CodeRabbit reviews a pull request, it writes a plain-language **summary** directly into the PR description. The summary is on by default and fully configurable.
- [PR Walkthroughs](https://docs.coderabbit.ai/pr-reviews/walkthroughs.md): Every time CodeRabbit reviews a pull request, it posts a **walkthrough comment** — a structured overview of the changes that appears at the top of the PR comment thread, separate from inline code comments. The walkthrough is on by default and fully configurable.
- [Change Stack](https://docs.coderabbit.ai/pr-reviews/change-stack.md): Change Stack is CodeRabbit's PR inspection interface. It reorganizes a pull request from a flat file list into a structured, layer-by-layer walkthrough. Reviewers can explore the change in a logical order instead of alphabetical file order. Each *cohort* includes range-specific summaries and, when u…
- [CI/CD Pipeline Analysis](https://docs.coderabbit.ai/pr-reviews/cicd-pipeline-analysis.md): How CodeRabbit reads CI/CD pipeline failures and posts inline fix suggestions directly on the relevant lines of your pull request.
- [PR validation using linked issues](https://docs.coderabbit.ai/issues/pr-validation.md): CodeRabbit provides intelligent assessment of linked issues to validate whether pull requests properly address their requirements. This guide explains how to effectively use linked issues and write clear issue descriptions for optimal results.
- [Slop Detection](https://docs.coderabbit.ai/pr-reviews/slop-detection.md): Automatically detect low-quality, AI-generated 'Slop' pull requests on GitHub repositories.
- [Request changes workflow](https://docs.coderabbit.ai/pr-reviews/request-changes-workflow.md): Use request changes workflow to keep review decisions synchronized with resolved feedback, completed reviews, and Pre-Merge Checks.
- [Path-based review instructions](https://docs.coderabbit.ai/configuration/path-instructions.md): Customize how CodeRabbit reviews different parts of your codebase using glob patterns. Apply focused, context-aware instructions to controllers, tests, documentation, and more.
- [AST-based path instructions](https://docs.coderabbit.ai/configuration/ast-grep-instructions.md): Write structural code pattern rules using ast-grep to give CodeRabbit precise, syntax-aware review instructions.
- [Automatic review controls](https://docs.coderabbit.ai/configuration/auto-review.md): Configure when and how CodeRabbit automatically reviews pull requests using the `reviews.auto_review` settings.
- [Manage code reviews](https://docs.coderabbit.ai/guides/commands.md): Learn how to control and manage CodeRabbit's automatic code reviews with commands. Pause, resume, ignore reviews, request manual reviews, resolve comments, request approval, and update pull request summaries using @coderabbitai commands.
- [Code review commands](https://docs.coderabbit.ai/reference/review-commands.md): Complete reference of CodeRabbit commands for controlling code reviews, generating documentation, and managing pull requests.
- [Create issues](https://docs.coderabbit.ai/issues/creation.md): Turn code discussions into tracked issues across GitHub, GitLab, Jira, and Linear directly from CodeRabbit's chat interface.
- [Built-in Pre-Merge Checks](https://docs.coderabbit.ai/pr-reviews/pre-merge-checks.md): Enforce quality gates and your organization's custom requirements before pull requests are merged.
- [Custom checks](https://docs.coderabbit.ai/pr-reviews/custom-checks.md): Define your own validation logic using natural language instructions for pre-merge checks.
- [Post-Merge Actions](https://docs.coderabbit.ai/pr-reviews/post-merge-actions.md): Run automated follow-up work, including changelog updates, tickets, and notifications, after a pull request is merged.
- [Finishing Touches overview](https://docs.coderabbit.ai/finishing-touches/index.md): One-click agentic actions that polish and extend your pull requests or merge requests: fix review findings, resolve merge conflicts, generate unit tests, simplify code, run any custom recipes.
- [Autofix: apply CodeRabbit code fixes to pull requests](https://docs.coderabbit.ai/finishing-touches/autofix.md): Use CodeRabbit Autofix to automatically implement code changes for unresolved review findings in your pull request as a commit or stacked PR.
- [Fix CI failures](https://docs.coderabbit.ai/finishing-touches/fix-ci.md): Automatically fix failing CI checks with a stacked pull request or a direct commit.
- [Resolve Merge Conflicts](https://docs.coderabbit.ai/finishing-touches/resolve-merge-conflict.md): Automatically detect and resolve merge conflicts in pull requests with a single click or comment.
- [Generate unit tests](https://docs.coderabbit.ai/finishing-touches/unit-test-generation.md): Generate comprehensive unit tests automatically for your pull requests, including edge cases and error conditions.
- [Custom Finishing Touch recipes](https://docs.coderabbit.ai/finishing-touches/custom-finishing-touches.md): Define reusable, named recipes that run agentic code changes on your pull requests.
- [Simplify code](https://docs.coderabbit.ai/finishing-touches/simplify.md): Automatically review changed code for opportunities to simplify, improve reuse, quality, and efficiency, then apply targeted improvements.
- [Generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings.md): Automatically generate comprehensive docstrings that match your existing format, delivered through PR workflow for complete review control
- [Knowledge Base overview](https://docs.coderabbit.ai/knowledge-base/index.md): How CodeRabbit enriches code reviews with context beyond the diff — learnings, code guidelines, multi-repo analysis, MCP servers, web search, and linked issues.
- [Learnings](https://docs.coderabbit.ai/knowledge-base/learnings.md): Teach CodeRabbit your review preferences using natural-language chat.
- [Code Guidelines](https://docs.coderabbit.ai/knowledge-base/code-guidelines.md): CodeRabbit automatically detects coding guideline files such as .cursorrules, CLAUDE.md, and AGENTS.md in your repository and applies them as review criteria—no extra configuration required.
- [Multi-Repo Analysis](https://docs.coderabbit.ai/knowledge-base/multi-repo-analysis.md): Link related repositories so CodeRabbit can detect breaking changes, API mismatches, and dependency issues that cross repository boundaries during code review.
- [MCP Servers](https://docs.coderabbit.ai/knowledge-base/mcp-context.md): Use MCP servers as a knowledge source to give CodeRabbit additional context from your documentation systems, design tools, and project management platforms during reviews and chat.
- [Web Search](https://docs.coderabbit.ai/knowledge-base/web-search.md): How CodeRabbit uses web search to gather additional context during code reviews and chat responses.
- [CodeRabbit Security](https://docs.coderabbit.ai/security/index.md): Scan GitHub, GitLab, Azure DevOps Services, and Bitbucket Cloud repositories for potential security issues across the committed codebase.
- [Attack surface and continuous posture](https://docs.coderabbit.ai/security/attack-surface.md): Understand how CodeRabbit maps security-relevant code, tracks verification coverage, and keeps repository posture current as pull requests merge.
- [Security Blast Radius](https://docs.coderabbit.ai/security/blast-radius.md): Map how a pull request's changes connect to dependencies, downstream consumers, tests, and security-relevant paths in Change Stack.
- [Security Architecture Review](https://docs.coderabbit.ai/security/architecture-review.md): Assess the security implications of architecture-level changes in pull requests covered by CodeRabbit Security.
- [Configuration overview](https://docs.coderabbit.ai/guides/configuration-overview.md): Configure CodeRabbit to fit your organization and repositories using multiple approaches with clear priority rules.
- [Configuration inheritance](https://docs.coderabbit.ai/configuration/configuration-inheritance.md): Learn how CodeRabbit merges configuration settings across multiple levels, from repository files to organization defaults.
- [Configuration via YAML file](https://docs.coderabbit.ai/getting-started/yaml-configuration.md): Learn how to configure CodeRabbit using a YAML file for advanced customization.
- [Central configuration](https://docs.coderabbit.ai/configuration/central-configuration.md): Manage CodeRabbit settings across all repositories from a single central location, eliminating per-repository configuration updates.
- [YAML validator](https://docs.coderabbit.ai/configuration/yaml-validator.md): Validate and edit YAML configuration files for CodeRabbit
- [Repository settings](https://docs.coderabbit.ai/guides/repository-settings.md): Configure CodeRabbit's behavior for individual repositories using the web interface. Learn about configuration precedence and best practices.
- [Organization settings](https://docs.coderabbit.ai/guides/organization-settings.md): Manage default CodeRabbit settings across your entire Git platform organization and configure repository-level overrides.
- [Configuration examples](https://docs.coderabbit.ai/configuration/example/index.md): This section provides ready-to-use CodeRabbit configuration examples tailored to specific frameworks, languages, and project types. Each example demonstrates best practices and common patterns for configuring CodeRabbit to work effectively with your technology stack.
- [Sample configuration for React Native + Expo](https://docs.coderabbit.ai/configuration/example/typescript/expo.md)
- [Sample configuration for Django](https://docs.coderabbit.ai/configuration/example/python/django.md)
- [Sample configuration for Mintlify-based documentation website](https://docs.coderabbit.ai/configuration/example/other/mintlify-documentation.md)
- [Third-party tools overview](https://docs.coderabbit.ai/tools/index.md): Integrate 50+ third-party tools like ESLint, Ruff, and Betterleaks into CodeRabbit reviews for enhanced code quality and 1-click fixes.
- [Tool catalog](https://docs.coderabbit.ai/tools/list.md): Browse all linters, security analyzers, and CI/CD tools supported by CodeRabbit.
- [ast-grep](https://docs.coderabbit.ai/tools/ast-grep.md): How CodeRabbit runs ast-grep to find code patterns and report rule matches in pull requests.
- [Semgrep](https://docs.coderabbit.ai/tools/semgrep.md): CodeRabbit's guide to Semgrep.
- [OpenGrep](https://docs.coderabbit.ai/tools/opengrep.md): CodeRabbit runs OpenGrep to find security vulnerabilities and bugs across supported languages.
- [Betterleaks](https://docs.coderabbit.ai/tools/betterleaks.md): CodeRabbit runs Betterleaks to detect secrets in changed files.
- [SkillSpector](https://docs.coderabbit.ai/tools/skillspector.md): CodeRabbit uses SkillSpector to scan AI agent skill and MCP configuration files for security risks.
- [TruffleHog](https://docs.coderabbit.ai/tools/trufflehog.md): CodeRabbit's guide to TruffleHog.
- [Microsoft Presidio Analyzer](https://docs.coderabbit.ai/tools/presidio.md): CodeRabbit's guide to Microsoft Presidio Analyzer.
- [OSV-Scanner](https://docs.coderabbit.ai/tools/osv-scanner.md): Guide to using the OSV-Scanner tool with CodeRabbit's AI code reviews.
- [Brakeman](https://docs.coderabbit.ai/tools/brakeman.md): CodeRabbit runs Brakeman to identify security vulnerabilities in Ruby on Rails applications.
- [ESLint](https://docs.coderabbit.ai/tools/eslint.md): How CodeRabbit runs ESLint to lint JavaScript, TypeScript, and framework files on every pull request — including supported plugins, sandboxed execution, and skip conditions.
- [Biome](https://docs.coderabbit.ai/tools/biome.md): CodeRabbit runs Biome to find code quality issues in web projects.
- [Oxlint](https://docs.coderabbit.ai/tools/oxlint.md): CodeRabbit runs Oxlint to lint JavaScript, TypeScript, and framework files.
- [React Doctor](https://docs.coderabbit.ai/tools/react-doctor.md): CodeRabbit runs React Doctor to find React security, performance, correctness, and accessibility issues.
- [Ruff](https://docs.coderabbit.ai/tools/ruff.md): CodeRabbit runs Ruff to find issues in Python code and Jupyter Notebooks.
- [Pylint](https://docs.coderabbit.ai/tools/pylint.md): CodeRabbit's guide to Pylint.
- [Flake8](https://docs.coderabbit.ai/tools/flake8.md): CodeRabbit's guide to Flake8.
- [golangci-lint](https://docs.coderabbit.ai/tools/golangci-lint.md): CodeRabbit runs golangci-lint to find issues in changed Go code.
- [Clippy](https://docs.coderabbit.ai/tools/clippy.md): CodeRabbit's guide to Clippy.
- [RuboCop](https://docs.coderabbit.ai/tools/rubocop.md): CodeRabbit's guide to RuboCop.
- [SwiftLint](https://docs.coderabbit.ai/tools/swiftlint.md): CodeRabbit's guide to SwiftLint.
- [PHPStan](https://docs.coderabbit.ai/tools/phpstan.md): CodeRabbit's guide to PHPStan.
- [PHPMD](https://docs.coderabbit.ai/tools/phpmd.md): CodeRabbit's guide to PHPMD.
- [PHPCS](https://docs.coderabbit.ai/tools/phpcs.md): CodeRabbit's guide to PHPCS.
- [PMD](https://docs.coderabbit.ai/tools/pmd.md): CodeRabbit's guide to PMD.
- [detekt](https://docs.coderabbit.ai/tools/detekt.md): CodeRabbit's guide to detekt.
- [Clang-Tidy](https://docs.coderabbit.ai/tools/clang-tidy.md): CodeRabbit's guide to Clang-Tidy.
- [Cppcheck](https://docs.coderabbit.ai/tools/cppcheck.md): CodeRabbit's guide to Cppcheck.
- [Verilator](https://docs.coderabbit.ai/tools/verilator.md): CodeRabbit's guide to Verilator.
- [Infer](https://docs.coderabbit.ai/tools/fbinfer.md): CodeRabbit's guide to Infer.
- [Luacheck](https://docs.coderabbit.ai/tools/luacheck.md): CodeRabbit's guide to Luacheck.
- [ShellCheck](https://docs.coderabbit.ai/tools/shellcheck.md): CodeRabbit's guide to ShellCheck.
- [Blinter](https://docs.coderabbit.ai/tools/blinter.md): CodeRabbit runs Blinter to analyze Windows batch files for syntax, security, performance, and style issues.
- [Fortitude](https://docs.coderabbit.ai/tools/fortitude.md): CodeRabbit's guide to Fortitude.
- [Regal](https://docs.coderabbit.ai/tools/regal.md): CodeRabbit's guide to Regal.
- [PSScriptAnalyzer](https://docs.coderabbit.ai/tools/psscriptanalyzer.md): CodeRabbit's guide to PSScriptAnalyzer.
- [smarty-lint](https://docs.coderabbit.ai/tools/smarty-lint.md): CodeRabbit's guide to smarty-lint.
- [SQLFluff](https://docs.coderabbit.ai/tools/sqlfluff.md): How CodeRabbit runs SQLFluff to lint SQL files in pull requests.
- [Squawk](https://docs.coderabbit.ai/tools/squawk.md): How CodeRabbit runs Squawk to detect unsafe PostgreSQL schema changes in migration files.
- [Prisma Lint](https://docs.coderabbit.ai/tools/prisma-lint.md): CodeRabbit's guide to Prisma Lint.
- [Stylelint](https://docs.coderabbit.ai/tools/stylelint.md): CodeRabbit's guide to Stylelint.
- [HTMLHint](https://docs.coderabbit.ai/tools/htmlhint.md): CodeRabbit's guide to HTMLHint.
- [ember-template-lint](https://docs.coderabbit.ai/tools/ember-template-lint.md): How CodeRabbit runs ember-template-lint to lint Ember Handlebars template files on pull requests — including supported file types, project detection, configuration, and skip conditions.
- [YAMLlint](https://docs.coderabbit.ai/tools/yamllint.md): YAMLlint is a linter for YAML files.
- [Dotenv Linter](https://docs.coderabbit.ai/tools/dotenv.md): CodeRabbit's guide to Dotenv Linter.
- [Buf](https://docs.coderabbit.ai/tools/buf.md): CodeRabbit's guide to Buf.
- [oasdiff](https://docs.coderabbit.ai/tools/oasdiff.md): CodeRabbit runs oasdiff to detect breaking changes in OpenAPI and Swagger specifications.
- [Checkmake](https://docs.coderabbit.ai/tools/checkmake.md): CodeRabbit's guide to Checkmake.
- [Shopify Theme Check](https://docs.coderabbit.ai/tools/shopify-cli.md): How CodeRabbit handles Shopify Theme Check for Liquid theme files.
- [Checkov](https://docs.coderabbit.ai/tools/checkov.md): CodeRabbit runs Checkov to find misconfigurations in infrastructure-as-code files.
- [Trivy](https://docs.coderabbit.ai/tools/trivy.md): CodeRabbit runs Trivy to find misconfigurations and exposed secrets in infrastructure-as-code files.
- [TFLint](https://docs.coderabbit.ai/tools/tflint.md): CodeRabbit's guide to TFLint.
- [Hadolint](https://docs.coderabbit.ai/tools/hadolint.md): CodeRabbit's guide to Hadolint.
- [actionlint](https://docs.coderabbit.ai/tools/actionlint.md): CodeRabbit's guide to actionlint.
- [zizmor](https://docs.coderabbit.ai/tools/zizmor.md): CodeRabbit's guide to zizmor, a static security analyzer for GitHub Actions workflow files.
- [CircleCI](https://docs.coderabbit.ai/tools/circleci.md): CodeRabbit runs CircleCI validation to find errors in CircleCI configuration files.
- [GitHub Checks](https://docs.coderabbit.ai/tools/github-checks.md): How CodeRabbit integrates with GitHub Checks to surface CI/CD pipeline failures and provide automated remediation suggestions on every pull request.
- [markdownlint](https://docs.coderabbit.ai/tools/markdownlint.md): CodeRabbit's guide to markdownlint.
- [LanguageTool](https://docs.coderabbit.ai/tools/languagetool.md): CodeRabbit's guide to LanguageTool.
- [Vale](https://docs.coderabbit.ai/tools/vale.md): CodeRabbit runs Vale to check changed prose against the repository's editorial style rules.
- [Tools configuration reference](https://docs.coderabbit.ai/tools/reference.md): Complete reference for all CodeRabbit supported tools and their configuration options.
- [CodeRabbit Plan overview](https://docs.coderabbit.ai/plan/index.md): Create precise, context-aware coding plans from issues, PRDs, designs, or free-form descriptions, powered by CodeRabbit's deep codebase understanding.
- [Create a plan](https://docs.coderabbit.ai/plan/create-plan.md): Create a Coding Plan from free-form descriptions, PRDs, designs, editor context, or attached files in the CodeRabbit web app, Issue Tracker or VS Code extension.
- [Plan structure and refinement](https://docs.coderabbit.ai/plan/plan-refinement.md): Learn what a Coding Plan contains, how to review and iterate on it, and how version history works.
- [Agent Handoff](https://docs.coderabbit.ai/plan/agent-handoff.md): Copy agent-ready prompts from a Coding Plan and hand them off to your preferred coding agent or IDE.
- [Issue Planner](https://docs.coderabbit.ai/issues/planner/index.md): Turn issues into comprehensive Coding Plans ready for your favorite coding agent or IDE copilot. Works with GitHub, GitLab, Azure DevOps, Jira, and Linear!
- [Planning on GitHub](https://docs.coderabbit.ai/issues/planner/github.md): Generate comprehensive Coding Plans from your issues on the GitHub issue tracker.
- [Planning on GitLab](https://docs.coderabbit.ai/issues/planner/gitlab.md): Generate comprehensive Coding Plans from your issues on the GitLab issue tracker.
- [Planning on Azure DevOps](https://docs.coderabbit.ai/issues/planner/azure-devops.md): Generate comprehensive Coding Plans from Azure DevOps Boards work items.
- [Planning on Jira](https://docs.coderabbit.ai/issues/planner/jira.md): Generate comprehensive Coding Plans from your issues using Jira issue tracker.
- [Planning on Linear](https://docs.coderabbit.ai/issues/planner/linear.md): Generate comprehensive Coding Plans from your issues using Linear issue tracker.
- [Issue Enrichment](https://docs.coderabbit.ai/issues/enrichment.md): CodeRabbit automatically analyzes your issues to detect duplicates, find related issues and PRs, suggest assignees, and apply smart labels.
- [Configuration reference](https://docs.coderabbit.ai/reference/configuration.md): Complete reference for CodeRabbit configuration options with detailed explanations, types, and examples.
- [CodeRabbit glossary: review, Git, and code analysis terms](https://docs.coderabbit.ai/reference/glossary.md): Definitions of CodeRabbit product terms, Git platform terminology across GitHub, GitLab, Bitbucket, and Azure DevOps, and common code review concepts.
- [CodeRabbit FAQs: reviews, pricing, security, and setup](https://docs.coderabbit.ai/faq.md): Answers to common CodeRabbit questions about triggering reviews, supported platforms, pricing, data privacy, self-hosting, and pull request automation.
- [Command-Line Review Tool](https://docs.coderabbit.ai/cli/index.md): Get AI code reviews directly in your CLI before you commit. Catch race conditions, memory leaks, and security vulnerabilities without leaving your development environment.
- [CodeRabbit Skills](https://docs.coderabbit.ai/cli/skills.md): Install agent-native skills to trigger AI-powered code reviews using natural language.
- [Claude Code integration](https://docs.coderabbit.ai/cli/claude-code-integration.md): AI-powered code review in Claude Code through the CodeRabbit plugin. Let AI code, review, and fix issues autonomously without human intervention.
- [Cursor integration: run CodeRabbit CLI reviews in your IDE](https://docs.coderabbit.ai/cli/cursor-integration.md): Configure Cursor to run the CodeRabbit CLI on generated code, then automatically review, fix, and iterate on issues as part of an autonomous AI workflow.
- [Codex integration](https://docs.coderabbit.ai/cli/codex-integration.md): AI-powered code review in Codex through the CodeRabbit plugin. Let AI code, review, and fix issues autonomously without human intervention.
- [Gemini integration](https://docs.coderabbit.ai/cli/gemini-integration.md): Enable Gemini to execute CodeRabbit directly in your development workflow. Let AI code, review, and fix issues autonomously without human intervention.
- [Headless CLI integration](https://docs.coderabbit.ai/cli/headless-cli-integration.md): Authenticate CodeRabbit CLI non-interactively in headless and bot-driven environments using an Agentic API key. Use this flow in CI runners, remote bots, or any automation pipeline where browser-based sign-in is not available.
- [Install CLI on Windows](https://docs.coderabbit.ai/cli/windows.md): Install the signed native CodeRabbit CLI on Windows with PowerShell, without administrator rights.
- [Deploy CodeRabbit CLI with Jamf Pro](https://docs.coderabbit.ai/cli/jamf-managed-macos.md): Deploy and update a shared CodeRabbit CLI installation on managed Macs while keeping authentication per user.
- [CLI network requirements](https://docs.coderabbit.ai/cli/network-requirements.md): Allow the outbound domains and ports required to run CodeRabbit CLI from restricted networks, proxies, and cloud sandboxes.
- [Use with self-hosted CodeRabbit](https://docs.coderabbit.ai/cli/cli-with-self-hosted-CodeRabbit.md): Connect the CLI to your self-hosted CodeRabbit instance
- [CLI Command Reference](https://docs.coderabbit.ai/cli/reference.md): Reference for supported CodeRabbit CLI commands and commonly used options.
- [CodeRabbit IDE Extension](https://docs.coderabbit.ai/ide/index.md): Review code changes before you commit and create agent-ready Coding Plans, directly in your IDE with the CodeRabbit extension.
- [Install the VS Code extension](https://docs.coderabbit.ai/ide/vscode-install.md): Install the CodeRabbit VS Code extension to review code changes locally in your editor.
- [Plan implementation in VS Code](https://docs.coderabbit.ai/ide/vscode-plan.md): Create, browse, and implement CodeRabbit Coding Plans directly from the VS Code extension, then hand off selected phases to your AI coding agent.
- [Review code changes in VS Code](https://docs.coderabbit.ai/ide/vscode-use.md): Review code changes in your local Git repository using the CodeRabbit VS Code extension with automatic or manual review options.
- [Configure the VS Code extension](https://docs.coderabbit.ai/ide/vscode-config.md): Customize the CodeRabbit VS Code extension settings, including AI agent integration, automatic review behavior, regional infrastructure, task startup, and self-hosted configurations.
- [Uninstall the VS Code extension](https://docs.coderabbit.ai/ide/vscode-uninstall.md): Step-by-step guide to properly uninstall the CodeRabbit VS Code extension, including logout and removal from your editor.
- [Use with self-hosted CodeRabbit](https://docs.coderabbit.ai/ide/vscode-selfhosted.md): Connect the VS Code extension to your self-hosted CodeRabbit instance for on-premises code reviews with full data control.
- [CodeRabbit Agent overview](https://docs.coderabbit.ai/agent/index.md): CodeRabbit Agent brings AI-powered code investigation, planning, and action into the tools where your team already works.
- [CodeRabbit Agent for Slack](https://docs.coderabbit.ai/slack-agent/index.md): Bring AI-powered investigation, planning, and action into your Slack workspace with shared controls, persistent knowledge, and governed access.
- [Quickstart](https://docs.coderabbit.ai/slack-agent/onboarding.md): Set up CodeRabbit Agent for Slack with your Git platform, create the Base Scope, and start working.
- [Working in Slack](https://docs.coderabbit.ai/slack-agent/use-in-slack.md): Start work with CodeRabbit Agent from mentions, direct conversations, and slash commands.
- [Connections](https://docs.coderabbit.ai/slack-agent/connections.md): Connect external tools and APIs to your workspace so CodeRabbit Agent for Slack can access issue trackers, documentation, observability, and custom integrations.
- [Scopes](https://docs.coderabbit.ai/slack-agent/scopes.md): Use scopes to control which Slack conversations can access which repositories, connections, and spend limits in CodeRabbit Agent for Slack.
- [Automations](https://docs.coderabbit.ai/slack-agent/automations.md): Create scheduled, webhook and message-triggered tasks that CodeRabbit Agent runs automatically.
- [Coding Plans](https://docs.coderabbit.ai/slack-agent/plans.md): Turn Slack discussions into structured implementation plans — with file references, design rationale, and one-click handoff to an agent for implementation.
- [Knowledge Base](https://docs.coderabbit.ai/slack-agent/knowledge-base.md): Understand how CodeRabbit Agent for Slack stores facts, separates public and private knowledge, and lets teams review fact history.
- [Agent skills](https://docs.coderabbit.ai/agent/skills.md): Learn how CodeRabbit Agent writes reusable procedures, stores them across sessions, and applies them to future work.
- [Thread reviews](https://docs.coderabbit.ai/slack-agent/thread-reviews.md): Inspect what CodeRabbit Agent for Slack did in a Slack thread with run history, context, diffs, and execution details.
- [Usage](https://docs.coderabbit.ai/slack-agent/usage.md): Review CodeRabbit Agent for Slack activity across your workspace, including when runs happened, which scope handled them, how many agent minutes they used, and where to inspect each thread.
- [Sandboxes](https://docs.coderabbit.ai/slack-agent/sandboxes.md): Configure the shared workspace sandbox CodeRabbit Agent for Slack uses for reproducible execution, package setup, and saved snapshots.
- [Admin roles and security](https://docs.coderabbit.ai/slack-agent/admin-and-security.md): Understand global admin, automation admin, and scope admin permissions, usage visibility, and how CodeRabbit Agent for Slack keeps private conversation knowledge isolated.
- [Slack permissions](https://docs.coderabbit.ai/slack-agent/slack-permissions.md): Review the Slack app install, user OAuth, and sign-in permissions CodeRabbit Agent requests.
- [CodeRabbit Agent for Discord](https://docs.coderabbit.ai/discord-agent/index.md): Use CodeRabbit from public Discord channels in eligible communities and organizations.
- [Set up CodeRabbit Agent for Discord](https://docs.coderabbit.ai/discord-agent/setup.md): Connect CodeRabbit to Discord for an eligible community or organization and manage the integration from the dashboard.
- [Usage and limits](https://docs.coderabbit.ai/discord-agent/usage-and-limits.md): Understand where CodeRabbit for Discord can run, how pull request authorship works, and what limits apply during launch.
- [Management overview](https://docs.coderabbit.ai/management/index.md): Manage your CodeRabbit platform: repositories, subscriptions, billing, integrations, and analytics
- [Overview](https://docs.coderabbit.ai/platforms/overview.md): Connect CodeRabbit with your preferred Git platform including GitHub, GitLab, Azure DevOps, Bitbucket Cloud, and Bitbucket Data Center for AI-powered code reviews right in your PR.
- [GitHub](https://docs.coderabbit.ai/platforms/github-com.md): Learn how to integrate CodeRabbit with GitHub.com repositories for automated AI-powered code reviews, including setup, permissions, and repository configuration.
- [GitHub Enterprise Server](https://docs.coderabbit.ai/platforms/github-enterprise-server.md): Complete guide to integrate CodeRabbit with your self-hosted GitHub Enterprise Server. Set up OAuth apps, GitHub apps, webhooks, and configure AI-powered code reviews for your enterprise development workflow.
- [GitLab](https://docs.coderabbit.ai/platforms/gitlab-com.md): Learn how to integrate CodeRabbit with GitLab.com repositories using personal or group access tokens for automated AI-powered code reviews and collaboration.
- [Self-managed GitLab](https://docs.coderabbit.ai/platforms/self-hosted-gitlab.md): Learn how to integrate CodeRabbit with your self-managed GitLab instance through automated or manual onboarding, including OAuth setup, user configuration, and webhook installation.
- [Azure DevOps](https://docs.coderabbit.ai/platforms/azure-devops.md): Learn how to integrate CodeRabbit with Azure DevOps repositories using a personal access token or a Microsoft Entra service principal for automated AI-powered code reviews and pull request analysis.
- [Bitbucket Cloud](https://docs.coderabbit.ai/platforms/bitbucket-cloud.md): Learn how to integrate CodeRabbit with Bitbucket Cloud repositories for automated AI-powered code reviews.
- [Bitbucket Data Center](https://docs.coderabbit.ai/platforms/bitbucket-data-center.md): Learn how to integrate CodeRabbit with your self-hosted Bitbucket Data Center instance for AI-powered code reviews on pull requests.
- [Plans and pricing](https://docs.coderabbit.ai/management/plans.md): Compare CodeRabbit plans and understand per-developer review rate limits and feature limits.
- [Review rate limits](https://docs.coderabbit.ai/management/rate-limits.md): How CodeRabbit counts review events, how per-developer allowances refill, what happens when a review is rate-limited, and how to spend fewer reviews.
- [Billing and changing plans](https://docs.coderabbit.ai/management/billing.md): View invoices, change your subscription plan, update payment methods, and adjust seat counts from CodeRabbit's Subscription and Billing page.
- [Usage-based Add-on](https://docs.coderabbit.ai/management/usage-based-addon.md): Enable pay-as-you-go billing to continue eligible PR reviews and CLI-triggered reviews after the applicable review limit is reached.
- [Subscription management](https://docs.coderabbit.ai/management/subscription-management.md): Start a free trial, switch trial plans, convert to a paid subscription, reactivate after cancellation, or cancel a paid subscription.
- [Overview](https://docs.coderabbit.ai/guides/dashboard.md)
- [Git platform review metrics](https://docs.coderabbit.ai/guides/dashboard-metrics.md): Detailed definitions and calculations for all CodeRabbit Git platform review dashboard metrics.
- [IDE/CLI review metrics](https://docs.coderabbit.ai/guides/ide-cli-dashboard-metrics.md): Detailed definitions for all CodeRabbit IDE and CLI review dashboard metrics.
- [Review Usage dashboard](https://docs.coderabbit.ai/management/review-usage-dashboard.md): Read the Review Usage dashboard: review events, rate-limit impact, per-developer adaptive limits, and the Review Log behind them.
- [Data Export](https://docs.coderabbit.ai/guides/data-export.md): Export data from your CodeRabbit Dashboard for offline analysis and reporting.
- [Reports Overview](https://docs.coderabbit.ai/management/reports/index.md): Track and analyze pull request activity across your organization's repositories with CodeRabbit's reporting feature. Set up scheduled reports with customizable prompts.
- [Schedule reports](https://docs.coderabbit.ai/guides/scheduled-reports.md): Set up automated recurring reports for GitHub, GitLab, Bitbucket, and Azure DevOps with customizable schedules, filters, and delivery channels including email, Slack, Discord, and Teams.
- [Legacy Report Testing](https://docs.coderabbit.ai/guides/ondemand-reports.md): Generate single-use test reports using the legacy CodeRabbit API. Learn how to create API keys and make test sample report requests programmatically.
- [Customize CodeRabbit pull request reports with prompts](https://docs.coderabbit.ai/guides/custom-reports.md): Build tailored CodeRabbit pull request reports using natural language prompts, custom formatting, scheduling, and flexible data filtering for your team.
- [Integrate MCP servers](https://docs.coderabbit.ai/integrations/mcp-servers.md): Connect CodeRabbit to external tools and data sources through the Model Context Protocol (MCP) for enhanced code reviews with richer contextual understanding.
- [Issue trackers](https://docs.coderabbit.ai/integrations/issue-trackers.md): CodeRabbit integrates with popular issue tracking systems to enrich reviews with issue context, validate requirements, create issues from review comments, and design Coding Plans.
- [Jira Integration](https://docs.coderabbit.ai/integrations/jira.md): Connect CodeRabbit to Jira to enrich pull request reviews with issue context, validate changes against acceptance criteria, create issues from review comments, and design Coding Plans.
- [Linear Integration](https://docs.coderabbit.ai/integrations/linear.md): Connect CodeRabbit to Linear to enrich pull request reviews with issue context, validate changes against acceptance criteria, create issues from review comments, and design Coding Plans.
- [CircleCI integration](https://docs.coderabbit.ai/integrations/circleci.md): Connect CodeRabbit to CircleCI to surface pipeline failure context directly in pull request reviews.
- [Jenkins integration](https://docs.coderabbit.ai/integrations/jenkins.md): Connect CodeRabbit to Jenkins to include matching build failures and test results in pull request reviews.
- [Seat assignment](https://docs.coderabbit.ai/management/seat-assignment.md): Understand how CodeRabbit assigns seats to users, including trial mode, manual approval, and auto-approval methods.
- [Role-based access](https://docs.coderabbit.ai/management/roles.md): Control access to CodeRabbit administrative features by assigning Admin, Member, or Billing Admin roles to organization users.
- [Custom roles and permissions](https://docs.coderabbit.ai/management/custom-roles.md): Create and manage custom roles with granular permissions for your Enterprise organization in CodeRabbit.
- [Set up Multi-Org](https://docs.coderabbit.ai/management/multi-org.md): Add and configure multiple organizations in CodeRabbit for Enterprise deployments.
- [Add organizations](https://docs.coderabbit.ai/management/adding-organizations.md): Learn how to add new organizations to CodeRabbit and grant the necessary permissions to enable code review across your organization's repositories.
- [Set permissions](https://docs.coderabbit.ai/management/upgrading-permissions.md): Learn how to grant updated permissions to CodeRabbit when new features require additional GitHub access.
- [Audit Logs](https://docs.coderabbit.ai/management/audit-logs.md): Track and review administrative actions across your organization with a tamper-resistant audit log.
- [Self-hosted CodeRabbit](https://docs.coderabbit.ai/self-hosted/overview.md): Run CodeRabbit inside your own infrastructure for full control over code, data, and network access. Available for Enterprise customers on GitHub, GitLab, Azure DevOps, and Bitbucket Data Center.
- [CodeRabbit Reverse Tunnel](https://docs.coderabbit.ai/self-hosted/coderabbit-reverse-tunnel.md): Connect CodeRabbit to private-network services without opening inbound network access. Carries Git platform traffic and internal MCP servers over a single outbound connection.
- [Reverse Tunnel connector configuration](https://docs.coderabbit.ai/self-hosted/reverse-tunnel-connector-configuration.md): Configure CodeRabbit Reverse Tunnel Connector with a multi-route configuration file so one connector serves several private destinations, including internal MCP servers.
- [CodeRabbit API](https://docs.coderabbit.ai/api/index.md): Authenticate with the CodeRabbit API and find endpoints for organizations, repositories, metrics, learnings, users, roles, audit logs, and AI Deep Scan findings.
- [Workspace API tokens](https://docs.coderabbit.ai/api/workspace-api-tokens.md): Create and use workspace-scoped API tokens for Enterprise SSO workspaces.
- [Metrics Data](https://docs.coderabbit.ai/api-reference/metrics-data-api.md): Access CodeRabbit metrics data programmatically via REST API.
- [MCP server usage](https://docs.coderabbit.ai/api-reference/mcp-metrics.md): Returns one JSON row per merged, reviewed pull request that used MCP, with MCP servers and tools nested under servers. Join to GET /v1/metrics/reviews on pr_url. Counts are best-effort usage telemetry. Access is controlled by an organization-scoped feature flag.
- [Learnings](https://docs.coderabbit.ai/api-reference/learnings-list.md): Programmatic access to an organization's CodeRabbit learnings. Returns paginated JSON or a CSV download. Enterprise plan only. Mirrors the auth, rate-limit and response-size contract of the Metrics public API.
- [Update Learning](https://docs.coderabbit.ai/api-reference/learnings-update.md): Replaces canonical learning text and refreshes its LanceDB embedding. The text is trimmed and recognized credentials are redacted before persistence and indexing. Enterprise plan and learning:write permission required.
- [Delete Learning](https://docs.coderabbit.ai/api-reference/learnings-delete.md): Idempotently deletes a canonical learning from PostgreSQL, the LanceDB knowledge index, and patterned-learning caches. Enterprise plan and learning:write permission required.
- [AI Deep Scan code findings](https://docs.coderabbit.ai/api-reference/security-scans-code-list.md): Returns cursor-paginated JSON by default. CSV and SARIF formats download the complete repository/scan inventory (up to 50,000 records and 16 MB). Requires Enterprise, the Security add-on, and security:read.
- [List organizations](https://docs.coderabbit.ai/api-reference/organizations-list.md): Lists active organizations in CodeRabbit. Organization API keys return their bound organization; workspace API keys return all active organizations in the workspace. Enterprise plan only.
- [List organization repositories](https://docs.coderabbit.ai/api-reference/organization-repositories-list.md): Lists repositories that CodeRabbit currently records as active for an organization. The organization_id is the CodeRabbit organization UUID returned by GET /organizations. Enterprise plan only.
- [Users](https://docs.coderabbit.ai/api-reference/users-list.md): List all users in your organization with optional filtering by seat assignment and role status. Supports cursor-based pagination.
- [Seats](https://docs.coderabbit.ai/api-reference/users-manage-seats.md): Bulk assign or unassign seats for up to 500 users. The request format depends on the type of API key used. **Organization and self-hosted instance API keys** address users by provider user ID with the `action` + `user_ids` format, where the `action` field determines the operation type. **Workspace A…
- [Seat Assignment Mode](https://docs.coderabbit.ai/api-reference/users-seat-assignment-mode.md): Update the seat assignment mode for the organization. Only accessible by fully self-hosted organizations with enterprise plans.
- [List Roles](https://docs.coderabbit.ai/api-reference/roles-list.md): Lists built-in roles and Enterprise custom roles for the authenticated organization.
- [Create Role](https://docs.coderabbit.ai/api-reference/roles-create.md): Creates an Enterprise custom role. If is_default is true, the new role becomes the subscription default and the previous default is cleared.
- [Role permissions](https://docs.coderabbit.ai/api-reference/roles-permissions.md): Lists the valid resource_id and access_type values that can be used when creating or updating Enterprise custom roles.
- [Get Role](https://docs.coderabbit.ai/api-reference/roles-get.md): Retrieves one built-in or Enterprise custom role.
- [Update Role](https://docs.coderabbit.ai/api-reference/roles-update.md): Updates custom role metadata, permissions, or default status. System roles are immutable. Omitting is_default preserves the current default status; true clears any previous default; false unsets this role as default.
- [Delete Role](https://docs.coderabbit.ai/api-reference/roles-delete.md): Deletes an Enterprise custom role when it is not assigned to any organization members. System roles cannot be deleted.
- [Assign roles](https://docs.coderabbit.ai/api-reference/users-change-roles.md): Bulk change roles for up to 500 users. Returns partial success with details of which users succeeded or failed.
- [Audit Logs](https://docs.coderabbit.ai/api-reference/audit-logs.md): Returns a paginated list of organization-level audit log entries. Requires the Enterprise plan, Admin role, and a non-agentic API key.
- [Report generate](https://docs.coderabbit.ai/api-reference/report-generate.md): DEPRECATED: Generate a developer activity report based on the provided parameters and date range. This endpoint may take up to 10 minutes to respond depending on the data volume.  Prompts cannot be used and this is only for testing purposes. We recommend creating a recurring report and triggering a…
- [Caching](https://docs.coderabbit.ai/reference/caching.md): CodeRabbit provides caching capabilities for code and dependencies to accelerate the review process. This feature enhances your development workflow by delivering faster feedback.
- [Early Access Program](https://docs.coderabbit.ai/early-access.md): In CodeRabbit's dashboard, in the settings of a repository, there is the "Early access" toggle, which enables early access features. Early access is divided into two categories: "beta" and "experimental". Both are enabled by the same toggle, but should be differentiated by a warning whenever they ar…

## OpenAPI Specs

- [openapi](/openapi.json)

## Optional

- [Blog](https://coderabbit.ai/blog)
- [Discord](https://discord.gg/coderabbit)