Quick Start

Get CommitWeave running in under 5 minutes with the most common installation method:

npm install -g @typeweaver/commitweave
commitweave init

yarn global add @typeweaver/commitweave
commitweave init

pnpm add -g @typeweaver/commitweave
commitweave init

System Requirements

CommitWeave requires Node.js 18+ and Git to be installed on your system.

Installation Methods

Choose your preferred installation method based on your platform and requirements:

NPM, Yarn & PNPM

Install using Node.js package managers - most common method

Perfect for developers with Node.js already installed. Supports global and project-specific installation.

macOS Installation

macOS-specific installation with Homebrew, shell integration, and Xcode support

Native macOS experience with Apple Silicon support, Terminal integration, and development tools.

Windows Installation

Windows installation with PowerShell, Visual Studio integration, and WSL support

Complete Windows support including Chocolatey, PowerShell completion, and IDE integration.

Docker & Containers

Containerized deployment for CI/CD pipelines and team environments

Production-ready containers with Kubernetes support, perfect for automated workflows.

Prerequisites

Before installing CommitWeave, ensure you have:

Node.js 18+

CommitWeave requires Node.js 18.0 or higher. Check your version:

node --version

Download Node.js →

Git

Git must be installed and configured:

git --version
git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"

AI Provider (Optional)

For AI-powered commits, set up an API key:

OpenAI: Get API key
Anthropic: Get API key

Verification

After installation, verify CommitWeave is working correctly:

# Check version
commitweave --version

# Test help command  
commitweave --help

# Test in a Git repository (preview mode)
cd /path/to/your/git/repo
commitweave --preview

Installation Complete

If all commands run without errors, CommitWeave is successfully installed!

Next Steps

Now that CommitWeave is installed:

Initialize Configuration: Run commitweave init in your Git repository
Configure AI Provider: Set up OpenAI or Anthropic API keys
Create Your First Commit: Try commitweave --ai for AI-powered commit generation
Explore Advanced Features: Check out team workflows and VSCode integration

Usage Guide

Learn how to use CommitWeave effectively

Basic and advanced usage patterns for individual developers and teams.

Configuration

Customize CommitWeave for your workflow

AI providers, commit types, team settings, and advanced customization options.

Examples & Workflows

Real-world usage scenarios

Common patterns, team workflows, and integration examples.

Need help? Check our troubleshooting guide or CLI reference for detailed information.

Installation