Skip to content

Installation

v0.2.0 Latest Release

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

Terminal window
brew tap cameronrye/aranet
brew install aranet

Download binaries directly from GitHub Releases:

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 using Cargo (requires Rust toolchain):

Terminal window
cargo install aranet-cli

This installs the aranet executable.

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

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

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

Generate shell completions for your shell:

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

Add aranet-core to your Cargo.toml:

[dependencies]
aranet-core = "0.2"

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