Skip to main content
CodeRabbit can show the configuration it resolved for a repository and the file a review used. Use this guide after every configuration change, and as the first step when a setting doesn’t behave as expected.

Before you start

  • You need a pull request in the repository. Anyone who can comment on it can run the command.
  • Know the configuration priority, so the source labels below make sense.

Show the resolved configuration

  1. Open a pull request in the repository.
  2. Post @coderabbitai configuration as the entire text of a comment. The command works on every Git platform.
  3. Read the reply. Its Configuration used line names the source mode, the repository, branch, entry file and commit CodeRabbit read, and the layers that contributed. The full resolved YAML follows in a collapsed CodeRabbit configuration section. A # Source: comment above each value names the layer that supplied it, including defaults. A list carries one comment for all of its entries, and an object with keys carries no comment of its own.
When no configuration file from the repository applied, the Configuration used line says so instead of naming a file. On GitHub Cloud, a note before the YAML says that the command doesn’t load directory documents.

Read the source labels

Each # Source: comment uses one of these labels. With inheritance on, a layer label ends in (base) for the layer that started the walk or (inherited) for a parent merged into it. For example, Repository YAML (base) followed by Organization UI (inherited) means the repository file inherits from the organization’s saved settings.
The output doesn’t label TypeScript files separately. A value that comes from a specific file in a TypeScript configuration carries that file’s name as its label. Everything else shows Repository YAML (base) or Central YAML (base). Only the Layers line says Repository TS config or Central TS config.

Find the file a review used

Each review records the file it read. Open the review’s Review info section on the pull request and expand Run configuration. The selected file alone doesn’t show values that inheritance or global overrides supplied. Run @coderabbitai configuration to see what those layers supply now. Values can differ from what a past review used. To change which branch a repository reads, see Choose the configuration branch.

Read the output with its limits in mind

  • The command shows the configuration resolved at the moment you post it. A past review used the configuration recorded in its own Run configuration.
  • The resolved YAML uses the setting names used at run time. With schema V3, the reply says the YAML is an internal V2 runtime format and not a file to copy.
  • The output doesn’t prove that directory documents loaded during a review.

Read the configuration through the API

Call the effective-configuration operation to read the repository’s current configuration without a pull request. It takes only a repository ID, so it doesn’t show a configuration that a pull request’s own branch changes. It returns the resolved YAML and a layers array with each layer’s source and YAML. When CodeRabbit can’t resolve the configuration, it returns complete: false with a reason. The key needs the configuration:read scope.
See Read effective repository configuration for the response, and Automate configuration for the related operations.

Check the result

Confirm that the value you changed shows the label you expect. A value from the layer you edited means the change applies. A different label means another layer outranks it. If so, continue with Fix settings that aren’t applied.

What’s next

Fix settings that aren't applied

Match a symptom to its cause and fix it.

How CodeRabbit resolves configuration

See the order in which CodeRabbit combines layers.

Automate configuration

Read, preview, and change configuration with the API, MCP, and CLI.