Installation Guide

This guide walks you through setting up the Sigao AI DevKit and your development environment.

Prerequisites

• Ubuntu 20.04+ or WSL2 with Ubuntu (see WSL Setup Guide)
• Node.js 18+ (will be installed if missing)
• Basic command line knowledge

🚀 Quick Start (Recommended)

Bootstrap Method - Zero Configuration

The easiest way to get started is with our bootstrap package:

# For most systems:
npx @sigaostudios/bootstrap

# For WSL users (if you get Windows PATH errors):
/usr/bin/npx @sigaostudios/bootstrap

The bootstrap will:

• ✅ Install Node.js and GitHub CLI if needed
• ✅ Authenticate with GitHub (one-time setup)
• ✅ Configure npm for private packages
• ✅ Launch the Sigao installer

Fresh WSL Setup

Starting with a brand new WSL instance? Here's the complete setup:

# 1. Create a fresh WSL instance (from PowerShell)
wsl --install Ubuntu-24.04 --name claude-code --location C:\wsl-distros\claude-code
wsl -d claude-code

# 2. Inside WSL, install npm first:
sudo apt update && sudo apt install -y nodejs npm

# 3. Run the bootstrap:
npx @sigaostudios/bootstrap

⚠️ Common WSL Issue: If you see "CMD.EXE was started" errors, you have Windows tools in your PATH. Use: /usr/bin/npx @sigaostudios/bootstrap

Installation Options

🎯 Option 1: Interactive Sigao CLI

Install and run the Sigao CLI for full control:

# Install globally
npm install -g @sigaostudios/sigao-cli

# Run interactive setup
sigao

# Or install specific components
sigao -c node,docker,python,claude

# List all available components
sigao --list

Available Components:

• Core: shell, essentials, git-config
• Development: cli-tools, node, claude, shell-enhancements
• Languages: dotnet, docker, python, python-tools
• Cloud: azure-cli

🚀 Option 2: Install Everything

For a complete development environment:

# Using bootstrap (recommended)
npx @sigaostudios/bootstrap

# Or using sigao CLI
sigao --yes

This gives you:

• ✅ Complete modern development environment
• ✅ 40+ CLI tools (ripgrep, fzf, bat, eza, zoxide, etc.)
• ✅ Node.js, Docker, Python, .NET SDK support
• ✅ Claude CLI for AI coding
• ✅ Smart shell with aliases and navigation helpers
• ✅ Workpackage automation system

🤖 Workpackage Automation

The Sigao CLI includes powerful AI-powered automation:

# Generate a workpackage from requirements
sigao generate requirements.md my-project.json

# Execute the workpackage
sigao work my-project.json --output-dir ./my-project

# Use a specific Claude model
sigao work my-project.json --model opus

Learn more about workpackages →

Post-Installation

After installation:

1. Reload your shell:

   source ~/.bashrc  # or ~/.zshrc if using Zsh
   

2. Verify installation:

   # Check Node.js
   node --version
   
   # Check Sigao CLI
   sigao --version
   
   # Check Git configuration
   git config --list
   
   # Check Docker (if installed)
   docker --version
   

3. Clone the DevKit (optional):

   git clone https://github.com/sigaostudios/sigao-ai-devkit.git
   cd sigao-ai-devkit
   

WSL-Specific Features

If you're using WSL2:

• Git Credential Manager is automatically configured to use Windows credentials
• PATH isolation prevents Windows/Linux tool conflicts
• Locale is properly configured to avoid warnings
• Browser integration for opening URLs from terminal

Troubleshooting

npm/npx not found

# Install Node.js and npm
sudo apt update && sudo apt install -y nodejs npm

Windows PATH contamination in WSL

# Use Linux-specific paths
/usr/bin/npx @sigaostudios/bootstrap
/usr/bin/npm install -g @sigaostudios/sigao-cli

Permission denied with Docker

# Add user to docker group
sudo usermod -aG docker $USER
# Then log out and back in, or run:
newgrp docker

GitHub authentication issues

# Re-authenticate with GitHub
gh auth login -s read:packages -p https

Locale warnings

sudo locale-gen en_US.UTF-8
sudo update-locale LANG=en_US.UTF-8

Next Steps

• Continue to the Quick Start guide
• Learn about Workpackage Automation
• Explore Sigao CLI Commands
• Set up your IDE

Need help? Open an issue