Windows Installation
Install CommitWeave on Windows using various methods
CommitWeave works seamlessly on Windows with multiple installation options available.
Package Managers
Chocolatey
Coming Soon
Chocolatey package is in development.
# Coming soon
choco install commitweaveScoop
Coming Soon
Scoop package is in development.
# Coming soon
scoop install commitweavewinget
Coming Soon
Windows Package Manager support is in development.
# Coming soon
winget install typeweaver.commitweaveNode.js Package Managers (Recommended)
The most reliable method is using Node.js package managers:
npm install -g @typeweaver/commitweaveyarn global add @typeweaver/commitweavepnpm add -g @typeweaver/commitweavePrerequisites
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/commitweaveWindows-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/commitweaveIDE Integration
Visual Studio Code
- Install the CommitWeave VSCode Extension from the marketplace
- Configure in VSCode settings:
{
"commitweave.enabled": true,
"commitweave.aiProvider": "openai"
}Visual Studio
For Visual Studio users, set up Git hooks:
- Navigate to Tools > Options > Source Control > Git Global Settings
- 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 CurrentUserPATH 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:
- Windows Defender: Add Node.js and npm directories to exclusions
- 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 1Line Ending Issues
Configure Git to handle line endings correctly:
# Global configuration
git config --global core.autocrlf true
git config --global core.safecrlf falsePerformance 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/commitweaveDisk Space
Clean npm cache if running low on disk space:
npm cache clean --force
npm cache verifyNext Steps
After installation on Windows:
- Configure environment: Set up API keys in environment variables
- Initialize project: Run
commitweave initin your Git repository - Test installation: Verify with
commitweave --version
Consider using Windows Terminal with PowerShell 7 for the best CommitWeave experience on Windows.