Temporal CLI operator command reference

Operator commands enable actions on Namespaces 🔗

x

Link preview

What is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

term explanation

, Search Attributes 🔗

x

Link preview

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

term explanation filtered-lists visibility

, and Temporal Clusters 🔗

x

Link preview

What is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

term explanation

. These actions are performed through subcommands.

To run an Operator command, run temporal operator [command] [subcommand] [command options].

cluster

Operator commands enable actions on Namespaces 🔗

x

Link preview

What is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

term explanation

, Search Attributes 🔗

x

Link preview

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

term explanation filtered-lists visibility

, and Temporal Clusters 🔗

x

Link preview

What is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

term explanation

. These actions are performed through subcommands for each Operator area.

To run an Operator command, run temporal operator [command] [subcommand] [command options].

describe

The temporal operator cluster describe command shows information about the Cluster 🔗

x

Link preview

What is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

term explanation

. This information can include information about other connected services, such as a remote Codec Server 🔗

x

Link preview

What is a Codec Server?

A Codec Server is an HTTP server that uses your custom Payload Codec to encode and decode your data remotely through endpoints.

term

.

Use the options listed below to change the output 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

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

health

The temporal operator cluster health command checks the health of the Frontend Service 🔗

x

Link preview

What is a Frontend Service?

The Frontend Service is a stateless gateway service that exposes a strongly typed Proto API. The Frontend Service is responsible for rate limiting, authorizing, validating, and routing all inbound calls.

term

. A successful execution returns a list of Cluster 🔗

x

Link preview

What is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

term explanation

metrics.

Use the options listed below to change the behavior and output 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

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

list

The temporal operator cluster list command prints a list of all remote Clusters 🔗

x

Link preview

What is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

term explanation

on the system.

temporal operator cluster list

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

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

remove

The temporal operator cluster remove command removes a remote Cluster 🔗

x

Link preview

What is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

term explanation

from the system.

temporal operator cluster remove --name=SomeCluster

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

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

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

system

The temporal operator cluster system command provides information about the system the Cluster 🔗

x

Link preview

What is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

term explanation

is running on. This information can be used to diagnose problems occurring in the Temporal Server 🔗

x

Link preview

What is the Temporal Server?

The Temporal Server is a grouping of four horizontally scalable services.

term explanation

.

temporal operator cluster system

Use the options listed below to change this command's output.

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

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

upsert

The temporal operator cluster upsert command allows the user to add or update a remote Cluster 🔗

x

Link preview

What is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

term explanation

. temporal operator cluster upsert --frontend-address="127.0.2.1"

Upserting can also be used to enable or disabled cross-cluster connection. temporal operator cluster upsert --enable-connection=true

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

• --enable-connection 🔗

  x

  Link preview

  temporal enable-connection

  Enable cross-cluster connection

  cli reference temporal cli options-feature command-line-interface-cli cross-cluster-connection

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

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

• --frontend-address 🔗

  x

  Link preview

  temporal frontend-address

  Frontend address of the remote Cluster.

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

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

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

namespace

Namespace commands allow Namespace 🔗

x

Link preview

What is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

term explanation

operations to be performed on the Temporal Cluster 🔗

x

Link preview

What is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

term explanation

.

create

The temporal operator namespace create command creates a new Namespace 🔗

x

Link preview

What is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

term explanation

. The Namespace can be created on the active Cluster 🔗

x

Link preview

What is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

term explanation

, or any named Cluster within the system. temporal operator namespace --cluster=MyCluster

Global Namespaces can also be created. temporal operator namespace create --global

Other settings, such as retention 🔗

x

Link preview

What is a Retention Period?

A Retention Period is the amount of time a Workflow Execution Event History remains in the Cluster's persistence store.

term explanation

and Visibility Archival State 🔗

x

Link preview

What is Visibility?

The term Visibility, within the Temporal Platform, refers to the subsystems and APIs that enable an operator to view Workflow Executions that currently exist within a Cluster.

term

, can be configured according to the application's needs. The Visibility Archive can be set on a separate URI. temporal operator namespace create --retention=RetentionMyWorkflow --visibility-archival-state="enabled" --visibility-uri="some-uri"

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

• --active-cluster 🔗

  x

  Link preview

  temporal active-cluster

  Active cluster name

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

• --cluster 🔗

  x

  Link preview

  temporal cluster

  Cluster name

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

• --data 🔗

  x

  Link preview

  temporal data

  Namespace data in a key=value format

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

• --description 🔗

  x

  Link preview

  temporal description

  Namespace description

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

• --email 🔗

  x

  Link preview

  temporal email

  Owner email

  cli reference temporal cli 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

• --global 🔗

  x

  Link preview

  temporal global

  Flag to indicate whether namespace is a global namespace

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

