Installation

Install Hotspots on your system.

Quick Install

cargo (Rust toolchain)

cargo install hotspots-cli

Available on crates.io/crates/hotspots-cli. Works on macOS, Linux, and Windows wherever Rust is installed.

macOS (Homebrew)

brew install Stephen-Collins-tech/tap/hotspots

Linux

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

This installs the binary to ~/.local/bin/hotspots and prints a PATH reminder if needed.

Install a specific version:

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

Windows

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

From Source (Rust Required)

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

GitHub Action

Use Hotspots in GitHub Actions without installing anything:

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

See CI/CD & GitHub Action Guide for complete usage.

AI Integration

Use Hotspots with Claude Code directly via CLI commands:

# Analyze changes in your project
hotspots analyze . --mode delta --format json

# Get agent-optimized output (quadrant buckets + action text)
hotspots analyze . --mode delta --all-functions --format json

See AI Integration Guide for complete AI workflow documentation.

Verify Installation

hotspots --version
hotspots analyze --help

Next Steps

• Quick Start Guide — 5-minute tutorial
• Usage Guide — Complete CLI reference
• Configuration — Config file setup

Troubleshooting

Command not found

Ensure ~/.local/bin is in your PATH:

echo $PATH

If it's missing, add to ~/.zshrc or ~/.bashrc:

export PATH="$HOME/.local/bin:$PATH"
source ~/.zshrc  # or source ~/.bashrc

Build from source fails

Ensure you have Rust 1.75 or later:

rustc --version
rustup update stable

Upgrading

macOS (Homebrew):

brew upgrade Stephen-Collins-tech/tap/hotspots

Linux (curl install):

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

Uninstall

macOS (Homebrew):

brew uninstall hotspots

Linux (curl install):

rm ~/.local/bin/hotspots