FAQ - MergeGuide

How do I install the CLI?

With pip: pip install mergeguide. It requires Python 3.11 or newer and installs a single mergeguide executable. See Install the CLI.

How do I install the MCP server?

Run it with npx @mergeguide/mcp-server — no global install needed. mergeguide init installs and registers it for you. See Install the MCP server.

What's the fastest way to get set up?

Run mergeguide init. It writes your config, authenticates, installs the MCP server, and installs git hooks in one idempotent step. See the Quickstart.

Can I run a check without sending results to the dashboard?

Yes — add --local: mergeguide check src/ --local.

What languages does MergeGuide support?

Many common languages, including Python, JavaScript, TypeScript, Java, Go, Rust, Ruby, PHP, C#, and C/C++, plus IaC formats like Terraform. See the full list in Supported languages.

What output formats can I get?

check supports text, json, sarif, and markdown. The scanners support text, json, and sarif. See Output formats.

How do I stop a check from blocking my build?

Run in advisory mode: mergeguide check . --advisory. It reports findings but always exits 0. See Thresholds.

How do I suppress a finding I've reviewed and accepted?

Disable the specific policy or exclude the path in your config. See Reading findings.

How do I check whether my setup is healthy?

Run mergeguide doctor. It diagnoses configuration and connectivity and reports anything that needs attention.

How do I verify a signed evidence artifact?

Run mergeguide verify-evidence ./evidence.json. It exits 0 if valid, 1 if tampered, 2 if malformed, and 3 if a required network step was unreachable. See OSCAL export.

Which plan do I need?

Free covers local checks; Builder adds the dashboard, MCP server, PR gate, and compliance exports; Enterprise adds SSO and advanced access control. See Plans & entitlements.

​Still stuck?

Still stuck?