tctl version-next command modifiers reference

--data

Specify data for a Namespace

A Namespace is a unit of isolation within the Temporal Platform

in the form of key-value pairs (such as k1:v1,k2:v2,k3:v3).

--description

Specify a description when registering a Namespace

A Namespace is a unit of isolation within the Temporal Platform

What is an Activity Execution?

--detail

Specify details of the reason for failing an Activity Execution

An Activity Execution is the full chain of Activity Task Executions.

--dry-run

Simulate a reset without resetting any Workflow Executions

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

. Output is logged to stdout.

--email

Specify the email address of the Namespace

A Namespace is a unit of isolation within the Temporal Platform

owner.

--event-id

Specify the eventId of any event after WorkflowTaskStarted to which you want to reset. Valid values are WorkflowTaskCompleted, WorkflowTaskFailed, and WorkflowTaskTimeout.

--exclude-file

Provide an input file that specifies Workflow Executions

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

A Workflow Id is a customizable, application-level identifier for a Workflow Execution that is unique to an Open Workflow Execution within a Namespace.

to exclude from resetting.

Each line contains one Workflow Id

What is a Workflow Id?

What is a Start-To-Close Timeout?

--execution-modifier

Specify the Start-To-Close Timeout

A Start-To-Close Timeout is the maximum time allowed for a single Activity Task Execution.

of the Workflow Execution

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.

in seconds. The default value is 0.

--fields

Customize the fields to print. Set to 'long' to automatically print more of the main fields.

--follow

Follows the progress of a Workflow Execution.

--global

Specifies whether a Namespace

A Namespace is a unit of isolation within the Temporal Platform

is a Global Namespace

What is a Global Namespace?

A Global Namespace is a Namespace that exists across Clusters when Multi-Cluster Replication is set up.

. When enabled, it controls the creation of replication tasks on updates allowing the state to be replicated across Clusters. This is a read-only setting and cannot be changed.

--history-archival-state

Set the state of Archival

Archival is a feature that automatically backs up Event Histories from Temporal Cluster persistence to a custom blob store after the Closed Workflow Execution retention period is reached.

. Valid values are disabled and enabled.

--history-uri

Specify the URI for Archival

Archival is a feature that automatically backs up Event Histories from Temporal Cluster persistence to a custom blob store after the Closed Workflow Execution retention period is reached.

What is an Activity Execution?

. The URI cannot be changed after Archival is first enabled.

--identity

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

An Activity Execution is the full chain of Activity Task Executions.

What is a Workflow Id Reuse Policy?

--id-reuse-policy

Specify a Workflow Id Reuse Policy

A Workflow Id Reuse Policy determines whether a Workflow Execution is allowed to spawn with a particular Workflow Id, if that Workflow Id has been used with a previous, and now Closed, Workflow Execution.

. Configure if the same 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.

is allowed for use in new Workflow Executions

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.

A Signal is an asynchronous request to a Workflow Execution.

Values: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate

Examples

tctl workflow <command> --id-reuse-policy AllowDuplicate
tctl workflow <command> --id-reuse-policy AllowDuplicateFailedOnly
tctl workflow <command> --id-reuse-policy RejectDuplicate

--input-file

Pass input for the Workflow from a JSON file. For multiple JSON objects, concatenate them and use spaces or newline characters as separators. Input from the command line overwrites input from the file.

--input-parallelism

Specify the number of goroutines to run in parallel. Each goroutine processes one line for every second. The default is 1.

--input

Pass input for the Workflow. Input must be in JSON format. For multiple JSON objects, pass each in a separate --input option. Use null for null values.

--job-id

Required modifier

Specify the job ID of a batch job.

--limit

Sets the number of items to print.

--max-field-modifier

Specify the maximum length for each attribute field. The default value is 500.

--memo

Pass a memo in the format key=value.

A memo is information in JSON format that can be shown when the Workflow is listed. For multiple memos, pass each in a separate --memo modifier.

--memo-file

Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for values.

--name

Specify the name of a Signal

What is a Signal?

--namespace

Specify a Namespace hosted on Temporal Cloud. If not specified, the value of the environment variable $TEMPORAL_CLOUD_NAMESPACE is used.

Disables the interactive pager.

