codeflow-hook 1.4.0 → 2.0.1

package/README.md

@@ -1,116 +1,36 @@
-# Codeflow Commander — Nexus Gateway CLI
+# Codeflow Hook
 
-**The Command-Line Interface for the Autonomous Engineering Platform**
+**AI-Powered Code Analysis and Git Hook Management**
 
-Your gateway to the Codeflow Commander Nexus Gateway — a comprehensive AI-driven engineering ecosystem that spans the entire software development lifecycle. This CLI tool serves as the entry point to enterprise-wide autonomous engineering capabilities, from intelligent code analysis to organization-scale workflow automation.
+A lightweight command-line tool that provides AI-driven code analysis, automated git hook installation, and intelligent code review capabilities. This standalone CLI tool analyzes your local code changes using advanced AI models (Gemini, OpenAI GPT, or Claude) and helps maintain code quality through automated pre-commit and pre-push checks.
 
-This is the universal command-line client for interacting with the **Phase 4 Autonomous Engineering Platform**, featuring next-generation components including the Enterprise Knowledge Graph (EKG), Autonomous Agent Network (AAN), Multi-Modal Interface Layer (MMIL), and Predictive Intelligence Engine (PIE).
+**✨ Standalone Package**: This CLI tool works independently and can be installed globally via npm. No additional setup or enterprise infrastructure required.
 
-## 🚀 Key Capabilities
+## 🚀 Features
 
-### **Enterprise Knowledge Graph (EKG)**
-- **Cross-Repository Intelligence**: Unified knowledge across all organizational repositories
-- **Semantic Dependency Mapping**: Understand organizational code relationships and patterns
-- **Expert Discovery**: Identify domain experts through code analysis patterns
-- **Supply Chain Intelligence**: Vulnerability tracking and license compliance across repositories
+### **AI-Powered Code Analysis**
+- **Local Code Diff Analysis**: Analyze git diffs using Gemini, OpenAI GPT, or Claude AI models
+- **Quality Assessment**: Get 1-10 quality ratings with detailed feedback on code changes
+- **Security Detection**: Identify potential security vulnerabilities in code changes
+- **Performance Insights**: Receive suggestions for performance optimizations
 
-### **Autonomous Agent Network (AAN)**
-- **Workflow Automation**: Transform JIRA tickets into validated pull requests automatically
-- **Self-Healing Operations**: Monitor, detect, diagnose, and fix production issues autonomously
-- **Predictive Maintenance**: Scheduled optimization tasks and dependency updates
-- **Multi-Agent Coordination**: Intelligent conflict resolution and approval workflows
+### **Git Hook Automation**
+- **Pre-commit Hooks**: Automatic analysis of staged changes before commits
+- **Pre-push Hooks**: Comprehensive code review simulation before pushing to remote
+- **Quality Gates**: Prevent problematic commits and pushes based on AI analysis
+- **Customizable Thresholds**: Configure when to block commits based on quality scores
 
-### **Multi-Modal Interface Layer (MMIL)**
-- **Conversational Code Generation**: Natural language → complex refactorings and implementations
-- **Design-to-Code Pipeline**: Figma designs to validated production code
-- **IDE Ecosystem Integration**: Native support across VSCode, IntelliJ, Vim, and more
-- **API-First Architecture**: REST APIs for all platform capabilities
+### **Local Knowledge Base (RAG)**
+- **Project Context Indexing**: Build searchable knowledge base from your project files
+- **Context-Aware Analysis**: AI analysis considers your project's documentation and code patterns
+- **Offline Capability**: Works without internet for local analysis (with indexed knowledge)
+- **Incremental Updates**: Automatically update knowledge base as project evolves
 
