tctl version-next command modifiers reference
Modifiers change the behavior of the command.
--active-cluster
Specify the name of the active Temporal Cluster
What is a Temporal Cluster?
A Temporal Cluster is the Temporal Server paired with persistence.
Learn more when registering a NamespaceWhat is a Namespace?
A Namespace is a unit of isolation within the Temporal Platform
Learn more.
This value changes for Global Namespaces when a failover occurs.
--activity-id
Specify the Activity IdWhat is an Activity Id?
A unique identifier for an Activity Execution.
Learn more of an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more to execute a command on.
--archived
This is an experimental feature.
List archived Workflow Executions.
--cluster
Specify a list of Temporal ClustersWhat is a Temporal Cluster?
A Temporal Cluster is the Temporal Server paired with persistence.
Learn more 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 ScheduleWhat is a Temporal Cron Job?
A Temporal Cron Job is the series of Workflow Executions that occur when a Cron Schedule is provided in the call to spawn a Workflow Execution.
Learn more.
--data
Specify data for a NamespaceWhat is a Namespace?
A Namespace is a unit of isolation within the Temporal Platform
Learn more in the form of key-value pairs (such as k1:v1,k2:v2,k3:v3).
--description
Specify a description when registering a NamespaceWhat is a Namespace?
A Namespace is a unit of isolation within the Temporal Platform
Learn more.
--detail
Specify details of the reason for failing an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
--dry-run
Simulate a reset without resetting any Workflow Executions.
Output is logged to stdout.
--email
Specify the email address of the NamespaceWhat is a Namespace?
A Namespace is a unit of isolation within the Temporal Platform
Learn more 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 to exclude from resetting.
Each line contains one Workflow IdWhat 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.
Learn more.
--execution-modifier
Specify the Start-To-Close TimeoutWhat is a Start-To-Close Timeout?
A Start-To-Close Timeout is the maximum time allowed for a single Activity Task Execution.
Learn more of the Workflow Execution 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 NamespaceWhat is a Namespace?
A Namespace is a unit of isolation within the Temporal Platform
Learn more is a Global NamespaceWhat is a Global Namespace?
A Global Namespace is a Namespace that exists across Clusters when Multi-Cluster Replication is set up.
Learn more.
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 ArchivalWhat is 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.
Learn more.
Valid values are disabled and enabled.
--history-uri
Specify the URI for ArchivalWhat is 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.
Learn more.
The URI cannot be changed after Archival is first enabled.
--identity
Specify the identity of the operator when using tctl to fail an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
--id-reuse-policy
Specify a Workflow Id Reuse PolicyWhat is 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.
Learn more.
Configure if the same Workflow IdWhat 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.
Learn more is allowed for use in new Workflow Executions.
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 SignalWhat is a Signal?
A Signal is an asynchronous request to a Workflow Execution.
Learn more.
--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 Execution should be reset only if its last event is WorkflowTaskFailed with a non-deterministic 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 VisibilityWhat is 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.
Learn more is configured with the Cluster.
Specify an SQL-like query of Search AttributesWhat is a Search Attribute?
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.
Learn more.
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 Execution.
--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 ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more when using tctl to complete the Activity Execution.
--retention
Set the Retention Period for the NamespaceWhat is a Namespace?
A Namespace is a unit of isolation within the Temporal Platform
Learn more.
The Retention Period applies to Closed Workflow Executions.
--rps
Specify RPS of processing. The default value is 50.
--run-id
Show the History of a Workflow Execution by specifying a Run IdWhat is a Run Id?
A Run Id is a globally unique, platform-level identifier for a Workflow Execution.
Learn more.
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 SignalWhat is a Signal?
A Signal is an asynchronous request to a Workflow Execution.
Learn more.
--skip-base-is-not-current
Indicate that a Workflow Execution should be skipped if the base Run is not the current Run.
--skip-current-open
Indicate that a Workflow Execution should be skipped if the current Run is open for the same Workflow IdWhat 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.
Learn more as the base Run.
--task-queue-type
Specify the type of a Task QueueWhat is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
Learn more.
The type can be workflow or activity.
The default is workflow.
--task-queue
Specify a Task QueueWhat is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
Learn more.
Alias: --t
--task-timeout
Specify the Start-To-Close Timeout of the Workflow TaskWhat is a Workflow Task?
A Workflow Task is a Task that contains the context needed to make progress with a Workflow Execution.
Learn more 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 TypeWhat is a Workflow Type?
A Workflow Type is a name that maps to a Workflow Definition.
Learn more.
Specity the type of Query to send.
--visibility-archival-state
Set the visibility state for ArchivalWhat is 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.
Learn more.
Valid values are disabled and enabled.
--visibility-uri
Specify the visibility URI for ArchivalWhat is 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.
Learn more.
The URI cannot be changed after Archival is first enabled.
--workflow-id
This modifier is required.
Show the History of a Workflow Execution by specifying a Workflow IdWhat 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.
Learn more.
--yes
Use the --yes modifier to automatically confirm all prompts.
Alias: --y