help-generator

Generate standardized help.md documentation from Node.js and TypeScript CLI module source code.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/linzb93/cli-tools --skill help-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: help-generator
Source: https://github.com/linzb93/cli-tools/tree/main/.trae/skills/help-generator
Command: npx skills add https://github.com/linzb93/cli-tools --skill help-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about help-generator

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

FAQPage Schema
How do I auto-generate CLI usage documentation from TypeScript source code?

You can auto-generate CLI usage documentation by parsing TypeScript command modules to extract command names, options, and descriptions, which are then written into a standardized docs/help.md file within the target module directory.

How do I generate help.md files for multiple CLI modules in a monorepo?

To generate help.md files in a monorepo, you run the documentation generator targeting specific module paths, automatically parsing source code and refreshing help pages for each CLI module before releases or documentation audits.

Can I extract command definitions and options from Node.js CLI modules?

Yes, you can extract command definitions, parameter details, and options directly from Node.js and TypeScript CLI modules by analyzing the source code to produce a standardized usage reference.

What is the best way to maintain consistent CLI documentation across modules?

The best way to maintain consistent CLI documentation is to analyze source code and generate a standardized help.md file using a consistent template that includes usage, options, configuration, and notes for each module.

Does this CLI documentation generator work without external dependencies?

Yes, the CLI documentation generator operates without external dependencies, directly analyzing TypeScript command module source code to extract definitions and write help.md files into the module docs directory.