Skip to main content

Hotspots

Hotspots

CI Security npm downloads

Website: https://hotspots.dev  |  Docs: https://docs.hotspots.dev  |  Crates.io: crates.io

Install: brew install Stephen-Collins-tech/tap/hotspots  |  npm install -g @stephencollinstech/hotspots  |  pip install hotspots-cli  |  cargo install hotspots-cli

Find the code that's actually causing problems.

Your codebase has thousands of functions. Some are messy but never break. Others are complex AND change constantly — those are your hotspots, the 20% of code causing 80% of your bugs, incidents, and slowdowns.


Install

brew install Stephen-Collins-tech/tap/hotspots   # macOS
npm install -g @stephencollinstech/hotspots       # any platform
pip install hotspots-cli                          # any platform
cargo install hotspots-cli                        # Rust toolchain
curl -fsSL https://raw.githubusercontent.com/Stephen-Collins-tech/hotspots/main/install.sh | sh  # Linux

Windows: download the binary from GitHub Releases.

New here? Start with the Quick Start guide.

Verify: hotspots --version

GitHub Action:

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

Quick Start

# Find your hotspots
hotspots analyze src/

# Critical (LRS ≥ 9.0):
# processPlanUpgrade    src/api/billing.ts:142    LRS 12.4  CC 15  ND 4  FO 8  NS 3
#
# High (6.0 ≤ LRS < 9.0):
# validateSession       src/auth/session.ts:67    LRS 9.8   CC 11  ND 3  FO 7  NS 2

Critical = refactor now. High = refactor next time you touch it. Moderate = block increases. Low = leave it alone.

Common commands

# Per-function explanations with refactoring advice
hotspots analyze . --format text --explain --top 10

# Block complexity regressions in CI
hotspots diff --auto-analyze --policy

# Compare any two git refs
hotspots diff main HEAD --top 10 --policy

# Interactive HTML report
hotspots analyze src/ --format html

# JSON for tooling/AI
hotspots analyze src/ --format json

# Train a repo-specific ranker from your bug history (always runs its own P@K eval)
hotspots train . --blame

# Driving this CLI from a coding agent? Start here
hotspots analyze --help-agent

How It Works

Hotspots computes a Local Risk Score (LRS) per function from four structural metrics:

Metric What it measures
CC — Cyclomatic Complexity Independent decision paths (if/loop/catch/&&/||)
ND — Nesting Depth Maximum depth of nested control structures
FO — Fan-Out Distinct functions called
NS — Non-Structured Exits Early returns, throws, breaks
LRS = 1.0×R_cc + 0.8×R_nd + 0.6×R_fo + 0.7×R_ns

where each component is log-scaled and capped to prevent outliers from dominating (full formula, caps, and weight rationale).

Every analyze run also combines LRS with the file's git history (churn, touch frequency, recency) into an absolute Activity Risk Score, and marks each function active (its file is touched more than the repo median, or changed in the last 30 days) or quiet:

Activity Risk = LRS/20.2 + churn + touch + recency      (each term scaled to 0–1)

Activity Risk says where attention is likely needed next, not how good the code is. Editing a file raises it for every function in the file and it decays as the file goes quiet, so use the risk band (from LRS) to judge structure and Activity Risk to decide where to look first. See Activity Risk and Activity tier.

Risk bands: Low (< 3) · Moderate (3–6) · High (6–9) · Critical (≥ 9)

These formulas aren't hand-tuned guesses — every weight, cutoff, and signal that made it into the CLI was validated (or rejected) against real repo history and ground-truth bug/fix data in the open hotspots-public-research repo. See its findings index for the evidence behind each shipped feature, including the negative results that kept things out.


Supported Languages

TypeScript · JavaScript · Go · Python · Rust · Java · C/C headers · C++ · C# · PHP · Vue · Astro

All supported file extensions (.ts, .tsx, .mts, .cts, .js, .jsx, .mjs, .cjs, .go, .py, .rs, .java, .c, .h, .cpp, .cc, .cxx, .hpp, .hxx, .hh, .cs, .php, .vue, .astro) work out of the box.


CI/CD Integration

GitHub Action (zero config)

name: Hotspots
on: [pull_request, push]
jobs:
  analyze:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: Stephen-Collins-tech/hotspots-action@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

Posts PR comments, generates HTML reports, fails builds on policy violations.

Manual CI

# Fail CI if new critical functions introduced or LRS increases ≥ 1.0
hotspots diff --auto-analyze --policy

Exit code 1 on blocking violations, 0 on warnings only.


Key Features

