vulkro-sf flowmap

Renders the automation graph Vulkro builds over your project: every flow and subflow, the call edges between them, and the fields and objects each flow touches. The map is the visual companion to the process-mining detectors. Where the detectors flag orphan and hub flows, flowmap lets you see the whole estate and trace a single flow's neighbourhood.

Runs entirely on the local project. No org connection is required.

Synopsis

vulkro-sf flowmap [PATH] [flags]

PATH defaults to the current directory and should contain an SFDX project or a retrieved metadata folder.

Flags

Flag	Type	Default	Description
--format <fmt>	enum	json	Output format: json (the full graph as machine-readable nodes and edges), mermaid (a Mermaid flowchart definition you can paste into Markdown or a Mermaid renderer), or dot (Graphviz DOT for rendering with dot -Tsvg).
--root <apiName>	string	(none)	Limit the map to the connected component reachable from one flow, so a large estate renders as a focused neighbourhood instead of the full graph.

Exit codes

• 0 - the graph was rendered successfully.
• 1 - the graph was rendered and at least one structural issue (an orphan or a dangling subflow edge) was annotated in it.
• 2 - error: bad arguments, no parseable flows under PATH, IO failure, or internal error. The message names the cause and the next step.

What it does

flowmap parses every flow in the project, resolves subflow calls into edges, and attaches the fields and objects each flow reads or writes as node attributes. Orphan flows (no inbound trigger and no caller) and dangling edges (a subflow call to a missing target) are annotated in the output so the rendered map shows them rather than hiding them.

The json format is the integration surface: pipe it into a graph tool or a custom dashboard. The mermaid and dot formats are for human review, in a pull request, a wiki, or an architecture doc.

Example

# Full automation graph as JSON, saved for a dashboard.
vulkro-sf flowmap . --format json > flowmap.json

# Mermaid flowchart to paste into a design doc.
vulkro-sf flowmap . --format mermaid > flowmap.mmd

# Focused neighbourhood around one hub flow, rendered to SVG via Graphviz.
vulkro-sf flowmap . --format dot --root Lead_Routing | dot -Tsvg > lead-routing.svg