Built on the OpenCLI specification

Turn any CLI into
beautiful docs

Generate polished, interactive documentation from your CLI's OpenCLI spec. Markdown or relocatable HTML app bundles. One command.

Try Now →
$ dotnet tool install -g InSpectra.Gen
inspectra
$ inspectra render file html jellyfin.json --xmldoc jellyfin.xml
  Validating OpenCLI schema... OK
  Normalizing 47 commands, 128 options... OK
  Enriching from XML metadata... OK
  Copying HTML app bundle... OK
  ✓ Written index.html and assets to jellyfin-docs/ (relocatable static bundle)
See it in action

Real documentation generated by InSpectraGen. Click through to explore the full interactive HTML output.

Everything you need

From schema validation to interactive viewers, InSpectraGen handles the full pipeline.

Markdown & HTML
Two output formats. GitHub-compatible Markdown for repos, plus an HTML app bundle for static hosting.
Interactive SPA
Generated HTML is a full single-page app with hash-based deep links, command filtering, and static-host friendly routing.
Drop or Link
Boot with injected data, fetchable URLs, or manual file import. One viewer covers local previews and hosted bundles.
Source of Truth
HTML runs on raw opencli.json plus optional xmldoc.xml. No parallel viewer schema in v1.
Markdown Layouts
Markdown still supports single-file and tree layouts. HTML intentionally ships as an app bundle directory.
Schema Validation
Validates input against an embedded JSON Schema (2020-12) with detailed error messages.
XML Enrichment
Optionally merge richer descriptions from XML metadata. Additive only, never overwrites.
Zero Network Calls
Fully offline. No telemetry, no CDN, no external requests. Runs locally, writes to disk.
Three steps to docs

Install the tool, point it at your CLI, and open the result.

1
Install the tool
Available as a .NET global tool via NuGet. Requires .NET 10 SDK.
2
Render from a file
Pass your opencli.json and optional xmldoc.xml. Pick Markdown or HTML.
3
Or render from a live CLI
Use exec mode to invoke a CLI directly and capture its OpenCLI output.
# Install dotnet tool install -g InSpectra.Gen # Render interactive HTML inspectra render file html \ mycli.json --xmldoc mycli.xml \ --out-dir ./docs # Render Markdown inspectra render file markdown \ mycli.json --out docs.md
# Render directly from a running CLI inspectra render exec html \ jf --with-xmldoc \ --out-dir ./jellyfin-docs # Custom OpenCLI arguments inspectra render exec markdown \ mytool --opencli-arg "cli opencli" \ --out docs.md
# HTML always writes an app bundle directory inspectra render file html \ mycli.json \ --out-dir ./docs/ # Markdown keeps tree layout support inspectra render file markdown \ mycli.json \ --layout tree \ --out-dir ./docs/