< woml />
View on GitHub

WOML Projects

A WOML project keeps workflows and the configuration they need together. Run woml init to create a project, then use woml check to validate it before starting a runtime.

Create a project

Terminal
woml init my-automation
cd my-automation
woml check
woml test

Initialization creates workflow.json, AGENTS.md, and a starter workflow under workflows/. It does not overwrite existing files. Keep credentials out of the manifest and workflow source.

Understand workflow.json

JSON
{
  "profile": "woml.project/v1",
  "version": 1,
  "name": "my-automation",
  "workflows": ["./workflows"]
}

The manifest can also reference runtime configuration, operator-controlled policies, a reviewer directory, and remote target configuration. These are paths to separately governed documents, not grants of new authority. WOML resolves references relative to the manifest and rejects escapes, duplicate workflows, and unsupported versions.

Run and inspect

From the project directory, woml check, woml test, woml types, and woml run discover workflow.json in the current directory only. Use --project from another directory:

Terminal
woml check --project ./workflow.json --json
woml run --project ./workflow.json

An explicit CLI option cannot silently replace authority declared by the project; conflicting inputs fail. Existing commands that name a .woml file directly still work.