Check, run, test, and types

Human-readable colored output is default. Commands offering --json expose a stable machine-readable form. Relative paths resolve from the current working directory. Default durable state is .woml/state.sqlite.

woml check

Terminal
woml check <workflow.woml|directory>... [--config <path>] [--json]

Parses, validates, compiles, checks cross-workflow calls, packages module graphs, verifies referenced secret names when production config is supplied, and refreshes editor declarations. It does not execute scripts, activate triggers, connect providers, or create workflow runs. Direct .woml files in a directory are loaded non-recursively.

Use --config for production preflight, including listener/storage checks and an aggregated missing-secret report. Use --json in CI.

woml run

Terminal
woml run <workflow.woml|directory>... \
  [--config <path>] [--host <address>] [--port <port>] \
  [--state <path>] [--trigger <manualTriggerId>] [--resume <runId>] \
  [--approval-port <port>] [--json] [--verbose] \
  [--color=auto|always|never] [--background|-d]

Activates one or more workflows as one deployment unit. It validates the full set, pins exact definitions/module artifacts, prepares recovery, starts providers and listeners behind a closed readiness gate, then opens admission atomically. It remains active for future trigger occurrences.

Important options:

OptionMeaning
--configRuntime configuration JSON.
--host, --portOverride public trigger listener.
--stateSelect durable SQLite authority; use consistently across related processes/commands.
--triggerSelect a manual trigger when needed.
--resumeContinue one recoverable existing run against its stored immutable definition.
--approval-portOverride local approval listener port.
--jsonMachine-readable command output where supported.
--verboseAdditional safe diagnostics.
--colorAuto, always, or never.
--background, -dDetach only after genuine readiness.

Multiple explicit files are supported:

Terminal
woml run parent.woml child.woml

A directory is supported:

Terminal
woml run workflows/

Reusable definition files may be present as dependencies, but only runnable workflow profiles activate.

woml test

Terminal
woml test <workflow.woml> [--state <path>] \
  [--trigger <manualTriggerId>] [--resume <runId>] \
  [--approval-port <port>]

Executes one manual occurrence and exits. This is for integration tests and CI, not normal automation hosting.

woml types

Terminal
woml types <workflow.woml|directory> [--output <path>]

Explicitly refreshes built-in and imported service declarations. check and run already generate the default woml-env.d.ts; use this command for a custom path or editor-only refresh.