Skip to main content

mr docs lint

Validate every user-facing command's help against the template rules defined in the spec: Short, Long, ≥2 Examples per leaf, rich flag descriptions, required Annotations (outputShape where applicable, exitCodes), and sensible Short length. Missing # mr-doctest: examples emit warnings, not errors.

Lint is allowlist-gated during migration: only command groups explicitly added to the allowlist are subject to the strict rules, so partial migrations do not block CI.

Usage

mr docs lint

Examples

Lint the full command tree

mr docs lint

Use in CI (non-zero exit fails the build)

mr docs lint || exit 1

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 if all commands pass; 1 if any fail

See Also