Installation
Orchard ships as a single Go binary. There is no daemon, no server, and no database of its own — it reads HCL files and talks to the systems you configure.
Homebrew
On macOS and Linux:
brew install pthm/tap/orchardScoop
On Windows:
scoop bucket add pthm https://github.com/pthm/scoop-bucket
scoop install pthm/orchardInstall with Go
go install github.com/pthm/orchard@latestThis installs orchard into $GOBIN (defaulting to $HOME/go/bin). Make sure that
directory is on your PATH.
Prebuilt binaries
Each GitHub release includes:
.tar.gzarchives for Linux and macOS, and.ziparchives for Windows (amd64 and arm64).deband.rpmpackages for Linuxchecksums.txtwith SHA-256 sums for every artifact
Download the file for your platform, check it against checksums.txt, and put the
orchard binary on your PATH (or install the package with dpkg -i / rpm -i).
Verify the install
orchard versionThis prints the installed version, commit, and build date. Run orchard --help to
see the available subcommands.
Requirements
- Go 1.25 or newer if installing with
go install. - A target system to drive. Orchard itself is just an orchestrator — you need
something for it to talk to. For the built-in providers that means a reachable
PostgreSQL or MySQL database (for
builtin/postgresorbuiltin/mysql), a database file (forbuiltin/sqlite, which needs no server), an HTTP endpoint (forbuiltin/http), or a shell environment (forbuiltin/exec).