Reach.CLI.Commands.Map (Reach v2.0.1)

Copy Markdown View Source

Shows a project-level map of modules, coupling, hotspots, depth, effects, boundaries, and data-flow summaries.

mix reach.map
mix reach.map --modules
mix reach.map --coupling
mix reach.map --hotspots
mix reach.map --effects
mix reach.map --boundaries
mix reach.map --depth
mix reach.map --data
mix reach.map --format json

Options

  • --format — output format: text, json, oneline
  • --modules — show module inventory
  • --coupling — show module coupling and cycles
  • --hotspots — show risky high-impact functions
  • --effects — show effect distribution
  • --boundaries — show mixed-effect functions
  • --depth — show functions ranked by dominator depth
  • --data — show cross-function data-flow summary
  • --top — pass top-N limit to analyses that support it
  • --sort — sort modules/coupling sections (name, functions, complexity, afferent, efferent, instability)
  • --module — restrict effects to a module name fragment
  • --min — minimum distinct effects for --boundaries (default: 2)
  • --orphans — with --coupling, show only orphan modules
  • --graph — render a terminal graph for graph-capable sections

Summary

Functions

run(opts, positional \\ [])