Configuration keys

MergeGuide reads project configuration from a YAML file. This page is the reference for the user-facing keys. For a task-oriented walkthrough, see Configuration file.

Where config is loaded from

MergeGuide looks for a config file in this order and uses the first it finds:

.mergeguide.yaml
.mergeguide/config.yaml
~/.mergeguide/config.yaml (user-global)

Keys written by `init`

mergeguide init writes this starting config:

.mergeguide/config.yaml

version: "1.0"
fail_mode: closed
enforcement_mode: graduated
policies:
  use_defaults: true
  custom_dir: .mergeguide/policies

Key	Type	Default	Description
`version`	string	`"1.0"`	Config schema version.
`fail_mode`	string	`closed`	Whether a failed check blocks. `closed` blocks on blocking findings.
`enforcement_mode`	string	`graduated`	Applies enforcement progressively across your workflow layers.
`policies.use_defaults`	bool	`true`	Run MergeGuide’s default policy set.
`policies.custom_dir`	string	`.mergeguide/policies`	Directory holding your custom policy files.

Keys managed with `config set`

These keys tune what’s reported and what blocks. You can edit them in the file directly or with mergeguide config set:

Key	Type	Values	Description
`severity`	choice	`error`, `warning`, `info`	Minimum severity to report.
`fail_on_warning`	bool	`true` / `false`	Exit with an error if warnings are found.
`exclude_patterns`	list	glob patterns	Paths to exclude from checks.
`enabled_policies`	list	policy IDs	Policies to explicitly enable.
`disabled_policies`	list	policy IDs	Policies to explicitly disable.

mergeguide config set severity warning
mergeguide config set fail_on_warning true

.mergeguide/config.yaml

severity: warning
fail_on_warning: true
exclude_patterns:
  - "**/vendor/**"
  - "**/generated/**"
enabled_policies:
  - owasp-top-10
disabled_policies:
  - example-noisy-rule

Manage config from the CLI

Command	What it does
`mergeguide config list`	List current configuration.
`mergeguide config get <key>`	Get a value.
`mergeguide config set <key> <value>`	Set a value.
`mergeguide config unset <key>`	Remove a value.
`mergeguide config path`	Show the config file path.

This reference covers the user-facing keys MergeGuide reads from your config file. If you find a key in an example that isn’t listed here, confirm it against mergeguide config list before relying on it.

Get started

Provisioning & account

Setup & installation

Configuration

Operation

Navigation

Integrations & CI/CD

Compliance

Methodology

Troubleshooting & FAQ

Reference

Where config is loaded from

Keys written by `init`

Keys managed with `config set`

Manage config from the CLI

Next steps

Configuration file

Thresholds

​Where config is loaded from

​Keys written by init

​Keys managed with config set

​Manage config from the CLI

​Next steps

Configuration file

Thresholds

Where config is loaded from

Keys written by `init`

Keys managed with `config set`

Manage config from the CLI

Next steps