Skip to main content

tctl version-next command modifiers reference

Modifiers change the behavior of the command.

--active-cluster

Specify the name of the active Temporal Cluster when registering a NamespaceLink preview icon

. This value changes for Global Namespaces when a failover occurs.

--activity-id

Specify the Activity IdLink preview icon

of an Activity ExecutionLink preview icon to execute a command on.

--archived

This is an experimental feature.

List archived Workflow Executions.

--cluster

Specify a list of Temporal Clusters when registering a Namespace.

The flag contains a single name of a Cluster to which the Namespace can fail over. For multiple Clusters pass each in a separate --cluster option. Make sure to include to the currently active Cluster. This is a read-only setting and cannot be changed.

This modifier is valid only when the --global modifier is set to true.

--cron

Specify a Cron ScheduleLink preview icon

.

--data

Specify data for a NamespaceLink preview icon

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

--description

Specify a description when registering a NamespaceLink preview icon

.

--detail

Specify details of the reason for failing an Activity ExecutionLink preview icon

.

--dry-run

Simulate a reset without resetting any Workflow ExecutionsLink preview icon

. Output is logged to stdout.

--email

Specify the email address of the NamespaceLink preview icon

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 ExecutionsLink preview icon

to exclude from resetting.

Each line contains one Workflow IdLink preview icon

.

--execution-modifier

Specify the Start-To-Close TimeoutLink preview icon

of the Workflow ExecutionLink preview icon 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 NamespaceLink preview icon

is a Global NamespaceLink preview icon. 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 ArchivalLink preview icon

. Valid values are disabled and enabled.

--history-uri

Specify the URI for ArchivalLink preview icon

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

--identity

Specify the identity of the operator when using tctl to fail an Activity ExecutionLink preview icon

.

--id-reuse-policy

Specify a Workflow Id Reuse PolicyLink preview icon

. Configure if the same Workflow IdLink preview icon is allowed for use in new Workflow ExecutionsLink preview icon.

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 SignalLink preview icon

.

--namespace

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

--no-pager

Disables the interactive pager.

--non-deterministic

Indicate that a Workflow ExecutionLink preview icon

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

--pager

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.

--query

Required modifier

The --query flag is supported only when Advanced VisibilityLink preview icon

is configured with the Cluster.

Specify an SQL-like query of Search AttributesLink preview icon

.

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

Alias: --q

--raw

Print properties exactly as they are stored.

--reason

Specify a reason for terminating the Workflow ExecutionLink preview icon

.

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

ValueDescription
FirstWorkflowTaskReset to the beginning of the Event History.
LastWorkflowTaskReset to the end of the Event History.
LastContinuedAsNewReset to the end of the Event History for the previous Run.
BadBinaryReset to the point where a bad binary was used.

--result

Specify the result of an Activity ExecutionLink preview icon

when using tctl to complete the Activity Execution.

--retention

Set the Retention Period for the NamespaceLink preview icon

.

The Retention Period applies to Closed Workflow ExecutionsLink preview icon

.

--rps

Specify RPS of processing. The default value is 50.

--run-id

Show the History of a Workflow ExecutionLink preview icon

by specifying a Run IdLink preview icon.

Alias: --r

--run-timeout

Single Workflow Run timeout, in seconds.

--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 SignalLink preview icon

.

--skip-base-is-not-current

Indicate that a Workflow ExecutionLink preview icon

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

--skip-current-open

Indicate that a Workflow ExecutionLink preview icon

should be skipped if the current Run is open for the same Workflow IdLink preview icon as the base Run.

--task-queue-type

Specify the type of a Task QueueLink preview icon

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

--task-queue

Specify a Task QueueLink preview icon

.

Alias: --t

--task-timeout

Specify the Start-To-Close Timeout of the Workflow TaskLink preview icon

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 TypeLink preview icon

. Specity the type of Query to send.

--visibility-archival-state

Set the visibility state for ArchivalLink preview icon

. Valid values are disabled and enabled.

--visibility-uri

Specify the visibility URI for ArchivalLink preview icon

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

--workflow-id

This modifier is required.

Show the History of a Workflow ExecutionLink preview icon

by specifying a Workflow IdLink preview icon.

--yes

Use the --yes modifier to automatically confirm all prompts.

Alias: --y