https://github.com/shunkosa/sfdx-flowdoc-plugin
A Salesforce CLI plugin that generates design document from Lightning Flow (currently Process Builder) metadata
https://github.com/shunkosa/sfdx-flowdoc-plugin
lightning-experience salesforce salesforcedx sfdx-cli sfdx-plugin
Last synced: 5 months ago
JSON representation
A Salesforce CLI plugin that generates design document from Lightning Flow (currently Process Builder) metadata
- Host: GitHub
- URL: https://github.com/shunkosa/sfdx-flowdoc-plugin
- Owner: shunkosa
- Created: 2020-03-23T03:01:13.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T16:54:13.000Z (over 3 years ago)
- Last Synced: 2025-10-22T10:59:44.494Z (8 months ago)
- Topics: lightning-experience, salesforce, salesforcedx, sfdx-cli, sfdx-plugin
- Language: TypeScript
- Homepage: https://flowdoc.herokuapp.com
- Size: 3.84 MB
- Stars: 70
- Watchers: 11
- Forks: 15
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-sfdx-plugins - Flowdoc
README
# 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](https://flowdoc.herokuapp.com/).
[](https://github.com/shunkosa/sfdx-flowdoc-plugin/actions?query=workflow%3A%22unit%20test%22)
[](https://npmjs.org/package/sfdx-flowdoc-plugin)
[](https://codecov.io/gh/shunkosa/sfdx-flowdoc-plugin)
[](https://npmjs.org/package/sfdx-flowdoc-plugin)
[](https://github.com/shunkosa/sfdx-flowdoc-plugin/blob/master/package.json)
## 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