Temporal CLI workflow command reference

Workflow 🔗

x

Link preview

What is a Workflow?

In day-to-day conversations, the term "Workflow" frequently denotes either a Workflow Type, a Workflow Definition, or a Workflow Execution.

term explanation

commands allow operations to be performed on Workflow Executions 🔗

x

Link preview

What 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.

term explanation

.

cancel

The temporal workflow cancel command cancels a Workflow Execution 🔗

x

Link preview

What 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.

term explanation

.

Canceling a running Workflow Execution records a WorkflowExecutionCancelRequested event 🔗

x

Link preview

Events reference

Events are created by the Temporal Cluster in response to external occurrences and Commands generated by a Workflow Execution.

reference

in the Event History 🔗

x

Link preview

What is an Event History?

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

term explanation

. A new Workflow Task 🔗

x

Link preview

What is a Workflow Task?

A Workflow Task is a Task that contains the context needed to make progress with a Workflow Execution.

term explanation

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

temporal workflow cancel --workflow-id=meaningful-business-id

In addition to Workflow IDs, Workflows can also be Signaled 🔗

x

Link preview

What is a Signal?

A Signal is an asynchronous request to a Workflow Execution.

term signals explanation

by a Query 🔗

x

Link preview

What is a Query?

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

term queries explanation

. temporal workflow cancel --query=MyQuery

Use the options listed below to change the behavior of this command.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --query 🔗

  x

  Link preview

  temporal query

  Visibility Query of Search Attributes describing the Workflow Executions to reset.

  cli reference temporal cli options-feature command-line-interface-cli query queries-feature search attributes visibility workflow visibility

• --reason 🔗

  x

  Link preview

  temporal reason

  Reason for the operation

  cli reference temporal cli options-feature command-line-interface-cli operation

• --run-id 🔗

  x

  Link preview

  temporal run-id

  Identifies the current Workflow Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id

• --yes 🔗

  x

  Link preview

  temporal yes

  Confirm all prompts.

  cli reference temporal cli options-feature command-line-interface-cli

count

The temporal workflow count command returns a count of Workflow Executions 🔗

x

Link preview

What 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.

term explanation

. This command requires Elasticsearch to be enabled.

Use the options listed below to change the command's behavior.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --query 🔗

  x

  Link preview

  temporal query

  Visibility Query of Search Attributes describing the Workflow Executions to reset.

  cli reference temporal cli options-feature command-line-interface-cli query queries-feature search attributes visibility workflow visibility

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

delete

The temporal workflow delete command deletes the specified Workflow Execution 🔗

x

Link preview

What 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.

term explanation

.

Use the options listed below to change the command's behavior.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --run-id 🔗

  x

  Link preview

  temporal run-id

  Identifies the current Workflow Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id

describe

The temporal workflow describe command shows information about a given Workflow Execution 🔗

x

Link preview

What 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.

term explanation

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

temporal workflow describe --workflow-id=meaningful-business-id

The output of this command can be changed to show as printed ('raw') or to only show the Workflow Execution's auto-reset points.

temporal workflow describe --workflow-id=meaningful-business-id --raw=true --reset-points=true

Use the command options listed below to change the information returned by this command.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --raw 🔗

  x

  Link preview

  temporal raw

  Print raw data as json (prefer this over -o json for scripting).

  cli reference temporal cli options-feature command-line-interface-cli

• --reset-points 🔗

  x

  Link preview

  temporal reset-points

  Only show Workflow Events that are eligible for reset.

  cli reference temporal cli options-feature command-line-interface-cli reset point resets-feature

• --run-id 🔗

  x

  Link preview

  temporal run-id

  Identifies the current Workflow Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id

execute

The temporal workflow execute command starts a new Workflow Execution 🔗

x

Link preview

What 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.

term explanation

and prints its progress. The command doesn't finish until the Workflow Execution completes.

To execute a Workflow 🔗

x

Link preview

What is a Workflow?

In day-to-day conversations, the term "Workflow" frequently denotes either a Workflow Type, a Workflow Definition, or a Workflow Execution.

term explanation

from the CLI: temporal workflow execute --workflow-id=meaningful-business-id --type=MyWorkflow --task-queue=MyTaskQueue

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

temporal workflow execute --workflow-id=meaningful-business-id --type-MyWorkflow --task-queue-MyTaskQueue --input='{"JSON": "Input"}'

Use the command options listed below to change how the Workflow Execution behaves during its run.

• --cron 🔗

  x

  Link preview

  temporal cron

  Optional Cron Schedule for the Workflow.

  cli reference temporal cli options-feature command-line-interface-cli cron

• --execution-timeout 🔗

  x

  Link preview

  temporal execution-timeout

  Timeout (in seconds) for a Workflow Execution, including retries and continue-as-new tasks.

  cli reference temporal cli options-feature command-line-interface-cli workflow execution retries timeout continue-as-new

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --id-reuse-policy 🔗

  x

  Link preview

  temporal id-reuse-policy

  Allows the same Workflow Id to be used in a new Workflow Execution.

  cli reference temporal cli options-feature command-line-interface-cli workflow id workflow execution reuse policy

• --input 🔗

  x

  Link preview

  temporal input

  Optional JSON input to provide to the Workflow.

  cli reference temporal cli options-feature command-line-interface-cli workflow

• --input-file 🔗

  x

  Link preview

  temporal input-file

  Passes optional input for the Workflow from a JSON file.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --max-field-length 🔗

  x

  Link preview

  temporal max-field-length

  Maximum length for each attribute field.

  cli reference temporal cli options-feature command-line-interface-cli search attributes

• --memo 🔗

  x

  Link preview

  temporal memo

  Set a memo on a schedule (in key=value format).

  cli reference temporal cli options-feature command-line-interface-cli memo

• --memo-file 🔗

  x

  Link preview

  temporal memo-file

  Set a memo from a file.

  cli reference temporal cli options-feature command-line-interface-cli memo

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --run-timeout 🔗

  x

  Link preview

  temporal run-timeout

  Timeout (in seconds) of a single Workflow run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run timeout

• --search-attribute 🔗

  x

  Link preview

  temporal search-attribute

  Set Search Attribute on a schedule.

  cli reference temporal cli options-feature command-line-interface-cli search attributes schedule

• --task-queue 🔗

  x

  Link preview

  temporal task-queue

  Task Queue

  cli reference temporal cli options-feature command-line-interface-cli task queue

• --task-timeout 🔗

  x

  Link preview

  temporal task-timeout

  Start-to-close timeout for a Workflow Task (in seconds).

  cli reference temporal cli options-feature command-line-interface-cli timeout workflow task start-to-close

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --type 🔗

  x

  Link preview

  temporal type

  Search attribute type.

  cli reference temporal cli options-feature command-line-interface-cli search attribute

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id

list

The temporal workflow list command provides a list of Workflow Executions 🔗

x

Link preview

What 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.

term explanation

that meet the criteria of a given Query 🔗

x

Link preview

What is a Query?

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

term queries explanation

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

temporal workflow list --query=MyQuery

The command can also return a list of archived Workflow Executions.

temporal workflow list --archived=true

Use the command options listed below to change the information returned by this command.

• --archived 🔗

  x

  Link preview

  temporal archived

  List archived Workflow Executions.

  cli reference temporal cli archival workflow execution options-feature command-line-interface-cli

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --query 🔗

  x

  Link preview

  temporal query

  Visibility Query of Search Attributes describing the Workflow Executions to reset.

  cli reference temporal cli options-feature command-line-interface-cli query queries-feature search attributes visibility workflow visibility

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

query

The temporal workflow query command sends a Query 🔗

x

Link preview

What is a Query?

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

term queries explanation

to a Workflow Execution 🔗

x

Link preview

What 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.

term explanation

.

Queries can retrieve all or part of the Workflow state within given parameters. Queries can also be used on completed Workflows 🔗

x

Link preview

What 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.

term explanation

.

temporal workflow query --workflow-id=meaningful-business-id --type=MyQueryType

Use the command options listed below to change the information returned by this command.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --input 🔗

  x

  Link preview

  temporal input

  Optional JSON input to provide to the Workflow.

  cli reference temporal cli options-feature command-line-interface-cli workflow

• --input-file 🔗

  x

  Link preview

  temporal input-file

  Passes optional input for the Workflow from a JSON file.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --reject-condition 🔗

  x

  Link preview

  temporal reject-condition

  Optional flag for rejecting Queries based on Workflow state.

  cli reference temporal cli options-feature command-line-interface-cli query workflow state queries-feature

• --run-id 🔗

  x

  Link preview

  temporal run-id

  Identifies the current Workflow Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --type 🔗

  x

  Link preview

  temporal type

  Search attribute type.

  cli reference temporal cli options-feature command-line-interface-cli search attribute

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id

reset

The temporal workflow reset command resets a Workflow Execution 🔗

x

Link preview

What 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.

term explanation

. A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History 🔗

x

Link preview

What is an Event History?

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

term explanation

.

The Workflow Execution can be set to a given Event Type 🔗

x

Link preview

What is an Event?

Events are created by the Temporal Cluster in response to external occurrences and Commands generated by a Workflow Execution.

term explanation

. temporal workflow reset --workflow-id=meaningful-business-id --type=LastContinuedAsNew

Alternatively, the Workflow Execution can be reset to any Event after WorkflowTaskStarted. temporal workflow reset --workflow-id=meaningful-business-id --event-id=MyLastEvent

Use the options listed below to change reset behavior.

• --event-id 🔗

  x

  Link preview

  temporal event-id

  The Event Id for any Event after WorkflowTaskStarted you want to reset to (exclusive).

  cli reference temporal cli options-feature command-line-interface-cli event id events

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --reapply-type 🔗

  x

  Link preview

  temporal reapply-type

  Event types to reapply after the reset point.

  cli reference temporal cli options-feature command-line-interface-cli events event type

• --reason 🔗

  x

  Link preview

  temporal reason

  Reason for the operation

  cli reference temporal cli options-feature command-line-interface-cli operation

• --run-id 🔗

  x

  Link preview

  temporal run-id

  Identifies the current Workflow Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --type 🔗

  x

  Link preview

  temporal type

  Search attribute type.

  cli reference temporal cli options-feature command-line-interface-cli search attribute

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id

reset-batch

The temporal workflow reset-batch command resets a batch of Workflow Executions 🔗

x

Link preview

What 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.

term explanation

by resetType. Resetting a Workflow 🔗

x

Link preview

What is a Workflow?

In day-to-day conversations, the term "Workflow" frequently denotes either a Workflow Type, a Workflow Definition, or a Workflow Execution.

term explanation

allows the process to resume from a certain point without losing your parameters or Event History 🔗

x

Link preview

What is an Event History?

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

term explanation

.

The set of Workflow Executions to reset can be specified in an input file. The input file must have a Workflow ID 🔗

x

Link preview

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

on each line.

temporal workflow reset-batch --input-file=MyInput --input-separator="\t"

Workflow Executions can also be found by Query 🔗

x

Link preview

What is a Query?

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

term queries explanation

. `temporal workflow reset-batch --query=MyQuery

Use the options listed below to change reset behavior.

• --dry-run 🔗

  x

  Link preview

  temporal dry-run

  Simulate reset without resetting any Workflow Executions.

  cli reference temporal cli options-feature command-line-interface-cli workflow execution resets-feature

• --exclude-file 🔗

  x

  Link preview

  temporal exclude-file

  Input file that specifies Workflow Executions to exclude from resetting.

  cli reference temporal cli options-feature command-line-interface-cli workflow execution

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --input-file 🔗

  x

  Link preview

  temporal input-file

  Passes optional input for the Workflow from a JSON file.

  cli reference temporal cli options-feature command-line-interface-cli

• --input-parallelism 🔗

  x

  Link preview

  temporal input-parallelism

  Number of goroutines to run in parallel.

  cli reference temporal cli options-feature command-line-interface-cli goroutine

• --input-separator 🔗

  x

  Link preview

  temporal input-separator

  Separator for the input file.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --non-deterministic 🔗

  x

  Link preview

  temporal non-deterministic

  Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error.

  cli reference temporal cli options-feature command-line-interface-cli workflow execution event workflow task failure resets-feature nondeterministic

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --query 🔗

  x

  Link preview

  temporal query

  Visibility Query of Search Attributes describing the Workflow Executions to reset.

  cli reference temporal cli options-feature command-line-interface-cli query queries-feature search attributes visibility workflow visibility

• --reason 🔗

  x

  Link preview

  temporal reason

  Reason for the operation

  cli reference temporal cli options-feature command-line-interface-cli operation

• --skip-base-is-not-current 🔗

  x

  Link preview

  temporal skip-base-is-not-current

  Skip a Workflow Execution if the base Run is not the current Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow execution workflow run

• --skip-current-open 🔗

  x

  Link preview

  temporal skip-current-open

  Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow execution workflow run workflow id

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --type 🔗

  x

  Link preview

  temporal type

  Search attribute type.

  cli reference temporal cli options-feature command-line-interface-cli search attribute

show

The temporal workflow show command provides the Event History 🔗

x

Link preview

What is an Event History?

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

term explanation

for a specified Workflow Execution 🔗

x

Link preview

What 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.

term explanation

.

Use the options listed below to change the command's behavior.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --follow 🔗

  x

  Link preview

  temporal follow

  Follow the progress of a Workflow Execution.

  cli reference temporal cli options-feature command-line-interface-cli workflow execution

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --max-field-length 🔗

  x

  Link preview

  temporal max-field-length

  Maximum length for each attribute field.

  cli reference temporal cli options-feature command-line-interface-cli search attributes

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --output-filename 🔗

  x

  Link preview

  temporal output-filename

  Serializes Event History to a file.

  cli reference temporal cli options-feature command-line-interface-cli events history

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --reset-points 🔗

  x

  Link preview

  temporal reset-points

  Only show Workflow Events that are eligible for reset.

  cli reference temporal cli options-feature command-line-interface-cli reset point resets-feature

• --run-id 🔗

  x

  Link preview

  temporal run-id

  Identifies the current Workflow Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id

signal

The temporal workflow signal command is used to Signal 🔗

x

Link preview

What is a Signal?

A Signal is an asynchronous request to a Workflow Execution.

term signals explanation

a Workflow Execution 🔗

x

Link preview

What 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.

term explanation

by ID or List Filter 🔗

x

Link preview

What is a List Filter?

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

term explanation filtered-lists visibility

.

Use the options listed below to change the command's behavior.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --input 🔗

  x

  Link preview

  temporal input

  Optional JSON input to provide to the Workflow.

  cli reference temporal cli options-feature command-line-interface-cli workflow

• --input-file 🔗

  x

  Link preview

  temporal input-file

  Passes optional input for the Workflow from a JSON file.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --name 🔗

  x

  Link preview

  temporal name

  Frontend address of the remote Cluster.

  cli reference temporal cli options-feature command-line-interface-cli frontend address cluster

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --query 🔗

  x

  Link preview

  temporal query

  Visibility Query of Search Attributes describing the Workflow Executions to reset.

  cli reference temporal cli options-feature command-line-interface-cli query queries-feature search attributes visibility workflow visibility

• --reason 🔗

  x

  Link preview

  temporal reason

  Reason for the operation

  cli reference temporal cli options-feature command-line-interface-cli operation

• --run-id 🔗

  x

  Link preview

  temporal run-id

  Identifies the current Workflow Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id

• --yes 🔗

  x

  Link preview

  temporal yes

  Confirm all prompts.

  cli reference temporal cli options-feature command-line-interface-cli

stack

The temporal workflow stack command queries a Workflow Execution 🔗

x

Link preview

What 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.

term explanation

with --stack-trace as the Query 🔗

x

Link preview

What is a Query?

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

term queries explanation

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.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --input 🔗

  x

  Link preview

  temporal input

  Optional JSON input to provide to the Workflow.

  cli reference temporal cli options-feature command-line-interface-cli workflow

• --input-file 🔗

  x

  Link preview

  temporal input-file

  Passes optional input for the Workflow from a JSON file.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --reject-condition 🔗

  x

  Link preview

  temporal reject-condition

  Optional flag for rejecting Queries based on Workflow state.

  cli reference temporal cli options-feature command-line-interface-cli query workflow state queries-feature

• --run-id 🔗

  x

  Link preview

  temporal run-id

  Identifies the current Workflow Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id

start

The temporal workflow start command starts a new Workflow Execution 🔗

x

Link preview

What 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.

term explanation

. When invoked successfully, the Workflow and Run ID are returned immediately after starting the Workflow 🔗

x

Link preview

What is a Workflow?

In day-to-day conversations, the term "Workflow" frequently denotes either a Workflow Type, a Workflow Definition, or a Workflow Execution.

term explanation

.

temporal workflow start --task-queue=MyTaskQueue --type=MyWorkflow

Use the command options listed below to change how the Workflow Execution behaves upon starting.

• --cron 🔗

  x

  Link preview

  temporal cron

  Optional Cron Schedule for the Workflow.

  cli reference temporal cli options-feature command-line-interface-cli cron

• --execution-timeout 🔗

  x

  Link preview

  temporal execution-timeout

  Timeout (in seconds) for a Workflow Execution, including retries and continue-as-new tasks.

  cli reference temporal cli options-feature command-line-interface-cli workflow execution retries timeout continue-as-new

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --id-reuse-policy 🔗

  x

  Link preview

  temporal id-reuse-policy

  Allows the same Workflow Id to be used in a new Workflow Execution.

  cli reference temporal cli options-feature command-line-interface-cli workflow id workflow execution reuse policy

• --input 🔗

  x

  Link preview

  temporal input

  Optional JSON input to provide to the Workflow.

  cli reference temporal cli options-feature command-line-interface-cli workflow

• --input-file 🔗

  x

  Link preview

  temporal input-file

  Passes optional input for the Workflow from a JSON file.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --max-field-length 🔗

  x

  Link preview

  temporal max-field-length

  Maximum length for each attribute field.

  cli reference temporal cli options-feature command-line-interface-cli search attributes

• --memo 🔗

  x

  Link preview

  temporal memo

  Set a memo on a schedule (in key=value format).

  cli reference temporal cli options-feature command-line-interface-cli memo

• --memo-file 🔗

  x

  Link preview

  temporal memo-file

  Set a memo from a file.

  cli reference temporal cli options-feature command-line-interface-cli memo

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --run-timeout 🔗

  x

  Link preview

  temporal run-timeout

  Timeout (in seconds) of a single Workflow run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run timeout

• --search-attribute 🔗

  x

  Link preview

  temporal search-attribute

  Set Search Attribute on a schedule.

  cli reference temporal cli options-feature command-line-interface-cli search attributes schedule

• --task-queue 🔗

  x

  Link preview

  temporal task-queue

  Task Queue

  cli reference temporal cli options-feature command-line-interface-cli task queue

• --task-timeout 🔗

  x

  Link preview

  temporal task-timeout

  Start-to-close timeout for a Workflow Task (in seconds).

  cli reference temporal cli options-feature command-line-interface-cli timeout workflow task start-to-close

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --type 🔗

  x

  Link preview

  temporal type

  Search attribute type.

  cli reference temporal cli options-feature command-line-interface-cli search attribute

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id

terminate

The temporal workflow terminate command terminates a Workflow Execution 🔗

x

Link preview

What 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.

term explanation

Terminating a running Workflow Execution records a WorkflowExecutionTerminated event 🔗

x

Link preview

Events reference

Events are created by the Temporal Cluster in response to external occurrences and Commands generated by a Workflow Execution.

reference

as the closing Event in the Event History 🔗

x

Link preview

What is an Event History?

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

term explanation

. Any further Command 🔗

x

Link preview

What is a Command?

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

term explanation

Tasks cannot be scheduled after running this command.

Workflow terminations require a valid Workflow ID 🔗

x

Link preview

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

to function. temporal workflow terminate --workflow-id=meaningful-business-id

Use the options listed below to change termination behavior.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --query 🔗

  x

  Link preview

  temporal query

  Visibility Query of Search Attributes describing the Workflow Executions to reset.

  cli reference temporal cli options-feature command-line-interface-cli query queries-feature search attributes visibility workflow visibility

• --reason 🔗

  x

  Link preview

  temporal reason

  Reason for the operation

  cli reference temporal cli options-feature command-line-interface-cli operation

• --run-id 🔗

  x

  Link preview

  temporal run-id

  Identifies the current Workflow Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id

• --yes 🔗

  x

  Link preview

  temporal yes

  Confirm all prompts.

  cli reference temporal cli options-feature command-line-interface-cli

trace

The temporal workflow trace command tracks the progress of a Workflow Execution 🔗

x

Link preview

What 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.

term explanation

and any Child Workflows 🔗

x

Link preview

What is a Child Workflow Execution?

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

term explanation child-workflow

it generates.

Use the options listed below to change the command's behavior.

• --concurrency 🔗

  x

  Link preview

  temporal concurrency

  Request concurrency.

  cli reference temporal cli options-feature command-line-interface-cli concurrency control

• --depth 🔗

  x

  Link preview

  temporal depth

  Number of Child Workflows to expand.

  cli reference temporal cli options-feature command-line-interface-cli child workflows

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --fold 🔗

  x

  Link preview

  temporal fold

  Statuses for which Child Workflows will be folded in (this will reduce the number of information fetched and displayed).

  cli reference temporal cli options-feature command-line-interface-cli child workflows

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-fold 🔗

  x

  Link preview

  temporal no-fold

  Disable folding

  cli reference temporal cli options-feature command-line-interface-cli child workflows

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --run-id 🔗

  x

  Link preview

  temporal run-id

  Identifies the current Workflow Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id