Skip to main content

mr docs

Introspect and validate the mr CLI's own documentation. The docs subcommands walk the command tree to emit machine-readable JSON, generate docs-site Markdown pages, validate help text against the template rules, and execute runnable examples.

Use mr docs during CLI development to keep help text consistent, and in CI to guarantee that published documentation stays in sync with the implementation.

Usage

mr docs

Flags

This command has no local flags.

Inherited global flags

FlagTypeDefaultDescription
--jsonboolfalseOutput raw JSON
--no-headerboolfalseOmit table headers
--pageint1Page number for list commands (default page size: 50)
--quietboolfalseOnly output IDs
--serverstringhttp://localhost:8181mahresources server URL (env: MAHRESOURCES_URL)

Exit Codes

0 on success; 1 on any error

See Also