Installation
dotnet tool install --global clidoc
Quick Start
What do you want to do?
1
Install clidoc
dotnet tool install --global clidoc
Installs the global tool used to render the site.
2
Extract commands.json from your project
clidoc generate commands --project src/MyCli/MyCli.csproj
Builds the project and reflects over the output to produce ./commands.json. Picks up
<ToolCommandName> automatically.3
Render the site
clidoc generate docs --output docs
Uses ./commands.json in the current directory. Add
--metadata cli-docs.yaml to enrich the output with examples and custom sections.Features
- Beautiful UIDark and light theme support with automatic persistence
- Multiple ViewsColumn, tree, and list layouts for browsing commands
- SearchFilter commands by name and description
- Copy-to-ClipboardEasily copy example commands for quick pasting into a terminal
- ResponsiveWorks on mobile and desktop
- llms.txtPlain-text reference for LLM consumption
- Metadata EnrichmentAdd examples, sections, and custom descriptions via YAML
- System.CommandLine integrationDrop-in NuGet for .NET CLIs — emit commands.json from inside your app, DI and all