Mergify CLI

Drive Mergify from your terminal and CI pipelines: stacked pull requests, the merge queue, Test Engine, scheduled freezes, and configuration — all from a single self-contained binary that reuses your existing GitHub (gh) login.

mergify stack push          # turn your local commits into stacked PRs
mergify queue status        # inspect the merge queue
mergify ci junit-process report.xml   # upload test results to Test Engine

• One static binary. No runtime, no dependencies — drop it on a developer laptop or a CI runner and go.
• One command to sign in. mergify auth login approves the CLI in your browser and keeps the credential in your OS keychain; MERGIFY_TOKEN or --token for scripting.
• Built for pipelines. Logs to stderr, structured --json output on read commands, and stable exit codes for scripts and runbooks.
• Cross-platform. Linux, macOS (x86_64 + aarch64), and Windows.

Installation

Homebrew (recommended for macOS)

brew install mergifyio/tap/mergify-cli

The fully-qualified name taps and installs in one step. Upgrade with brew upgrade mergify-cli — not mergify self-update, which overwrites the Homebrew-managed binary. See the tap for tap-trust and short-name details.

Install script (recommended for Linux; also macOS — x86_64 and aarch64)

curl -fsSL https://raw.githubusercontent.com/Mergifyio/mergify-cli/main/install.sh | sh

Installs to ~/.local/bin/mergify. Override with MERGIFY_INSTALL_DIR=/usr/local/bin or pin a version with MERGIFY_VERSION=<version>. Upgrade with mergify self-update.

Manual download (Windows, or to bypass the script)

Grab the matching archive from the latest release:

• Windows — download mergify-<version>-x86_64-pc-windows-msvc.zip, extract it, and put mergify.exe anywhere on your PATH.
• Linux / macOS — download mergify-<version>-<target>.tar.gz (e.g. mergify-2026.10.1-aarch64-apple-darwin.tar.gz), extract with tar -xzf, and put the resulting mergify binary anywhere on your PATH.

Verify against SHA256SUMS from the same release if you care.

Authentication

Sign in once:

mergify auth login

It opens the approval page in your browser, and prints the URL and the code as well: pass --no-browser, or run it where there is no browser to open, and the printed pair is all you need. Once you approve, the credential lands in your OS keychain — or, on a machine with none (a container, an unattended agent, a headless box with no D-Bus session), in a restricted file under your configuration directory. mergify auth status says which account you are signed in as, and mergify auth logout asks the Mergify API to revoke the credential rather than only deleting the local copy.

The approval page labels the new token Mergify CLI on <hostname>. Pass --device-name "work laptop" to name the machine yourself, or --device-name= to keep the hostname from leaving the machine at all.

The commands that talk to the Mergify API resolve a credential in this order:

A GitHub token (GITHUB_TOKEN, gh auth token) is no longer a fallback: the Mergify API is dropping GitHub tokens, and a command with none of the credentials above fails and says how to get one. Run mergify auth login, or set MERGIFY_TOKEN in CI.

mergify ci skips step 3. Those endpoints require an organization application key, which is what MERGIFY_TOKEN holds in a CI job; the per-user credential mergify auth login mints is refused there by design.

mergify stack also calls the GitHub API directly, and resolves that token separately (--token, MERGIFY_TOKEN, GITHUB_TOKEN, gh auth token). It is unaffected by the change above: stack needs a GitHub credential and Mergify never issues one. A Mergify-issued token (mut_…) is skipped there rather than sent to GitHub, which would only answer 401 Bad credentials — in MERGIFY_TOKEN, in GITHUB_TOKEN, and in what gh auth token returns, since it echoes GITHUB_TOKEN when that is set. Only an explicit --token is sent as given.

The repository and API URL resolve as before:

Credentials are stored per API URL, so one machine can hold a credential for the hosted service and one for an on-premise install.

Mergify application keys come in two classes, each reaching its own set of endpoints rather than one being a subset of the other. A ci key is scoped to what a CI job does — trace upload, ci scopes-send, quarantine evaluation and the quarantine list. Trace upload and ci scopes-send take a ci key only, and answer an admin key or a user credential with 403 Forbidden. Reading test health (mergify tests show) and changing the quarantine (mergify tests quarantines add / remove) need an admin key or a user credential — the one mergify auth login stores — and answer a ci key with 403 Forbidden. GITHUB_TOKEN is not a Mergify credential and does not reach the Mergify API.

See the authentication guide for details.

Quick start

# Stacked pull requests — one PR per commit, kept in sync
mergify stack setup                # once per repo: install the git hooks the stack needs
mergify stack push                 # push commits and create/update their PRs
mergify stack list                 # show the stack and its PR status
mergify stack sync                 # rebase the stack onto its trunk

# Merge queue
mergify queue status               # current queue state for the repo
mergify queue status --json        # same, as machine-readable JSON
mergify queue add 123              # queue a pull request (number or URL)

# Test Engine — from inside your pipeline
mergify ci junit-process report.xml --test-language python

# Configuration
mergify config validate            # check .mergify.yml against the schema

Run mergify --help for the full command list and mergify <command> --help for any command's flags.

Commands

Every command group maps to a section of the CLI reference.

• mergify auth — Sign in to Mergify and manage the stored credential (login, logout, status).
• mergify stack — Create and maintain stacked pull requests. Docs
• mergify queue — Inspect and control the merge queue. Docs
• mergify events — Browse the events Mergify recorded for the repository or one pull request, as a timeline or JSON.
• mergify ci — Send JUnit results and pull request scopes from any CI provider. Docs
• mergify tests — Look up test health and manage the flaky-test quarantine. Docs
• mergify freeze — Schedule merge freezes for release windows and maintenance. Docs
• mergify config — Validate your configuration and simulate actions before you merge. Docs
• mergify self-update — Update the CLI to the latest release.
• mergify completions <shell> — Print a shell completion script (see below).

Run mergify <command> --help for a group's subcommands and flags.

Shell completions

Generate a completion script for your shell — bash, zsh, fish, elvish, or powershell:

# zsh — write to a directory on your $fpath
mergify completions zsh > ~/.zfunc/_mergify

# bash — load in your current session (add to ~/.bashrc to persist)
source <(mergify completions bash)

# fish
mergify completions fish > ~/.config/fish/completions/mergify.fish

Global options

These are accepted on every command:

Environment variables

Exit codes

Commands return stable exit codes so scripts and runbooks can branch on them:

AI Agent Skills

Mergify CLI provides AI skills for managing stacked PRs and Git workflows, compatible with Claude Code, Cursor, and many other AI agents.

Install via npx (all agents):

npx skills add Mergifyio/mergify-cli

Install as a Claude Code plugin:

/plugin install mergify@claude-plugins-official

Documentation

Full reference and guides live at docs.mergify.com/cli.

Contributing

Bug reports and feature requests are welcome: open an issue. The CLI is developed by Mergify; this repository publishes it: the releases, the installer, the agent skills and this README, all updated with each release. Suggestions to install.sh, skills/ or the documentation are welcome as issues too. See AGENTS.md for what lives where.

License

Proprietary — see LICENSE. Use is governed by the Mergify Terms of Service.