Skip to content

Commit 57943b1

Browse files
committed
docs: reframe Windows setup — PowerShell is supported, Git Bash/WSL optional
Previous wording said 'recommended shell is Git Bash or WSL (not PowerShell, not cmd)' which was incorrect — claw builds and runs fine in PowerShell. New framing: - PowerShell: supported primary Windows path with PowerShell-style commands - Git Bash / WSL: optional alternatives, not requirements - MINGW64 note moved to Git Bash callout (no longer implies it is required) Source: gaebal-gajae correction 2026-04-10.
1 parent 4730b66 commit 57943b1

1 file changed

Lines changed: 13 additions & 18 deletions

File tree

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -72,34 +72,29 @@ export ANTHROPIC_API_KEY="sk-ant-..."
7272
> [!NOTE]
7373
> **Windows (PowerShell):** the binary is `claw.exe`, not `claw`. Use `.\target\debug\claw.exe` or run `cargo run -- prompt "say hello"` to skip the path lookup.
7474
75-
### Windows setup (Git Bash / WSL)
75+
### Windows setup
7676

77-
If you are on Windows, the recommended shell is **Git Bash** (ships with Git for Windows) or **WSL**. Full sequence:
77+
**PowerShell is a supported Windows path.** Use whichever shell works for you. The common onboarding issues on Windows are:
7878

79-
1. **Install Rust** — download from <https://rustup.rs/> and run the installer. Close and reopen the terminal when it finishes.
80-
2. **Open Git Bash** — search for "Git Bash" in the Start menu (not PowerShell, not cmd). The prompt shows `MINGW64` — this is normal and expected, not a broken install.
81-
3. **Verify Rust is on PATH:**
82-
```bash
79+
1. **Install Rust first** — download from <https://rustup.rs/> and run the installer. Close and reopen your terminal when it finishes.
80+
2. **Verify Rust is on PATH:**
81+
```powershell
8382
cargo --version
8483
```
85-
If you see `bash: cargo: command not found`, run `. ~/.cargo/env` or restart Git Bash, then retry.
86-
4. **Use bash-style paths** — in Git Bash, `C:\Users\you` becomes `/c/Users/you`:
87-
```bash
88-
cd /c/Users/you/projects
89-
```
90-
5. **Clone and build:**
91-
```bash
84+
If this fails, reopen your terminal or run the PATH setup from the Rust installer output, then retry.
85+
3. **Clone and build** (works in PowerShell, Git Bash, or WSL):
86+
```powershell
9287
git clone https://github.com/ultraworkers/claw-code
9388
cd claw-code/rust
9489
cargo build --workspace
9590
```
96-
6. **Run:**
97-
```bash
98-
export ANTHROPIC_API_KEY="sk-ant-..."
99-
./target/debug/claw prompt "say hello"
91+
4. **Run** (PowerShell — note `.exe` and backslash):
92+
```powershell
93+
$env:ANTHROPIC_API_KEY = "sk-ant-..."
94+
.\target\debug\claw.exe prompt "say hello"
10095
```
10196

102-
> **WSL tip:** WSL2 (`wsl --install` from an admin PowerShell) is the most friction-free Windows path — follow the Linux quick-start steps inside the WSL terminal.
97+
**Git Bash / WSL** are optional alternatives, not requirements. If you prefer bash-style paths (`/c/Users/you/...` instead of `C:\Users\you\...`), Git Bash (ships with Git for Windows) works well. In Git Bash, the `MINGW64` prompt is expected and normal — not a broken install.
10398

10499
> [!NOTE]
105100
> **Auth:** claw requires an **API key** (`ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, etc.) — Claude subscription login is not a supported auth path.

0 commit comments

Comments
 (0)