clidoc

Generate beautiful static documentation websites for CLI tools.

clidoc renders a searchable, themeable static site from a commands.json document that describes your CLI.

📖 Live demo → (clidoc documents itself)

Features

• Beautiful UI — dark/light theme, responsive, column / tree / list views.
• Smart search — filter by name and description.
• LLM-friendly — emits llms.txt alongside the site.
• Framework-agnostic — any tool that can emit commands.json works. Ships with a companion NuGet for System.CommandLine apps (including DI-heavy ones).
• Metadata enrichment — add examples, taglines, and prose sections via cli-docs.yaml.

Documentation

• Getting started
• Companion NuGet (Clidoc.SystemCommandLine)
• CLI reference
• commands.json schema
• cli-docs.yaml metadata
• Architecture

Contributing

Contributions welcome — see CONTRIBUTING.md.

License

MIT.

Acknowledgments

• UI design inspired by SonarQube CLI Documentation, designed by Clifford Goh.
• Schema shape inspired by SonarQube's commands.json.
• Built on System.CommandLine and YamlDotNet.