Skip to main content
Version: june-2022

tctl workflow terminate

The tctl workflow terminate command terminates a Workflow Execution.

Terminating a running Workflow Execution records a WorkflowExecutionTerminated event as the closing event in the History. No more command tasks will be scheduled.

See also tctl workflow cancel.

tctl workflow terminate [<modifiers>]

The following modifiers control the behavior of the command.

--workflow_id

Specify a Workflow Id.

Aliases: --wid, -w

Example

tctl workflow terminate --workflow_id <id>

--run_id

Specify a Run Id.

Aliases: --rid, -r

Example

tctl workflow terminate --run_id <id>

--reason

Specify a reason for terminating the Workflow Execution.

Alias: --re

Example

tctl workflow terminate --reason <string>