Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Workflows

List workflows

tpv workflow list [--status <STATUS>] [--workflow-type <TYPE>] [--since <TIME>] [--before <TIME>]

Filters

FlagDescriptionExample
--statusFilter by execution statusRunning, Completed, Failed
--workflow-typeFilter by workflow type nameOrderWorkflow
--sinceWorkflows started after this time2h, 3d, 2024-01-15
--beforeWorkflows started before this time1h, 2024-12-01
# Running workflows from the last 24 hours
tpv workflow list --status Running --since 24h

# All failed workflows of a specific type
tpv workflow list --status Failed --workflow-type PaymentWorkflow

Get workflow details

tpv workflow get <workflow-id> [--run-id <RUN_ID>]

If --run-id is omitted, the latest run is returned.

Count workflows

tpv workflow count [--status <STATUS>] [--query <QUERY>]

The --query flag accepts raw Temporal visibility queries.

Cancel a workflow

tpv workflow cancel <workflow-id> [--run-id <RUN_ID>]

Terminate a workflow

tpv workflow terminate <workflow-id> [--run-id <RUN_ID>] [--reason <REASON>]

The default reason is "Terminated via CLI".