generate-cli-docs

Regenerate CLI documentation site HTML from Typer metadata and Markdown sources.

112|10|Updated Mar 16, 2026
One-click install
npx skills add https://github.com/mycelium-io/mycelium --skill generate-cli-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-cli-docs
Source: https://github.com/mycelium-io/mycelium/tree/main/.claude/skills/generate-cli-docs
Command: npx skills add https://github.com/mycelium-io/mycelium --skill generate-cli-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Regenerate the HTML docs site for CLI references, configuration, and content from decorators, the pydantic config schema, and markdown sources to keep documentation in sync with code.

Core Features & Use Cases

  • Generate the CLI Reference from @doc_ref metadata on Typer commands.
  • Build the Configuration docs from pydantic Field descriptions.
  • Update the Content sections from markdown files in docs/.

Quick Start

Run the docs generator to rebuild the CLI docs from the source metadata and markdown sources.

Frequently Asked Questions about generate-cli-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate CLI documentation from Typer command metadata?

To build configuration docs from pydantic schemas, run the docs generator to extract Field descriptions and output formatted HTML documentation. This ensures your configuration references stay synced with your pydantic schema definitions.

How do I build configuration documentation from pydantic Field descriptions?

To build configuration docs from pydantic schemas, run the docs generator to extract Field descriptions and output formatted HTML documentation. This ensures your configuration references accurately reflect your pydantic schema definitions.

What is the best way to keep CLI documentation in sync with code changes?

The best way to keep CLI documentation in sync with code is to automate regeneration from source metadata, pulling command decorators, pydantic config schemas, and markdown files to rebuild the HTML site. This eliminates manual documentation updates.

Can I use markdown files to generate content sections for my CLI docs site?

Yes, you can use markdown files to generate content sections by running the docs generator, which processes markdown sources from the docs directory and incorporates them into the final HTML documentation site alongside the CLI reference.

Do I need Python tooling in the mycelium-cli project to run the docs generator?

Yes, you need Python tooling within the mycelium-cli project to run the docs generator script, which executes the generation process and produces the updated HTML documentation site from your source metadata.