help-generator

What problem does it solve?

Many CLI modules lack consistent, up-to-date user documentation and maintaining manual help files is time-consuming and error-prone. This skill analyzes module source code to produce a standardized help.md file so users and maintainers always have an accurate usage reference.

Core Features & Use Cases

• Source analysis: Parse TypeScript command modules to extract command names, options, descriptions, and examples.
• Standardized output: Generate a docs/help.md file in the target module that follows a consistent template including usage, options, configuration, and notes.
• Use case: Developers working in a monorepo can run the generator to create or refresh help pages for CLI modules before releases or documentation audits.

Quick Start

Run the help-generator targeting the module path to produce a docs/help.md file in that module.