-### **Predictive Intelligence Engine (PIE)**
-- **Tech Debt Forecasting**: Predict maintenance hotspots and cost estimates
-- **Performance Prediction**: Identify regressions before deployment
-- **Engineering Analytics**: Data-driven process optimization and insights
-- **Risk Assessment**: Proactive security and compliance monitoring
-
-### **Governance Safety Framework (GSF)**
-- **Autonomous Permissions**: Dynamic access control based on context and risk
-- **Real-time Compliance**: Continuous regulatory and policy validation
-- **Emergency Controls**: System-wide safety mechanisms and overrides
-- **Human-in-the-Loop**: Graduated approval workflows for different risk levels
-
-### **Distributed Execution Engine (DEE)**
-- **Repository Federation**: Coordinate operations across multiple repositories
-- **Workflow Orchestration**: Complex process execution with dependency management
-- **State Synchronization**: Federated data consistency across the enterprise
-- **Resource Optimization**: Intelligent load balancing and execution management
-
-## 🏗️ Architecture Overview
-
-The CLI serves as your interface to the Codeflow Commander Nexus Gateway — a distributed, autonomous engineering platform designed for enterprise-scale operation.
-
-```
-┌─────────────────────────────────────────────────────────┐
-│               MULTI-MODAL INTERFACE LAYER (MMIL)      │
-│  ┌─────────────────┐ ┌─────────────────┐ ┌─────────────┐ │
-│  │ Conversational  │ │ Design→Code     │ │  IDE        │ │
-│  │ Interfaces      │ │ Pipeline        │ │ Integrations│ │
-│  └─────────────────┘ └─────────────────┘ └─────────────┘ │
-└─────────────────────────────────────────────────────────┘
-                                   │
-                                   ▼
-┌─────────────────────────────────────────────────────────┐
-│         AUTONOMOUS AGENT NETWORK (AAN) - ORCHESTRATOR  │
-│  ┌─────────────────┐ ┌─────────────────┐ ┌─────────────┐ │
-│  │ Workflow Agents │ │ Maintenance     │ │ Self-Heal   │ │
-│  │                 │ │ Bots            │ │ Agents      │ │
-│  └─────────────────┘ └─────────────────┘ └─────────────┘ │
-└─────────────────────────────────────────────────────────┘
-                                   │
-                                   ▼
-┌─────────────────────────────────────────────────────────┐
-│      GOVERNANCE & SAFETY FRAMEWORK - RISK CONTROL      │
-│  ┌─────────────────┐ ┌─────────────────┐ ┌─────────────┐ │
-│  │ Permission      │ │ Audit &        │ │ Emergency    │ │
-│  │ Engine          │ │ Compliance      │ │ Controls    │ │
-│  └─────────────────┘ └─────────────────┘ └─────────────┘ │
-└─────────────────────────────────────────────────────────┘
-                                   │
-                                   ▼
-┌─────────────────────────────────────────────────────────┐
-│     ENTERPRISE KNOWLEDGE GRAPH (EKG) - INTELLIGENCE    │
-│  ┌─────────────────┐ ┌─────────────────┐ ┌─────────────┐ │
-│  │ Cross-Repo      │ │ Semantic        │ │ Expert      │ │
-│  │ Dependencies    │ │ Mapping         │ │ Discovery   │ │
-│  └─────────────────┘ └─────────────────┘ └─────────────┘ │
-└─────────────────────────────────────────────────────────┘
-                                   │
-                                   ▼
-┌─────────────────────────────────────────────────────────┐
-│  PREDICTIVE INTELLIGENCE ENGINE (PIE) - FORECASTING    │
-│  ┌─────────────────┐ ┌─────────────────┐ ┌─────────────┐ │
-│  │ Tech Debt       │ │ Performance     │ │ Risk        │ │
-│  │ Forecasting     │ │ Prediction      │ │ Analytics   │ │
-│  └─────────────────┘ └─────────────────┘ └─────────────┘ │
-└─────────────────────────────────────────────────────────┘
-                                   │
-                                   ▼
-┌─────────────────────────────────────────────────────────┐
-│      DISTRIBUTED EXECUTION ENGINE (DEE) - RUNTIME      │
-│  ┌─────────────────┐ ┌─────────────────┐ ┌─────────────┐ │
-│  │ Repository      │ │ Workflow        │ │ State       │ │
-│  │ Federation      │ │ Orchestration   │ │ Sync        │ │
-│  └─────────────────┘ └─────────────────┘ └─────────────┘ │
-└─────────────────────────────────────────────────────────┘
-                                   │
-                                   ▼
-┌─────────────────────────────────────────────────────────┐
-│         EXTERNAL SYSTEMS INTEGRATION                    │
-│  ┌─────┐ ┌─────┐ ┌─────┐ ┌─────┐ ┌─────┐ ┌─────┐       │
-│  │GitHub│ │GitLab│ │JIRA │ │Slack│ │Jenkins│     │
-│  │Actions│ │     │ │     │ │     │ │       │     │
-│  └─────┘ └─────┘ └─────┘ └─────┘ └─────┘       │
-└─────────────────────────────────────────────────────────┘
-```
+### **Multi-Provider AI Support**
+- **Google Gemini**: Default AI provider with latest models (1.5 Pro, 1.5 Flash, Pro)
+- **OpenAI GPT**: Support for GPT-4, GPT-4 Turbo, GPT-3.5 Turbo
+- **Anthropic Claude**: Integration with Claude 3 Opus, Sonnet, and Haiku
+- **Custom Endpoints**: Connect to self-hosted or custom AI model endpoints
 
 ## 📦 Installation
 
