Installation

Install Aether from pre-built binaries or build from source with the Rust toolchain.

This guide walks you through installing Aether on your system. You can either download pre-built binaries or build from source.

Prerequisites

Aether is built in Rust. If you plan to build from source or develop with Aether, you need the Rust stable toolchain.

Install Rust via rustup:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

After installation, verify Rust is available:

rustc --version
cargo --version

Option A: Pre-built Binaries

The fastest way to get started. Download the latest release for your platform from GitHub Releases, or install with the install script:

curl -fsSL https://raw.githubusercontent.com/rhoninl/Aether/main/install.sh | sh

Once installed, verify it works:

aether --version

You can list all available examples to confirm everything is set up:

aether run --list

Option B: Build from Source

Clone the repository and build with Cargo:

git clone https://github.com/rhoninl/Aether.git
cd aether
cargo build

Run the full test suite to verify your build:

cargo test

This runs 3,074 tests across all crates. All tests should pass with zero failures.

Verify Your Installation

Depending on how you installed Aether:

  • Pre-built binary: Run aether --version to confirm the CLI is on your PATH.
  • From source: Run cargo test from the repository root. A fully passing test suite confirms your environment is correctly set up.

Next Steps

With Aether installed, head to the Quick Start guide to run your first demo.