Installation

Install options

macOS (Homebrew)

brew install Stephen-Collins-tech/tap/hotspots

npm

npm install -g @stephencollinstech/hotspots

Works on macOS, Linux, and Windows. No Rust toolchain required.

pip

pip install hotspots-cli

Available on PyPI. Works on macOS, Linux, and Windows.

Linux

curl -fsSL https://raw.githubusercontent.com/Stephen-Collins-tech/hotspots/main/install.sh | sh

Installs to ~/.local/bin/hotspots. The script checks your current version first — if you're already up to date, it exits immediately. If an update is available, it shows the versions and asks before installing.

Install a specific version:

HOTSPOTS_VERSION=v1.23.0 curl -fsSL https://raw.githubusercontent.com/Stephen-Collins-tech/hotspots/main/install.sh | sh

Any platform (Rust required)

cargo install hotspots-cli

Available on crates.io. Works on macOS, Linux, and Windows.

Windows

Download the latest binary from GitHub Releases and add it to your PATH.

GitHub Action

Use Hotspots in CI without installing anything locally:

- uses: Stephen-Collins-tech/hotspots@v1
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}

See CI/CD Guide for full usage.

Build from source

git clone https://github.com/Stephen-Collins-tech/hotspots.git
cd hotspots
cargo build --release
cp target/release/hotspots ~/.local/bin/

Requires Rust 1.75+.

---

Verify

hotspots --version
hotspots analyze --help

---

Upgrade

macOS:

brew upgrade Stephen-Collins-tech/tap/hotspots

npm:

npm update -g @stephencollinstech/hotspots

pip:

pip install --upgrade hotspots-cli

Linux:

curl -fsSL https://raw.githubusercontent.com/Stephen-Collins-tech/hotspots/main/install.sh | sh

---

Troubleshoot

command not found after Linux install — ~/.local/bin may not be in your PATH:

export PATH="$HOME/.local/bin:$PATH"

Add that line to your ~/.zshrc or ~/.bashrc to make it permanent.

Build from source fails — check your Rust version:

rustc --version   # need 1.75+
rustup update stable

---

Next

Quick Start → — analyze your first codebase in 5 minutes.