Skip to content

Install

Omniglass ships as a single self-contained binary with the operator console compiled in, so one file is the whole app: every run mode (server, node run, migrate, bootstrap, token) is the same binary with a different first argument. You can download that binary directly, or run the container image instead.

Each GitHub Release carries an archive per platform:

OSArchitecturesArchive
Linuxamd64, arm64.tar.gz
macOSamd64 (Intel), arm64 (Apple silicon).tar.gz
Windowsamd64.zip

Download the archive for your platform, verify it against checksums.txt, extract the omniglass binary, and put it on your PATH:

Terminal window
VERSION=0.1.0 # the release tag, without the leading v
BASE=https://github.com/hyperscaleav/omniglass/releases/download/v$VERSION
curl -sSLO $BASE/omniglass_${VERSION}_linux_amd64.tar.gz
curl -sSLO $BASE/checksums.txt
sha256sum --check --ignore-missing checksums.txt
tar xzf omniglass_${VERSION}_linux_amd64.tar.gz
sudo install omniglass /usr/local/bin/
omniglass --version

Each archive also ships an SBOM (.sbom.json) alongside its checksum.

The macOS binaries are not yet notarized (#58), so Gatekeeper quarantines a freshly downloaded binary. Clear the quarantine attribute once:

Terminal window
xattr -d com.apple.quarantine omniglass

The binary is the server, the collection node, and the CLI in one. To stand up the API and console you need Postgres and the same environment the image uses; see Container image for the OMNIGLASS_DSN and migrate/server/bootstrap/token flow, which is identical for the binary. To drive a running server from the command line, see the CLI.