hardis:doc:packagexml2markdown
Description
Generates a markdown documentation from a package.xml 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 package.xml file. If not specified, the command will look in manifest folder | |||
| json | boolean | Format output as json. | |||
| outputfile -f |
option | Force the path and name of output report 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:packagexml2markdown
$ sf hardis:doc:packagexml2markdown --inputfile manifest/package-all.xml