Wondering what’s next for npm?Check out our public roadmap! »

bbdoc

3.4.6 • Public • Published

bbdoc

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

Version Downloads/week License

INSTALLING
  $ sfdx plugins:install bbdoc
  $ sfdx plugins
    @salesforce/sfdx-diff 0.0.6
       ...
    bbdoc 3.4.6

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.json --report-dir ./report --source-dir force-app/main/default/
  Documenting Org
  Documented Org
  Report generated at report/index.html

See code: src/commands/bbdoc/doc.ts

Keywords

Install

npm i bbdoc

DownloadsWeekly Downloads

64

Version

3.4.6

License

MIT

Unpacked Size

559 kB

Total Files

57

Last publish

Collaborators

  • avatar