Skip to content

docs: note Windows install needs Go on PATH (follow-up to #45) #46

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
cloudmanic merged 1 commit into from
Jul 22, 2026
Merged

docs: note Windows install needs Go on PATH (follow-up to #45) #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 9 additions & 1 deletion www/content/docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
Loading