@salesforce/plugin-command-reference

@salesforce/plugin-command-reference

Generate the Salesforce CLI command reference guide.

First install the plugin.

$ sfdx plugins:install @salesforce/plugin-command-reference

Ensure any plugins are installed that you with to generate documentation for.

$ sfdx plugins:install salesforcedx

Now we can generate the documentation.

$ sfdx commandreference --plugins salesforcedx

Note: Warnings will occur for missing properties in plugins. Those have to be fixed in the plugin itself.

To add this to your plugin to catch warning at development time, add it as a dev plugin in the project.json.

"oclif": {
  "devPlugins": [
    "@salesforce/plugin-command-reference"
  ]
}

Then you can run this in your plugin's CI.

./bin/run commandreference --plugins <name-of-your-plugin> --error-on-warnings

• sfdx commandreference:generate -p <array> [-d <string>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx commandreference:generate -p <array> [-d <string>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

generate the command reference guide located

USAGE
  $ sfdx commandreference:generate -p <array> [-d <string>] [--hidden] [--erroronwarnings] [--json] [--loglevel
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --outputdir=outputdir                                                         [default: ./tmp/root] output
                                                                                    directory to put generated files

  -p, --plugins=plugins                                                             (required) comma separated list of
                                                                                    plugin names to be part of the
                                                                                    generation

  --erroronwarnings                                                                 fail the command if there are any
                                                                                    warnings

  --hidden                                                                          show hidden commands

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

See code: lib/commands/commandreference/generate.js