Skip to content

CLI Reference

wf is the single binary that provides all commands. All commands share a set of global flags.

Global Flags

These flags are available on every subcommand.

Flag Type Default Description
--config string platform default Path to the config file
--log-level string info Log verbosity: debug, info, warn, error
--verbose, -v bool false Shorthand for --log-level debug

Commands

Command Description
wf init Initialise workspace: create directories, database, and config file
wf run Execute a workflow
wf resume Resume a failed or interrupted run
wf validate Validate workflow definitions without running them
wf list List all available workflows
wf runs List, filter, and analyse past workflow runs
wf logs View task logs for a specific run
wf graph Visualise the workflow DAG
wf inspect Show detailed information about a run
wf status Live-poll the status of a running workflow
wf audit Show the chronological audit trail for a run
wf diff Compare two runs side-by-side
wf export Export a complete run record as JSON or tar archive
wf health System health check

Shell Completion

# Bash
wf completion bash > /etc/bash_completion.d/wf

# Zsh
wf completion zsh > "${fpath[1]}/_wf"

# Fish
wf completion fish > ~/.config/fish/completions/wf.fish