apunkt/omnigraph
1
0
Fork 0
mirror of https://github.com/ModernRelay/omnigraph.git synced 2026-07-03 02:51:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
omnigraph/docs/user/install.md
Ragnor Comerford d50d94f89b
ci: add linux-arm64 (aarch64) prebuilt release target (#316) 
* ci: add linux-arm64 (aarch64) prebuilt release target

Build an omnigraph-linux-arm64 archive in both the tagged-release and
edge-release matrices on the ubuntu-24.04-arm runner, and teach the
install script to map Linux/aarch64 to the new asset. Update the install
and CI docs to list the new platform.

Previously aarch64 Linux hit the install-script arch guard
("no prebuilt binary is available for Linux/aarch64") and could only
build from source; it is now a first-class prebuilt target.

* ci: emit a linux-arm64 bottle in the Homebrew formula

The formula generator only resolved macos-arm64 and linux-x86_64 and
emitted `on_linux { on_intel }`, so `brew install` on Linux/aarch64 had
no URL/sha and failed even though the release now ships an
omnigraph-linux-arm64 archive. Resolve that asset's digest and add an
`on_arm` block under `on_linux` so the documented Homebrew path matches
the new prebuilt target.
2026-06-29 22:55:44 +02:00

3.4 KiB
Raw Blame History

Install

Quick Install

macOS / Linux:

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

Windows PowerShell:

powershell -NoProfile -ExecutionPolicy Bypass -Command "iwr -UseBasicParsing https://raw.githubusercontent.com/ModernRelay/omnigraph/main/scripts/install.ps1 | iex"

By default the installer places:

  • omnigraph
  • omnigraph-server

in ~/.local/bin on macOS / Linux, or:

  • omnigraph.exe
  • omnigraph-server.exe

in %USERPROFILE%\.local\bin on Windows.

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

Windows rolling edge binaries:

iwr -UseBasicParsing https://raw.githubusercontent.com/ModernRelay/omnigraph/main/scripts/install.ps1 -OutFile install.ps1
powershell -NoProfile -ExecutionPolicy Bypass -File .\install.ps1 -ReleaseChannel edge

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

Windows:

powershell -NoProfile -ExecutionPolicy Bypass -File .\install.ps1 -InstallDir "$env:USERPROFILE\bin"

Install a specific tag:

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

Windows:

powershell -NoProfile -ExecutionPolicy Bypass -File .\install.ps1 -Version v0.1.0

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

macOS / Linux:

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

Windows:

cargo build --release --locked -p omnigraph-cli -p omnigraph-server
New-Item -ItemType Directory -Force "$env:USERPROFILE\.local\bin" | Out-Null
Copy-Item target\release\omnigraph.exe "$env:USERPROFILE\.local\bin\omnigraph.exe"
Copy-Item target\release\omnigraph-server.exe "$env:USERPROFILE\.local\bin\omnigraph-server.exe"

Release Assets

Tagged releases are expected to publish:

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

The macOS / Linux archives contain both binaries:

  • omnigraph
  • omnigraph-server

The Windows archive contains:

  • omnigraph.exe
  • omnigraph-server.exe

Verify The Install

macOS / Linux:

omnigraph version
omnigraph-server --help

Windows:

omnigraph.exe version
omnigraph-server.exe --help