Temporal CLI activity command reference
Activity commands operate on Activity Executions
What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
To run an Activity command, type temporal activity [command] [command options]
complete
The temporal activity complete command completes an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
Along with completing the Activity, the result given upon return can be set as well.
temporal activity complete --activity-id=MyActivity --result=ActivityComplete
Use the options listed below to change the behavior of this command.
- --activity-idtemporal activity-id
Identifies the Activity Execution.
Learn more - --fieldstemporal fields
Customize fields to print.
Learn more - --identitytemporal identity
Specify operator's identity.
Learn more - --limittemporal limit
Number of items to print.
Learn more - --no-pagertemporal no-pager
Disables the interactive pager.
Learn more - --outputtemporal output
Output format.
Learn more - --pagertemporal pager
Sets the pager for Temporal CLI to use.
Learn more - --resulttemporal result
Set the result value of Activity completion.
Learn more - --run-idtemporal run-id
Identifies the current Workflow Run.
Learn more - --time-formattemporal time-format
Format time as either relative, iso, raw.
Learn more - --workflow-idtemporal workflow-id
Workflow Id
Learn more
fail
The temporal activity fail command fails an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
The Activity must already be running on a valid WorkflowWhat is a Workflow?
In day-to-day conversations, the term "Workflow" frequently denotes either a Workflow Type, a Workflow Definition, or a Workflow Execution.
Learn more.
temporal fail --workflow-id=meaningful-business-id --activity-id=MyActivity
Use the options listed below to change the behavior of this command.
- --activity-idtemporal activity-id
Identifies the Activity Execution.
Learn more - --detailtemporal detail
Detail to fail the Activity.
Learn more - --fieldstemporal fields
Customize fields to print.
Learn more - --identitytemporal identity
Specify operator's identity.
Learn more - --limittemporal limit
Number of items to print.
Learn more - --no-pagertemporal no-pager
Disables the interactive pager.
Learn more - --outputtemporal output
Output format.
Learn more - --pagertemporal pager
Sets the pager for Temporal CLI to use.
Learn more - --reasontemporal reason
Reason for the operation
Learn more - --run-idtemporal run-id
Identifies the current Workflow Run.
Learn more - --time-formattemporal time-format
Format time as either relative, iso, raw.
Learn more - --workflow-idtemporal workflow-id
Workflow Id
Learn more