1.0.3 • Published 2 years ago
commander-documentation-generator v1.0.3
Commander Documentation Generator
Description
This tool generates a markdown file containing the documentation for a given commander cli module.
Installation
npm install -g commander-documentation-generatorDocumentation
Table of Contents
Commander-documentation-generator
Description: This is a CLI to generate commander CLI documentation
Arguments
| Nom | Alias | Description | Optionnelle | Valeur par défaut | Exemple |
|---|---|---|---|---|---|
--version | -V | output the version number | optional |
Module: Generate
Description:
Arguments
| Nom | Alias | Description | Optionnelle | Valeur par défaut | Exemple |
|---|---|---|---|---|---|
--input | -i | Path to config file | required | ||
--output | -o | Path to output file | required | ./documentation.md |
Example:
commander-documentation-generator generate --input <input> --output <output>