yargs-reference
Version:
A tool to generate a command line reference from a yargs powered cli
27 lines (18 loc) • 915 B
Markdown
# Command Reference
Note: This is not an exauhstive list, and entries may be missing or incomplete.
----
### Command
`yargs-reference `
### Description
Generate markdown/html reference for a yargs powered CLI app
### Options
| Option Name | Description | Type | Required | Default Value |
| :--- | :------------ | :---: | :---: | :---: |
| debug | Show debug messages in console | boolean | false | false |
| output | Output format (Choices: [md,html]) | string | false | md |
| target | Directory to wrote the reference file to | string | false | ./docs |
| overwrite | Overwrite existing reference file if it already exists | boolean | false | false |
| quiet | Suppress rendered output, will still ouput error messages | boolean | false | false |
| silent | Suppress all output, error code indicated result | boolean | false | false |
| hidden | Document hidden commands | boolean | false | false |
----