Installation

Installation

Quick Install

Requires Node.js 18+

# Install globally via npm
npm install -g sigmap

# Or use npx (no install)
npx sigmap --version

Verify Installation

# Check version
sigmap --version

# Run health check
sigmap --health

Expected output shows SigMap version and project health score (0-100).

---

Installation Methods

Option 1: npm Global (Recommended)

npm install -g sigmap
sigmap --version

Pros: Fast, simple, single command
Cons: Updates require npm install -g sigmap@latest

Option 2: npx (No Installation)

npx sigmap --version
npx sigmap ask "explain the auth flow"

Pros: Always latest version, no disk space
Cons: Slower first run (downloads ~50MB)

Option 3: Standalone Binary

Download from GitHub Releases:

# macOS/Linux
chmod +x sigmap-darwin-arm64
./sigmap-darwin-arm64 --version

# Linux (x64)
chmod +x sigmap-linux-x64
./sigmap-linux-x64 --version

# Windows
sigmap-win32-x64.exe --version

Pros: No Node.js required, works offline
Cons: Larger file size (~80MB)

---

Platform-Specific Notes

macOS

• M1/M2/M3 (ARM): Use sigmap-darwin-arm64
• Intel: Use sigmap-darwin-x64
• First run may trigger "unidentified developer" warning — click "Open Anyway"

Linux

• Requires glibc 2.28+
• Tested on Ubuntu 20.04+, Fedora 35+
• WSL2 on Windows: Supported

Windows

• Requires Windows 10+ or Windows Server 2019+
• Use PowerShell or CMD
• Git Bash: Supported

---

Troubleshooting Installation

sigmap: command not found

Solution: npm install location not in PATH

# Check npm global bin path
npm config get prefix

# Add to ~/.zshrc or ~/.bashrc
export PATH="$(npm config get prefix)/bin:$PATH"
source ~/.zshrc

Permission denied (Linux/macOS)

# Make binary executable
chmod +x sigmap-darwin-arm64
./sigmap-darwin-arm64 --version

"Cannot find module" error

Solution: Reinstall to clear cache

npm install -g sigmap@latest

---

Next Steps

1. Generate your first context
2. Set up your IDE
3. Read the main docs