Installation
Aeroflare distributes binaries via Nix flakes, prebuilt release archives, and standard Go toolchains.
Two binaries are shipped. aeroflare is the interactive CLI. aeroflare-ci
is the non-interactive CI runner, which the GitHub Action wraps.
Option 1: Nix Flakes (Recommended)
If you have a modern Nix installation with flakes enabled, you can run Aeroflare directly without installing it globally.
nix run github:ItzEmoji/aeroflare -- --help
To install it into your user profile permanently:
nix profile install github:ItzEmoji/aeroflare
Both binaries are in the package's bin/, so aeroflare-ci comes along with it. To run it without installing:
nix shell github:ItzEmoji/aeroflare --command aeroflare-ci --config .aeroflare-ci.yaml
Option 2: Prebuilt Release Binaries
Each GitHub release attaches a compressed archive per binary and architecture:
| Asset | Contents |
|---|---|
aeroflare-x86_64.tar.zst | aeroflare, Linux x86_64 |
aeroflare-aarch64.tar.zst | aeroflare, Linux aarch64 |
aeroflare-ci-x86_64.tar.zst | aeroflare-ci, Linux x86_64 |
aeroflare-ci-aarch64.tar.zst | aeroflare-ci, Linux aarch64 |
version=1.8.0
arch=x86_64 # or aarch64
curl -fsSL -O "https://github.com/ItzEmoji/aeroflare/releases/download/v${version}/aeroflare-${arch}.tar.zst"
tar --zstd -xf "aeroflare-${arch}.tar.zst"
sudo mv aeroflare /usr/local/bin/
The archives are built with build provenance attestations. Verify one before trusting it:
gh attestation verify "aeroflare-${arch}.tar.zst" --repo ItzEmoji/aeroflare
Release archives are attached from v1.8.0 onward. Earlier tags, including
v1.7.0, carry source only, and these downloads will 404 against them. The
archives are also Linux-only — on macOS or other platforms, use Nix or build
from source.
Option 3: Go Toolchain
Aeroflare is a Go module — github.com/itzemoji/aeroflare —
so the Go toolchain can install it directly, with no clone:
go install github.com/itzemoji/aeroflare/cmd/aeroflare@latest
go install github.com/itzemoji/aeroflare/cmd/aeroflare-ci@latest
This puts the binaries in $(go env GOPATH)/bin. Version metadata is recovered
from the module version, so aeroflare version reports the real release rather
than dev.
To build from a clone instead:
git clone https://github.com/ItzEmoji/aeroflare.git
cd aeroflare
go build -o aeroflare ./cmd/aeroflare
go build -o aeroflare-ci ./cmd/aeroflare-ci
sudo mv aeroflare aeroflare-ci /usr/local/bin/
Requires the Go version declared in go.mod. Note that both binaries live under
cmd/ — there is no package at the repository root, so go build . will not
work.
A plain go build omits the version ldflags, so the binary reports a
pseudo-version. Use task build (or make) to get a properly stamped binary.
See Development.
Aeroflare's engines can also be imported rather than installed — see the Go API.
Verification
Verify the installation by checking the version output.
aeroflare version