Documentation from your CLI definitions

clidoc turns a command-line interface into a portable description that can be validated and rendered as documentation. It is built upon the OpenCLI specification, which defines the format. clidoc is the TypeScript tooling and CLI for producing and using that format.

Pick a starting point

• Use the CLI to validate a CLI-generated document or render Markdown.
• Use the core library to parse, validate, and render an OpenCLI document in TypeScript.
• Connect a CLI framework to derive documentation from command definitions.
• Publish documentation with the Docusaurus or VitePress integration.

The CLI reference is generated from the CLI's own command definitions. The core API reference is generated from its TSDoc comments.