--non-deterministic

Indicate that 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.

What is Advanced Visibility?

should be reset only if its last event is WorkflowTaskFailed with a nondeterministic error.

--output-filename

Serialize an Event to a file.

--output

Specifies the format for printed output.

Values: table, json, card

Specifies the pager to use.

Values: less, more, favoritePager..[$PAGER]

--pagesize

Specify the maximum number of batch jobs to list on a page. The default value is 30.

Alias: --ps

--query

Required modifier

The --query flag is supported only when Advanced Visibility

Advanced Visibility, within the Temporal Platform, is the subsystem and APIs that enable the listing, filtering, and sorting of Workflow Executions through an SQL-like query syntax.

What is a Search Attribute?

is configured with the Cluster.

Specify an SQL-like query of Search Attributes

A Search Attribute is an indexed name used in List Filters to filter a list of Workflow Executions that have the Search Attribute in their metadata.

Using the --query option causes tctl to ignore all other filter options, including open, earliest-time, latest-time, workflow-id, and workflow-type.

--raw

Print properties exactly as they are stored.

--reason

Specify a reason for terminating the 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.

What is an Activity Execution?

Alias: -r

--reject-condition

Reject Queries based on Workflow state. Valid values are not-open and not-completed-cleanly.

--reset-bad-binary-checksum

Specify the binary checksum when using --reset-type BadBinary.

--reset-points-only

Show only events that are eligible for reset.

--reset-reapply-type

Specify the types of events to reapply after the reset point. Valid values are All, Signal, and None. The default is All.

Example

tctl workflow <command> --reset-reapply-type <value>

--reset-type

Specify the event type to which you want to reset.

Value	Description
`FirstWorkflowTask`	Reset to the beginning of the Event History.
`LastWorkflowTask`	Reset to the end of the Event History.
`LastContinuedAsNew`	Reset to the end of the Event History for the previous Run.
`BadBinary`	Reset to the point where a bad binary was used.

--result

Specify the result of an Activity Execution

An Activity Execution is the full chain of Activity Task Executions.

when using tctl to complete the Activity Execution.

--retention

Set the Retention Period for the Namespace

A Namespace is a unit of isolation within the Temporal Platform

The Retention Period applies to Closed Workflow Executions

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

Alias --rd

--rps

Specify RPS of processing. The default value is 50.

--run-id

Show the History of 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.

by specifying a Run Id

What is a Run Id?

A Run Id is a globally unique, platform-level identifier for a Workflow Execution.

A Signal is an asynchronous request to a Workflow Execution.

Alias: --rid

--run-timeout

Single Workflow Run timeout, in seconds.

Alias: --rt

--search-attribute

Pass a Search Attribute in the format key=value. For multiple values, pass each in a separate --search-attribute modifier.

To list valid keys, use the tctl search-attribute list command.

--name

Specify the name of a Signal

What is a Signal?

--skip-base-is-not-current

Indicate that 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.

should be skipped if the base Run is not the current Run.

--skip-current-open

Indicate that 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.

should be skipped if the current Run is open for the same 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.

A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.

as the base Run.

--task-queue-type

Specify the type of a Task Queue

What is a Task Queue?

A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.

. The type can be workflow or activity. The default is workflow.

--task-queue

Specify a Task Queue

What is a Task Queue?

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

--task-timeout

Specify the Start-To-Close Timeout of the Workflow Task

What is a Workflow Task?

A Workflow Type is a name that maps to a Workflow Definition.

in seconds. The default value is 10.

--time-format

Specifies the format for time values.

Values: relative, iso, raw

--type

Specify the name of a Workflow Type

What is a Workflow Type?

. Specity the type of Query to send.

--visibility-archival-state

Set the visibility state for Archival

Archival is a feature that automatically backs up Event Histories from Temporal Cluster persistence to a custom blob store after the Closed Workflow Execution retention period is reached.

. Valid values are disabled and enabled.

--visibility-uri

Specify the visibility URI for Archival

Archival is a feature that automatically backs up Event Histories from Temporal Cluster persistence to a custom blob store after the Closed Workflow Execution retention period is reached.

. The URI cannot be changed after Archival is first enabled.

--workflow-id

Show the History of 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.

by specifying a 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.