Code quality control,
enforced at every commit.

# 1. Download the binary for your platform (or `go install`, see Installation)
curl -fsSL -o quality-gate https://github.com/dmux/go-quality-gate/releases/latest/download/quality-gate-linux-amd64
chmod +x quality-gate && sudo mv quality-gate /usr/local/bin/quality-gate

# 2. Initialize — detects your languages and writes quality.yml
cd your-project
quality-gate --init

# 3. Install the Git hooks (pre-commit, commit-msg, pre-push) and check them
quality-gate --install
quality-gate doctor

# 4. That's it — checks run automatically and the commit is watermarked
git commit -m "feat: new feature"

# Once you've run it a few times:
quality-gate stats   # streaks, achievements, time saved
quality-gate ui      # local web dashboard

tools:
  - name: "Gitleaks"
    check_command: "gitleaks version"
    install_command: "go install github.com/zricethezav/gitleaks/v8@latest"
  - name: "Ruff (Python)"
    check_command: "ruff --version"
    install_command: "pip install ruff"
  - name: "Pip-Audit (Python Dependency Audit)"
    check_command: "pip-audit --version"
    install_command: "pip install pip-audit"

hooks:
  security:
    pre-commit:
      - name: "Security Check"
        command: "gitleaks detect --no-git --source . --verbose"
        output_rules:
          on_failure_message: "Secret leak detected!"

  python-backend:
    pre-commit:
      - name: "Format Check (Ruff)"
        command: "ruff format ./backend --check"
        fix_command: "ruff format ./backend"
        output_rules:
          show_on: failure
          on_failure_message: "Run 'quality-gate --fix' to format."
      - name: "Dependency Audit (pip-audit)"
        command: "pip-audit -r requirements.txt --aliases"
        fix_command: "pip-audit --fix -r requirements.txt"
        output_rules:
          show_on: failure
          on_failure_message: "Vulnerable dependencies found! Run 'quality-gate --fix'."
    pre-push:
      - name: "Dependency Audit (pip-audit)"
        command: "pip-audit -r requirements.txt --aliases"
        fix_command: "pip-audit --fix -r requirements.txt"
        output_rules:
          show_on: failure
          on_failure_message: "Vulnerable dependencies found! Run 'quality-gate --fix'."

  typescript-frontend:
    pre-commit:
      - name: "Format Check (Prettier)"
        command: "npx prettier --check 'frontend/**/*.{ts,tsx}'"
        fix_command: "npx prettier --write 'frontend/**/*.{ts,tsx}'"

# Automatic execution via Git hooks
git commit -m "feat: new feature"

# Manual execution
quality-gate pre-commit

# With automatic fixes
quality-gate --fix pre-commit

# JSON output for CI/CD pipelines
quality-gate --output=json pre-commit

# Verify commit watermarks (e.g. in CI)
quality-gate verify --range origin/main..HEAD

# Skip the checks on purpose, leaving an audit trailer
QG_SKIP="prod hotfix" git commit -m "fix: hotfix"

# Gate every repository on this machine that has a quality.yml
quality-gate --install --global

# Streaks, achievements and time saved
quality-gate stats

# Local web dashboard
quality-gate ui

# Check version
quality-gate --version

{
  "mcpServers": {
    "go-quality-gate": {
      "command": "./quality-gate",
      "args": ["mcp"]
    }
  }
}

name: Quality Gate
on: [pull_request]

jobs:
  quality-gate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0          # verify needs the PR commits
      - uses: dmux/go-quality-gate@main
        with:
          policy: strict          # or allow-skip to accept QG_SKIP commits
          run-checks: "true"      # re-run the checks, not just the watermark

# Then mark the job as a required status check on main.