CLI Reference

Commands

Start Twerk in a specific mode.

twerk server start <MODE> [OPTIONS]

Mode	Description
`standalone`	All-in-one: Coordinator + Worker
`coordinator`	API server, requires separate workers
`worker`	Task executor, requires coordinator

Option	Description	Default
`--hostname <HOSTNAME>`	Coordinator hostname for workers	none

Config is loaded from TWERK_CONFIG or the default config search paths. There is no --config CLI flag.

Run database migrations.

twerk migration [OPTIONS]

Option	Description
`-y, --yes`	Skip confirmation prompt

twerk migration reads the datastore type and Postgres DSN from config or TWERK_* environment variables.

Check coordinator health.

twerk health [OPTIONS]

Option	Description	Default
`-e, --endpoint <URL>`	Coordinator endpoint	`http://localhost:8000`

Show the current CLI version.

twerk version [--json]

Text-mode version discovery commands are clean endpoints: they print only the version line to stdout, keep stderr empty, and exit 0.

Supported forms:

Option	Description
`--json`	Emit machine-readable JSON for help, version, parse errors, and command failures on stdout
`--help`	Show CLI help
`--version`	Show the current version

Help discovery commands such as twerk --json, twerk --json --help, twerk help --json, and twerk run --json --help return JSON with a rendered content field.
Version discovery commands such as twerk --json --version and twerk version --json return JSON on stdout, keep stderr empty, and exit 0.
JSON parse failures keep Clap exit code 2 and write structured error JSON to stdout.
JSON command validation and runtime failures exit 1, write structured error JSON to stdout, and keep stderr empty.

All configuration can be set via environment variables:

TWERK_<SECTION>_<KEY>=value

Examples:

See Configuration for full reference.