Skip to main content

tctl v1.17 cluster command reference

Temporal CLI is now available!

The new Temporal CLI is available for use.

tctl v1.17 can still be used with Temporal Server version 1.20 and is expected to be compatible with Temporal Server version 1.21.

tctl is expected to be fully deprecated by Temporal Server version 1.22

The tctl cluster command enables Temporal Cluster operations.

get-search-attributes​

The tctl cluster get-search-attributes command lists all Search Attributes that can be used in the --query modifier of the tctl workflow list command and the --search_attr_key and --search_attr_value modifiers of the tctl workflow run and tctl workflow start commands.

Example:

tctl cluster get-search-attributes

The command has no modifiers.

Example output:

+-----------------------+----------+
|         NAME          |   TYPE   |
+-----------------------+----------+
| BinaryChecksums       | Keyword  |
| CloseTime             | Int      |
| CustomBoolField       | Bool     |
| CustomDatetimeField   | Datetime |
| CustomDoubleField     | Double   |
| CustomIntField        | Int      |
| CustomKeywordField    | Keyword  |
| CustomNamespace       | Keyword  |
| CustomStringField     | String   |
| ExecutionStatus       | Int      |
| ExecutionTime         | Int      |
| Operator              | Keyword  |
| RunId                 | Keyword  |
| StartTime             | Int      |
| TaskQueue             | Keyword  |
| TemporalChangeVersion | Keyword  |
| WorkflowId            | Keyword  |
| WorkflowType          | Keyword  |
+-----------------------+----------+

The admin version of this command displays default and custom Search Attributes separately, and also shows the underlying Elasticsearch index schema and system Workflow status.

health​

The tctl cluster health command checks the health of the Frontend Service.

tctl cluster health

The command has no modifiers.