Miss any of our Open RFC calls?Watch the recordings here! »

bbdoc

3.1.0 • Public • Published

bbdoc

Bob Buzzard's Salesforce CLI Plugin to allow documentation to be autogenerated from org metadata.

Version Downloads/week License

$ npm install -g bbdoc
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
bbdoc/3.1.0 darwin-x64 node-v8.11.3
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

sfdx bbdoc:doc -r <string> -s <string> [-c <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

generate documentation for an org

USAGE
  $ sfdx bbdoc:doc -r <string> -s <string> [-c <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --config=config                                                               configuration file

  -r, --report-dir=report-dir                                                       (required) directory to store the
                                                                                    generated report

  -s, --source-dir=source-dir                                                       (required) source directory
                                                                                    containing the org metadata

  --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

EXAMPLE
  $ sfdx bbdoc:doc --config ./config/bbdoc-config.jsob --report-dir ./report --source-dir force-app/main/default
  Documenting Org
  Documented Org
  Report generated at report/index.html

See code: lib/commands/bbdoc/doc.js

Keywords

Install

npm i bbdoc

DownloadsWeekly Downloads

20

Version

3.1.0

License

MIT

Unpacked Size

549 kB

Total Files

57

Last publish

Collaborators

  • avatar