Skip to content
Aranet

Installation

v0.1.9 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

Download Direct

Section titled “Download Direct”

Download binaries directly from GitHub Releases:

Install from crates.io

Section titled “Install from crates.io”

Install using Cargo (requires Rust toolchain):

Terminal window
cargo install aranet-cli

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.1"

Verify Installation

Section titled “Verify Installation”

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

Made with ❤️ by Cameron Rye