run

Runs a declarative playbook file — a YAML or JSON document that lists named steps, each invoking a step kind (for example source.create) with its params. The steps execute in file order over a live session, and a step can reference an earlier step's output with a ${step:field} placeholder, so you can chain resources together (create a source, then feed its id into the next step). This is how you provision a whole reconciliation setup from one version-controlled file instead of running many commands by hand.

Reach for this when you want a repeatable, scriptable way to stand up several related resources at once — the individual simetrik <resource> create commands are better for one-off, interactive work. The runner is fail-fast with no rollback: it stops at the first failed step, leaving steps before it created and marking every step after it skipped. A malformed playbook (bad format, unknown kind, duplicate step name, unsupported schema_version) is rejected whole, before any API call, so a typo in a later step never leaves the API half-mutated. The playbook must declare schema_version: '1', a name, and a non-empty steps list. Pass --output json to emit a single report envelope ({"ok":...,"steps":[...]}) for scripting; the default output is a per-step text summary.

See also: source create, reconciliation create. The permission required depends on the step kinds the playbook runs — a playbook that writes resources needs resources · create_edit. See permissions.

Arguments

• file — Path to the fixture playbook (.yaml, .yml, or .json)

Examples

simetrik fixtures run flow.yaml
simetrik fixtures run ./fixtures/basic-recon.yml
simetrik fixtures run playbook.json --output json

Exit codes