@@ -126,279 +46,69 @@ npm install -g codeflow-hook
 npm install --save-dev codeflow-hook
 ```
 
-## ⚙️ Setup
+## ⚙️ Quick Start
 
 ### 1. Configure AI Provider
 
 Choose your AI provider and configure with your API key:
 
-**Gemini (default):**
 ```bash
+# Gemini (default, recommended)
 codeflow-hook config -p gemini -k YOUR_GEMINI_API_KEY
-```
-*You'll be prompted to select a model: `gemini-1.5-pro-latest`, `gemini-1.5-flash-latest`, or `gemini-pro`*
 
-**OpenAI:**
-```bash
+# OpenAI
 codeflow-hook config -p openai -k YOUR_OPENAI_API_KEY
-```
-*You'll be prompted to select a model: `gpt-4o`, `gpt-4-turbo`, `gpt-4`, or `gpt-3.5-turbo`*
 
-**Claude/Anthropic:**
-```bash
+# Claude/Anthropic
 codeflow-hook config -p claude -k YOUR_CLAUDE_API_KEY
 ```
-*You'll be prompted to select a model: `claude-3-opus-20240229`, `claude-3-sonnet-20240229`, or `claude-3-haiku-20240307`*
-
-**Custom model/URL:**
-```bash
-codeflow-hook config -p openai -k YOUR_API_KEY -m gpt-3.5-turbo -u https://your-custom-endpoint.com
-```
 
 ### 2. Install Git Hooks
 
-In your project directory:
-
 ```bash
 codeflow-hook install
 ```
 
-This creates:
-- `pre-commit`: AI analysis of staged changes
-- `pre-push`: Full CI/CD simulation (tests + AI review)
-
-### 3. Index Project Knowledge (RAG Setup)
-
-Build a local knowledge base for context-aware analysis:
+### 3. Start Analyzing Code
 
 ```bash
-# Index current project files for RAG
-codeflow-hook index
-
-# Dry run to see what files would be indexed
-codeflow-hook index --dry-run
-```
-
-The knowledge base is stored in `.codeflow/index/` and includes:
-- README.md and documentation files
-- Source code files (.ts, .tsx, .js, .jsx, .json)
-- Configuration files (package.json, jest.config.*, etc.)
-- Architecture and design documents
-
-### 4. Check Status
+# Analyze your current changes
+git diff | codeflow-hook analyze-diff
 
-```bash
-codeflow-hook status
+# Or let the hooks run automatically on commit/push
+git add .
+git commit -m "feat: add new feature"
 ```
 
 ## 🛠️ Commands
 
 ### Core Commands
 
-**Index Project Knowledge**:
 ```bash
