Skip to content

Commit e06e747

Browse files
committed
docs: update Windows installation instructions and prerequisites in README
1 parent 540e77c commit e06e747

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Token compression + context optimization for Claude Code, OpenCode, and GitHub C
1515

1616
## Install
1717

18+
> **Windows users:** squeez requires **Git Bash** to run. PowerShell and CMD are not supported — the hooks and binary rely on a POSIX shell environment. Open Git Bash and run:
19+
1820
```bash
1921
curl -fsSL https://raw.githubusercontent.com/claudioemmanuel/squeez/main/install.sh | sh
2022
```
@@ -130,7 +132,7 @@ SQUEEZ_DIR=~/.copilot/squeez ~/.claude/squeez/bin/squeez init --copilot
130132

131133
## Local development
132134

133-
**Prerequisites:** Rust stable, `bash` (Git Bash on Windows). Works on Windows, macOS, and Linux.
135+
**Prerequisites:** Rust stable, `bash` (Git Bash on Windows — PowerShell is not supported). Works on Windows (Git Bash), macOS, and Linux.
134136

135137
Install Rust via [rustup](https://rust-lang.org/tools/install/):
136138
```bash

0 commit comments

Comments
 (0)