code-flow-map

Code Flow — Documentation Generator

Analyze the codebase and generate flow documentation for the requested functionality.

Before you write anything

Name the flow you are about to map and wait for the user to confirm it, unless their own request already named it. This skill writes files under Code_Flows/ and adds docstrings to source files that lack them. Some hosts start a skill because a conversation drifted near its description rather than because anyone asked for it, and on those hosts this paragraph is the only thing standing between that drift and an edit to the user's code.

User Input

The user's request says what to map, and may carry five option flags — --whole-code-base, --detail thin|standard|verbose, --output files|bundle|both, --frontend auto|react|vue|angular|svelte|off and --tracer auto|on|off. Step 1 reads them.

Instructions

1. Identify the Target Flow

The user's request says what to document. Read it first for its option flags. They are options, not part of the feature name — strip them out before you derive any filename from what is left.

• --whole-code-base — map the whole repository instead of one feature. If it is present, skip the rest of this section and everything through step 7, and follow Whole-Codebase Mode at the end of this document instead.
• --detail thin|standard|verbose — how much evidence each catalogued function carries. Default standard. It only changes anything in whole-codebase mode; if it appears without --whole-code-base, accept it silently rather than erroring. If it appears with a value that is not one of those three, tell the user what you read, use standard, and carry on.
• --output files|bundle|both chooses which HTML gets written, default files. files writes index.html, one page per flow, and the quality report page, exactly as before. both adds Code_Flows/code-flow.html, a single self-contained page carrying every flow. bundle writes that page and no other HTML. If its value is not one of those three, say what you read, use files, and carry on. --output never suppresses the JSON artifacts — index.json, <functionality_name>.json and inventory.json are written in every mode, because /code-flow-quality reads them and a run that skipped them would break it silently. Unlike --detail, it changes behavior in both modes: in whole-codebase mode it governs the bundle exactly as it does here — see Whole-Codebase Mode's Pass 1 and Pass 2 for where that applies.
• --frontend auto|react|vue|angular|svelte|off — whether to map UI components as well as functions. Default auto: detect the frameworks this repository actually uses and map their components too. Naming one forces that framework; off maps functions only. Frontend Component Mapping below says what it changes. If its value is not one of those, say what you read, use auto, and carry on.
• --tracer auto|on|off — whether to run the installed static tracers before tracing anything. Default auto: run each tracer whose language this repository contains and whose interpreter this machine has, and read source yourself where none applies. on means say so and stop when no tracer could run, since a user who asked for a traced map would otherwise get a slower one silently. off never runs one. Automated Tracing below says what they produce and how far to trust it. If its value is not one of those three, say what you read, use auto, and carry on.