Skip to main content

tctl v1.17 activity command reference

Temporal CLI is now available!

The new Temporal CLI is available for use.

tctl v1.17 can still be used with Temporal Server version 1.20 and is expected to be compatible with Temporal Server version 1.21.

tctl is expected to be fully deprecated by Temporal Server version 1.22

The tctl activity commands enable Activity Execution operations.

complete

The tctl activity complete command completes an Activity Execution.

tctl activity complete <modifiers>

The following modifiers control the behavior of the command.

--workflow_id

Specify the Workflow Id of an Activity Execution to complete.

Alias: -w

Example

tctl activity complete --workflow_id <id>

--run_id

Specify the Run Id of an Activity Execution to complete.

Alias: -r

Example

tctl activity complete --run_id <id>

--activity_id

Specify the Activity Id of an Activity Execution to complete.

Example

tctl activity complete --activity_id <id>

--result

Specify the result of an Activity Execution when using tctl to complete the Activity Execution.

Example

tctl activity complete --result <value>

--identity

Specify the identity of the operator when using tctl to complete an Activity Execution.

Example

tctl activity complete --identity <value>

fail

The tctl activity fail command fails an Activity Execution.

tctl activity fail [<modifiers>]

The following modifiers control the behavior of the command.

--workflow_id

Specify the Workflow Id of an Activity Execution to fail.

Alias: -w

Example

tctl activity fail --workflow_id <id>

--run_id

Specify the Run Id of an Activity Execution to fail.

Alias: -r

Example

tctl activity fail --run_id <id>

--activity_id

Specify the Activity Id of an Activity Execution to fail.

Example

tctl activity fail --activity_id <id>

--reason

Specify the reason for failing an Activity Execution.

Example

tctl activity fail --reason <value>

--detail

Specify details of the reason for failing an Activity Execution.

Example

tctl activity fail --detail <value>

--identity

Specify the identity of the operator when using tctl to fail an Activity Execution.

Example

tctl activity complete --identity <value>