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 🔗
What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
operations.
tctl activity complete 🔗 tctl activity complete
How to provide a result and complete an Activity Execution using tctl.
tctl cli reference
tctl activity fail 🔗 tctl activity fail
How to fail an Activity Execution using tctl.
tctl cli reference
complete The tctl activity complete command completes an Activity Execution 🔗
What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
.
tctl activity complete <modifiers>
The following modifiers control the behavior of the command.
--workflow_id Specify the Workflow Id 🔗
What is a Workflow Id?
A Workflow Id is a customizable, application-level identifier for a Workflow Execution that is unique to an Open Workflow Execution within a Namespace.
term explanation
of an
Activity Execution 🔗 What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
to complete.
Alias: -w
Example
tctl activity complete --workflow_id < id > --run_id Specify the Run Id 🔗
What is a Run Id?
A Run Id is a globally unique, platform-level identifier for a Workflow Execution.
term explanation
of an
Activity Execution 🔗 What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
to complete.
Alias: -r
Example
tctl activity complete --run_id < id > --activity_id Specify the Activity Id 🔗
What is an Activity Id?
A unique identifier for an Activity Execution.
term explanation
of an
Activity Execution 🔗 What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
to complete.
Example
tctl activity complete --activity_id < id > --result Specify the result of an Activity Execution 🔗
What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
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 🔗
What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
.
Example
tctl activity complete --identity < value > fail The tctl activity fail command fails an Activity Execution 🔗
What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
.
tctl activity fail [<modifiers>]
The following modifiers control the behavior of the command.
--workflow_id Specify the Workflow Id 🔗
What is a Workflow Id?
A Workflow Id is a customizable, application-level identifier for a Workflow Execution that is unique to an Open Workflow Execution within a Namespace.
term explanation
of an
Activity Execution 🔗 What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
to fail.
Alias: -w
Example
tctl activity fail --workflow_id < id > --run_id Specify the Run Id 🔗
What is a Run Id?
A Run Id is a globally unique, platform-level identifier for a Workflow Execution.
term explanation
of an
Activity Execution 🔗 What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
to fail.
Alias: -r
Example
tctl activity fail --run_id < id > --activity_id Specify the Activity Id 🔗
What is an Activity Id?
A unique identifier for an Activity Execution.
term explanation
of an
Activity Execution 🔗 What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
to fail.
Example
tctl activity fail --activity_id < id > --reason Specify the reason for failing an Activity Execution 🔗
What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
.
Example
tctl activity fail --reason < value > --detail Specify details of the reason for failing an Activity Execution 🔗
What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
.
Example
tctl activity fail --detail < value > --identity Specify the identity of the operator when using tctl to fail an Activity Execution 🔗
What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
term explanation
.
Example
tctl activity complete --identity < value >