Mailer
Workflows

Workflow CLI

Run and inspect workflow files.

The CLI is part of the Mailer repository.

go run ./cmd/mailer-workflow --file examples/workflows/order-totals.yaml

Flags

FlagPurpose
--fileYAML or JSON workflow path. Required.
--data-dirBase data directory for state and checkpoint defaults.
--dry-runParse, validate, resolve, and compile without executing.
--describePrint the compiled pipeline description.
--quietSuppress the summary.

Dry run

go run ./cmd/mailer-workflow \
  --file examples/workflows/order-totals.yaml \
  --dry-run \
  --describe

Use dry run before connecting service-backed workflows to Kafka or Postgres.

Programmatic runner

result, err := runner.RunFile(ctx, "workflow.yaml", runner.Options{
    BaseDataDir: "./data",
})

Use CompileFile when you want the compiled environment and metadata without executing the pipeline.

On this page