CLI documentation from the source

Built for your CLI framework

Use built-in adapters for yargs, Commander.js, and oclif to generate an OpenCLI document from the command definitions you already maintain.

Publishing plugins generate command pages for Docusaurus and VitePress. You can also render Markdown for other documentation sites.

Give your CLI a docgen command with an adapter, then validate its OpenCLI document with clidoc.

$ npm install -g @clidoc/cli
$ mycli docgen --output cli.json
$ clidoc validate cli.json

Turn real command definitions into an OpenCLI document with a framework adapter.

Validate a JSON or YAML document against the OpenCLI specification.

Generate command pages for Docusaurus, VitePress, or Markdown.