Skip to content

docs: add Windows setup instructions to README#2

Open
wayrk wants to merge 1 commit into
devfrom
docs/windows-setup
Open

docs: add Windows setup instructions to README#2
wayrk wants to merge 1 commit into
devfrom
docs/windows-setup

Conversation

@wayrk

@wayrk wayrk commented Apr 12, 2026

Copy link
Copy Markdown
Owner

Summary

Adds Windows (PowerShell) setup documentation to the README, covering the full workflow from building to running HackCode on Windows.

Changes

  • Updated platform support line to include Windows (x64)
  • Added Windows (PowerShell) subsection under Install with:
    • Build-from-source instructions
    • PowerShell profile setup ($env:HOME, $env:PATH)
    • Anthropic API configuration with a wrapper function for default model
    • Verification commands (doctor, status, --help)
    • Platform-specific notes (sandbox unavailable, Unix-only test suites, HOME requirement)

Testing

All instructions were verified on Windows x86_64 with PowerShell 7.6.0:

  • cargo build --workspace succeeds
  • hackcode doctor passes (4 OK, 1 expected sandbox warning)
  • hackcode --model sonnet prompt "..." returns correct AI responses
  • Wrapper function function hackcode { hackcode.exe --model sonnet @args } works as documented
  • Session resume, status, and JSON output all verified

Warp conversation

Co-Authored-By: Oz oz-agent@warp.dev

- Add Windows (PowerShell) build-from-source instructions
- Document Anthropic API configuration with wrapper function
- Add Windows-specific notes (sandbox, tests, HOME env var)
- Update platform support line to include Windows

Co-Authored-By: Oz <oz-agent@warp.dev>
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