sfdx-flowdoc-plugin
A Salesforce CLI plugin that generates design document from Lightning Flow metadata.
Last updated 5 days ago by shunkosa .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install sfdx-flowdoc-plugin 
SYNC missed versions from official npm registry.

Flowdoc (alpha)

A Salesforce CLI plugin that generates design document from Lightning Flow metadata. If you're not familiar with CLI, try the web app version.

Github Workflow Version Codecov Downloads/week License

Features

Supported Flow

  • Trigger based Process
  • Platform Event based Process
  • Invocable Process

Supported Actions

  • Chatter Post
  • Quick Action
  • Apex (Invocable Action)
  • Sub flow/process
  • Record Create
  • Record Update
  • Approval Process

Output Format

  • Word (.docx)
  • PDF
  • JSON

Setup

Install as plugin

sfdx plugins:install sfdx-flowdoc-plugin

Install from source

Clone this repo and run npm install. Then run,

sfdx plugins:link .

Usage

Specify an API name of your process

PDF output

sfdx flowdoc:pdf:generate Example_Process -o dest

Word output

sfdx flowdoc:docx:generate Example_Process -o dest

JSON output

sfdx flowdoc:json:generate Example_Process

You can also use the display command and redirect the output. Use --nospinner option if you don't need spinner while the command execution.

sfdx flowdoc:json:display Example_Process --nospinner > example_process.json

Locale

Add -l (--locale) ja option to export Japanese document.

sfdx flowdoc:pdf:generate Example_Process -l ja

Feedback

Feature requests, bug reports and pull requests are welcome!

Coming Soon

  • Flow Builder
  • Diagram

Current Tags

  • 0.5.1                                ...           latest (5 days ago)

18 Versions

  • 0.5.1                                ...           5 days ago
  • 0.5.0                                ...           a month ago
  • 0.4.0                                ...           a month ago
  • 0.3.0                                ...           a month ago
  • 0.2.0                                ...           2 months ago
  • 0.1.0                                ...           2 months ago
  • 0.0.11                                ...           2 months ago
  • 0.0.10                                ...           2 months ago
  • 0.0.9                                ...           2 months ago
  • 0.0.8                                ...           2 months ago
  • 0.0.7                                ...           2 months ago
  • 0.0.6                                ...           2 months ago
  • 0.0.5                                ...           2 months ago
  • 0.0.4                                ...           2 months ago
  • 0.0.3                                ...           2 months ago
  • 0.0.2                                ...           2 months ago
  • 0.0.1                                ...           2 months ago
  • 0.0.0                                ...           2 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 9
Last Month 31
Dependencies (12)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |