Public beta — not for production use. Data may be wiped at any time. Questions? Contact us.
Documentation menu

axiom flow preview

Preview the exact value(s) a mapping produces for sample input

View as Markdown
<!-- GENERATED by docs/scripts/gen-cli-reference — DO NOT EDIT. Source of truth: the cobra command definitions in cmd/axiom/cmd/. Regenerate from the repo root with: go run ./docs/scripts/gen-cli-reference -->

axiom flow preview

Preview the exact value(s) a mapping produces for sample input

Preview a flow.yaml edge adapter or compose-consumer mapping against sample source value(s), without a live invoke.

Runs the SAME mapping engine (PrepareAdapter/ExecuteAdapter, CEL, transforms) the registry compiler and worker use at real dispatch time — the output is the exact value your mapping produces, not an approximation.

Preview a plain edge's adapter (a single source, "from" node's alias, to a "to" node's alias):

axiom flow preview --edge from:to --sample source.json

source.json is one JSON object shaped like the "from" node's output message.

Preview a compose-consumer node's compose mapping (one or more incident edges joined into a single input):

axiom flow preview --node consumer_alias --sample sources.json

sources.json is a JSON object keyed by each incident edge's SOURCE node alias:

{"branch_a": {...}, "branch_b": {...}}

--sample defaults to stdin when omitted. Requires a prior "axiom login" and a flow.yaml whose nodes/edges resolve against the live registry (same resolution "axiom flow compile" performs) — the flow does not need to be compiled or saved first.

Usage

axiom flow preview [flow.yaml] [flags]

Flags

FlagShorthandTypeDefaultDescription
--edgestringPreview a plain edge's adapter, given as "from:to" node aliases
--help-hboolhelp for preview
--jsonboolEmit a single JSON result object
--nodestringPreview a compose-consumer node's compose mapping, given its alias
--samplestringPath to a JSON file with sample source value(s) (defaults to stdin)

See also

  • axiom flow — Author and compile flows (graphs of published nodes)
Related