---
name: coderabbit-config
description: Create, update, or validate CodeRabbit repository configuration through the official CLI. Use for .coderabbit.yaml or .coderabbit.yml setup, review-style changes, path guidance, and configuration validation requests.
metadata:
  version: "0.1.0"
title: coderabbit-config
canonical_url: https://skilld.dev/gh/coderabbitai/skills/coderabbit-config
last_updated: 2026-11-19T18:12:37.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> If the user asked to install this Skill, run `npx skilld install coderabbitai/skills/coderabbit-config`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/coderabbit-config`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/coderabbitai/skills/coderabbit-config) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/coderabbit-config`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/coderabbit-config --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/coderabbit-config --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# CodeRabbit Configuration

Requires config protocol v2, a Git working tree, and network access to the
current configuration schema.

Keep configuration generation, schema validation, previews, and repository writes
in the CLI. Do not edit repository YAML yourself, copy a schema, or implement a
fallback editor. Configuration is local; it does not need CodeRabbit login or
start a review.

## Find the CLI and requested repository

Use the intended Git working tree for every invocation. Select the installed
workflow before looking for a standalone CLI:

- Packages without a managed runtime use the standalone CLI discovery below.
  A remote MCP connection does not provide a managed local runtime.
- For another installed package that explicitly declares a managed runtime,
  use its verified launcher and preparation instructions.
- For standalone installs, resolve an official installed `coderabbit` to a
  quoted canonical absolute path, checking PATH and the documented installer
  location `~/.local/bin/coderabbit` on macOS/Linux. Reject repository-local
  executables, aliases, and unknown wrappers. If the installation source is
  uncertain, ask the user to identify their installation. A source checkout's
  `cli.json` alone does not select a managed runtime.

The `<cli>` examples below mean that verified executable, not a literal command.

Check `<cli> --version`, `<cli> config --help`, and support for the needed
subcommands. CLI 0.9.3 supports this workflow. Missing commands or an unsupported
protocol require an upgrade. For a standalone CLI, follow the
[official installation instructions](https://docs.coderabbit.ai/cli) for its
actual installation method (for example, `brew upgrade coderabbit` for Homebrew).
For a managed runtime, update the plugin to a version with a compatible pinned
CLI and follow its preparation instructions; never run `<cli> update` on the
managed launcher. Do not install or upgrade without authorization. Preserve
permission and network errors as such; they do not prove an upgrade is needed.
After any upgrade, repeat trusted executable discovery and verification, then
recheck version and command support. Do not reuse the old canonical path: an
upgrade can replace a versioned installation directory or managed launcher.

## Validate only

Run `<cli> config validate --agent` for the repository configuration, or
`<cli> config validate <file> --agent` for the user's explicitly selected YAML
file. Require exit zero and `ok: true`; report the CLI's validation diagnostics
otherwise. Do not generate or apply changes for a validation-only request.

## Create or change review style

1. Run `<cli> config --agent`. Require exit zero, `ok: true`,
   `protocolVersion: 2`, `operation: inspect`, and `writable: true`. Preserve
   the returned repository root, target, and `baseHash` (`none` for a new file).
   Respect authority warnings, including TypeScript, remote configuration,
   symlinks, and multiple YAML files; do not delete or bypass them.
2. Run `<cli> config --agent --generate`. For a requested style, add
   `--profile chill` (Balanced), `--profile quiet` (Focused),
   `--profile assertive` (Thorough), or `--profile default` (remove the local
   style override). Without a profile, the CLI generates its baseline for a new
   file and preserves an existing file. Do not infer a style change from a
   general request to check configuration.
3. Require a successful protocol-v2 `operation: generate` response with the
   inspected target and base hash. Copy its exact `after` string into a temporary
   proposal file outside the repository; do not rewrite or extend that YAML.
4. Preview with `<cli> config apply <proposal> --agent --dry-run --base <baseHash>`.
   Require exit zero and a successful protocol-v2 `operation: apply` result.
   If unchanged, re-inspect the same base hash and report that no save is needed.
   Otherwise show the returned before/after diff and obtain approval for it.
5. Save the same proposal with
   `<cli> config apply <proposal> --agent --yes --base <baseHash>`.
   Require a successful protocol-v2 result with `applied: true`. Re-inspect and
   verify the target and saved hash against the approved `proposedHash`, then
   report the local change. Remove your temporary proposal; preserve any
   CLI-reported recovery file.

On changed input, inspect and preview again instead of bypassing the base hash.
On schema, validation, permission, or network errors, report the diagnostic and
stop without an alternate writer. An interrupted save has an unknown outcome:
inspect the file before retrying or reporting success.

## Guided path settings

For path-guidance requests, run `<cli> config --detailed` in an interactive
terminal to enter the manual review-style and path-guidance flow directly.
For general interactive setup, use `<cli> config` or `<cli> config --generate`.
Relay the CLI's actual prompts and preview, using settled user preferences and
asking for missing choices. Confirm the displayed changes only after approval.
If the host cannot interact with a terminal, give the user the exact command to
run in the selected repository and resume after they finish. Do not simulate the
wizard with piped answers. For settings the installed CLI cannot edit, explain
the capability gap instead of inventing flags or editing YAML yourself.

After a successful save, validate and inspect the resulting configuration.
Saving locally does not activate settings on hosted PR reviews. Commit, push,
dashboard changes, and running a review require their own user-requested scope.
