mirror of
https://github.com/coleam00/Archon
synced 2026-04-21 13:37:41 +00:00
- Replace all dynamous-community/remote-coding-agent references with coleam00/Archon - Replace all ghcr.io/dynamous-community/remote-coding-agent with ghcr.io/coleam00/archon - Change license from proprietary Dynamous to MIT - Fix cd directory name in docs (remote-coding-agent → Archon) - Remove hardcoded local paths from skills and docs - Add Windows x64 binary to release pipeline (cross-compiled from Linux) - Add --minify --bytecode flags to binary compilation - Create PowerShell install script (scripts/install.ps1) - Fix isBinaryBuild() detection for Bun 1.3.5+ (use import.meta.dir virtual FS check) - Scaffold Astro Starlight docs site at website/ (Astro 6 + Starlight 0.38) - Add deploy-docs.yml workflow for GitHub Pages - Update test.yml branch triggers (develop → dev) - Add install section with curl/PowerShell/Homebrew/Docker to README - Add badges and archon.diy docs link to README - Create SECURITY.md with vulnerability disclosure policy - Update CONTRIBUTING.md for public audience - Add website/ and eslint ignores for Astro-generated files Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2 KiB
2 KiB
Windows Setup
Archon runs on Windows in two ways:
- Native Windows with Bun: Works for basic usage (server, Web UI, simple workflows). No WSL2 required. Install Bun for Windows, clone the repo, and run
bun install && bun run dev. - WSL2 (recommended): Required for full compatibility, especially git worktree isolation, shell-based workflow steps, and CLI features that depend on Unix tooling.
The rest of this guide covers the WSL2 setup for full compatibility.
Why WSL2?
The Archon CLI relies on Unix-specific features and tools:
- Git worktree operations with symlinks
- Shell scripting for AI agent execution
- File system operations that differ between Windows and Unix
WSL2 provides a full Linux environment that runs seamlessly on Windows.
Quick WSL2 Setup
-
Install WSL2 (requires Windows 10 version 2004+ or Windows 11):
wsl --installThis installs Ubuntu by default. Restart your computer when prompted.
-
Set up Ubuntu: Open "Ubuntu" from the Start menu and create a username/password.
-
Install Bun in WSL2:
curl -fsSL https://bun.sh/install | bash source ~/.bashrc -
Clone and install Archon:
git clone https://github.com/coleam00/Archon cd Archon bun install -
Make CLI globally available:
cd packages/cli bun link -
Verify installation:
archon version
Working with Windows Files
WSL2 can access your Windows files at /mnt/c/ (for C: drive):
archon workflow run assist --cwd /mnt/c/Users/YourName/Projects/my-repo "What does this code do?"
For best performance, keep projects inside the WSL2 file system (~/projects/) rather than /mnt/c/.
Tips
- VS Code Integration: Install the "Remote - WSL" extension to edit WSL2 files from VS Code
- Terminal: Windows Terminal provides excellent WSL2 support
- Git: Use Git inside WSL2 for consistent behavior with Archon