Skip to content

docs: note WSL2 support with install-inside-WSL requirement#116

Merged
George-iam merged 1 commit intomainfrom
docs/readme-wsl2-support-20260417
Apr 17, 2026
Merged

docs: note WSL2 support with install-inside-WSL requirement#116
George-iam merged 1 commit intomainfrom
docs/readme-wsl2-support-20260417

Conversation

@George-iam
Copy link
Copy Markdown
Contributor

Summary

Adds an explicit "Windows via WSL2" note to the Quick Start in README.md, after the Linux/macOS install line. End-to-end verified on 2026-04-17 on an Azure Win11 Pro 24H2 D2s_v5 VM running WSL2 Ubuntu 22.04 (kernel 6.6.87):

  • install.sh downloads linux-x64 binary correctly
  • axme-code setup with real Claude subscription OAuth — 9 LLM-extracted decisions + 13 presets, $0.31, 115s, zero errors
  • MCP server stdio initialize handshake returns proper serverInfo
  • PreToolUse hook blocks rm -rf / (permissionDecision: deny), allows ls
  • Full claude --print session — SessionEnd hook fires, detached audit worker spawns and completes with audit_complete written to worklog.jsonl (cost $0.086)
  • 510 / 511 unit tests pass in WSL kernel (the one flaky test was fixed in fix: bump session lock wait to 3s so slow I/O does not race duplicates #115)

Critical caveat captured in the README

Claude Code must be installed inside the WSL distro, not on the Windows host. A Linux binary in WSL cannot be spawned over stdio by a Windows-side Claude Code — users who install Claude Code natively on Windows and try to point it at a WSL-side axme-code will hit this silently. The README now says this in the same sentence so it is impossible to miss.

What's NOT claimed yet

Native Windows (cmd.exe / PowerShell, no WSL) is still explicitly called out as not supported. That's the next phase.

Test plan

  • Read through the Quick Start — wording reads naturally inline with the existing install-sh line
  • No code changes, no tests affected
  • Site SEO (schema.org JSON-LD in axme-code-site) stays at "Linux, macOS" for now — can extend in a follow-up if we want Windows searches to find us

🤖 Generated with Claude Code

End-to-end verified on 2026-04-17 on Win11 Pro 24H2 + WSL2 Ubuntu 22.04
(kernel 6.6.87): install.sh, axme-code setup with real Claude
subscription OAuth, MCP server stdio handshake, PreToolUse hook
block/allow, full Claude Code session, detached audit worker
completion. Details in wsl2-full-e2e-verified-2026-04-17 memory.

Critical caveat the README must land up front: Claude Code must be
installed inside the WSL distro, not on the Windows host — the Linux
binary in WSL cannot be spawned by a Windows-side Claude Code over
stdio.

#!axme pr=none repo=AxmeAI/axme-code
@George-iam George-iam merged commit 186515f into main Apr 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant