Skip to main content

Temporal CLI workflow command reference

Workflow commands allow operations to be performed on Workflow ExecutionsLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more.

cancel​

The temporal workflow cancel command cancels a Workflow ExecutionLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more.

Canceling a running Workflow Execution records a WorkflowExecutionCancelRequested event in the Event HistoryLink preview iconWhat is an Event History?

An append log of Events that represents the full state a Workflow Execution.

Learn more. A new CommandLink preview iconWhat is a Command?

A Command is a requested action issued by a Worker to the Temporal Cluster after a Workflow Task Execution completes.

Learn more Task will be scheduled, and the Workflow Execution performs cleanup work.

Use the options listed below to change the behavior of this command. Make sure to write the command as follows: temporal workflow cancel [command options] [arguments]

count​

The temporal workflow count command returns a count of Workflow ExecutionsLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more. This command requires Elasticsearch to be enabled.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal workflow count [command options] [arguments]

delete​

The temporal workflow delete command deletes the specified Workflow ExecutionLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal workflow delete [command options] [arguments]

describe​

The temporal workflow describe command shows information about a given Workflow ExecutionLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more. This information can be used to locate Workflow Executions that weren't able to run successfully.

Use the command options listed below to change the information returned by this command. Make sure to write the command in this format: temporal workflow describe [command options] [arguments]

execute​

The temporal workflow execute command starts a new Workflow ExecutionLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more and prints its progress. The command doesn't finish until the WorkflowLink preview iconWhat 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 completes.

Single quotes('') are used to wrap input as JSON.

Use the command options listed below to change how the Workflow Execution behaves during its run. Make sure to write the command in this format: temporal workflow execute [command options] [arguments]

list​

The temporal workflow list command provides a list of Workflow ExecutionsLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more that meet the criteria of a given QueryLink preview iconWhat is a Query?

A Query is a synchronous operation that is used to report the state of a Workflow Execution.

Learn more. By default, this command returns a list of up to 10 closed Workflow Executions.

Use the command options listed below to change the information returned by this command. Make sure to write the command as follows: temporal workflow list [command options] [arguments]

query​

The temporal workflow query command sends a QueryLink preview iconWhat is a Query?

A Query is a synchronous operation that is used to report the state of a Workflow Execution.

Learn more to a Workflow ExecutionLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more.

Queries can retrieve all or part of the Workflow state within given parameters. Queries can also be used on completed WorkflowsLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more.

Use the command options listed below to change the information returned by this command. Make sure to write the command as follows: temporal workflow query [command options] [arguments]

reset​

The temporal workflow reset command resets a Workflow ExecutionLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more. A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event HistoryLink preview iconWhat is an Event History?

An append log of Events that represents the full state a Workflow Execution.

Learn more.

Use the options listed below to change reset behavior. Make sure to write the command as follows: temporal workflow reset [command options] [arguments]

reset-batch​

The temporal workflow reset-batch command resets a batch of Workflow ExecutionsLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more by resetType. Resetting a WorkflowLink preview iconWhat 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 allows the process to resume from a certain point without losing your parameters or Event HistoryLink preview iconWhat is an Event History?

An append log of Events that represents the full state a Workflow Execution.

Learn more.

Use the options listed below to change reset behavior. Make sure to write the command as follows: temporal workflow reset-batch [command options] [arguments]

show​

The temporal workflow show command provides the Event HistoryLink preview iconWhat is an Event History?

An append log of Events that represents the full state a Workflow Execution.

Learn more for a specified Workflow ExecutionLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal workflow show [command options] [arguments]

signal​

The temporal workflow signal command is used to SignalLink preview iconWhat is a Signal?

A Signal is an asynchronous request to a Workflow Execution.

Learn more a Workflow ExecutionLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more by ID or List FilterLink preview iconWhat is a List Filter?

A List Filter is the SQL-like string that is provided as the parameter to an Advanced Visibility List API.

Learn more.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal workflow signal [command options] [arguments]

stack​

The temporal workflow stack command queries a Workflow ExecutionLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more with --stack-trace as the QueryLink preview iconWhat is a Query?

A Query is a synchronous operation that is used to report the state of a Workflow Execution.

Learn more type. Returning the stack trace of all the threads owned by a Workflow Execution can be great for troubleshooting in production.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal workflow stack [command options] [arguments]

start​

The temporal workflow start command starts a new Workflow ExecutionLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more. When invoked successfully, the Workflow and Run ID are returned immediately after starting the WorkflowLink preview iconWhat 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.

Use the command options listed below to change how the Workflow Execution behaves upon starting. Make sure to write the command in this format: temporal workflow start [command options] [arguments]

terminate​

The temporal workflow terminate command terminates a Workflow ExecutionLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more

Terminating a running Workflow Execution records a WorkflowExecutionTerminated event as the closing Event in the Event HistoryLink preview iconWhat is an Event History?

An append log of Events that represents the full state a Workflow Execution.

Learn more. Any further CommandLink preview iconWhat is a Command?

A Command is a requested action issued by a Worker to the Temporal Cluster after a Workflow Task Execution completes.

Learn more Tasks cannot be scheduled after running this command.

Use the options listed below to change termination behavior. Make sure to write the command as follows: temporal workflow terminate [command options] [arguments]

trace​

The temporal workflow trace command tracks the progress of a Workflow ExecutionLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more and any Child WorkflowsLink preview iconWhat is a Child Workflow Execution?

A Child Workflow Execution is a Workflow Execution that is spawned from within another Workflow.

Learn more it generates.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal workflow trace [command options] [arguments]