CommitWeave VS Code Extension
Smart, structured, and beautiful git commits with AI assistance - directly from VS Code!
Developed & Published by GLINR STUDIOS • @glincker
Features
🚀 Core Commands
- CommitWeave: Create Commit - Launch the interactive CLI-style commit builder in the integrated terminal
- CommitWeave: AI Commit - Generate AI-powered commit messages based on your staged changes
- CommitWeave: Quick Commit - Fast conventional commits with native VS Code UI and real-time validation
- CommitWeave: Validate Commit - Validate your last commit message against conventional commit standards
- CommitWeave: Configure - Open the enhanced settings panel with tabbed interface
⚙️ Enhanced Settings Panel
The tabbed configuration webview provides:
Settings Tab:
- Repository Status: Real-time monitoring of git repository, staged files, and CLI availability
- Emoji Settings: Enable/disable emoji integration in commit messages
- AI Provider: Choose between OpenAI, Anthropic, or mock providers
- Dark Mode: Automatically adapts to VS Code's theme with smooth animations
Commit History Tab:
- Recent Commits: View last 10 commits with validation status indicators
- Validation Status: See which commits follow conventional commit standards
- Quick Actions: Refresh history and validate latest commit
Templates Tab:
- Quick Templates: Pre-built commit message templates with variable substitution
- Template Types: Common patterns for features, fixes, docs, refactoring, and tests
- Direct Integration: Click templates to trigger Quick Commit workflow
🤖 AI Integration
Supports multiple AI providers:
- OpenAI GPT models for intelligent commit message generation
- Anthropic Claude models for detailed commit analysis
- Mock provider for testing and development
⚡ Quick Commit Workflow
Streamlined commit process with native VS Code UI:
- Type Selection: Choose from conventional commit types with emoji support
- Scope Support: Optional scope specification for better organization
- Template System: Use templates or write custom commit messages
- Real-time Validation: Instant feedback on commit message quality
- Source Control Integration: Quick commit button directly in Source Control panel
Quick Start
Method 1: Quick Commit (Recommended)
- Install the Extension: Search for "CommitWeave" in the VS Code marketplace
- Stage Changes: Use VS Code's Source Control panel to stage files
- Quick Commit: Click "⚡ Quick Commit" in Source Control panel OR Command Palette → "CommitWeave: Quick Commit"
- Follow Prompts: Select commit type, add scope/message, and commit with validation
Method 2: CLI Integration
- Install CLI: Run
npm install -g @typeweaver/commitweave
- Stage Changes: Use
git add .
or stage files in VS Code's Source Control panel
- Create Commit: Command Palette (
Ctrl+Shift+P
) → "CommitWeave: Create Commit"
Requirements
- VS Code 1.80.0 or higher
- Git repository
- CommitWeave CLI (installed globally or available via npx)
Extension Settings
This extension contributes the following settings:
commitweave.emojiEnabled
: Enable emoji in commit messages (default: true
)
commitweave.aiProvider
: AI provider selection (openai
| anthropic
| mock
, default: openai
)
Commands
commitweave.create
: Launch interactive CLI-style commit creation
commitweave.ai
: Generate AI-powered commit message
commitweave.quickCommit
: Fast conventional commits with native VS Code UI
commitweave.validateCommit
: Validate last commit message
commitweave.configure
: Open enhanced tabbed settings panel
Command Palette Access
- CommitWeave: Create Commit → Full CLI experience in integrated terminal
- CommitWeave: AI Commit → AI-powered commit generation
- CommitWeave: Quick Commit → Native VS Code commit workflow
- CommitWeave: Validate Commit → Check last commit against standards
- CommitWeave: Configure → Open settings with tabs for Settings/History/Templates
Installation Methods
From VS Code Marketplace
- Open VS Code
- Go to Extensions (Ctrl+Shift+X)
- Search for "CommitWeave"
- Click Install
From VSIX File
- Download the
.vsix
file from releases
- In VS Code: View → Command Palette → "Extensions: Install from VSIX..."
- Select the downloaded file
CLI Installation
The extension requires the CommitWeave CLI:
# Global installation (recommended)
npm install -g @typeweaver/commitweave
# Or use npx (the extension will detect this automatically)
npx @typeweaver/commitweave --version
Troubleshooting
CLI Not Found
If you see "CLI not found" errors:
- Install globally:
npm install -g @typeweaver/commitweave
- Or ensure npx is available:
npm install -g npx
- Check PATH includes npm global bin directory
No Git Repository
Make sure you're working in a git repository:
git init # Initialize if needed
No Staged Changes
Stage your changes before creating commits:
git add . # Stage all changes
# Or use VS Code's Source Control panel
Development
To set up the extension for development:
# Clone the repository
git clone https://github.com/GLINCKER/commitweave.git
cd commitweave/vscode-extension
# Install dependencies
npm install
# Build
npm run build
# Test
npm test
# Package
npm run package
Contributing
Contributions are welcome! Please see our Contributing Guide for details.
Support
License
MIT License - see LICENSE for details.
🏢 Developed & Maintained by GLINR STUDIOS
📦 Published by @glincker
🧶✨ Part of the CommitWeave ecosystem