CLI reference / Navigate
cumaru map
List Markdown headings with their section start and end lines.
Synopsis
cumaru map [<directory-or-md>] [--rows|--markdown] Arguments and options
| Argument or option | Meaning |
|---|---|
<directory-or-md> | A directory, searched recursively, or one exact Markdown file, relative to .cumaru/. Default: the root. |
--rows | Emit path:start,end<TAB>title TSV (the default). |
--markdown | Emit an escaped Selector/Title table instead. |
Side effects
- Writes: None. Read-only.
- Network: None. Offline; needs no config, index, or summary.
Behavior
- The first field is a cumaru get selector. Each row spans a complete section: an H2 includes its H3s.
- Matching is literal: headings inside fenced code are listed; setext and indented headings are not.
- No match is success.
Example
cumaru map specs/auth.md Failures
- Exit 1: an unsafe descendant during a recursive walk. Safe rows still print.
- Absolute paths, .., symlinks, hidden targets, and non-Markdown files are rejected.
Sources: docs/map.md; cumaru map --help of CLI 0.15.3.