Installation
This guide walks you through installing Aether on your system.
Prerequisites
Before installing Aether, ensure you have:
- Go 1.25 or later (required)
- make (for building from source)
- git (for cloning the repository)
Optional tools:
- TORCH server access (for FHIR data extraction)
- DIMP service (for pseudonymization features)
Installation from Source
1. Clone the Repository
git clone https://github.com/trobanga/aether.git
cd aether2. Build Aether
Using the Makefile:
make buildThis compiles the Aether binary for your system.
3. Install to System PATH
Option A: System-wide installation (requires sudo)
sudo make install
# Installs to /usr/local/binOption B: User-local installation (no sudo required)
make install-local
# Installs to ~/.local/bin
# Ensure ~/.local/bin is in your PATHTo verify ~/.local/bin is in your PATH:
echo $PATH | grep '.local/bin'If not present, add to your shell configuration file (~/.bashrc, ~/.zshrc, etc.):
export PATH="$HOME/.local/bin:$PATH"Verification
Verify the installation by checking the version:
aether --helpYou should see the help output with available commands and options.
Shell Completions (Optional)
For improved command-line experience, install shell completions.
For Zsh (oh-my-zsh)
Automatic installation:
./scripts/install-completions.shOr manual installation:
mkdir -p ~/.oh-my-zsh/custom/plugins/aether
aether completion zsh > ~/.oh-my-zsh/custom/plugins/aether/_aetherThen add 'aether' to the plugins array in ~/.zshrc:
plugins=(... aether)Reload your shell:
exec zshFor Bash
aether completion bash | sudo tee /etc/bash_completion.d/aetherThen reload your shell:
exec bashFor Fish or Other Shells
For comprehensive shell completion setup for fish, bash, zsh, and other shells:
./scripts/install-completions.shOr see manual instructions:
aether completion --helpNext Steps
- Quick Start Guide - Get started with your first pipeline
- Configuration Guide - Learn how to configure Aether for your environment