omnigraph/docs/install.md
2026-04-11 14:12:49 +03:00

2.1 KiB

Install

Quick Install

curl -fsSL https://raw.githubusercontent.com/ModernRelay/omnigraph/main/scripts/install.sh | bash

By default the installer places:

  • omnigraph
  • omnigraph-server

in ~/.local/bin.

The default installer is binary-only. It downloads a published release asset, verifies the SHA256 checksum, and unpacks it. It does not build from source. If no stable tag is published yet, the installer automatically falls back to the rolling edge release.

Homebrew

brew tap ModernRelay/tap
brew install ModernRelay/tap/omnigraph

Channels

Stable binaries:

curl -fsSL https://raw.githubusercontent.com/ModernRelay/omnigraph/main/scripts/install.sh | bash

Rolling edge binaries from main:

curl -fsSL https://raw.githubusercontent.com/ModernRelay/omnigraph/main/scripts/install.sh | RELEASE_CHANNEL=edge bash

Install from source:

curl -fsSL https://raw.githubusercontent.com/ModernRelay/omnigraph/main/scripts/install-source.sh | bash

Useful Overrides

Install to a different directory:

curl -fsSL https://raw.githubusercontent.com/ModernRelay/omnigraph/main/scripts/install.sh | INSTALL_DIR="$HOME/bin" bash

Install a specific tag:

curl -fsSL https://raw.githubusercontent.com/ModernRelay/omnigraph/main/scripts/install.sh | VERSION=v0.1.0 bash

Build from a specific git ref:

curl -fsSL https://raw.githubusercontent.com/ModernRelay/omnigraph/main/scripts/install-source.sh | SOURCE_REF=main bash

Manual Source Build

cargo build --release --locked -p omnigraph-cli -p omnigraph-server
install -m 0755 target/release/omnigraph ~/.local/bin/omnigraph
install -m 0755 target/release/omnigraph-server ~/.local/bin/omnigraph-server

Release Assets

Tagged releases are expected to publish:

  • omnigraph-linux-x86_64.tar.gz
  • omnigraph-macos-x86_64.tar.gz
  • omnigraph-macos-arm64.tar.gz

Each archive contains both binaries:

  • omnigraph
  • omnigraph-server

Verify The Install

omnigraph version
omnigraph-server --help