hardis:doc:flow2markdown
Description
Generates a markdown documentation from a Flow file
Parameters
| Name | Type | Description | Default | Required | Options |
|---|---|---|---|---|---|
| debug -d |
boolean | Activate debug mode (more logs) | |||
| flags-dir | option | undefined | |||
| inputfile -x |
option | Path to Flow metadata file. If not specified, the command will prompt the user | |||
| json | boolean | Format output as json. | |||
| outputfile -f |
option | Force the path and name of output markdown file. Must end with .md | |||
| skipauth | boolean | Skip authentication check when a default username is required | |||
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration |
Examples
$ sf hardis:doc:flow2markdown
$ sf hardis:doc:flow2markdown --inputfile force-app/main/default/flows/MyFlow.flow-meta.xml