Starflow CLI Export

Starflow CLI Export

Use sf export (or starflow export) to emit a compiled pipeline snapshot in formats suited for:

• machine consumption (json, yaml)
• agent/system-readable docs (text)
• human review and sharing (html-bundle)

Command

sf export <pipeline> [--format=<json|yaml|text|html-bundle>] [--out=<path>] [--config=<path>]

Formats

• json - canonical machine payload with compiled graph and metadata
• yaml - same payload in YAML form for config-centric tools
• text - concise, plain text structure for LLM agents and logs
• html-bundle - single-file HTML report with steps, edges, and embedded graph JSON

Defaults

If --out is omitted, output is written to:

• .starsystem/tmp/<pipeline>-export.json
• .starsystem/tmp/<pipeline>-export.yaml
• .starsystem/tmp/<pipeline>-export.txt
• .starsystem/tmp/<pipeline>-export.html

--config defaults to the nearest discovered starflow.yaml.

Examples

# JSON export (default format)
sf export guided-rfp

# YAML export with explicit output
sf export guided-rfp --format=yaml --out .starsystem/tmp/guided-rfp.yaml

# Agent-friendly text export
sf export guided-rfp --format=text

# Portable HTML export bundle
sf export guided-rfp --format=html-bundle --out .starsystem/tmp/guided-rfp.html

Suggested usage by surface

• CI / automation: json or yaml
• Agent pipelines / prompt context: text
• Human review handoff: html-bundle

JSON Schema (sf schema)

For editor validation of starflow.yaml, emit JSON Schema from the same Zod as loadStarflowConfig:

sf schema step > starflow-step.schema.json
sf schema config --out=./starflow.schema.json
sf schema help

Use starflow schema help for a YAML quick reference (use_sandbox, sandbox_provider, vpn-connect, …). See Starflow Designer vs Engine and CLI Reference.