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.