<!-- 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 flowNode positions are coarse grid cells (col, row); omit them to auto-layout.
Usage
axiom flow [flags]
axiom flow [command]Flags
| Flag | Shorthand | Type | Default | Description |
|---|---|---|---|---|
--help | -h | bool | help for flow |
Subcommands
| Command | Description |
|---|---|
| axiom flow assemble | Emit the flow's assembled SourceGraph JSON (no save, no compile) |
| axiom flow compile | Resolve nodes, lay out, and compile a runnable flow artifact |
| axiom flow layout | Auto-position nodes on the grid and write col/row back |
| axiom flow mapping-scope | Show the CEL variables and functions in scope for an edge mapping |
| axiom flow mock | Manage the flow's authoring mocks (ADR-176) |
| axiom flow new | Scaffold a starter flow.yaml |
| axiom flow preview | Preview the exact value(s) a mapping produces for sample input |
| axiom flow publish | Publish a flow document to the public marketplace |
| axiom flow pull | Materialize an existing compiled flow into an editable flow.yaml |
| axiom flow run | Invoke a compiled flow and print its result |
| axiom flow save | Save a flow as an editor document openable in the visual editor |
| axiom flow test | Run the flow's tests/*.test.yaml suites against the real worker (ADR-200) |
| axiom flow validate | Validate a flow.yaml's structure (local checks) |
See also
- axiom — Axiom CLI — build and push node packages
- axiom flow assemble — Emit the flow's assembled SourceGraph JSON (no save, no compile)
- axiom flow compile — Resolve nodes, lay out, and compile a runnable flow artifact
- axiom flow layout — Auto-position nodes on the grid and write col/row back
- axiom flow mapping-scope — Show the CEL variables and functions in scope for an edge mapping
- axiom flow mock — Manage the flow's authoring mocks (ADR-176)
- axiom flow new — Scaffold a starter flow.yaml
- axiom flow preview — Preview the exact value(s) a mapping produces for sample input
- axiom flow publish — Publish a flow document to the public marketplace
- axiom flow pull — Materialize an existing compiled flow into an editable flow.yaml
- axiom flow run — Invoke a compiled flow and print its result
- axiom flow save — Save a flow as an editor document openable in the visual editor
- axiom flow test — Run the flow's tests/*.test.yaml suites against the real worker (ADR-200)
- axiom flow validate — Validate a flow.yaml's structure (local checks)
Related