Documentation

CLI reference / Maintain

cumaru doctor

Validate the installed configuration, tree, tags, references, and agent instructions.

Synopsis

cumaru doctor [--quiet]

Arguments and options

Argument or optionMeaning
--quietHide [ok] lines. Warnings, errors, and the summary still print.

Side effects

  • Writes: Only a daily drift cache, .cumaru/.cache/config-<date>.yaml, plus its .gitignore entry. With meta.doctor.after.warm: true, a passing run also warms the adopter vector cache.
  • Network: At most one read of the domain config on GitHub main per day, for the drift check. Offline runs use the cache or warn.

Behavior

  • Running cumaru with no command runs doctor.
  • A preflight stops before the checks on a config version below 9, a malformed or symlinked config, unsafe entries, or invalid workflows.
  • Eleven checks: tree contracts, navigation and summaries, balanced tags (errors); unknown tags, stale markers, RAW blocks, file references, external tools, context paths, agent instructions, config drift (warnings).
  • Config drift is a warning. It is an error when the reference config version is newer than the binary. The report still prints, doctor exits 1, and the message directs cumaru upgrade, then cumaru migrate.
  • Doctor does not check skills, commands, or hooks, and never checks CLI staleness.

Example

cumaru doctor --quiet

Failures

  • Exit 1: preflight failure or any [error] check, including a reference config version newer than the binary (run cumaru upgrade, then cumaru migrate). Warnings never fail the run.

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

Back to all commands