Skip to main content

​
Quick Start

Get MergeGuide running in your development environment in under 5 minutes.

​
Prerequisites

  • Node.js 18+ or Python 3.9+
  • Git repository with code to analyze

​
Install the CLI

# Using npm (recommended)
npm install -g @mergeguide/cli

# Using pip
pip install mergeguide

​
Authenticate

mergeguide auth login
This opens your browser to complete authentication. Your API key is stored securely in ~/.mergeguide/credentials.

​
Run Your First Check

Navigate to any Git repository and run: 
mergeguide check
MergeGuide analyzes your staged changes against your organization’s policies and displays results: 
MergeGuide Check Results
========================

Repository: my-app
Branch: feature/user-auth
Files analyzed: 12

Policies: 3 passed, 1 warning, 0 failed

[PASS] no-hardcoded-secrets
[PASS] no-sql-injection
[WARN] require-error-handling
       src/api/users.ts:45 - Consider adding error handling for async operation
[PASS] no-console-in-production

Overall: PASS (with warnings)

​
What’s Next?