๐ก๏ธ Production-Grade Safety Layer for AI-First Development
Git hygiene monitoring + Security scanning + Semantic search + Full observability
AI coding assistants are incredibly productiveโbut they can also create massive, hard-to-review changesets and security risks. FlowCheck is a production-grade safety layer that:
- ๐ Monitors Git state in real-time during AI-assisted coding
- ๐ Scans for security issues (PII, secrets, prompt injection attacks)
- ๐ Semantic history search - find commits by meaning, not keywords
- ๐ Tracks flow health (time, lines, branch age, drift from main)
- ๐ Full observability (OpenTelemetry traces, audit logs)
- ๐ฏ Intent validation (ticket-to-diff alignment)
- ๐ค Designed for AI agents with enforceable rules
Think of FlowCheck as a "smart fitness watch with a biometric lock" for your codebaseโit helps you code faster while actively defending against security threats.
FlowCheck is built specifically for the agentic coding workflow:
flowchart LR
Agent["๐ค AI Agent<br/>(Claude, Cursor, etc)"]
FC["๐ก๏ธ FlowCheck<br/>MCP Server"]
Git["๐ Git Repo<br/>(.git)"]
Agent -->|"get_flow_state()"| FC
FC -->|"analyze"| Git
Git -->|"metrics"| FC
FC -->|"status: warning<br/>security_flags: [...]"| Agent
Agent -->|"โธ๏ธ Pause & suggest<br/>checkpoint commit"| Agent
Copy rules/flowcheck-rules.md to your AI tool's rules directory:
# For Cursor
cp rules/flowcheck-rules.md .cursor/rules/
# For Claude Projects
cp rules/flowcheck-rules.md .claude/rules/
# For other tools
cp rules/flowcheck-rules.md .agent/rules/This instructs AI agents to automatically check Git hygiene before starting tasks and to pause when thresholds are exceeded.
git clone https://github.com/backslash-ux/flowcheck.git
cd flowcheck
python3 -m venv .venv
source .venv/bin/activate
pip install -e .Add to ~/Library/Application Support/Claude/claude_desktop_config.json:
{
"mcpServers": {
"flowcheck": {
"command": "/path/to/flowcheck/.venv/bin/python",
"args": ["-m", "flowcheck.server"],
"env": {
"PYTHONPATH": "/path/to/flowcheck/src"
}
}
}
}| Tool | Purpose |
|---|---|
get_flow_state |
Returns metrics + security_flags (PII/injection) |
get_recommendations |
Returns actionable nudges + security warnings |
set_rules |
Dynamically adjust thresholds |
| Tool | Purpose |
|---|---|
search_history |
Semantic search - find commits by meaning |
verify_intent |
Smart Intent Verification - use "AI Judge" (BYOK LLM) to align diffs with tickets |
sanitize_content |
PII/secret redaction before sharing with AI |
{
"alignment_score": 0.4,
"is_aligned": false,
"ticket_id": "42",
"scope_creep_warnings": ["Scope Creep Detected by AI Judge"],
"reasoning": "The ticket asks for a bug fix in auth, but the diff contains a full refactor of the billing module."
}FlowCheck supports hierarchical configuration:
- Repo Config:
.flowcheck.json(in project root) - Global Config:
~/.flowcheck/config.json - Defaults
{
"max_minutes_without_commit": 45,
"intent": {
"provider": "openai",
"model": "gpt-4o",
"api_key_env": "OPENAI_API_KEY"
}
}Create a .flowcheckignore file in your repo root to exclude files from analysis (uses gitignore syntax):
tests/fixtures/
*.min.js
legacy/- PII Detection: Emails, phone numbers, SSNs, credit cards
- Secret Scanning: AWS keys, GitHub tokens, API keys, passwords
- Injection Filtering: Detects prompt injection attacks in diffs
- OpenTelemetry Traces:
gen_ai.*semantic conventions - Audit Logs: Append-only JSON Lines format in
~/.flowcheck/audit.log - All tool invocations are logged with trace IDs
- TF-IDF Vectorization: No external ML dependencies
- SQLite Storage: Local index in
~/.flowcheck/semantic_index.db - Find commits by meaning, not just keywords
Get FlowCheck running in 30 seconds:
# Clone and setup
git clone https://github.com/backslash-ux/flowcheck.git
cd flowcheck
# Configure environment
cp .env.example .env
nano .env # Add your API keys
# Start the stack
docker-compose upFlowCheck is now running at http://localhost:8000
See Docker Deployment Guide for:
- Local development setup
- Production deployment
- Image variants (production/slim/dev)
- Troubleshooting
pip install git+https://github.com/backslash-ux/flowcheck.git
# Set environment variables
export ANTHROPIC_API_KEY=sk-ant-xxxxx
# Start server
flowcheck-servergit clone https://github.com/backslash-ux/flowcheck.git
cd flowcheck
# Create virtual environment
python3 -m venv .venv
source .venv/bin/activate
# Install in development mode
pip install -e ".[dev]"
# Run tests
pytest tests/
# Start server
flowcheck-serverFlowCheck supports multiple deployment models:
| Scenario | Time | Guide |
|---|---|---|
| Local Development | 5 min | Docker |
| Production (Docker) | 10 min | Docker.md |
| Kubernetes | 30 min | Kubernetes.md |
| CI/CD Integration | 15 min | CI-CD.md |
๐ Deployment Guide for full options
# Setup development environment
docker-compose -f docker-compose.dev.yml up
# Or use Python venv
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
# Run tests
pytest tests/ -v
# Run with coverage
pytest tests/ --cov=src/flowcheckFlowCheck embodies the principle that good Git hygiene enables good AI collaboration:
- Smaller commits are easier for humans to review and audit
- Frequent checkpoints prevent losing work during long sessions
- Clean history makes it easier to understand what the AI changed
- Non-blocking nudges preserve developer autonomy
MIT