Core Commands

CommitWeave provides a comprehensive set of commands for different workflows and needs.

AI Command

Generate intelligent commit messages using AI analysis of your staged changes.

# Basic AI commit generation
commitweave ai

# Specify AI model
commitweave ai --model claude-3-5-sonnet

# Include additional context
commitweave ai --context "Refactoring authentication system"

Synopsis: Analyzes staged changes using AI models (GPT-4, Claude) to generate contextual commit messages following conventional commit standards.

AI Performance Tip: Stage related files together and provide context with --context for more accurate commit messages. The AI analyzes file diffs, so meaningful staging leads to better results.

Learn more about AI configuration →

Commit Command

Interactive commit creation with guided prompts for conventional commits.

# Interactive commit builder
commitweave commit

# Quick commit with type and message
commitweave commit --type feat --message "add user authentication"

# Include scope and body
commitweave commit --type fix --scope auth --body "Resolves token expiration issues"

Synopsis: Provides step-by-step guidance for creating well-structured conventional commits with proper formatting and metadata.

View commit options →

Quick Command

Streamlined commit workflow for rapid development cycles.

# Fastest commit generation
commitweave quick

# Quick commit with auto-detected type
commitweave quick --auto

# Skip confirmations
commitweave quick --yes

Synopsis: Optimized for speed, automatically detects likely commit types and generates commits with minimal user interaction.

See quick options →

Validate Command

Verify commit message format and compliance with conventional commit standards.

# Validate current commit message
commitweave validate

# Validate specific message
commitweave validate --message "feat(auth): add JWT support"

# Validate commit history
commitweave validate --range HEAD~5..HEAD

Synopsis: Ensures commit messages follow conventional commit format, validates structure, and checks for required components.

Explore validation rules →

Doctor Command

Comprehensive health check and diagnostic tool for CommitWeave configuration.

# Run full system diagnostics
commitweave doctor

# Check specific components
commitweave doctor --check config,ai,git

# Generate detailed report
commitweave doctor --verbose --output doctor-report.txt

Synopsis: Analyzes system configuration, Git setup, AI model connectivity, and identifies potential issues or optimization opportunities.

View doctor checks →

Utility Commands

Aliases Command

Manage Git aliases for CommitWeave commands to streamline your workflow.

# List current aliases
commitweave aliases

# Create common aliases
commitweave aliases --setup

# Add custom alias
commitweave aliases --add cw="commitweave ai"

Synopsis: Simplifies CommitWeave usage by creating convenient Git aliases for frequently used commands.

Workflow Optimization: Set up aliases with commitweave aliases --setup to use shortcuts like git cw instead of commitweave ai. This dramatically speeds up your daily commit workflow.

Configure aliases →

Version Command

Display CommitWeave version and build information.

# Show version info
commitweave v
# or
commitweave --version

# Detailed version information
commitweave v --detailed

Synopsis: Shows current version, build date, and compatibility information for troubleshooting and support.

List Command

Explore available commit types, scopes, and templates.

# List all commit types
commitweave ls types

# Show available scopes
commitweave ls scopes

# Display templates
commitweave ls templates

Synopsis: Provides quick reference for conventional commit types, configured scopes, and available message templates.

Browse available options →

Health Command

Quick status check for CommitWeave functionality.

# Basic health check
commitweave health

# Include AI model connectivity
commitweave health --full

# Monitor mode
commitweave health --watch

Synopsis: Performs lightweight system checks to ensure CommitWeave is functioning correctly with your Git repository and configuration.

Health monitoring guide →

Workflow Examples

AI-Powered Development

# Make changes to authentication system
git add src/auth/

# Generate intelligent commit message
commitweave ai

# Result: feat(auth): ✨ implement OAuth2 integration with JWT refresh tokens

Quick Development Cycle

# Rapid feature development
git add src/components/UserDashboard.tsx

# Fast commit with auto-detection
commitweave quick --auto

# Result: feat(ui): add user dashboard component

Validation-Driven Workflow

# Validate existing commits
commitweave validate --range HEAD~3..HEAD

# Ensure new commit follows standards
git add src/utils/helpers.ts
commitweave commit --type refactor --validate

Health Monitoring

# Check system before important commits
commitweave health --full

# Run diagnostics for troubleshooting
commitweave doctor --verbose

Best Practices

Use AI for Complex Changes: Let AI analyze intricate modifications
Quick for Simple Updates: Use quick command for straightforward commits
Validate Regularly: Check commit history compliance with validate
Monitor System Health: Run health checks before major releases
Configure Aliases: Set up shortcuts for frequently used commands

Command Quick Reference

Command	Primary Use Case	Key Features
`commitweave ai`	Complex changes requiring context	AI analysis, model selection
`commitweave commit`	Standard interactive commits	Step-by-step guidance
`commitweave quick`	Rapid development cycles	Auto-detection, minimal prompts
`commitweave validate`	Quality assurance	Format validation, compliance
`commitweave doctor`	System diagnostics	Health checks, troubleshooting
`commitweave aliases`	Workflow optimization	Git alias management
`commitweave v`	Version information	Build details, compatibility
`commitweave ls`	Reference lookup	Available types, scopes, templates
`commitweave health`	Status monitoring	Quick functionality check

Explore these related topics to enhance your CommitWeave workflow:

Terminal

Usage