Skip to content
Aranet

Installation

v0.2.1 Latest Release

Pre-built Binaries

Section titled “Pre-built Binaries”

The fastest way to install Aranet CLI is using pre-built binaries:

Terminal window
brew tap cameronrye/aranet
brew install aranet

On a minimal Linux system, such as a container image, first install curl, ca-certificates, xz-utils and the D-Bus library (for example apt-get update && apt-get install -y curl ca-certificates xz-utils libdbus-1-3, as root or with sudo): the installer downloads with curl and unpacks a .tar.xz archive, and aranet needs libdbus-1.so.3 to talk to BlueZ.

The prebuilt Linux binaries need glibc 2.35 or newer: Ubuntu 22.04, Debian 12, Raspberry Pi OS Bookworm, Fedora 36 or later. On an older system, build from source instead (see Downloads).

Download Direct

Section titled “Download Direct”

Download binaries directly from GitHub Releases:

Docker

Section titled “Docker”

Run aranet-service in a container (requires BLE access on the host):

8080/dashboard
docker compose up -d

Or use the full monitoring stack with Prometheus and Grafana:

Terminal window
docker compose -f docker/docker-compose.yml up -d

See Service Deployment for configuration details.

Install from crates.io

Section titled “Install from crates.io”

Install using Cargo (requires Rust toolchain):

Terminal window
cargo install aranet-cli

This installs the aranet executable.

Build from Source

Section titled “Build from Source”

Alternatively, build from source for the latest development version:

  1. Clone the repository

    Terminal window
    git clone https://github.com/cameronrye/aranet.git
    cd aranet

  2. Build all crates

    Terminal window
    cargo build --release

  3. Run the CLI

    Terminal window
    ./target/release/aranet --help

Platform-Specific Notes

Section titled “Platform-Specific Notes”

No additional dependencies required. Bluetooth access will prompt for permission on first use.

Installing the CLI Globally

Section titled “Installing the CLI Globally”

To install the CLI to your Cargo bin directory:

Terminal window
cargo install --path crates/aranet-cli

This allows you to run aranet from anywhere:

Terminal window
aranet scan

Shell Completions

Section titled “Shell Completions”

Generate shell completions for your shell:

Terminal window
aranet completions bash > ~/.local/share/bash-completion/completions/aranet

Using as a Library

Section titled “Using as a Library”

Add aranet-core to your Cargo.toml:

[dependencies]
aranet-core = "0.2"

Verify Installation

Section titled “Verify Installation”

If you used the shell or PowerShell installer, open a new terminal first. Then check that everything is working:

Terminal window
# Show version
aranet --version


# Run BLE diagnostics
aranet doctor


# Scan for devices (requires Bluetooth)
aranet scan --timeout 5