Skip to content

Installation

Public beta

Every channel below is live — Homebrew, Scoop, Docker, .deb/.rpm, and direct downloads are published on each release (Releases).

macOS / Linux — Homebrew

brew install --cask orlandoburli/tap/apiary

The cask strips the macOS Gatekeeper quarantine flag automatically, so the binary runs without the "unidentified developer" prompt.

Windows — Scoop

scoop bucket add orlandoburli https://github.com/orlandoburli/scoop-bucket
scoop install apiary

Linux — deb / rpm

Download the package for your architecture from the latest release:

sudo dpkg -i apiary_*_linux_amd64.deb      # Debian / Ubuntu
sudo rpm -i  apiary_*_linux_amd64.rpm      # Fedora / RHEL

arm64 packages are published too — swap amd64 for arm64.

Docker

docker run --rm -v apiary-data:/data ghcr.io/orlandoburli/apiary:latest version

Multi-arch image (linux/amd64, linux/arm64). Apiary persists state in a SQLite database — mount a volume at /data to keep it across runs.

Direct download

Grab the archive for your OS/arch from the latest release (.tar.gz for macOS/Linux, .zip for Windows), verify it against checksums.txt, extract, and put apiary on your PATH.

Unsigned binaries

Releases are not yet code-signed or notarized.

  • macOS — a directly downloaded binary is quarantined by Gatekeeper. Clear it with xattr -dr com.apple.quarantine ./apiary. (The Homebrew cask does this for you.)
  • Windows — SmartScreen may warn "unknown publisher". Choose More info → Run anyway.

Code signing and notarization are on the roadmap.

From source

See the Development guide for building with the Go toolchain.

Verify the install

apiary version

Upgrading

Apiary is a single binary; upgrading replaces it in place and your project state (.apiary/ directories) is untouched.

brew upgrade --cask orlandoburli/tap/apiary     # Homebrew
scoop update apiary                             # Scoop
docker pull ghcr.io/orlandoburli/apiary:latest  # Docker

For .deb/.rpm and direct downloads, install the new release the same way as the original.

Pin a version

Apiary is in public beta — config and adapter APIs may still change before v1.0. For anything you depend on, pin a release (e.g. the ghcr.io/orlandoburli/apiary:0.10.0 Docker tag) and read the release notes before upgrading.

Next step

Continue with the Quickstart — from a fresh install to your first autonomously handled issue in about ten minutes.