Configuration

Customize Peqy's behavior with a configuration file in your repository.

Config File Location

Create a file at .peqy/config.yml in your repository root.

Basic Example

version: "1.0"

Full Example

version: "1.0"
auto_run: true
disabled:
  - "Security > SQL injection"
  - "Performance"
context:
  stage: "early-startup"
  type: "internal"
  team_size: 5
  notes: "MVP phase - prioritize speed over perfect security"

Configuration Options

`version` (required)

The config schema version. Currently only "1.0" is supported.

version: "1.0"

`auto_run`

Whether Peqy automatically runs on PR events (webhooks). Set to false to only allow API-triggered analysis.

auto_run: true  # default

`disabled`

A list of checks or groups to disable. Use the format "Group > Check" for specific checks, or just "Group" to disable an entire group.

disabled:
  - "Security > SQL injection"  # Disable specific check
  - "Performance"               # Disable entire group

`context`

Provide context about your project to help the AI make better decisions.

Field	Description	Values
`stage`	Project maturity	`early-startup`, `growth`, `enterprise`
`type`	Application type	`internal`, `customer-facing`, `open-source`
`team_size`	Number of developers	Any number
`notes`	Free-form notes	Any text

context:
  stage: "early-startup"
  type: "internal"
  team_size: 3
  notes: "Environment variables are acceptable for secrets in this phase"

Finding Check Names

To see the exact names of checks and groups, run Peqy on a PR and look at the check run output. The output shows the full hierarchy of checks that ran.

GitHub Actions