Skip to main content
The MergeGuide CLI is the Python package mergeguide. It installs a single mergeguide executable and is the foundation for local checks, git hooks, and CI integration.
Requires Python 3.11 or newer. Check with python --version.

Install

pip install mergeguide

Verify

mergeguide --version
Then run the built-in diagnostics to confirm your environment and connectivity:
mergeguide doctor

Set up everything at once

Rather than installing each piece by hand, mergeguide init wires up the whole local toolchain — config, dashboard authentication, the MCP server (installed via npx), and git hooks — in one idempotent command:
mergeguide init --api-key mg_xxxxxxxxxxxxxxxx
See the Quickstart for the full first-run flow.

Authenticate

If you set things up manually, authenticate against the dashboard:
mergeguide login --api-key mg_xxxxxxxxxxxxxxxx
Run mergeguide login with no flags to authenticate interactively, then confirm:
mergeguide auth whoami

Troubleshooting

Install into an isolated environment with pipx install mergeguide, or use the per-user flag:
pip install --user mergeguide
Point Python at your corporate CA bundle:
export REQUESTS_CA_BUNDLE=/path/to/certificate.pem
which mergeguide
pip show mergeguide
mergeguide --version

Next steps

Install the MCP server

Bring governance into your AI coding assistant.

Install git hooks

Check staged changes before they leave your machine.

CLI reference

Every command and flag.

Run your first check

Go from install to first finding.