🧶 CommitWeave

CommitWeave is a modern CLI tool and VS Code extension that transforms your git commit workflow. Create beautiful, consistent, and meaningful commit messages following conventional commit standards—with emoji support, AI assistance, and powerful automation.

Add animated GIF showing CLI in action here

Coming Soon: Watch CommitWeave create perfect commits interactively with emoji selection, conventional commit formatting, and AI-powered suggestions.

# CLI Tool
npm install -g @typeweaver/commitweave

# VS Code Extension
# Search "CommitWeave" in VS Code Extensions (Publisher: glincker)

# Set up your project configuration
commitweave init

# Interactive commit creation
commitweave

# Or with AI assistance
commitweave --ai

That's it! 🎉 Start creating professional commits instantly.

Our VS Code extension brings CommitWeave directly into your editor with a rich, native experience.

Quick Access:

• Command Palette: Ctrl+Shift+P → "CommitWeave"
• Source Control Panel: Click the "⚡ Quick Commit" button
• Status Bar: Monitor your repo status at a glance

Features:

• 🎯 5 Powerful Commands: Create, AI Commit, Quick Commit, Validate, Configure
• ⚙️ Enhanced Settings Panel: Tabbed interface with visual configuration
• 📊 Commit History: View and validate recent commits
• 📝 Smart Templates: Pre-built commit templates with variables
• ✅ Real-time Validation: Live commit message validation with suggestions

Transform your workflow with intelligent commit generation:

• 🧠 Smart Analysis: AI analyzes your staged changes
• ⚡ Multiple Providers: OpenAI GPT & Anthropic Claude support
• 🎨 Perfect Formatting: Always follows conventional commit standards
• 🔒 Secure: Safe API key handling and local storage

# Generate AI commits from your changes
commitweave --ai

{
  "version": "1.0",
  "emojiEnabled": true,
  "conventionalCommits": true,
  "maxSubjectLength": 50,
  "ai": {
    "provider": "openai",
    "model": "gpt-4"
  },
  "ui": {
    "fancyUI": true,
    "asciiArt": true,
    "animations": true,
    "colors": true,
    "emoji": true
  }
}

• Node.js ≥ 18.0.0
• npm or yarn
• Git

git clone https://github.com/GLINCKER/commitweave.git
cd commitweave
npm install
npm run build
npm test

CommitWeave maintains exceptional quality through comprehensive testing across multiple dimensions:

• Platform Compatibility: 6/6 tests passed (100% success rate)
• AI Functionality: 6/6 AI tests passed with fallback validation
• Performance: 24ms startup time (12x better than 300ms target)
• VS Code Integration: All extension commands validated
• Fallback Behavior: 5/5 network failure scenarios handled gracefully

• Operating Systems: macOS, Linux, Windows
• Shells: zsh, bash, PowerShell, Command Prompt
• Terminals: Terminal.app, iTerm2, Windows Terminal, VS Code integrated terminal
• Full emoji and ANSI color support verified across platforms

• OpenAI GPT: Full integration with API key validation
• Anthropic Claude: Complete Claude 3 model support
• Mock AI Provider: Always available as ultimate fallback
• Network Failure Handling: Graceful degradation with user warnings
• Invalid API Key Detection: Automatic fallback to Mock AI

# Run performance benchmarks
npm run bench

# Results: ~24ms cold-start (target: ≤300ms)
# 13x performance improvement achieved

# Cross-platform compatibility testing
npx tsx scripts/test-cross-platform.ts

# AI functionality and fallback testing  
npx tsx scripts/test-ai-functionality.ts
npx tsx scripts/test-ai-fallback.ts

# VS Code extension integration testing
npx tsx scripts/test-vscode-integration.ts

# Performance benchmarking
npm run bench

• Platform Results: docs/platform-compatibility.md
• Test Artifacts: docs/testing-reports/ directory
• File Structure: docs/file-map.md

We welcome contributions! Please read our Contributing Guide for:

• 🔧 Local development setup
• 🧪 Testing instructions
• 📝 How to add commit types
• 🤖 Adding AI providers
• 📋 Code style guidelines

• 📚 Full Documentation - Complete guides and tutorials
• 🐛 Report Issues - Bug reports and feature requests
• 💬 Discussions - Community support and ideas
• 🚀 Releases - Latest versions and changelog
• 📦 NPM Package - Package details and stats

📝 Join the Beta Program

Get early access to new features:

• 🚀 Latest features before general release
• 💬 Direct feedback channel with our team
• 🎁 Exclusive beta-only features and themes
• 📧 Priority support and feature requests

This project is licensed under the MIT License - see the LICENSE file for details.