cli-md-docs
v1.0.5
Published
Tool for creating markdown Readme documentation for cli tools created with [yargs](https://github.com/yargs/yargs) ## Install ```shell npm i -g cli-md-docs ``` ## Usage ## cli-md-docs --- ```shell $ cli-md-docs ``` Tool for creating
Downloads
3
Maintainers
Readme
cli-md-docs
Tool for creating markdown Readme documentation for cli tools created with yargs
Install
npm i -g cli-md-docs
Usage
cli-md-docs
$ cli-md-docs
Tool for creating markdown Readme documentation for cli tools created with
yargs
Options:
|option|description|type|required|default|
|---|---|---|---|---|
|--help|Show help|boolean|||
|--version|Show version number|boolean|||
|--path|path to the cli executable|string|true||
|--name|real name of the cli. If omitted, the name of the executable is used|string|||
|--output, -o|the output file.|string||./Readme.md|
|--installTemplate|replaces the default how to install.|string|||