Documentation

CLI reference / Navigate

cumaru tree

List filesystem candidates under .cumaru/ and their one-line summaries.

Synopsis

cumaru tree [<directory-or-md>...] [--deep] [--rows|--markdown]

Arguments and options

Argument or optionMeaning
<directory-or-md>...Directories or Markdown files relative to .cumaru/. A Markdown file resolves to its parent. Default: the root.
--deepInspect every non-hidden descendant and report every defect on stderr.
--rowsEmit path<TAB>summary TSV (the default).
--markdownEmit an escaped Markdown table instead.

Side effects

  • Writes: None. Read-only.
  • Network: None. Offline; needs no config.

Behavior

  • Shallow mode lists direct Markdown files other than index.md and direct directories that have an index.md. Each target needs a regular index.md.
  • Summaries come only from YAML frontmatter. A valid summary is 32 to 512 characters.
  • Rows from all targets are sorted by byte order and deduplicated. Diagnostics go to stderr only.
  • Absolute paths, .. segments, hidden paths, missing targets, non-Markdown files, and symlinks are rejected.

Example

cumaru tree plans specs --rows

Failures

  • Exit 1: runtime, safety, or tree validation error. With --deep, valid rows may print first.
  • Exit 2: usage error.

Sources: docs/tree.md; cumaru tree --help of CLI 0.15.3.

Back to all commands