Configuration

Validate your Mergify configuration and simulate actions before you merge.

Learn more: Configuration file

mergify config validate #

Validate the Mergify configuration file against the schema

Usage 
mergify config validate [OPTIONS]
Global options
--debug flag

Enable verbose debug logging. Mirrors the Python CLI's top-level --debug flag so the same invocations work against either binary; native commands accept it as a no-op today (no native code path consults it yet), shimmed ones re-inject it into the forwarded argv so the Python side can honor it

-f, --config-file <CONFIG_FILE> path

Path to the Mergify configuration file (auto-detected if not provided)

mergify config simulate #

Simulate Mergify actions on a pull request using the local configuration

Usage 
mergify config simulate [OPTIONS] <PULL_REQUEST_URL>
Arguments
<PULL_REQUEST_URL> string required

Pull request URL (e.g. <https://github.com/owner/repo/pull/123>)

Options
-t, --token <TOKEN> string

Mergify or GitHub token. Falls back to MERGIFY_TOKEN and then GITHUB_TOKEN env vars

-u, --api-url <API_URL> string

Mergify API URL. Falls back to MERGIFY_API_URL env var, then to the default

Global options
--debug flag

Enable verbose debug logging. Mirrors the Python CLI's top-level --debug flag so the same invocations work against either binary; native commands accept it as a no-op today (no native code path consults it yet), shimmed ones re-inject it into the forwarded argv so the Python side can honor it

-f, --config-file <CONFIG_FILE> path

Path to the Mergify configuration file (auto-detected if not provided)

Was this page helpful?