Skip to content

Install

Quick Start

HeliosAOT ships as a Python CLI and as a standalone app. Pick one of the quick paths below; advanced, from-source options are at the end.

Permissions Warning

Before installing HeliosAOT, you must be granted permission to the repository. Please reach out to the Ambiq AI team to request access or support.

Using pipx is the recommended way to install helios-aot as it allows installing and running python apps in isolated environments. Upon installation, helios-aot will be available in your PATH.

  • Install helios-aot: pipx install 'helios-aot @ git+https://github.com/AmbiqAI/helios-aot.git@main'
  • Upgrade helios-aot: pipx upgrade helios-aot
  • Invoke helios-aot: helios-aot --help
  • Remove helios-aot: pipx uninstall helios-aot

Tip

pipx requires a local Python (see requirements below), but isolates HeliosAOT from your global environment.

Download the app for your OS from the latest release page. No Python, no dependencies.

# Download an archive from the release page, then:
tar -xzf helios-aot-macos-*.tar.gz
sudo mv helios-aot /usr/local/bin/            # or any dir on your PATH
helios-aot --version
If you hit Gatekeeper warnings, either use Right click → Open once, or: 
xattr -d com.apple.quarantine /usr/local/bin/helios-aot


tar -xzf helios-aot-linux-*.tar.gz
sudo mv helios-aot /usr/local/bin/
helios-aot --version

# Unzip the archive and move the exe somewhere on PATH:
move .\helios-aot.exe "C:\Program Files\HeliosAOT\helios-aot.exe"
# Optional: add that folder to the System PATH
.\helios-aot.exe --version

Tip

Binary filenames may include the OS/arch (e.g. helios-aot-linux-x86_64.tar.gz, helios-aot-windows-x86_64.zip). View the Assets list on the release for the exact names.

Verify the install

Once installed, verify the CLI is working:

helios-aot version
helios-aot --help

You should see usage text and a semantic version. If the command isn’t found, ensure the install location is on your PATH.

Requirements

Software (tooling)

  • For pipx/pip/uv installs: Python 3.10+
  • For standalone app: no runtime dependencies

The project’s Python dependencies are listed in pyproject.toml and are automatically handled by pipx, pip, or uv.

Firmware (for generated C modules)

See platform-specific integration guides:

Usage (CLI)

$ helios-aot --help

usage: helios-aot [-h] <command> ...

positional arguments:
  <command>
    version   Display the version of the HeliosAOT library.
    convert   Convert a model to standalone C inference module.

options:
  -h, --help  show this help message and exit

See the CLI Reference for all commands and flags.

Advanced: Install from source

If you want the latest, editable install for development, use one of the methods below.

git clone https://github.com/AmbiqAI/helios-aot.git
cd helios-aot
python -m venv .venv && source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -U pip setuptools wheel
pip install -e .
helios-aot --help

git clone https://github.com/AmbiqAI/helios-aot.git
cd helios-aot
uv sync
uv run helios-aot --help

Updating

  • pipx: pipx upgrade helios-aot
  • Standalone App: download the new release asset and replace the old binary
  • pip/uv dev installs: pull main and reinstall (pip install -e . or uv sync)

Uninstall

  • pipx: pipx uninstall helios-aot
  • Standalone App: delete the executable you placed on your PATH
  • pip/uv: remove the venv and repo folder

Next Steps