Policy engine — blocks: new critical-risk functions and LRS regressions ≥ 1.0.

Suppression comments — exclude functions from CI failures while keeping them visible:

// hotspots-ignore: legacy payment processor, rewrite scheduled Q2 2026
function legacyBillingLogic() { ... }

Trained ranker — fit a RandomForest from your repo's bug-fix history (training always checks P@K vs. base rate before saving the model):

hotspots train . --blame

Output formats — text (terminal), json (machine), html (interactive), sarif (GitHub Code Scanning).

Configuration — .hotspotsrc.json in project root (auto-discovered):

{
  "include": ["src/**/*.ts"],
  "exclude": ["**/*.test.ts"],
  "min_lrs": 0.0,
  "policy": { "critical_introduction": "block" }
}

Documentation

  • docs/COMMANDS.md — every command: why it exists, when to use it, how to read its output
  • docs/USAGE.md — workflows, CI setup, output formats, policy engine, suppression, training, snapshot management
  • docs/REFERENCE.md — complete CLI reference, all flags, config options, JSON schema, metrics formula
  • docs/ARCHITECTURE.md — system design, analysis pipeline, invariants, design decisions
  • docs/CONTRIBUTING.md — dev setup, adding languages, release process
  • hotspots-public-research — the published evidence behind the scoring formulas: what was tested, what shipped, and what was rejected

Telemetry (opt-in)

Off by default. If you choose to enable it (set HOTSPOTS_TELEMETRY=on), hotspots sends one anonymous ping a day (version, OS, architecture, install channel, subcommand name, random install id) so I can see real usage and decide what to improve. No code, paths or results. Run hotspots analyze --show-config to see whether it's currently on, and unset HOTSPOTS_TELEMETRY (or set it to anything other than on) to turn it off. Details: docs/TELEMETRY.md.


Why Hotspots?

vs ESLint complexity rules — ESLint checks one metric in isolation with no git context. Hotspots combines four metrics, git history, and call graph topology into a single prioritized list.

vs SonarQube / CodeClimate — Enterprise platforms requiring server infrastructure. Hotspots is a single binary, zero config, works offline, results in seconds.

vs code reviews — Reviews catch complexity subjectively and miss gradual drift. Hotspots enforces objective thresholds automatically on every commit.


Contributing


License

MIT — see LICENSE-MIT.

Metadata

Release files for hotspots-cli 5.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for hotspots-cli 5.0.0
File Interpreter ABI Platform Actions
hotspots_cli-5.0.0-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for hotspots_cli-5.0.0-py3-none-win_amd64.whl
hotspots_cli-5.0.0-py3-none-manylinux_2_39_x86_64.whl Python 3 none Linux glibc 2.39+ x86-64 Details for hotspots_cli-5.0.0-py3-none-manylinux_2_39_x86_64.whl
hotspots_cli-5.0.0-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details for hotspots_cli-5.0.0-py3-none-macosx_11_0_arm64.whl

Total release size: 21.1 MB

Release files / hotspots_cli-5.0.0-py3-none-win_amd64.whl

Download URL hotspots_cli-5.0.0-py3-none-win_amd64.whl
Size 7.0 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
99234a1b070d7af0287c13261e56a4380f5f2531d5f77d7bb9dec5e8bae23621
BLAKE2b-256 checksum
How to use checksums
ba001639a9bf3d316627df39315482ab5bf3f47c9d3c707451d0c5edfe745ea8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.16.0

Release files / hotspots_cli-5.0.0-py3-none-manylinux_2_39_x86_64.whl

Download URL hotspots_cli-5.0.0-py3-none-manylinux_2_39_x86_64.whl
Size 7.5 MB
Tags Linux glibc 2.39+ x86-64 Python 3
SHA-256 checksum
How to use checksums
2061174d4b556320e499d5d5249e03b24793557852a6e6738ae2c1eece72d117
BLAKE2b-256 checksum
How to use checksums
eabe68b7540dd354ae36412dd17332cf16d636d2f131ea834e8e136b7215cc22
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.16.0

Release files / hotspots_cli-5.0.0-py3-none-macosx_11_0_arm64.whl

Download URL hotspots_cli-5.0.0-py3-none-macosx_11_0_arm64.whl
Size 6.6 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
063d3c7c8668948128b1ec35702a01e2051900e7727be059c5f0a99b812b0fc8
BLAKE2b-256 checksum
How to use checksums
1ed56eeaf53c2a7a20281171d978def8e7238c4501a640fa3b254ede5dc740ff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.16.0

Security for hotspots-cli 5.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

5.0.0 This release

3 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page