-# Build local RAG knowledge base
-codeflow-hook index
-
-# Preview what will be indexed
-codeflow-hook index --dry-run
+codeflow-hook config     # Configure AI provider settings
+codeflow-hook install    # Install git hooks
+codeflow-hook analyze-diff # Analyze code changes
+codeflow-hook index      # Build local knowledge base
+codeflow-hook status     # Check installation status
 ```
 
-**Analyze Diff**:
-```bash
-# Analyze staged changes
-git diff --staged | codeflow-hook analyze-diff
-
-# Disable RAG context (faster but less precise)
-git diff | codeflow-hook analyze-diff --no-rag
-
-# Use legacy monolithic analysis
-git diff | codeflow-hook analyze-diff --legacy
-```
+### Usage Examples
 
-**Configuration & Setup**:
 ```bash
-# Configure AI provider
-codeflow-hook config -p gemini -k YOUR_API_KEY
+# Configure with Gemini (default)
+codeflow-hook config -p gemini -k your-api-key
 
-# Install git hooks
+# Install hooks in current project
 codeflow-hook install
 
-# Check installation status
-codeflow-hook status
-```
-
-### Advanced Options
-
-```bash
-# Use legacy mode for backwards compatibility
-codeflow-hook analyze-diff --legacy
-
-# Skip RAG for faster analysis
-codeflow-hook analyze-diff --no-rag
-
-# Custom hooks directory
-codeflow-hook install --hooks-dir .custom-hooks
-```
-
-### View Help
-
-```bash
-codeflow-hook --help             # Main help
-codeflow-hook index --help      # Index command help
-codeflow-hook analyze-diff --help # Analysis options
-```
-
-## 🔄 How It Works
-
-### Pre-commit Hook
-- Analyzes staged changes only
-- Provides quick feedback on code quality
-- Prevents problematic commits
-
-### Pre-push Hook
-- Runs full test suite
-- Performs comprehensive AI code review
-- Simulates deployment pipeline
-- Blocks pushes with failing checks
-
-### AI Analysis Features
-- Code quality assessment
-- Security vulnerability detection
-- Performance optimization suggestions
-- Best practice recommendations
-- Maintainability evaluation
-
-## 🔬 Enterprise Technology Stack
-
-### **Multi-Modal AI Integration**
-The Nexus Gateway integrates multiple AI modalities for comprehensive engineering intelligence:
-
-**🤖 Conversational Interface Layer**: Natural language processing for requirement analysis and complex code generation
-**🎨 Design-to-Code Pipeline**: Computer vision and ML models for design artifact ingestion
-**📊 Predictive Analytics Engine**: Time-series analysis and machine learning for trend forecasting
-**🔍 Semantic Code Analysis**: Advanced NLP for code understanding and pattern recognition
-
-### **Autonomous Agent Architecture**
-The core platform intelligence is delivered through specialized agent networks:
-
-**🎯 Workflow Execution Agents**:
-- Ticket-to-PR automation with full engineering lifecycle management
-- Self-healing operations with automated issue detection and remediation
-- Dependency management with intelligent version conflict resolution
-
-**🔬 Observational Intelligence Agents**:
-- Predictive maintenance scheduling based on code analysis patterns
-- Performance regression detection using historical benchmarking
-- Risk assessment with real-time compliance monitoring
-
-**🤝 Collaborative Learning Agents**:
-- Cross-repository knowledge synthesis and pattern mining
-- Expert identification through contribution analysis
-- Team productivity optimization through workflow analysis
-
-### **Federated Data Architecture**
-Enterprise-scale data management across distributed repositories:
-
-**🌐 Enterprise Knowledge Graph (EKG)**:
-- Multi-modal data integration (code, documentation, metrics, design artifacts)
-- Semantic relationship mapping across the entire organization
-- Real-time knowledge updates with conflict-free replication
-
-**📈 Predictive Intelligence Engine (PIE)**:
-- Time-series analytics for development velocity and quality trends
-- Anomaly detection using unsupervised learning algorithms
-- Forecasting models trained on enterprise development data
-
-### **Distributed Execution Framework**
-Coordination of autonomous operations across multiple systems:
-
-**⚡ Distributed Execution Engine (DEE)**:
-- Multi-repository workflow orchestration with dependency management
-- Resource optimization through intelligent load balancing
-- Federated state management with eventual consistency guarantees
-
-**🔐 Governance Safety Framework (GSF)**:
-- Risk-based permission evaluation with dynamic access controls
-- Multi-level audit trails with blockchain-verified immutability
-- Emergency stop mechanisms with graduated escalation protocols
-
-### **Structured Intelligence Output Format**
-Enterprise reporting with actionable insights and automated workflows:
-
-```
-🏢 Enterprise Code Review Summary:
-   🔒 Organization-wide Security risks: 2
-   🏗️ Architecture Optimization opportunities: 7
-   📝 Cross-repository Maintainability issues: 15
-   🎯 Predictive Maintenance alerts: 3
-
-📊 Trend Analysis:
-   📈 Code quality velocity: +12% (improving)
-   📉 Tech debt accumulation: -8% (reducing)
-   🎲 Risk exposure index: LOW (confidence: 94%)
-
-📋 Recommended Actions:
-   🔧 Automated fixes available for 23 issues
-   🚀 Cross-repository refactor suggested for auth module
-   📅 Maintenance window scheduled for Q4 dependency updates
-```
-
-### **Multi-Repository Analysis Benefits**
-- **Scale**: Analyzes thousands of repositories simultaneously
-- **Intelligence**: Learns organizational patterns and standards
-- **Automation**: Initiates cross-cutting improvements autonomously
-- **Governance**: Ensures compliance across all engineering activities
-- **Prediction**: Forecasts development bottlenecks before they occur
-
-## 💡 Usage Examples
-
-### Standard Development Workflow
-
-```bash
-# Stage your changes
-git add .
-
-# Pre-commit hook automatically runs AI analysis
-git commit -m "feat: add new authentication"
-
-# Pre-push hook runs tests and full AI review
-git push origin main
-```
-
-### Manual Analysis
-
-```bash
-# Analyze uncommitted changes
-git diff | codeflow-hook analyze-diff
-
-# Analyze specific files
-git diff path/to/file.js | codeflow-hook analyze-diff
-
-# Analyze between commits
-git diff HEAD~1 HEAD | codeflow-hook analyze-diff
-```
-
-## 🎯 AI Analysis Output
-
-The tool provides:
-
-- **Rating**: 1-10 quality score with color coding
-- **Summary**: Brief assessment of changes
-- **Issues**: Specific problems with solutions
-- **Recommendations**: Improvement suggestions
-
-Example output:
-```
-⭐ **Rating:** 9/10
-📝 **Summary:** Clean implementation with good separation of concerns
+# Analyze staged changes
+git diff --staged | codeflow-hook analyze-diff
 
