From 39af3a9bd6447254c28d107ed7b8b6b30c9cf8ab Mon Sep 17 00:00:00 2001 From: Matt Van Horn <455140+mvanhorn@users.noreply.github.com> Date: Tue, 28 Apr 2026 00:24:23 -0700 Subject: [PATCH 1/2] docs: add Windows / WSL note to README install section (#10) Adds a short Windows subsection that: - points users at `npx promexeus setup` as the friction-free path - warns against mixing WSL + native Windows when using `setup.sh` - links back to issue #10 for context Documents the mitigation the maintainer described in the issue thread (npx path sidesteps it completely). No code changes. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 84f6f85..6e5765f 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,14 @@ 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. + +If you previously installed via the legacy `setup.sh` script, do not mix environments. 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) From a6c939107107470770a2b47396931c44e6ad7a1e Mon Sep 17 00:00:00 2001 From: CK Date: Sat, 6 Jun 2026 05:31:27 +0000 Subject: [PATCH 2/2] docs: add prominent Windows callout for legacy setup.sh users Adds a blockquote with the issue #10 wording so the WSL/Git Bash warning is visible at a glance without changing the npx-first guidance. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e5765f..1306002 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,9 @@ npm install -g mex-agent 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. -If you previously installed via the legacy `setup.sh` script, do not mix environments. 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`. +> **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.