Skip to content
mdkg Docs

Command Contract

The command contract is a maintainer and integration surface. Most users should start with the generated CLI reference.

mdkg publishes command metadata in the repository build output:

dist/command-contract.json

Reference pages should derive command coverage from that artifact where possible so user docs stay aligned with the CLI.

Reference pages should include:

  • command name
  • purpose
  • usage
  • flags
  • output formats
  • read-only or mutating status
  • examples
  • related commands
  • safety notes
  • alpha labels where relevant

Derived docs artifacts:

  • docs/_generated/cli-reference.md
  • docs/_generated/command-contract-summary.json

Refresh and check:

Terminal window
npm run docs:generate
npm run docs:check