Command

okulo map

Hierarchical map of the codebase: size × hotspots × health (terminal or HTML).

overviewvisual

When to use it

You want a spatial overview for a review meeting or to explore where hotspots cluster.

Usage

okulo map [repo] [options]

Options

OptionDefaultDescription
--depth3Folder depth in the terminal view
--html FILE—Write a self-contained interactive treemap
--top-percent10Hotspot cut used for coloring/marks
-n, --limit20Entries shown per level in the terminal

Examples

Terminal overview

okulo map --depth 2 -n 10

Shareable HTML treemap

okulo map --html map.html
open map.html   # or your browser of choice

Machine-readable tree

okulo map -f json -o tree.json

Sample output

Illustrative terminal output (column layout matches the real CLI):

Code map · payments-service  420 files · 86,000 LOC · 18 hotspots · health 6.4
path              loc  share of code   heat  top  revs  hotspots  health
──────────────  ─────  ──────────────  ────  ───  ────  ────────  ──────
src/            5.1e4  ████████······  ▓▓▓    92   210        11     5.8
  billing/      1.2e4  ██············  ▓▓▓    92    48         4     4.1
  orders/       9.4e3  █·············  ▒▒▒    70    36         2     6.0
web/            2.8e4  ████··········  ▒▒▒    71   140         6     6.6
  checkout/     8.1e3  █·············  ▓▓▓    71    40         3     5.1

heat/top = highest hotspot score inside · health = LOC-weighted mean · sorted hottest first

How to read it

Tips

Related