Skip to main content

Temporal CLI operator command reference

Operations performed on the Temporal Server.

Operator commands enable actions on NamespacesLink preview iconWhat is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

Learn more, Search AttributesLink preview iconWhat 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, and Temporal ClustersLink preview iconWhat is a Temporal Cluster?

A Temporal Cluster is the Temporal Server paired with persistence.

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

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

cluster​

Cluster commands enabled operations on Temporal ClustersLink preview iconWhat is a Temporal Cluster?

A Temporal Cluster is the Temporal Server paired with persistence.

Learn more.

describe​

The temporal operator cluster describe command shows information about the ClusterLink preview iconWhat is a Temporal Cluster?

A Temporal Cluster is the Temporal Server paired with persistence.

Learn more.

Use the options listed below to change the output of this command. Make sure to write the command as follows: temporal operator cluster describe [command options]

health​

The temporal operator cluster health command checks the health of the Frontend ServiceLink preview iconWhat 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.

Learn more.

Use the options listed below to change the behavior and output of this command. Make sure to write the command as follows: temporal operator cluster health [command options]

list​

The temporal operator cluster list command prints a list of all remote ClustersLink preview iconWhat is a Temporal Cluster?

A Temporal Cluster is the Temporal Server paired with persistence.

Learn more on the system.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal operator cluster list [command options]

remove​

The temporal operator cluster remove command removes a remote ClusterLink preview iconWhat is a Temporal Cluster?

A Temporal Cluster is the Temporal Server paired with persistence.

Learn more from the system.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal operator cluster remove [command options]

system​

The temporal operator cluster system command provides information about the system the Cluster is running on.

Use the options listed below to change this command's output. Make sure to write the command as follows: temporal operator cluster system [command options]

upsert​

The temporal operator cluster upsert command allows the user to add or update a remote ClusterLink preview iconWhat is a Temporal Cluster?

A Temporal Cluster is the Temporal Server paired with persistence.

Learn more.

Use the options listed below to change the behavior of this command. Make sure to write the command as follows: temporal operator cluster upsert [command options]

namespace​

Namespace commands allow NamespaceLink preview iconWhat is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

Learn more operations to be performed on the Temporal ClusterLink preview iconWhat is a Temporal Cluster?

A Temporal Cluster is the Temporal Server paired with persistence.

Learn more.

create​

The temporal operator namespace create command creates a new NamespaceLink preview iconWhat is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

Learn more.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal operator namespace create [command options] [arguments]

delete​

The temporal operator namespace delete command deletes a given NamespaceLink preview iconWhat is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

Learn more from the system.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal operator namespace delete [command options] [arguments]

describe​

The temporal operator namespace describe command provides a description of a NamespaceLink preview iconWhat is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

Learn more. Namespaces can be identified by name or Namespace ID.

Use the options listed below to change the command's output. Make sure to write the command as follows: temporal operator namespace describe [command options] [arguments]

list​

The temporal operator namespace list command lists all Namespaces on the ServerLink preview iconWhat 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.

Learn more.

Use the options listed below to change the command's output. Make sure to write the command as follows: temporal operator namespace list [command options]

update​

The temporal operator namespace update command updates a given NamespaceLink preview iconWhat is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

Learn more.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal operator namespace update [command options] [arguments]

search-attribute​

Search Attribute commands enable operations for the creation, listing, and removal of Search AttributesLink preview iconWhat 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.

create​

The temporal operator search-attribute create command adds one or more custom Search AttributesLink preview iconWhat 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. These Search Attributes can be used to filter a listLink preview iconWhat is a List Filter?

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

Learn more of Workflow ExecutionsLink preview iconWhat 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.

Learn more that contain the given Search Attributes in their metadata.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal operator search-attribute create [command options]

list​

The temporal operator search-attrbute list command displays a list of all Search AttributesLink preview iconWhat 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 that can be used in temporal workflow list --query.

Use the options listed below to change the command's behavior. Make sure to write the command as follows: temporal operator search-attribute list [command options]

remove​

The temporal operator search-attribute remove command removes custom Search AttributeLink preview iconWhat 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 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. Make sure to write the command as follows: temporal operator search-attribute remove [command options]