Skip to main content

Configuration

Customize diffray behavior with a configuration file.

Quick Start​

Create .diffray/config.yaml in your repository:

your-repo/
└── .diffray/
    ├── config.yaml      # Project settings
    ├── rules/           # Custom rules (optional)
    └── agents/          # Custom agents (optional)

Example​

version: 1

# Exclude files from review
filters:
  exclude:
    - 'vendor/**'
    - '**/*.generated.ts'
  include:
    - 'package.json'      # Re-include specific files

# Review settings
review:
  maxFiles: 100           # Max files per PR (default: 150)

# Disable specific rules
rules:
  exclude:
    - doc_missing_jsdoc
    - perf_large_bundle

Available Settings​

filters — File Exclusions​

SettingDefaultDescription
useDefaultstrueUse built-in exclusions (lock files, node_modules, dist, etc.)
exclude[]Additional glob patterns to exclude
include[]Patterns to re-include (overrides exclusions)

review — Review Behavior​

SettingDefaultDescription
maxFiles150Max files per PR (0 = no limit)

rules — Rule Settings​

SettingDefaultDescription
exclude[]Rule IDs to disable

Finding Rule IDs​

To disable a rule, you need its ID. Rule IDs appear in:

  • Review comments (in parentheses after the issue title)
  • Your custom rules in .diffray/rules/*.yaml

See Also​