-⚠️ **Issues:**
-- Consider adding input validation for edge cases
+# Build project knowledge base
+codeflow-hook index
 
-💡 **Recommendations:**
-- Add comprehensive error handling
-- Consider extracting common logic to a utility function
+# Check everything is working
+codeflow-hook status
 ```
 
 ## 🔧 Configuration
@@ -409,31 +119,28 @@ Configuration is stored in `~/.codeflow-hook/config.json`:
 {
   "provider": "gemini",
   "apiKey": "your-api-key",
-  "apiUrl": "https://generativelanguage.googleapis.com/v1beta/models/gemini-pro:generateContent",
-  "model": "gemini-pro"
+  "model": "gemini-1.5-pro-latest"
 }
 ```
 
 ### Supported AI Providers
 
-- **Gemini**: `provider: "gemini"` - Default, uses Google AI
+- **Gemini**: `provider: "gemini"` - Google AI (recommended)
 - **OpenAI**: `provider: "openai"` - GPT models
 - **Claude**: `provider: "claude"` - Anthropic models
 
-Each provider has optimized prompts and supports custom endpoints.
-
 ## 📋 Requirements
 
 - Node.js 16+
 - Git repository
-- Gemini API key
+- AI API key (Gemini, OpenAI, or Claude)
 
-## 🔒 Security
+## 🔒 Security & Privacy
 
