From 2f25121ae1ea10afdddc360a08e0186e4210dfc6 Mon Sep 17 00:00:00 2001 From: Spicer Matthews Date: Wed, 22 Jul 2026 15:16:14 -0700 Subject: [PATCH] docs: note Windows install needs Go on PATH (follow-up to #45) The Windows build step compiles from source with the Go toolchain and has no prebuilt-binary fallback like the Linux/macOS sh script, so Windows installs require Go on PATH. Document that in the README and the installation docs, and refresh the now-stale "not tested on Windows" / Linux+macOS-only platform lines now that Windows is supported and validated against herdr's Windows beta. --- README.md | 7 +++++++ www/content/docs/installation.md | 10 +++++++++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 01bd7be..0c46e52 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,13 @@ and **falls back to downloading the latest prebuilt release binary**, so it work `herdr plugin action list --plugin cloudmanic.herdr-plus`, and `herdr plugin uninstall cloudmanic.herdr-plus`. +> **Windows** (herdr's Windows support is in preview): the plugin installs and +> runs on Windows, but its build step compiles straight from source with the Go +> toolchain — there's **no prebuilt-binary fallback** like the Linux/macOS `sh` +> script has — so **Go must be on your `PATH`** to `herdr plugin install`. The +> plugin talks to herdr over a named pipe there instead of a unix socket; it's +> validated against the herdr Windows beta. + **Local development:** build the binary and link your checkout in place: ```bash diff --git a/www/content/docs/installation.md b/www/content/docs/installation.md index 5b9d68c..ea12b69 100644 --- a/www/content/docs/installation.md +++ b/www/content/docs/installation.md @@ -22,6 +22,12 @@ plugin's actions. The build step **prefers a local Go toolchain** (an exact buil of the cloned source) and **falls back to downloading the latest prebuilt release binary**, so it works **with or without Go**. +> **Windows** (herdr's Windows support is in preview): the plugin's Windows build +> step compiles straight from source with the Go toolchain — there is **no +> prebuilt-binary fallback** like the Linux/macOS `sh` script has — so **Go must +> be on your `PATH`** to install. On Windows the plugin talks to herdr over a +> named pipe rather than a unix socket. + After it finishes, manage the plugin with: ```bash @@ -92,7 +98,9 @@ curl -fsSL https://raw.githubusercontent.com/cloudmanic/herdr-plus/main/install. ## Supported platforms Releases are cross-compiled for **Linux** and **macOS** on `amd64` (x86_64) and -`arm64` (aarch64). herdr-plus is not tested on Windows. +`arm64` (aarch64), plus **Windows** on `amd64` (shipped as a `.zip`). Windows +support tracks herdr's Windows beta and is validated against it; installing on +Windows builds from source, so it needs Go on your `PATH` (see the note above). ## Checking the version