• --history-archival-state 🔗

  x

  Link preview

  temporal history-archival-state

  Flag to set history archival state, valid values are "disabled" and "enabled"

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

• --history-uri 🔗

  x

  Link preview

  temporal history-uri

  Optionally specify history archival URI

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

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

• --retention 🔗

  x

  Link preview

  temporal retention

  Workflow Execution retention

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

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

• --visibility-archival-state 🔗

  x

  Link preview

  temporal visibility-archival-state

  Flag to set visibility archival state.

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

• --visibility-uri 🔗

  x

  Link preview

  temporal visibility-uri

  Optionally specify visibility archival URI (cannot be changed after first time archival is enabled).

  cli reference temporal cli options-feature command-line-interface-cli visibility archival uri

delete

The temporal operator namespace delete command deletes a given Namespace 🔗

x

Link preview

What is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

term explanation

from the system.

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

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

• --yes 🔗

  x

  Link preview

  temporal yes

  Confirm all prompts.

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

describe

The temporal operator namespace describe command provides a description of a Namespace 🔗

x

Link preview

What is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

term explanation

. Namespaces are identified by Namespace ID.

temporal operator namespace describe --namespace-id=meaningful-business-id

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

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

• --namespace-id 🔗

  x

  Link preview

  temporal namespace-id

  Namespace Id

  cli reference temporal cli options-feature command-line-interface-cli namespace namespace id namespace management

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

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

list

The temporal operator namespace list command lists all Namespaces on the Server 🔗

x

Link preview

What is a Frontend Service?

The Frontend Service is a stateless gateway service that exposes a strongly typed Proto API. The Frontend Service is responsible for rate limiting, authorizing, validating, and routing all inbound calls.

term

.

temporal operator namespace list

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

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

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

update

The temporal operator namespace update command updates a given Namespace 🔗

x

Link preview

What is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

term explanation

.

Namespaces can be assigned a different active Cluster 🔗

x

Link preview

What is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

term explanation

. temporal operator namespace update --active-cluster=NewActiveCluster

Namespaces can also be promoted to global Namespaces. temporal operator namespace --promote-global=true

Any Archives 🔗

x

Link preview

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

term explanation

that were previously enabled or disabled can be changed through this command. However, URI values for archival states cannot be changed after the states are enabled. temporal operator namespace update --history-archival-state="enabled" --visibility-archival-state="disabled"

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

• --active-cluster 🔗

  x

  Link preview

  temporal active-cluster

  Active cluster name

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

• --cluster 🔗

  x

  Link preview

  temporal cluster

  Cluster name

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

• --data 🔗

  x

  Link preview

  temporal data

  Namespace data in a key=value format

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

• --description 🔗

  x

  Link preview

  temporal description

  Namespace description

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

• --email 🔗

  x

  Link preview

  temporal email

  Owner email

  cli reference temporal cli 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

• --history-archival-state 🔗

  x

  Link preview

  temporal history-archival-state

  Flag to set history archival state, valid values are "disabled" and "enabled"

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

• --history-uri 🔗

  x

  Link preview

  temporal history-uri

  Optionally specify history archival URI

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

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

• --promote-global 🔗

  x

  Link preview

  temporal promote-global

  Promote local namespace to global namespace

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

• --reason 🔗

  x

  Link preview

  temporal reason

  Reason for the operation

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

• --retention 🔗

  x

  Link preview

  temporal retention

  Workflow Execution retention

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

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

• --visibility-archival-state 🔗

  x

  Link preview

  temporal visibility-archival-state

  Flag to set visibility archival state.

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

• --visibility-uri 🔗

  x

  Link preview

  temporal visibility-uri

  Optionally specify visibility archival URI (cannot be changed after first time archival is enabled).

  cli reference temporal cli options-feature command-line-interface-cli visibility archival uri

search-attribute

Search Attribute commands enable operations for the creation, listing, and removal of Search Attributes 🔗

x

Link preview

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

term explanation filtered-lists visibility

.

create

The temporal operator search-attribute create command adds one or more custom Search Attributes 🔗

x

Link preview

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

term explanation filtered-lists visibility

. These Search Attributes can be used to filter a list 🔗

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

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 contain the given Search Attributes in their metadata.

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

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

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

list

The temporal operator search-attribute list command displays a list of all Search Attributes 🔗

x

Link preview

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

term explanation filtered-lists visibility

that can be used in temporal workflow list --query.

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

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

remove

The temporal operator search-attribute remove command removes custom Search Attribute 🔗

x

Link preview

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

term explanation filtered-lists visibility

metadata. This command does not remove custom Search Attributes from Elasticsearch. The index schema is not modified.

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

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

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

• --yes 🔗

  x

  Link preview

  temporal yes

  Confirm all prompts.

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