Skip to content

windows-setup.md

Latest commit

 

History

History
63 lines (45 loc) · 1.56 KB

windows-setup.md

File metadata and controls

63 lines (45 loc) · 1.56 KB

Windows Setup

This guide covers running Aegis natively on Windows for local development and CI-like verification.

Prerequisites

  • Node.js 20+ (Node.js 22 recommended)
  • npm 10+
  • Claude Code CLI installed and authenticated

Aegis bundles claude-agent-acp — no tmux or psmux required on any platform.

Install

Install Aegis dependencies:

git clone https://github.com/OneStepAt4time/aegis.git
cd aegis
npm ci
npm run build

Verification

Build, typecheck, and run tests:

npx tsc --noEmit
npm run build
npm test

Run a smoke check for the health endpoint:

$proc = Start-Process -FilePath node -ArgumentList 'dist/cli.js','--port','9100' -PassThru
node scripts/ci-smoke-health.mjs
Stop-Process -Id $proc.Id -Force

Expected health payload includes platform:

{
  "status": "ok",
  "version": "2.x.x",
  "platform": "win32"
}

Troubleshooting

  • If health checks time out, ensure port 9100 is not blocked by local firewall software.
  • If Claude sessions fail to launch, run claude --version and confirm CLI auth status.
  • If npm install or build fails due to antivirus locks, retry after excluding the repo temp/build folders.

Notes

  • Path handling differs on Windows (drive letters, backslashes); prefer normalized paths in tests and scripts.
  • Some shell snippets written for POSIX tools (grep, awk, find) are not portable; use PowerShell alternatives in Windows-specific scripts/workflows.
  • CI and local verification should always include a real /v1/health smoke check to catch platform drift early.