Layers and sources
| Term we use | What it means | Product UI today | Also seen in docs |
|---|---|---|---|
| settings | Values you change in the web interface | Review settings | configuration, config |
| configuration | The resolved whole: files, schema and layers | Configuration used (in the @coderabbitai configuration reply) | config, settings file |
| configuration schema V2 or V3 | The shape of the configuration. V2 is the default, V3 is a limited preview | Configuration schema: V3 | V3 schema, config V3, Configuration V3 |
| layer | One entry in the priority order | Layers (PR comment), Configuration sources (popover) | source, level, hierarchy |
| Repository YAML | The repository’s own .coderabbit.yaml | Repository YAML | repository file, repository configuration file |
| Central YAML | The file in the coderabbit repository | Central YAML | Central repository (in one table) |
| Repository settings | Settings saved for one repository in the web interface | Repository settings (Review changes dialog), Repository UI (command output) | Repository UI |
| Organization defaults | Settings saved for the whole organization in the web interface | Organization defaults (editor), Organization UI (command output) | Organization settings |
| workspace | A CodeRabbit grouping of organizations | Workspace management | SSO workspace, Enterprise workspace |
| Workspace settings | Settings saved for the workspace | Workspace settings or CodeRabbit configuration (same page, two labels) | Workspace UI, workspace configuration |
| Use workspace settings as defaults | Workspace policy that fills values nothing else sets | Use workspace settings as defaults | workspace defaults |
| Use workspace settings | Organization toggle that replaces organization settings | Use workspace settings | not named |
| Environment YAML | The YAML_CONFIG variable layer on self-hosted CodeRabbit | Environment YAML | YAML_CONFIG |
| Defaults | Built-in values when nothing sets a key | defaults | schema defaults |
| Global overrides | Admin-enforced YAML that wins over every other layer | Global overrides, Organization global overrides, Workspace global overrides | Global Overrides (title case) |
| Inheritance | The inheritance setting that merges parent layers | Inheritance | parent level, merge chain |
| Use organization settings | Repository toggle on General that applies Organization defaults instead of the repository’s saved settings | Use organization settings | UI settings, UI settings source, saved settings |
| Configuration source | The page and control that picks the branch supplying the repository YAML | Configuration source | Repository YAML source |
| Source mode | The branch choice recorded in a review: Auto, Default branch, Trusted PR override, Custom | Source mode | not named |
Web app controls
| Term we use | What it means | Product UI today | Also seen in docs |
|---|---|---|---|
| web interface | The CodeRabbit app in the browser | CodeRabbit UI (fallback layer label) | web UI, web app, CodeRabbit UI |
| Review > Review settings | Where review settings live in the app | Review group, Review settings item | Reviews > Review settings |
| Select repositories | The picker that opens a repository or Organization defaults | Select repositories | not named |
| settings index | The left navigation of setting sections | Settings navigation (mobile button) | settings index |
| View mode | The picker that switches between Concise, All Settings, YAML editor and, for organizations and workspaces, Global overrides | View mode | Edit YAML |
| Apply changes | Saves your edits after a confirmation. For a repository, the Review changes dialog opens and Submit changes saves | Apply changes, Review changes, Submit changes | not named |
| Preview | The preview button next to Apply changes | Preview | not named |
| section names | Names of the sections in the settings index | General, Reviews, Chat, Knowledge base | Knowledge Base (feature name) |
Files and directories
| Term we use | What it means | Product UI today | Also seen in docs |
|---|---|---|---|
.coderabbit.yaml | The YAML configuration file; .coderabbit.yml also works | .coderabbit.yaml | YAML file, config file |
| TypeScript configuration | The .coderabbit.config.ts file | Repository TS config, Central TS config (command output) | TypeScript file, TS config |
| configuration directory | The .coderabbit/ directory of Markdown documents | configuration directory, Directory configuration, .coderabbit directory guide | .coderabbit/ documents, Directory configuration |
| directory document | One file in the configuration directory: instructions or pre-merge checks | directory documents | instruction files, check documents |
| nested directories | A .coderabbit/ directory inside a subdirectory | Directory containing .coderabbit | nested directories |
| path instructions | Path-scoped guidance in reviews.path_instructions | Path instructions | path-based instructions, path-specific instructions |
| instructions | Guidance in natural language, named by what it steers | Path Instructions, Labeling Instructions | review instructions, custom instructions |
Review behavior
| Term we use | What it means | Product UI today | Also seen in docs |
|---|---|---|---|
| review profile | How much feedback a review gives: chill, assertive or quiet | Profile, Review profile | not named |
| automatic review | The behavior that reviews pull requests without a command | Automatic review (field), Auto review (page) | auto review, auto-review |
| trusted PR | A collaborator pull request in the same repository | Allow configuration changes from trusted PRs | trusted PR |
Deployment and platforms
| Term we use | What it means | Product UI today | Also seen in docs |
|---|---|---|---|
| CodeRabbit Cloud | The deployment that CodeRabbit hosts | no label | SaaS, Cloud/SaaS deployment |
| self-hosted CodeRabbit | A CodeRabbit deployment you operate | Self-Hosted Only (docs badge) | self-hosted, Self-hosted deployment |
| GitHub Enterprise Server | GitHub you operate | Self-Hosted GitHub, Self-Managed GitHub | Self-hosted GitHub |
| Self-managed GitLab | GitLab you operate | Self-Managed GitLab | self-hosted GitLab |
| Bitbucket Data Center, Azure DevOps Server | Bitbucket and Azure DevOps you operate | Bitbucket Data Center, Azure DevOps Server | page titles match |
| GitHub Cloud | GitHub on github.com | GitHub | not named |
Output and inspection
| Term we use | What it means | Product UI today | Also seen in docs |
|---|---|---|---|
@coderabbitai configuration | The command that prints the resolved configuration | Configuration used, then a CodeRabbit configuration block | effective configuration, resolved YAML |
| resolved configuration | The result of merging all layers for a review | CodeRabbit configuration (block title) | effective configuration (API term) |
# Source: comment | Per-value comment that names the layer | # Source: Repository YAML (base) | possible sources |
| Review info | The summary comment section with run metadata, including Run configuration | Review info, Run configuration | Review details |
| Review details | An opt-in section: ignored files, extra context, suppressed comments | Review details | not named |
| configuration (API) | The API resource name; the API says configuration, not settings | /v1/configuration/... | settings |
What’s next
How CodeRabbit resolves configuration
See how the layers above combine into one configuration.
Settings map
Jump from a key or a web interface label to the page that explains it.