01_Overview

The AI
Guardrail.

GitPulse is an intelligent security and convention layer that sits between your AI coding tools and your git history. It ensures that every commit is safe, consistent, and documented.

Quality Gates

Block secrets and smells automatically.

MCP Native

Context for Windsurf & Claude.

Auto-Learning

Adapts to your team's style.

Docs Engine

Architecture diagrams from PRs.

02_Deployment

Initialise Protocol

01

Installation

$ npm install -g gitpulseCopy

Or use the PowerShell one-liner (no Node.js required):
irm https://raw.githubusercontent.com/codedrichy/gitpulse/main/scripts/install.ps1 | iex

02

Initialisation

$ gitpulse initCopy

This command automatically installs the pre-commit and commit-msg hooks.

03

First Commit

$ gitpulse commitCopy

03_Dashboard

Web Dashboard

Access the GitPulse web dashboard for visual analytics, team management, and configuration.

01

Launch Dashboard

$ gitpulse dashboardCopy

This command starts a local telemetry server and opens the web dashboard in your browser. Pro and Team tiers get cloud sync and advanced analytics.

Dashboard Features

  • ✦Real-time quality metrics and health scores
  • ✦Quality gate configuration (Pro/Team)
  • ✦Team analytics and member management (Team)
  • ✦Custom gate creation and management

04_Security

Quality Gates

GateProtectionSeverity
Security ScanHardcoded Secrets, SQLi, XSSCRITICAL
Code SmellsLong Functions, TODOs, debuggerHIGH
Test CoverageMissing tests for changed filesMEDIUM
DocumentationMissing JSDocs on core logicLOW

05_Installation

Get GitPulse

Option A: npm (Recommended)

npm install -g gitpulse

Requires Node.js 18+. Updates via npm.

Option B: PowerShell One-Liner

irm https://raw.githubusercontent.com/codedrichy/gitpulse/main/scripts/install.ps1 | iex

Zero dependencies. Downloads single binary to %LOCALAPPDATA%\gitpulse.

Option C: Build from Source

git clone https://github.com/codedrichy/gitpulse.git cd gitpulse npm install npm run build

06_AI_Infrastructure

Smart Provider Health

GitPulse monitors AI provider health in real-time. If your preferred provider fails, we automatically fall back to the best available alternative.

Circuit Breaker

  • • 3 failures → circuit opens (5 min timeout)
  • • Health checks every 30 seconds
  • • Auto-recovery when provider heals

Health Indicators

  • ⚡ <1s response time
  • 🟢 1-5s normal
  • 🐌 >5s slow
  • 🔴 Circuit open

// CLI shows fallback notification

$ gitpulse commit
⚡ Switched from groq to openrouter (groq unavailable)
Generating commit message...

07_Custom_Gates

Custom Quality Gates

Create custom quality gates tailored to your project's specific requirements (Pro/Team tier).

{
  "name": "no-console-logs",
  "description": "Block console.log statements in production code",
  "severity": "medium",
  "pattern": "console\.(log|warn|error|debug)",
  "include": ["src/**/*.ts", "src/**/*.tsx"],
  "exclude": ["src/**/*.test.ts", "src/**/*.spec.ts"]
}

Gate Configuration

  • ✦name: Unique identifier for the gate
  • ✦pattern: Regex pattern to match against code
  • ✦include: Glob patterns for files to check
  • ✦exclude: Glob patterns to exclude from checks

08_Calibration

Configuration

Tweak your guardrails in .gitpulse/config.json.

{
  "version": 1,
  "quality_gates": {
    "security-scan": { "enabled": true, "severity": "critical" },
    "code-smells": { "enabled": true, "severity": "high" }
  },
  "conventions": {
    "commit_style": "conventional",
    "auto_learn": true
  }
}

09_Integrations

MCP_Protocol

Bridge GitPulse intelligence directly to your AI agent. Add this to your Windsurf or Claude Desktop config:

"mcpServers": {
  "gitpulse": {
    "command": "npx",
    "args": ["-y", "gitpulse", "mcp", "start"]
  }
}

10_Reference

Terminal_ISA

gitpulse initInitialize GitPulse in your repository
gitpulse commitAI-powered commit with quality gates
gitpulse statusRepository health and status summary
gitpulse prGenerate PR documentation
gitpulse reviewAI-assisted code review
gitpulse dashboardLaunch web dashboard (Pro/Team)
gitpulse configView or update configuration
gitpulse mcp startStart MCP server for AI integration