Merge Queue

Pause, unpause, and inspect the merge queue from scripts and incident runbooks.

Learn more: Merge queue monitoring

mergify queue pause #

Pause the merge queue for the repository

Usage 
mergify queue pause [OPTIONS] --reason <REASON>
Options
--reason <REASON> string required

Reason for pausing the queue (max 255 characters)

--yes-i-am-sure flag

Skip the confirmation prompt. Required in non-interactive sessions

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

-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

-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Falls back to GITHUB_REPOSITORY env var

mergify queue unpause #

Unpause the merge queue for the repository

Usage 
mergify queue unpause [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

-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

-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Falls back to GITHUB_REPOSITORY env var

mergify queue status #

Show merge queue status for the repository

Usage 
mergify queue status [OPTIONS]
Options
-b, --branch <BRANCH> string

Filter the queue by branch name

--json flag

Emit the raw API response as a single JSON document

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

-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

-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Falls back to GITHUB_REPOSITORY env var

mergify queue show #

Show detailed state of a pull request in the merge queue

Usage 
mergify queue show [OPTIONS] <PR_NUMBER>
Arguments
<PR_NUMBER> string required

Pull request number to inspect

Options
-v, --verbose flag

Show the full checks table and the conditions tree instead of compact summaries

--json flag

Emit the raw API response as a single JSON document

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

-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

-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Falls back to GITHUB_REPOSITORY env var

Was this page helpful?