-- API keys stored locally (not in your repo)
-- Have to make an .env file for the credentials 
-- No data sent to third parties except Google Gemini
-- Code diffs analyzed locally before sending
+- **Local Processing**: All code analysis happens on your machine
+- **API Keys Stored Locally**: Keys are stored in `~/.codeflow-hook/config.json`
+- **No Data Collection**: Code diffs are only sent to your configured AI provider
+- **No Telemetry**: No usage data is collected or transmitted
 
 ## 🐛 Troubleshooting
 
@@ -447,72 +154,46 @@ codeflow-hook config -k YOUR_API_KEY
 **Hooks not running**
 ```bash
 codeflow-hook install
-# Ensure scripts are executable
-chmod +x .git/hooks/pre-commit .git/hooks/pre-push
+# On Windows, ensure hooks are executable
 ```
 
 **API errors**
-- Verify your API key is valid
-- Check Gemini API service status
-- Ensure you have quota remaining
+- Verify your API key is valid and has quota remaining
+- Check your internet connection
+- Try a different AI provider
 
 ### Manual Hook Setup
 
 If automatic installation fails:
 
-1. Create `.git/hooks/pre-commit`
-2. Add executable permissions: `chmod +x .git/hooks/pre-commit`
-3. Call the CLI: `npx codeflow-hook analyze-diff "$(git diff --cached)"`
+1. Create `.git/hooks/pre-commit`:
+```bash
+#!/bin/sh
+codeflow-hook analyze-diff
+```
+
+2. Make it executable:
+```bash
+chmod +x .git/hooks/pre-commit
+```
+
+## 📄 License
+
+MIT License
 
 ## 🤝 Contributing
 
 1. Fork the repository
 2. Create a feature branch
 3. Make your changes
-4. Run tests: `npm test`
+4. Test thoroughly
 5. Submit a pull request
 
-## 📄 License
-
-MIT License - see LICENSE file for details
-
-## 🎉 Acknowledgments
-
-Built with ❤️ using enterprise-grade technologies:
-
-### **Core Intelligence Stack**
-- **Multi-Modal AI Integration**: Google Gemini, OpenAI GPT-4, Anthropic Claude
-- **Distributed Graph Database**: Neo4j Enterprise for Knowledge Graph operations
-- **Federated Learning Infrastructure**: PyTorch and TensorFlow for ML model training
-- **Container Orchestration**: Kubernetes for enterprise-scale deployment
-
-### **Development & CLI Framework**
-- **Commander.js**: Professional CLI experience and command orchestration
-- **Chalk & Ora**: Advanced terminal rendering with progress indicators
-- **Axios**: Enterprise HTTP client with retry logic and circuit breakers
-- **Node.js & TypeScript**: Type-safe, scalable runtime environment
-
-### **Enterprise Integrations**
-- **Git Platforms**: Native GitHub, GitLab, and Bitbucket integration
-- **Project Management**: JIRA, Linear, and Azure DevOps workflows
-- **Communication**: Slack, Microsoft Teams, and Discord integrations
-- **Monitoring**: Datadog, New Relic, and Prometheus telemetry
-
-### **Security & Governance**
-- **Audit Framework**: Blockchain-verified audit trails
-- **Access Management**: OAuth 2.0, SAML, and LDAP integration
-- **Encryption**: End-to-end encryption with key management
-- **Compliance**: SOC 2, GDPR, and enterprise security standards
-
 ---
 
-**🚀 Ready to transform your organization's engineering capabilities?**
+**🚀 Enhance your development workflow with AI-powered code analysis!**
 
-Join the autonomous engineering revolution with Codeflow Commander Nexus Gateway — where AI meets enterprise-scale software development.
-
-**Install today and experience organization-wide autonomous engineering:**
 ```bash
 npm install -g codeflow-hook
-```
-
-**Visit [codeflow-commander-nexus-gateway](https://github.com/Sharv619/codeflow-commander---nexus-gateway) to explore the full platform.**
+codeflow-hook config -k YOUR_API_KEY
+codeflow-hook install