From 77672ae8f6d1d1df5d813bb55652a990a1e2b7d5 Mon Sep 17 00:00:00 2001 From: wayrk Date: Sun, 12 Apr 2026 18:05:34 +0300 Subject: [PATCH] docs: add Windows setup instructions to README - 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 --- README.md | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b284706618..ad17dea5b2 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,46 @@ cargo build --release -p rusty-claude-cli cp target/release/hackcode ~/.local/bin/ ``` -Works on **macOS** (Apple Silicon & Intel) and **Linux** (x64 & ARM64). Runs natively on **Kali Linux**. +Works on **macOS** (Apple Silicon & Intel), **Linux** (x64 & ARM64), and **Windows** (x64). Runs natively on **Kali Linux**. + +### Windows (PowerShell) + +Build from source: + +```powershell +git clone https://github.com/itwizardo/hackcode.git +cd hackcode\rust +cargo build --release -p rusty-claude-cli +``` + +Add to your PowerShell profile (`$PROFILE`): + +```powershell +$env:HOME = $env:USERPROFILE +$env:PATH += ";C:\path\to\hackcode\rust\target\release" +``` + +**Using with Anthropic API** (instead of local Ollama): + +The default model requires Ollama. To use the Anthropic API, set your API key and add a wrapper function to your profile: + +```powershell +$env:ANTHROPIC_API_KEY = "sk-ant-..." # or set via system env vars +function hackcode { hackcode.exe --model sonnet @args } +``` + +Verify the installation: + +```powershell +hackcode doctor # Health check +hackcode status # Workspace info +hackcode --help # Full command list +``` + +**Windows notes:** +- Sandbox isolation (Linux `unshare`) is unavailable; filesystem mode `workspace-only` remains active +- Some test suites use Unix-only APIs and will not compile on Windows — this does not affect the binary +- The `HOME` environment variable must be set for credential discovery to work ---