Installation

WOML is distributed as the global woml-cli npm package. The package installs the woml executable and selects the matching native Rust engine automatically.

Requirements

Requirement	Details
Bun	Version 1.3.14 or later for authored JavaScript and CLI runtime support.
Operating system	A supported Linux, macOS, or Windows target for the prebuilt native engine.
Local storage	A writable directory for `.woml/` state during normal local use.

Install the CLI

Choose one package manager:

Terminal

npm install --global woml-cli
# or
bun add --global woml-cli
# or
pnpm add --global woml-cli

The package is installed globally. A workflow project does not add WOML as an application dependency.

Verify the command

Terminal

woml --version
woml -v
woml --help

Local runtime state

The default durable authority is .woml/state.sqlite. Keep the .woml/ directory writable while developing locally and protect the state directory, snapshots, and backups in production.