From c6f7d6bb6daacc209a287bcac6be655f05098bef Mon Sep 17 00:00:00 2001 From: DavidKoleczek <45405824+DavidKoleczek@users.noreply.github.com> Date: Thu, 20 Aug 2026 11:39:35 -0400 Subject: [PATCH] docs: show Windows install command alongside Linux/macOS MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Windows users needed to run the installer through Git Bash and enable git long paths first, but that requirement was buried in a note in INSTALL.md and absent from the README entirely. Put the Windows invocation directly in the install code block in both places so it is visible at the point of use, and drop the now-redundant long-paths callout. 🤖 Generated with [Amplifier](https://github.com/microsoft/amplifier) Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com> --- README.md | 6 ++++++ docs/INSTALL.md | 22 ++++++---------------- 2 files changed, 12 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 6c2afb6b..ca989f0e 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,13 @@ Public integrations run opencode, paperclip, and NanoClaw on it: see [who has in ## Install ```bash +# Linux, MacOS curl -fsSL https://raw.githubusercontent.com/microsoft/amplifier-agent/main/install.sh | bash + +# Windows requires Git, Git Bash, and git long paths enabled +git config --global core.longpaths true +# Fill in C:\ with where your Git is installed +& "C:\\Git\bin\bash.exe" -lc "curl -fsSL https://raw.githubusercontent.com/microsoft/amplifier-agent/main/install.sh | bash" ``` Installs the latest release and primes the bundle cache so your first run is instant. Requires [`uv`](https://docs.astral.sh/uv/), `curl`, and `git`; the installer tells you what is missing rather than bootstrapping silently. `git` is a runtime dependency too -- bundles and modules are fetched by cloning git repositories. diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 7eac58b7..2a6c3d8e 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -6,24 +6,14 @@ `git` is needed at run time, not just at install time: bundles and modules are fetched by cloning git repositories, so a machine without `git` on `PATH` can neither prime the cache nor mount a bundle. On Windows, installing [Git for Windows](https://git-scm.com/download/win) satisfies this and also provides the `bash` that the shell tool looks for. -> **Windows: enable git long paths before installing.** This repo ships evaluation -> fixtures whose paths reach ~178 characters. `uv tool install --from git+...` clones -> the repo into a deep temporary build directory, which pushes those paths past -> Windows' 260-character `MAX_PATH` limit — the install then fails with -> `fatal: cannot create directory ... Filename too long`. Enable long-path support -> once, before installing: -> -> ```powershell -> git config --global core.longpaths true -> ``` -> -> (For paths that also exceed `MAX_PATH` at the OS level, additionally enable -> `Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem\LongPathsEnabled = 1`.) - -## Recommended - ```bash +# Linux, MacOS curl -fsSL https://raw.githubusercontent.com/microsoft/amplifier-agent/main/install.sh | bash + +# Windows requires Git, Git Bash, and git long paths enabled +git config --global core.longpaths true +# Fill in C:\ with where your Git is installed (just bash.exe may launch WSL instead) +& "C:\\Git\bin\bash.exe" -lc "curl -fsSL https://raw.githubusercontent.com/microsoft/amplifier-agent/main/install.sh | bash" ``` Installs the latest released version and primes the bundle cache so your first run is instant.