CONFIGURATION

Tune GitRabbit parameters using the .gitrabbit.yml file.

GitRabbit reads a config file named `.gitrabbit.yml` at the root of your repository on every pull request event. This file lets you define review guidelines, exclude folders (like node_modules, dist, or vendor), override model settings, and control chat settings.

Key_Capabilities

Fine-grained Exclusions

Ignore generated files, test fixtures, or vendor assets using glob patterns.

Toggle Features

Turn off specific modules like automated docstrings, unit tests, or SAST scanners.

Security Thresholds

Define fail-safe criteria to block merge requests if security violations are detected.

Setup_Sequence

Step 01

Create Config File

Create a new file named '.gitrabbit.yml' in the root directory of your project.

$touch .gitrabbit.yml

Step 02

Add Exclusions

Specify files or folders that GitRabbit should never analyze (e.g., third-party code).

Step 03

Commit and Push

Commit the configuration file to your main branch or directly in a new PR to apply settings immediately.

Code_Example

.gitrabbit.yml complete configuration template

# GitRabbit config schema v2
version: 2
reviews:
  auto_review: true
  exclude_paths:
    - "**/node_modules/**"
    - "**/dist/**"
    - "db/schema.rb"
  focus_areas:
    - security
    - performance
    - code_smells
  temperature: 0.2

chat:
  enabled: true
  allow_collaborators: true

sast:
  enable_linters: true
  severity_threshold: high

Pro_Tips

✦Excluding massive auto-generated files (like db/schema.rb or package-lock.json) keeps reviews blazing fast.
✦Set temperature lower (e.g. 0.1) for stricter, more deterministic syntax reviews.
✦You can check config file validity in the GitRabbit dashboard under Repository Settings.

Installation Automated Reviews