CliDoc

Beautiful static documentation for any CLI tool.

Installation

dotnet tool install --global clidoc
Browse Commands →

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 UI
    Dark and light theme support with automatic persistence
  • Multiple Views
    Column, tree, and list layouts for browsing commands
  • Search
    Filter commands by name and description
  • Copy-to-Clipboard
    Easily copy example commands for quick pasting into a terminal
  • Responsive
    Works on mobile and desktop
  • llms.txt
    Plain-text reference for LLM consumption
  • Metadata Enrichment
    Add examples, sections, and custom descriptions via YAML
  • System.CommandLine integration
    Drop-in NuGet for .NET CLIs — emit commands.json from inside your app, DI and all