Documentation menu
Installation
Install herdr-plus via Homebrew, the install.sh one-liner, or from source — with supported platforms, install locations, and upgrades.
herdr-plus is a single static binary. There are three ways to install it: Homebrew, the install script, or from source. All of them are free and open source.
Note: herdr-plus is an add-on for herdr. Install and set up herdr first — herdr-plus does its work by talking to a running herdr server.
Homebrew
The herdr-plus repository is its own Homebrew tap. Tap it, then install:
brew tap cloudmanic/herdr-plus https://github.com/cloudmanic/herdr-plus
brew install cloudmanic/herdr-plus/herdr-plus
To upgrade later:
brew upgrade cloudmanic/herdr-plus/herdr-plus
Install script
A POSIX sh installer detects your OS and architecture, downloads the matching
archive from the latest GitHub Release, extracts the static binary, and drops it
into place. It works under plain sh, so it’s fine on Alpine/BusyBox and minimal
SSH targets, not just bash.
curl -fsSL https://raw.githubusercontent.com/cloudmanic/herdr-plus/main/install.sh | sh
Re-running the script performs an upgrade.
Environment overrides
The script honors two environment variables:
| Variable | Default | What it does |
|---|---|---|
INSTALL_DIR | ~/.local/bin (else /usr/local/bin) | Where the binary is installed. |
VERSION | the latest GitHub Release | Pin a specific release tag to install. |
Examples:
# Install into a custom directory.
curl -fsSL https://raw.githubusercontent.com/cloudmanic/herdr-plus/main/install.sh | INSTALL_DIR=/opt/bin sh
# Pin a specific version (tags are prefixed with "v").
curl -fsSL https://raw.githubusercontent.com/cloudmanic/herdr-plus/main/install.sh | VERSION=v0.0.1 sh
From source
Clone the repository and build with the Makefile:
make build # build the herdr-plus binary
make install-bin # build, then install the binary onto your PATH
Or use the Go toolchain directly:
go build -o herdr-plus .
go test ./...
Supported platforms
Releases are cross-compiled for:
- Operating systems: Linux and macOS.
- Architectures:
amd64(x86_64) andarm64(aarch64).
The install script maps uname output onto those tokens and refuses to run on
anything else, telling you exactly what it detected.
Where the binary lands
The install script chooses, in order:
- The directory in
INSTALL_DIR, if you set it. ~/.local/bin— preferred, because it needs nosudo./usr/local/bin— the fallback, which may prompt forsudo.
Tip: If the chosen directory isn’t on your
$PATH, the script prints the exactexport PATH=...line to add to your shell rc. Without that, your shell won’t find theherdr-pluscommand.
Checking the version
Confirm what’s installed at any time:
herdr-plus version
(--version, -v, and -V all work too.) It prints herdr-plus followed by
the release version.
How upgrades work
Every merge to main auto-bumps the patch version and cuts a new GitHub Release
with cross-compiled binaries. To pull the latest:
- Homebrew:
brew upgrade cloudmanic/herdr-plus/herdr-plus - Install script: re-run the
curl ... | shone-liner. - From source:
git pullandmake install-binagain.
Next steps
Once herdr-plus is on your PATH, bind it to a key: Keybindings, then jump into the Quick Start.
Spot something off? Edit this page on GitHub ↗