Skip to content

map-system

/octopus:map-system answers β€œwhat is this area, in our own words?” at whatever depth the situation calls for. It is manual-invocation only β€” the command exists precisely because agents should not map on their own initiative.

What it solves

Reading code at the level of the question is the most common orientation mistake. When you’re trying to understand a feature area, reading individual functions tells you how, not what. A useful map sits one level above the question and uses the project’s own domain vocabulary, not code identifiers.

map-system enforces that abstraction discipline. It reads CONTEXT.md, ADRs, the module tree, and (when present) API and data model definitions, then produces a map written in the terms the team actually uses. For a new engineer being onboarded or a manager reviewing an unfamiliar area before a planning session, the output is the artifact they get walked through.

How it works

The command has two modes, selected with --mode:

complete (default) β€” an exhaustive crawl of the repository that renders a self-contained, themed HTML deck. The deck covers: project overview and business purpose, an architecture and module map with inline SVG diagrams, API contracts and data model (when detectable), and the ADRs that shape the codebase. Written to docs/system-map/<repo>.html by default. When frontend-design is available, it refines the visual design beyond the base template.

simplified β€” a one-shot ~30-line textual orientation map, rendered inline. Samples rather than crawls. The value is the discipline: one screen, domain vocabulary, one level above the question.

For both modes, if CONTEXT.md is missing the command surfaces that gap explicitly β€” the map falls back to code identifiers, which is a usable but weaker result.

Usage & parameters

/octopus:map-system <area or question>
  • <area or question> β€” the area or question to map. Required. The command decides the right abstraction level from this input.
  • --mode simplified | complete β€” content depth. Default: complete.
  • --save / --no-save β€” write to a file or return inline. Default: save on. --no-save returns the content inline regardless of --output.
  • --output markdown | html β€” saved-file format. Default: html (themed deck). markdown writes the same content as a plain document with no theme.
  • --theme <name> β€” preset theme for the HTML deck. Default: dark-blue.
  • --design-from "<prompt>" β€” synthesise a custom theme via frontend-design. Requires frontend-design to be available; falls back to a preset when it is not.

Source: commands/map-system.md