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

axiom flow

Author and compile flows (graphs of published nodes)

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

Author and compile flows (graphs of published nodes)

Author and compile Axiom flows from a flow.yaml.

A flow.yaml composes published nodes (referenced by package + node name) into a graph. The usual loop:

axiom flow new my-flow                  # scaffold my-flow.flow.yaml
# edit it: add nodes + wire edges
axiom flow validate my-flow.flow.yaml   # structural checks
axiom flow layout   my-flow.flow.yaml   # auto-position on the canvas grid
axiom flow compile  my-flow.flow.yaml   # resolve nodes + compile a runnable flow

Node positions are coarse grid cells (col, row); omit them to auto-layout.

Usage

axiom flow [flags]
axiom flow [command]

Flags

FlagShorthandTypeDefaultDescription
--help-hboolhelp for flow

Subcommands

CommandDescription
axiom flow compileResolve nodes, lay out, and compile a runnable flow artifact
axiom flow layoutAuto-position nodes on the grid and write col/row back
axiom flow newScaffold a starter flow.yaml
axiom flow publishPublish a compiled flow to the public marketplace
axiom flow pullMaterialize an existing compiled flow into an editable flow.yaml
axiom flow runInvoke a compiled flow and print its result
axiom flow validateValidate a flow.yaml's structure (local checks)

See also