GLINR Studio LogoTypeWeaver
Installation

Windows Installation

Install CommitWeave on Windows using various methods

Edit on GitHub

CommitWeave works seamlessly on Windows with multiple installation options available.

Package Managers

Chocolatey

Coming Soon

Chocolatey package is in development.

# Coming soon
choco install commitweave

Scoop

Coming Soon

Scoop package is in development.

# Coming soon
scoop install commitweave

winget

Coming Soon

Windows Package Manager support is in development.

# Coming soon
winget install typeweaver.commitweave

The most reliable method is using Node.js package managers:

npm install -g @typeweaver/commitweave
yarn global add @typeweaver/commitweave
pnpm add -g @typeweaver/commitweave

Prerequisites

Install Node.js

Download the Windows installer from nodejs.org:

  • Choose the LTS version (18.x or higher)
  • Select "Add to PATH" during installation
  • Install for all users (recommended)

Install Git

Download Git for Windows from git-scm.com:

  • Choose "Git from the command line and also from 3rd-party software"
  • Select "Use bundled OpenSSH"
  • Choose "Checkout Windows-style, commit Unix-style line endings"

Install CommitWeave

Open Command Prompt or PowerShell as Administrator:

npm install -g @typeweaver/commitweave

Windows-Specific Features

PowerShell Integration

Add PowerShell completion for enhanced experience:

# Add to PowerShell profile
if (!(Test-Path $PROFILE)) {
    New-Item -Path $PROFILE -Type File -Force
}
Add-Content $PROFILE "commitweave completion powershell | Out-String | Invoke-Expression"

Windows Terminal

For the best experience, use Windows Terminal:

// settings.json
{
  "profiles": {
    "defaults": {
      "fontFace": "Cascadia Code",
      "fontSize": 10
    }
  }
}

WSL Integration

If using Windows Subsystem for Linux, install CommitWeave in both environments:

# Windows Command Prompt/PowerShell
npm install -g @typeweaver/commitweave
# WSL Terminal
npm install -g @typeweaver/commitweave

IDE Integration

Visual Studio Code

  1. Install the CommitWeave VSCode Extension from the marketplace
  2. Configure in VSCode settings:
{
  "commitweave.enabled": true,
  "commitweave.aiProvider": "openai"
}

Visual Studio

For Visual Studio users, set up Git hooks:

  1. Navigate to Tools > Options > Source Control > Git Global Settings
  2. Set up pre-commit hooks pointing to CommitWeave

Troubleshooting

Execution Policy (PowerShell)

If you encounter execution policy errors:

# Check current policy
Get-ExecutionPolicy

# Set execution policy (run as Administrator)
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

PATH Issues

If commitweave command is not found:

# Check npm global directory
npm config get prefix

# Add to PATH permanently
setx PATH "%PATH%;%APPDATA%\npm"
# Check npm global directory
npm config get prefix

# Add to PATH permanently
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";" + $env:APPDATA + "\npm", "User")

Antivirus Interference

Some antivirus software may flag Node.js executables:

  1. Windows Defender: Add Node.js and npm directories to exclusions
  2. Third-party AV: Configure to allow Node.js global packages

Long Path Support

Enable long path support for deep project structures:

# Run as Administrator
reg add "HKLM\SYSTEM\CurrentControlSet\Control\FileSystem" /v LongPathsEnabled /t REG_DWORD /d 1

Line Ending Issues

Configure Git to handle line endings correctly:

# Global configuration
git config --global core.autocrlf true
git config --global core.safecrlf false

Performance Optimization

Faster Installs

Use faster npm registry mirrors:

# Use npm registry mirror
npm config set registry https://registry.npmmirror.com/

# Or use cnpm
npm install -g cnpm
cnpm install -g @typeweaver/commitweave

Disk Space

Clean npm cache if running low on disk space:

npm cache clean --force
npm cache verify

Next Steps

After installation on Windows:

  1. Configure environment: Set up API keys in environment variables
  2. Initialize project: Run commitweave init in your Git repository
  3. Test installation: Verify with commitweave --version

Consider using Windows Terminal with PowerShell 7 for the best CommitWeave experience on Windows.