tctl v1.17 cluster command reference
The public preview of Temporal CLI is now available. We encourage you to begin using it and to provide feedback.
After the release of Temporal CLI v1.0, tctl will deprecate.
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.