Skip to content

docs: add Windows / WSL note to README install section (#10) #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
theDakshJaitly merged 2 commits into from
Jun 6, 2026
Merged

docs: add Windows / WSL note to README install section (#10) #65

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39af3a9
docs: add Windows / WSL note to README install section (#10)
mvanhorn Apr 28, 2026
a6c9391
docs: add prominent Windows callout for legacy setup.sh users
advancedresearcharray Jun 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,16 @@ Install globally later at any time:
npm install -g mex-agent
```

### Windows

The recommended `npx mex-agent setup` flow runs in any terminal (Command Prompt, PowerShell, or WSL) and does not need bash, so most Windows users do not have to think about this section.

> **Windows users (legacy `setup.sh` flow):** Run all commands inside WSL or Git Bash. Do not mix environments.

If you previously installed via the legacy `setup.sh` script, building inside WSL and then running the CLI from a native Windows terminal causes "module not found" errors because `node_modules` and path resolution differ between the two filesystems. Run install, build, and CLI commands inside the same environment: either entirely in WSL / Git Bash, or entirely in native Windows via `npx mex-agent`.

See [issue #10](https://github.com/theDakshJaitly/mex/issues/10) for context.

## How It Works

![mex context routing flow](docs/diagrams/context-routing.svg)
Expand Down
Loading