diff --git a/temporalcli/commandsgen/docs.go b/temporalcli/commandsgen/docs.go index 35139fe5..03441525 100644 --- a/temporalcli/commandsgen/docs.go +++ b/temporalcli/commandsgen/docs.go @@ -36,7 +36,7 @@ func GenerateDocsFiles(commands Commands) (map[string][]byte, error) { } } - w.writeCmdOptions() + // w.writeCmdOptions() // Format and return var finalMap = make(map[string][]byte) @@ -106,10 +106,9 @@ func (w *docWriter) writeSubcommand(c *Command) { // add any options to the master option list for cmd-options.mdx for _, option := range allOptions { - w.fileMap[fileName].WriteString(fmt.Sprintf("- [--%s](cli/cmd-options#%s)\n\n", option.Name, option.Name)) - if !containsOption(w.allOptions, option) { - w.allOptions = append(w.allOptions, option) - } + w.fileMap[fileName].WriteString(fmt.Sprintf("## %s\n\n", option.Name)) + w.fileMap[fileName].WriteString(option.Description + "\n\n") + } } @@ -129,136 +128,3 @@ func (w *docWriter) processOptions(c *Command) { w.optionsStack = append(w.optionsStack, options) } - -// TODO: Remove this page and throw inline with each command -func (w *docWriter) writeCmdOptions() { - var items = []string{ - "actions", - "active cluster", - "activity", - "activity execution", - "activity id", - "address", - "archival", - "backfill", - "batch job", - "build", - "build id", - "ca-certificate", - "calendar", - "certificate key", - "child workflows", - "cli reference", - "cluster", - "codec server", - "command-line-interface-cli", - "concurrency control", - "configuration", - "context", - "continue-as-new", - "cron", - "cross-cluster-connection", - "data converters", - "endpoint", - "environment", - "event", - "event id", - "event type", - "events", - "external temporal and state events", - "failures", - "frontend", - "frontend address", - "frontend service", - "goroutine", - "grpc", - "history", - "http", - "interval", - "ip address", - "job id", - "log-feature", - "logging", - "logging and metrics", - "memo", - "metrics", - "namespace", - "namespace description", - "namespace id", - "namespace management", - "nondeterministic", - "notes", - "operation", - "operator", - "options-feature", - "overlap policy", - "pager", - "port", - "pragma", - "queries-feature", - "query", - "requests", - "reset point", - "resets-feature", - "retention policy", - "retries", - "reuse policy", - "schedule", - "schedule backfill", - "schedule id", - "schedule pause", - "schedule unpause", - "schedules", - "search attribute", - "search attributes", - "server", - "server options and configurations", - "sqlite", - "start-to-close", - "task queue", - "task queue type", - "temporal cli", - "temporal ui", - "time", - "time zone", - "timeout", - "timeouts and heartbeats", - "tls", - "tls server", - "uri", - "verification", - "visibility", - "web ui", - "workflow", - "workflow execution", - "workflow id", - "workflow run", - "workflow state", - "workflow task", - "workflow task failure", - "workflow type", - "workflow visibility", - "x509-certificate", - } - - w.fileMap["cmd-options"] = &bytes.Buffer{} - w.fileMap["cmd-options"].WriteString("---\n") - w.fileMap["cmd-options"].WriteString("id: cmd-options\n") - w.fileMap["cmd-options"].WriteString("title: Temporal CLI command options reference\n") - w.fileMap["cmd-options"].WriteString("sidebar_label: cmd options\n") - w.fileMap["cmd-options"].WriteString("description: Discover how to manage Temporal Workflows, from Activity Execution to Workflow Ids, using clusters, cron schedules, dynamic configurations, and logging. Perfect for developers.\n") - w.fileMap["cmd-options"].WriteString("toc_max_heading_level: 4\n") - w.fileMap["cmd-options"].WriteString("keywords:\n") - for _, item := range items { - w.fileMap["cmd-options"].WriteString(fmt.Sprintf(" - %s\n", item)) - } - w.fileMap["cmd-options"].WriteString("tags:\n") - for _, item := range items { - w.fileMap["cmd-options"].WriteString(fmt.Sprintf(" - %s\n", strings.ReplaceAll(item, " ", "-"))) - } - w.fileMap["cmd-options"].WriteString("---\n\n") - for _, option := range w.allOptions { - w.fileMap["cmd-options"].WriteString(fmt.Sprintf("## %s\n\n", option.Name)) - w.fileMap["cmd-options"].WriteString(option.Description + "\n\n") - } -} diff --git a/temporalcli/docs/activity.mdx b/temporalcli/docs/activity.mdx index 9707a9bc..b2fb1713 100644 --- a/temporalcli/docs/activity.mdx +++ b/temporalcli/docs/activity.mdx @@ -38,59 +38,113 @@ temporal activity complete \ Use the following options to change the behavior of this command. -- [--activity-id](cli/cmd-options#activity-id) +## activity-id -- [--address](cli/cmd-options#address) +Activity ID to complete. -- [--api-key](cli/cmd-options#api-key) +## address -- [--codec-auth](cli/cmd-options#codec-auth) +Temporal Service gRPC endpoint. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## api-key -- [--color](cli/cmd-options#color) +API key for request. -- [--command-timeout](cli/cmd-options#command-timeout) +## codec-auth -- [--env](cli/cmd-options#env) +Authorization header for Codec Server requests. -- [--env-file](cli/cmd-options#env-file) +## codec-endpoint -- [--grpc-meta](cli/cmd-options#grpc-meta) +Remote Codec Server endpoint. -- [--identity](cli/cmd-options#identity) +## color -- [--log-format](cli/cmd-options#log-format) +Output coloring. -- [--log-level](cli/cmd-options#log-level) +## command-timeout -- [--namespace](cli/cmd-options#namespace) +Timeout for the span of a command. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## env -- [--output](cli/cmd-options#output) +Active environment name (`ENV`). -- [--result](cli/cmd-options#result) +## env-file -- [--time-format](cli/cmd-options#time-format) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls](cli/cmd-options#tls) +## grpc-meta -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## identity -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Identity of the user submitting this request. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## log-format -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Log format. Options are: text, json. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## log-level -- [--tls-key-path](cli/cmd-options#tls-key-path) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## result + +Result `JSON` to return. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## fail @@ -105,59 +159,115 @@ temporal activity fail \ Use the following options to change the behavior of this command. -- [--activity-id](cli/cmd-options#activity-id) +## activity-id + +Activity ID to fail. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## detail + +Reason for failing the Activity (JSON). + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## identity + +Identity of the user submitting this request. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace -- [--address](cli/cmd-options#address) +Temporal Service Namespace. -- [--api-key](cli/cmd-options#api-key) +## no-json-shorthand-payloads -- [--codec-auth](cli/cmd-options#codec-auth) +Raw payload output, even if they are JSON. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## output -- [--color](cli/cmd-options#color) +Non-logging data output format. -- [--command-timeout](cli/cmd-options#command-timeout) +## reason -- [--detail](cli/cmd-options#detail) +Reason for failing the Activity. -- [--env](cli/cmd-options#env) +## time-format -- [--env-file](cli/cmd-options#env-file) +Time format. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## tls -- [--identity](cli/cmd-options#identity) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--log-format](cli/cmd-options#log-format) +## tls-ca-data -- [--log-level](cli/cmd-options#log-level) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--namespace](cli/cmd-options#namespace) +## tls-ca-path -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--output](cli/cmd-options#output) +## tls-cert-data -- [--reason](cli/cmd-options#reason) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--time-format](cli/cmd-options#time-format) +## tls-cert-path -- [--tls](cli/cmd-options#tls) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-disable-host-verification -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Disable TLS host-name verification. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-key-data -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-key-path -- [--tls-key-data](cli/cmd-options#tls-key-data) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-server-name -- [--tls-server-name](cli/cmd-options#tls-server-name) +Override target TLS server name. diff --git a/temporalcli/docs/batch.mdx b/temporalcli/docs/batch.mdx index 63c457bd..62a6c0c1 100644 --- a/temporalcli/docs/batch.mdx +++ b/temporalcli/docs/batch.mdx @@ -36,55 +36,105 @@ temporal batch describe \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--env](cli/cmd-options#env) +## codec-endpoint -- [--env-file](cli/cmd-options#env-file) +Remote Codec Server endpoint. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## color -- [--job-id](cli/cmd-options#job-id) +Output coloring. -- [--log-format](cli/cmd-options#log-format) +## command-timeout -- [--log-level](cli/cmd-options#log-level) +Timeout for the span of a command. -- [--namespace](cli/cmd-options#namespace) +## env -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Active environment name (`ENV`). -- [--output](cli/cmd-options#output) +## env-file -- [--time-format](cli/cmd-options#time-format) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls](cli/cmd-options#tls) +## grpc-meta -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## job-id -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Batch job ID. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## log-format -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Log format. Options are: text, json. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## log-level -- [--tls-key-path](cli/cmd-options#tls-key-path) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## list @@ -98,55 +148,105 @@ temporal batch list \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). -- [--api-key](cli/cmd-options#api-key) +## env-file -- [--codec-auth](cli/cmd-options#codec-auth) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## grpc-meta -- [--color](cli/cmd-options#color) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--command-timeout](cli/cmd-options#command-timeout) +## limit -- [--env](cli/cmd-options#env) +Maximum number of batch jobs to display. -- [--env-file](cli/cmd-options#env-file) +## log-format -- [--grpc-meta](cli/cmd-options#grpc-meta) +Log format. Options are: text, json. -- [--limit](cli/cmd-options#limit) +## log-level -- [--log-format](cli/cmd-options#log-format) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--log-level](cli/cmd-options#log-level) +## namespace -- [--namespace](cli/cmd-options#namespace) +Temporal Service Namespace. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## no-json-shorthand-payloads -- [--output](cli/cmd-options#output) +Raw payload output, even if they are JSON. -- [--time-format](cli/cmd-options#time-format) +## output -- [--tls](cli/cmd-options#tls) +Non-logging data output format. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## time-format -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Time format. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-ca-data -- [--tls-key-data](cli/cmd-options#tls-key-data) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-ca-path -- [--tls-server-name](cli/cmd-options#tls-server-name) +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## terminate @@ -162,55 +262,107 @@ temporal batch terminate \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## job-id + +Job ID to terminate. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads -- [--api-key](cli/cmd-options#api-key) +Raw payload output, even if they are JSON. -- [--codec-auth](cli/cmd-options#codec-auth) +## output -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Non-logging data output format. -- [--color](cli/cmd-options#color) +## reason -- [--command-timeout](cli/cmd-options#command-timeout) +Reason for terminating the batch job. -- [--env](cli/cmd-options#env) +## time-format -- [--env-file](cli/cmd-options#env-file) +Time format. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## tls -- [--job-id](cli/cmd-options#job-id) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--log-format](cli/cmd-options#log-format) +## tls-ca-data -- [--log-level](cli/cmd-options#log-level) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--namespace](cli/cmd-options#namespace) +## tls-ca-path -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--output](cli/cmd-options#output) +## tls-cert-data -- [--reason](cli/cmd-options#reason) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--time-format](cli/cmd-options#time-format) +## tls-cert-path -- [--tls](cli/cmd-options#tls) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-disable-host-verification -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Disable TLS host-name verification. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-key-data -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-key-path -- [--tls-key-data](cli/cmd-options#tls-key-data) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-server-name -- [--tls-server-name](cli/cmd-options#tls-server-name) +Override target TLS server name. diff --git a/temporalcli/docs/cmd-options.mdx b/temporalcli/docs/cmd-options.mdx deleted file mode 100644 index 214f4f3f..00000000 --- a/temporalcli/docs/cmd-options.mdx +++ /dev/null @@ -1,798 +0,0 @@ ---- -id: cmd-options -title: Temporal CLI command options reference -sidebar_label: cmd options -description: Discover how to manage Temporal Workflows, from Activity Execution to Workflow Ids, using clusters, cron schedules, dynamic configurations, and logging. Perfect for developers. -toc_max_heading_level: 4 -keywords: - - actions - - active cluster - - activity - - activity execution - - activity id - - address - - archival - - backfill - - batch job - - build - - build id - - ca-certificate - - calendar - - certificate key - - child workflows - - cli reference - - cluster - - codec server - - command-line-interface-cli - - concurrency control - - configuration - - context - - continue-as-new - - cron - - cross-cluster-connection - - data converters - - endpoint - - environment - - event - - event id - - event type - - events - - external temporal and state events - - failures - - frontend - - frontend address - - frontend service - - goroutine - - grpc - - history - - http - - interval - - ip address - - job id - - log-feature - - logging - - logging and metrics - - memo - - metrics - - namespace - - namespace description - - namespace id - - namespace management - - nondeterministic - - notes - - operation - - operator - - options-feature - - overlap policy - - pager - - port - - pragma - - queries-feature - - query - - requests - - reset point - - resets-feature - - retention policy - - retries - - reuse policy - - schedule - - schedule backfill - - schedule id - - schedule pause - - schedule unpause - - schedules - - search attribute - - search attributes - - server - - server options and configurations - - sqlite - - start-to-close - - task queue - - task queue type - - temporal cli - - temporal ui - - time - - time zone - - timeout - - timeouts and heartbeats - - tls - - tls server - - uri - - verification - - visibility - - web ui - - workflow - - workflow execution - - workflow id - - workflow run - - workflow state - - workflow task - - workflow task failure - - workflow type - - workflow visibility - - x509-certificate -tags: - - actions - - active-cluster - - activity - - activity-execution - - activity-id - - address - - archival - - backfill - - batch-job - - build - - build-id - - ca-certificate - - calendar - - certificate-key - - child-workflows - - cli-reference - - cluster - - codec-server - - command-line-interface-cli - - concurrency-control - - configuration - - context - - continue-as-new - - cron - - cross-cluster-connection - - data-converters - - endpoint - - environment - - event - - event-id - - event-type - - events - - external-temporal-and-state-events - - failures - - frontend - - frontend-address - - frontend-service - - goroutine - - grpc - - history - - http - - interval - - ip-address - - job-id - - log-feature - - logging - - logging-and-metrics - - memo - - metrics - - namespace - - namespace-description - - namespace-id - - namespace-management - - nondeterministic - - notes - - operation - - operator - - options-feature - - overlap-policy - - pager - - port - - pragma - - queries-feature - - query - - requests - - reset-point - - resets-feature - - retention-policy - - retries - - reuse-policy - - schedule - - schedule-backfill - - schedule-id - - schedule-pause - - schedule-unpause - - schedules - - search-attribute - - search-attributes - - server - - server-options-and-configurations - - sqlite - - start-to-close - - task-queue - - task-queue-type - - temporal-cli - - temporal-ui - - time - - time-zone - - timeout - - timeouts-and-heartbeats - - tls - - tls-server - - uri - - verification - - visibility - - web-ui - - workflow - - workflow-execution - - workflow-id - - workflow-run - - workflow-state - - workflow-task - - workflow-task-failure - - workflow-type - - workflow-visibility - - x509-certificate ---- - -## activity-id - -Activity ID to complete. - -## address - -Temporal Service gRPC endpoint. - -## api-key - -API key for request. - -## codec-auth - -Authorization header for Codec Server requests. - -## codec-endpoint - -Remote Codec Server endpoint. - -## color - -Output coloring. - -## command-timeout - -Timeout for the span of a command. - -## env - -Active environment name (`ENV`). - -## env-file - -Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). - -## grpc-meta - -HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. - -## identity - -Identity of the user submitting this request. - -## log-format - -Log format. Options are: text, json. - -## log-level - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. - -## namespace - -Temporal Service Namespace. - -## no-json-shorthand-payloads - -Raw payload output, even if they are JSON. - -## output - -Non-logging data output format. - -## result - -Result `JSON` to return. - -## time-format - -Time format. - -## tls - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. - -## tls-ca-data - -Data for server CA certificate. Can't be used with --tls-ca-path. - -## tls-ca-path - -Path to server CA certificate. Can't be used with --tls-ca-data. - -## tls-cert-data - -Data for x509 certificate. Can't be used with --tls-cert-path. - -## tls-cert-path - -Path to x509 certificate. Can't be used with --tls-cert-data. - -## tls-disable-host-verification - -Disable TLS host-name verification. - -## tls-key-data - -Private certificate key data. Can't be used with --tls-key-path. - -## tls-key-path - -Path to x509 private key. Can't be used with --tls-key-data. - -## tls-server-name - -Override target TLS server name. - -## detail - -Reason for failing the Activity (JSON). - -## reason - -Reason for failing the Activity. - -## job-id - -Batch job ID. - -## limit - -Maximum number of batch jobs to display. - -## key - -Property name. - -## value - -Property value (required). - -## name - -Cluster/Service name. - -## enable-connection - -Set the connection to "enabled". - -## frontend-address - -Remote endpoint. - -## active-cluster - -Active Cluster (Service) name. - -## cluster - -Cluster (Service) names for Namespace creation. Can be passed multiple times. - -## data - -Namespace data as `KEY=VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. - -## description - -Namespace description. - -## email - -Owner email. - -## global - -Enable multi-region data replication. - -## history-archival-state - -History archival state. - -## history-uri - -Archive history to this `URI`. Once enabled, can't be changed. - -## retention - -Time to preserve closed Workflows before deletion. - -## visibility-archival-state - -Visibility archival state. - -## visibility-uri - -Archive visibility data to this `URI`. Once enabled, can't be changed. - -## yes - -Request confirmation before deletion. - -## namespace-id - -Namespace ID. - -## promote-global - -Enable multi-region data replication. - -## description-file - -Endpoint description file in markdown format (encoded using the configured codec server). - -## target-namespace - -Namespace in which a handler worker will be polling for Nexus tasks on. - -## target-task-queue - -Task Queue in which a handler worker will be polling for Nexus tasks on. - -## target-url - -URL to direct Nexus requests to. - -## unset-description - -Unset the description. - -## type - -Search Attribute type. - -## end-time - -Backfill end time. - -## start-time - -Backfill start time. - -## calendar - -Calendar specification in JSON. For example: `{"dayOfWeek":"Fri","hour":"17","minute":"5"}`. - -## catchup-window - -Maximum catch-up time for when the Service is unavailable. - -## cron - -Calendar specification in cron string format. For example: `"30 12 * * Fri"`. - -## execution-timeout - -Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. - -## input - -Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. - -## input-base64 - -Assume inputs are base64-encoded and attempt to decode them. - -## input-file - -A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. - -## input-meta - -Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. - -## interval - -Interval duration. For example, 90m, or 60m/15m to include phase offset. - -## jitter - -Max difference in time from the specification. Vary the start time randomly within this amount. - -## memo - -Memo using 'KEY="VALUE"' pairs. Use JSON values. - -## notes - -Initial notes field value. - -## overlap-policy - -Policy for handling overlapping Workflow Executions. - -## pause-on-failure - -Pause schedule after Workflow failures. - -## paused - -Pause the Schedule immediately on creation. - -## remaining-actions - -Total allowed actions. Default is zero (unlimited). - -## run-timeout - -Fail a Workflow Run if it lasts longer than `DURATION`. - -## schedule-id - -Schedule ID. - -## schedule-memo - -Set schedule memo using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. - -## schedule-search-attribute - -Set schedule Search Attributes using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. - -## search-attribute - -Search Attribute in `KEY=VALUE` format. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. - -## task-queue - -Workflow Task queue. - -## task-timeout - -Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. - -## time-zone - -Interpret calendar specs with the `TZ` time zone. For a list of time zones, see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. - -## workflow-id - -Workflow ID. If not supplied, the Service generates a unique ID. - -## long - -Show detailed information. - -## query - -Filter results using given List Filter. - -## really-long - -Show extensive information in non-table form. - -## pause - -Pause the Schedule. - -## unpause - -Unpause the Schedule. - -## db-filename - -Path to file for persistent Temporal state store. By default, Workflow Executions are lost when the server process dies. - -## dynamic-config-value - -Dynamic configuration value using `KEY=VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey="YourString"'. Can be passed multiple times. - -## headless - -Disable the Web UI. - -## http-port - -Port for the HTTP API service. Default is off. - -## ip - -IP address bound to the front-end Service. - -## log-config - -Log the server config to stderr. - -## metrics-port - -Port for '/metrics'. Default is off. - -## port - -Port for the front-end gRPC Service. - -## sqlite-pragma - -SQLite pragma statements in "PRAGMA=VALUE" format. - -## ui-asset-path - -UI custom assets path. - -## ui-codec-endpoint - -UI remote codec HTTP endpoint. - -## ui-ip - -IP address bound to the Web UI. Default is same as '--ip' value. - -## ui-port - -Port for the Web UI. Default is '--port' value + 1000. - -## ui-public-path - -The public base path for the Web UI. Default is `/`. - -## disable-stats - -Disable task queue statistics. - -## legacy-mode - -Enable a legacy mode for servers that do not support rules-based worker versioning. This mode only provides pollers info. - -## partitions-legacy - -Query partitions 1 through `N`. Experimental/Temporary feature. Legacy mode only. - -## report-reachability - -Display task reachability information. - -## select-all-active - -Include all active versions. A version is active if it had new tasks or polls recently. - -## select-build-id - -Filter the Task Queue based on Build ID. - -## select-unversioned - -Include the unversioned queue. - -## task-queue-type - -Task Queue type. If not specified, all types are reported. - -## task-queue-type-legacy - -Task Queue type (legacy mode only). - -## build-id - -One or more Build ID strings. Can be passed multiple times. - -## reachability-type - -Reachability filter. `open`: reachable by one or more open workflows. `closed`: reachable by one or more closed workflows. `existing`: reachable by either. New Workflow Executions reachable by a Build ID are always reported. - -## max-sets - -Max return count. Use 1 for default major version. Use 0 for all sets. - -## existing-compatible-build-id - -Pre-existing Build ID in this Task Queue. - -## set-as-default - -Set the expanded Build ID set as the Task Queue default. - -## source-build-id - -Source build ID. - -## target-build-id - -Target build ID. - -## force - -Bypass recent-poller validation. - -## rule-index - -Position of the assignment rule to be replaced. Requests for invalid indices will fail. - -## percentage - -Traffic percent to send to target Build ID. - -## rps - -Limit batch's requests per second. Only allowed if query is present. - -## run-id - -Run ID. Only use with --workflow-id. Cannot use with --query. - -## raw - -Print properties without changing their format. - -## reset-points - -Show auto-reset points only. - -## detailed - -Display events as sections instead of table. Does not apply to JSON output. - -## fail-existing - -Fail if the Workflow already exists. - -## id-reuse-policy - -Re-use policy for the Workflow ID in new Workflow Executions. - -## start-delay - -Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. - -## source - -Path to the original file. - -## target - -Path to the results file. When omitted, output is sent to stdout. - -## archived - -Limit output to archived Workflow Executions. - -## reject-condition - -Optional flag for rejecting Queries based on Workflow state. - -## event-id - -Event ID to reset to. Event must occur after `WorkflowTaskStarted`. `WorkflowTaskCompleted`, `WorkflowTaskFailed`, etc. are valid. - -## reapply-exclude - -Exclude these event types from re-application. - -## reapply-type - -Types of events to re-apply after reset point. Deprecated. Use --reapply-exclude instead. - -## follow - -Follow the Workflow Execution progress in real time. Does not apply to JSON output. - -## concurrency - -Number of Workflow Histories to fetch at a time. - -## depth - -Set depth for your Child Workflow fetches. Pass -1 to fetch child workflows at any depth. - -## fold - -Fold away Child Workflows with the specified statuses. Case-insensitive. Ignored if --no-fold supplied. Available values: running, completed, failed, canceled, terminated, timedout, continueasnew. Can be passed multiple times. - -## no-fold - -Disable folding. Fetch and display Child Workflows within the set depth. - -## update-id - -Update ID. Must be unique per Workflow Execution. - -## first-execution-run-id - -Parent Run ID. The update is sent to the last Workflow Execution in the chain started with this Run ID. - -## wait-for-stage - -Update stage to wait for. The only option is `accepted`, but this option is required. This is to allow a future version of the CLI to choose a default value. - diff --git a/temporalcli/docs/env.mdx b/temporalcli/docs/env.mdx index bf4efd24..1454efef 100644 --- a/temporalcli/docs/env.mdx +++ b/temporalcli/docs/env.mdx @@ -49,55 +49,105 @@ temporal env delete \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--env](cli/cmd-options#env) +## codec-endpoint -- [--env-file](cli/cmd-options#env-file) +Remote Codec Server endpoint. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## color -- [--key](cli/cmd-options#key) +Output coloring. -- [--log-format](cli/cmd-options#log-format) +## command-timeout -- [--log-level](cli/cmd-options#log-level) +Timeout for the span of a command. -- [--namespace](cli/cmd-options#namespace) +## env -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Active environment name (`ENV`). -- [--output](cli/cmd-options#output) +## env-file -- [--time-format](cli/cmd-options#time-format) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls](cli/cmd-options#tls) +## grpc-meta -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## key -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Property name. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## log-format -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Log format. Options are: text, json. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## log-level -- [--tls-key-path](cli/cmd-options#tls-key-path) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## get @@ -122,55 +172,105 @@ environment. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## key + +Property name. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. -- [--api-key](cli/cmd-options#api-key) +## no-json-shorthand-payloads -- [--codec-auth](cli/cmd-options#codec-auth) +Raw payload output, even if they are JSON. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## output -- [--color](cli/cmd-options#color) +Non-logging data output format. -- [--command-timeout](cli/cmd-options#command-timeout) +## time-format -- [--env](cli/cmd-options#env) +Time format. -- [--env-file](cli/cmd-options#env-file) +## tls -- [--grpc-meta](cli/cmd-options#grpc-meta) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--key](cli/cmd-options#key) +## tls-ca-data -- [--log-format](cli/cmd-options#log-format) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--log-level](cli/cmd-options#log-level) +## tls-ca-path -- [--namespace](cli/cmd-options#namespace) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-cert-data -- [--output](cli/cmd-options#output) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--time-format](cli/cmd-options#time-format) +## tls-cert-path -- [--tls](cli/cmd-options#tls) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-disable-host-verification -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Disable TLS host-name verification. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-key-data -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-key-path -- [--tls-key-data](cli/cmd-options#tls-key-data) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-server-name -- [--tls-server-name](cli/cmd-options#tls-server-name) +Override target TLS server name. ## list @@ -179,53 +279,101 @@ stored in "$HOME/.config/temporalio/temporal.yaml". Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--env](cli/cmd-options#env) +## codec-endpoint -- [--env-file](cli/cmd-options#env-file) +Remote Codec Server endpoint. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## color -- [--log-format](cli/cmd-options#log-format) +Output coloring. -- [--log-level](cli/cmd-options#log-level) +## command-timeout -- [--namespace](cli/cmd-options#namespace) +Timeout for the span of a command. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## env -- [--output](cli/cmd-options#output) +Active environment name (`ENV`). -- [--time-format](cli/cmd-options#time-format) +## env-file -- [--tls](cli/cmd-options#tls) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## grpc-meta -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## log-format -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Log format. Options are: text, json. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## log-level -- [--tls-key-data](cli/cmd-options#tls-key-data) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## namespace -- [--tls-server-name](cli/cmd-options#tls-server-name) +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## set @@ -248,55 +396,107 @@ commands. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## key + +Property name (required). + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads -- [--api-key](cli/cmd-options#api-key) +Raw payload output, even if they are JSON. -- [--codec-auth](cli/cmd-options#codec-auth) +## output -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Non-logging data output format. -- [--color](cli/cmd-options#color) +## time-format -- [--command-timeout](cli/cmd-options#command-timeout) +Time format. -- [--env](cli/cmd-options#env) +## tls -- [--env-file](cli/cmd-options#env-file) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## tls-ca-data -- [--key](cli/cmd-options#key) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--log-format](cli/cmd-options#log-format) +## tls-ca-path -- [--log-level](cli/cmd-options#log-level) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--namespace](cli/cmd-options#namespace) +## tls-cert-data -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--output](cli/cmd-options#output) +## tls-cert-path -- [--time-format](cli/cmd-options#time-format) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls](cli/cmd-options#tls) +## tls-disable-host-verification -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Disable TLS host-name verification. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-key-data -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-key-path -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-server-name -- [--tls-key-path](cli/cmd-options#tls-key-path) +Override target TLS server name. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## value -- [--value](cli/cmd-options#value) +Property value (required). diff --git a/temporalcli/docs/operator.mdx b/temporalcli/docs/operator.mdx index 4b1d13c5..f2f2a3e7 100644 --- a/temporalcli/docs/operator.mdx +++ b/temporalcli/docs/operator.mdx @@ -66,53 +66,101 @@ temporal operator cluster health Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--env](cli/cmd-options#env) +## codec-endpoint -- [--env-file](cli/cmd-options#env-file) +Remote Codec Server endpoint. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## color -- [--log-format](cli/cmd-options#log-format) +Output coloring. -- [--log-level](cli/cmd-options#log-level) +## command-timeout -- [--namespace](cli/cmd-options#namespace) +Timeout for the span of a command. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## env -- [--output](cli/cmd-options#output) +Active environment name (`ENV`). -- [--time-format](cli/cmd-options#time-format) +## env-file -- [--tls](cli/cmd-options#tls) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## grpc-meta -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## log-format -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Log format. Options are: text, json. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## log-level -- [--tls-key-data](cli/cmd-options#tls-key-data) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## clusterdescribe @@ -125,55 +173,105 @@ temporal operator cluster describe [--detail] Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. -- [--api-key](cli/cmd-options#api-key) +## color -- [--codec-auth](cli/cmd-options#codec-auth) +Output coloring. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## command-timeout -- [--color](cli/cmd-options#color) +Timeout for the span of a command. -- [--command-timeout](cli/cmd-options#command-timeout) +## detail -- [--detail](cli/cmd-options#detail) +Show history shard count and Cluster/Service version information. -- [--env](cli/cmd-options#env) +## env -- [--env-file](cli/cmd-options#env-file) +Active environment name (`ENV`). -- [--grpc-meta](cli/cmd-options#grpc-meta) +## env-file -- [--log-format](cli/cmd-options#log-format) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--log-level](cli/cmd-options#log-level) +## grpc-meta -- [--namespace](cli/cmd-options#namespace) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## log-format -- [--output](cli/cmd-options#output) +Log format. Options are: text, json. -- [--time-format](cli/cmd-options#time-format) +## log-level -- [--tls](cli/cmd-options#tls) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-cert-path -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-disable-host-verification -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Disable TLS host-name verification. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-key-data -- [--tls-key-path](cli/cmd-options#tls-key-path) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## clusterhealth @@ -185,53 +283,101 @@ temporal operator cluster health Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). -- [--api-key](cli/cmd-options#api-key) +## env-file -- [--codec-auth](cli/cmd-options#codec-auth) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## grpc-meta -- [--color](cli/cmd-options#color) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--command-timeout](cli/cmd-options#command-timeout) +## log-format -- [--env](cli/cmd-options#env) +Log format. Options are: text, json. -- [--env-file](cli/cmd-options#env-file) +## log-level -- [--grpc-meta](cli/cmd-options#grpc-meta) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--log-format](cli/cmd-options#log-format) +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. -- [--log-level](cli/cmd-options#log-level) +## tls -- [--namespace](cli/cmd-options#namespace) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-ca-data -- [--output](cli/cmd-options#output) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--time-format](cli/cmd-options#time-format) +## tls-ca-path -- [--tls](cli/cmd-options#tls) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-cert-data -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-cert-path -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-disable-host-verification -- [--tls-key-data](cli/cmd-options#tls-key-data) +Disable TLS host-name verification. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-key-data -- [--tls-server-name](cli/cmd-options#tls-server-name) +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## clusterlist @@ -245,55 +391,105 @@ temporal operator cluster list [--limit max-count] Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## limit + +Maximum number of Clusters to display. + +## log-format -- [--api-key](cli/cmd-options#api-key) +Log format. Options are: text, json. -- [--codec-auth](cli/cmd-options#codec-auth) +## log-level -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--color](cli/cmd-options#color) +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. -- [--command-timeout](cli/cmd-options#command-timeout) +## output -- [--env](cli/cmd-options#env) +Non-logging data output format. -- [--env-file](cli/cmd-options#env-file) +## time-format -- [--grpc-meta](cli/cmd-options#grpc-meta) +Time format. -- [--limit](cli/cmd-options#limit) +## tls -- [--log-format](cli/cmd-options#log-format) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--log-level](cli/cmd-options#log-level) +## tls-ca-data -- [--namespace](cli/cmd-options#namespace) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-ca-path -- [--output](cli/cmd-options#output) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--time-format](cli/cmd-options#time-format) +## tls-cert-data -- [--tls](cli/cmd-options#tls) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-cert-path -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-disable-host-verification -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Disable TLS host-name verification. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-key-data -- [--tls-key-data](cli/cmd-options#tls-key-data) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-key-path -- [--tls-server-name](cli/cmd-options#tls-server-name) +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## clusterremove @@ -306,55 +502,105 @@ temporal operator cluster remove \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## name + +Cluster/Service name. + +## namespace + +Temporal Service Namespace. -- [--api-key](cli/cmd-options#api-key) +## no-json-shorthand-payloads -- [--codec-auth](cli/cmd-options#codec-auth) +Raw payload output, even if they are JSON. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## output -- [--color](cli/cmd-options#color) +Non-logging data output format. -- [--command-timeout](cli/cmd-options#command-timeout) +## time-format -- [--env](cli/cmd-options#env) +Time format. -- [--env-file](cli/cmd-options#env-file) +## tls -- [--grpc-meta](cli/cmd-options#grpc-meta) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--log-format](cli/cmd-options#log-format) +## tls-ca-data -- [--log-level](cli/cmd-options#log-level) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--name](cli/cmd-options#name) +## tls-ca-path -- [--namespace](cli/cmd-options#namespace) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-cert-data -- [--output](cli/cmd-options#output) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--time-format](cli/cmd-options#time-format) +## tls-cert-path -- [--tls](cli/cmd-options#tls) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-disable-host-verification -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Disable TLS host-name verification. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-key-data -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-key-path -- [--tls-key-data](cli/cmd-options#tls-key-data) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-server-name -- [--tls-server-name](cli/cmd-options#tls-server-name) +Override target TLS server name. ## clustersystem @@ -372,53 +618,101 @@ temporal operator cluster system \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--env](cli/cmd-options#env) +## codec-endpoint -- [--env-file](cli/cmd-options#env-file) +Remote Codec Server endpoint. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## color -- [--log-format](cli/cmd-options#log-format) +Output coloring. -- [--log-level](cli/cmd-options#log-level) +## command-timeout -- [--namespace](cli/cmd-options#namespace) +Timeout for the span of a command. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## env -- [--output](cli/cmd-options#output) +Active environment name (`ENV`). -- [--time-format](cli/cmd-options#time-format) +## env-file -- [--tls](cli/cmd-options#tls) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## grpc-meta -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## log-format -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Log format. Options are: text, json. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## log-level -- [--tls-key-data](cli/cmd-options#tls-key-data) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## clusterupsert @@ -438,57 +732,109 @@ temporal operator cluster upsert \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. -- [--api-key](cli/cmd-options#api-key) +## color -- [--codec-auth](cli/cmd-options#codec-auth) +Output coloring. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## command-timeout -- [--color](cli/cmd-options#color) +Timeout for the span of a command. -- [--command-timeout](cli/cmd-options#command-timeout) +## enable-connection -- [--enable-connection](cli/cmd-options#enable-connection) +Set the connection to "enabled". -- [--env](cli/cmd-options#env) +## env -- [--env-file](cli/cmd-options#env-file) +Active environment name (`ENV`). -- [--frontend-address](cli/cmd-options#frontend-address) +## env-file -- [--grpc-meta](cli/cmd-options#grpc-meta) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--log-format](cli/cmd-options#log-format) +## frontend-address -- [--log-level](cli/cmd-options#log-level) +Remote endpoint. -- [--namespace](cli/cmd-options#namespace) +## grpc-meta -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--output](cli/cmd-options#output) +## log-format -- [--time-format](cli/cmd-options#time-format) +Log format. Options are: text, json. -- [--tls](cli/cmd-options#tls) +## log-level -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-cert-path -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-disable-host-verification -- [--tls-key-data](cli/cmd-options#tls-key-data) +Disable TLS host-name verification. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-key-data -- [--tls-server-name](cli/cmd-options#tls-server-name) +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## namespace @@ -507,53 +853,101 @@ temporal operator namespace create \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env -- [--api-key](cli/cmd-options#api-key) +Active environment name (`ENV`). -- [--codec-auth](cli/cmd-options#codec-auth) +## env-file -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--color](cli/cmd-options#color) +## grpc-meta -- [--command-timeout](cli/cmd-options#command-timeout) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--env](cli/cmd-options#env) +## log-format -- [--env-file](cli/cmd-options#env-file) +Log format. Options are: text, json. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## log-level -- [--log-format](cli/cmd-options#log-format) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--log-level](cli/cmd-options#log-level) +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. -- [--namespace](cli/cmd-options#namespace) +## tls -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--output](cli/cmd-options#output) +## tls-ca-data -- [--time-format](cli/cmd-options#time-format) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls](cli/cmd-options#tls) +## tls-ca-path -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-cert-data -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-cert-path -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-disable-host-verification -- [--tls-key-path](cli/cmd-options#tls-key-path) +Disable TLS host-name verification. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## namespacecreate @@ -584,1109 +978,1963 @@ temporal operator namespace create \ --namespace YourNewNamespaceName ``` -Note: URI values for archival states can't be changed once enabled. +Note: URI values for archival states can't be changed once enabled. + +Use the following options to change the behavior of this command. + +## active-cluster + +Active Cluster (Service) name. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## cluster + +Cluster (Service) names for Namespace creation. Can be passed multiple times. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## data + +Namespace data as `KEY=VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. + +## description + +Namespace description. + +## email + +Owner email. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## global + +Enable multi-region data replication. + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## history-archival-state + +History archival state. + +## history-uri + +Archive history to this `URI`. Once enabled, can't be changed. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## retention + +Time to preserve closed Workflows before deletion. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## visibility-archival-state + +Visibility archival state. + +## visibility-uri + +Archive visibility data to this `URI`. Once enabled, can't be changed. + +## namespacedelete + +Removes a Namespace from the Service. + +``` +temporal operator namespace delete [options] +``` + +For example: + +``` +temporal operator namespace delete \ + --namespace YourNamespaceName +``` + +Use the following options to change the behavior of this command. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## yes + +Request confirmation before deletion. + +## namespacedescribe + +Provide long-form information about a Namespace identified by its ID or name: + +``` +temporal operator namespace describe \ + --namespace-id YourNamespaceId +``` + +or + +``` +temporal operator namespace describe \ + --namespace YourNamespaceName +``` + +Use the following options to change the behavior of this command. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## namespace-id + +Namespace ID. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## namespacelist + +Display a detailed listing for all Namespaces on the Service: + +``` +temporal operator namespace list +``` + +Use the following options to change the behavior of this command. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## namespaceupdate + +Update a Namespace using properties you specify. + +``` +temporal operator namespace update [options] +``` + +Assign a Namespace's active Cluster (Service): + +``` +temporal operator namespace update \ + --namespace YourNamespaceName \ + --active-cluster NewActiveCluster +``` + +Promote a Namespace for multi-region data replication: + +``` +temporal operator namespace update \ + --namespace YourNamespaceName \ + --promote-global +``` + +You may update archives that were previously enabled or disabled. Note: URI +values for archival states can't be changed once enabled. + +``` +temporal operator namespace update \ + --namespace YourNamespaceName \ + --history-archival-state enabled \ + --visibility-archival-state disabled +``` + +Use the following options to change the behavior of this command. + +## active-cluster + +Active Cluster (Service) name. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## cluster + +Cluster (Service) names. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## data + +Namespace data as `KEY=VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. + +## description + +Namespace description. + +## email + +Owner email. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## history-archival-state + +History archival state. + +## history-uri + +Archive history to this `URI`. Once enabled, can't be changed. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## promote-global + +Enable multi-region data replication. + +## retention + +Length of time a closed Workflow is preserved before deletion. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## visibility-archival-state + +Visibility archival state. + +## visibility-uri + +Archive visibility data to this `URI`. Once enabled, can't be changed. + +## nexus + +Nexus commands enable managing Nexus resources. + +Nexus commands follow this syntax: + +``` +temporal operator nexus [command] [command] [command options] +``` + +Use the following options to change the behavior of this command. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## nexusendpoint + +Endpoint commands enable managing Nexus Endpoints. + +Endpoint commands follow this syntax: + +``` +temporal operator nexus endpoint [command] [command options] +``` + +Use the following options to change the behavior of this command. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. -Use the following options to change the behavior of this command. +## tls-disable-host-verification -- [--active-cluster](cli/cmd-options#active-cluster) +Disable TLS host-name verification. -- [--address](cli/cmd-options#address) +## tls-key-data -- [--api-key](cli/cmd-options#api-key) +Private certificate key data. Can't be used with --tls-key-path. -- [--cluster](cli/cmd-options#cluster) +## tls-key-path -- [--codec-auth](cli/cmd-options#codec-auth) +Path to x509 private key. Can't be used with --tls-key-data. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## tls-server-name -- [--color](cli/cmd-options#color) +Override target TLS server name. -- [--command-timeout](cli/cmd-options#command-timeout) +## nexusendpointcreate -- [--data](cli/cmd-options#data) +Create a new Nexus Endpoint on the Server. -- [--description](cli/cmd-options#description) +An endpoint name is used in workflow code to invoke Nexus operations. The +endpoint target may either be a worker, in which case `--target-namespace` and +`--target-task-queue` must both be provided, or an external URL, in which case +`--target-url` must be provided. -- [--email](cli/cmd-options#email) +This command will fail if an endpoint with the same name is already registered. -- [--env](cli/cmd-options#env) +``` +temporal operator nexus endpoint create \ + --name your-endpoint \ + --target-namespace your-namespace \ + --target-task-queue your-task-queue \ + --description-file DESCRIPTION.md +``` -- [--env-file](cli/cmd-options#env-file) +Use the following options to change the behavior of this command. -- [--global](cli/cmd-options#global) +## address -- [--grpc-meta](cli/cmd-options#grpc-meta) +Temporal Service gRPC endpoint. -- [--history-archival-state](cli/cmd-options#history-archival-state) +## api-key -- [--history-uri](cli/cmd-options#history-uri) +API key for request. -- [--log-format](cli/cmd-options#log-format) +## codec-auth -- [--log-level](cli/cmd-options#log-level) +Authorization header for Codec Server requests. -- [--namespace](cli/cmd-options#namespace) +## codec-endpoint -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Remote Codec Server endpoint. -- [--output](cli/cmd-options#output) +## color -- [--retention](cli/cmd-options#retention) +Output coloring. -- [--time-format](cli/cmd-options#time-format) +## command-timeout -- [--tls](cli/cmd-options#tls) +Timeout for the span of a command. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## description -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Endpoint description in markdown format (encoded using the configured codec server). -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## description-file -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Endpoint description file in markdown format (encoded using the configured codec server). -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## env -- [--tls-key-data](cli/cmd-options#tls-key-data) +Active environment name (`ENV`). -- [--tls-key-path](cli/cmd-options#tls-key-path) +## env-file -- [--tls-server-name](cli/cmd-options#tls-server-name) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--visibility-archival-state](cli/cmd-options#visibility-archival-state) +## grpc-meta -- [--visibility-uri](cli/cmd-options#visibility-uri) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -## namespacedelete +## log-format -Removes a Namespace from the Service. +Log format. Options are: text, json. -``` -temporal operator namespace delete [options] -``` +## log-level -For example: +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -``` -temporal operator namespace delete \ - --namespace YourNamespaceName -``` +## name -Use the following options to change the behavior of this command. +Endpoint name. -- [--address](cli/cmd-options#address) +## namespace -- [--api-key](cli/cmd-options#api-key) +Temporal Service Namespace. -- [--codec-auth](cli/cmd-options#codec-auth) +## no-json-shorthand-payloads -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Raw payload output, even if they are JSON. -- [--color](cli/cmd-options#color) +## output -- [--command-timeout](cli/cmd-options#command-timeout) +Non-logging data output format. -- [--env](cli/cmd-options#env) +## target-namespace -- [--env-file](cli/cmd-options#env-file) +Namespace in which a handler worker will be polling for Nexus tasks on. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## target-task-queue -- [--log-format](cli/cmd-options#log-format) +Task Queue in which a handler worker will be polling for Nexus tasks on. -- [--log-level](cli/cmd-options#log-level) +## target-url -- [--namespace](cli/cmd-options#namespace) +URL to direct Nexus requests to. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## time-format -- [--output](cli/cmd-options#output) +Time format. -- [--time-format](cli/cmd-options#time-format) +## tls -- [--tls](cli/cmd-options#tls) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-ca-data -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-ca-path -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-cert-data -- [--tls-key-data](cli/cmd-options#tls-key-data) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-cert-path -- [--tls-server-name](cli/cmd-options#tls-server-name) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--yes](cli/cmd-options#yes) +## tls-disable-host-verification -## namespacedescribe +Disable TLS host-name verification. -Provide long-form information about a Namespace identified by its ID or name: +## tls-key-data -``` -temporal operator namespace describe \ - --namespace-id YourNamespaceId -``` +Private certificate key data. Can't be used with --tls-key-path. -or +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## nexusendpointdelete + +Delete a Nexus Endpoint configuration from the Server. ``` -temporal operator namespace describe \ - --namespace YourNamespaceName +temporal operator nexus endpoint delete --name your-endpoint ``` Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--env](cli/cmd-options#env) +## codec-endpoint -- [--env-file](cli/cmd-options#env-file) +Remote Codec Server endpoint. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## color -- [--log-format](cli/cmd-options#log-format) +Output coloring. -- [--log-level](cli/cmd-options#log-level) +## command-timeout -- [--namespace](cli/cmd-options#namespace) +Timeout for the span of a command. -- [--namespace-id](cli/cmd-options#namespace-id) +## env -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Active environment name (`ENV`). -- [--output](cli/cmd-options#output) +## env-file -- [--time-format](cli/cmd-options#time-format) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls](cli/cmd-options#tls) +## grpc-meta -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## log-format -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Log format. Options are: text, json. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## log-level -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## name -- [--tls-key-path](cli/cmd-options#tls-key-path) +Endpoint name. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## namespace -## namespacelist +Temporal Service Namespace. -Display a detailed listing for all Namespaces on the Service: +## no-json-shorthand-payloads -``` -temporal operator namespace list -``` +Raw payload output, even if they are JSON. -Use the following options to change the behavior of this command. +## output -- [--address](cli/cmd-options#address) +Non-logging data output format. -- [--api-key](cli/cmd-options#api-key) +## time-format -- [--codec-auth](cli/cmd-options#codec-auth) +Time format. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## tls -- [--color](cli/cmd-options#color) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--command-timeout](cli/cmd-options#command-timeout) +## tls-ca-data -- [--env](cli/cmd-options#env) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--env-file](cli/cmd-options#env-file) +## tls-ca-path -- [--grpc-meta](cli/cmd-options#grpc-meta) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--log-format](cli/cmd-options#log-format) +## tls-cert-data -- [--log-level](cli/cmd-options#log-level) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--namespace](cli/cmd-options#namespace) +## tls-cert-path -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--output](cli/cmd-options#output) +## tls-disable-host-verification -- [--time-format](cli/cmd-options#time-format) +Disable TLS host-name verification. -- [--tls](cli/cmd-options#tls) +## tls-key-data -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-key-path -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-server-name -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Override target TLS server name. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## nexusendpointget -- [--tls-key-path](cli/cmd-options#tls-key-path) +Get a Nexus Endpoint configuration by name from the Server. -- [--tls-server-name](cli/cmd-options#tls-server-name) +``` +temporal operator nexus endpoint get --name your-endpoint +``` -## namespaceupdate +Use the following options to change the behavior of this command. -Update a Namespace using properties you specify. +## address -``` -temporal operator namespace update [options] -``` +Temporal Service gRPC endpoint. -Assign a Namespace's active Cluster (Service): +## api-key -``` -temporal operator namespace update \ - --namespace YourNamespaceName \ - --active-cluster NewActiveCluster -``` +API key for request. -Promote a Namespace for multi-region data replication: +## codec-auth -``` -temporal operator namespace update \ - --namespace YourNamespaceName \ - --promote-global -``` +Authorization header for Codec Server requests. -You may update archives that were previously enabled or disabled. Note: URI -values for archival states can't be changed once enabled. +## codec-endpoint -``` -temporal operator namespace update \ - --namespace YourNamespaceName \ - --history-archival-state enabled \ - --visibility-archival-state disabled -``` +Remote Codec Server endpoint. -Use the following options to change the behavior of this command. +## color -- [--active-cluster](cli/cmd-options#active-cluster) +Output coloring. -- [--address](cli/cmd-options#address) +## command-timeout -- [--api-key](cli/cmd-options#api-key) +Timeout for the span of a command. -- [--cluster](cli/cmd-options#cluster) +## env -- [--codec-auth](cli/cmd-options#codec-auth) +Active environment name (`ENV`). -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## env-file -- [--color](cli/cmd-options#color) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--command-timeout](cli/cmd-options#command-timeout) +## grpc-meta -- [--data](cli/cmd-options#data) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--description](cli/cmd-options#description) +## log-format -- [--email](cli/cmd-options#email) +Log format. Options are: text, json. -- [--env](cli/cmd-options#env) +## log-level -- [--env-file](cli/cmd-options#env-file) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## name -- [--history-archival-state](cli/cmd-options#history-archival-state) +Endpoint name. -- [--history-uri](cli/cmd-options#history-uri) +## namespace -- [--log-format](cli/cmd-options#log-format) +Temporal Service Namespace. -- [--log-level](cli/cmd-options#log-level) +## no-json-shorthand-payloads -- [--namespace](cli/cmd-options#namespace) +Raw payload output, even if they are JSON. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## output -- [--output](cli/cmd-options#output) +Non-logging data output format. -- [--promote-global](cli/cmd-options#promote-global) +## time-format -- [--retention](cli/cmd-options#retention) +Time format. -- [--time-format](cli/cmd-options#time-format) +## tls -- [--tls](cli/cmd-options#tls) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-ca-data -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-ca-path -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-cert-data -- [--tls-key-data](cli/cmd-options#tls-key-data) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-cert-path -- [--tls-server-name](cli/cmd-options#tls-server-name) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--visibility-archival-state](cli/cmd-options#visibility-archival-state) +## tls-disable-host-verification -- [--visibility-uri](cli/cmd-options#visibility-uri) +Disable TLS host-name verification. -## nexus +## tls-key-data -Nexus commands enable managing Nexus resources. +Private certificate key data. Can't be used with --tls-key-path. -Nexus commands follow this syntax: +## tls-key-path -``` -temporal operator nexus [command] [command] [command options] -``` +Path to x509 private key. Can't be used with --tls-key-data. -Use the following options to change the behavior of this command. +## tls-server-name -- [--address](cli/cmd-options#address) +Override target TLS server name. -- [--api-key](cli/cmd-options#api-key) +## nexusendpointlist -- [--codec-auth](cli/cmd-options#codec-auth) +List all Nexus Endpoint configurations on the Server. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +``` +temporal operator nexus endpoint list +``` -- [--color](cli/cmd-options#color) +Use the following options to change the behavior of this command. -- [--command-timeout](cli/cmd-options#command-timeout) +## address -- [--env](cli/cmd-options#env) +Temporal Service gRPC endpoint. -- [--env-file](cli/cmd-options#env-file) +## api-key -- [--grpc-meta](cli/cmd-options#grpc-meta) +API key for request. -- [--log-format](cli/cmd-options#log-format) +## codec-auth -- [--log-level](cli/cmd-options#log-level) +Authorization header for Codec Server requests. -- [--namespace](cli/cmd-options#namespace) +## codec-endpoint -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Remote Codec Server endpoint. -- [--output](cli/cmd-options#output) +## color -- [--time-format](cli/cmd-options#time-format) +Output coloring. -- [--tls](cli/cmd-options#tls) +## command-timeout -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Timeout for the span of a command. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## env -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Active environment name (`ENV`). -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## env-file -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls-key-data](cli/cmd-options#tls-key-data) +## grpc-meta -- [--tls-key-path](cli/cmd-options#tls-key-path) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## log-format -## nexusendpoint +Log format. Options are: text, json. -Endpoint commands enable managing Nexus Endpoints. +## log-level -Endpoint commands follow this syntax: +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -``` -temporal operator nexus endpoint [command] [command options] -``` +## namespace -Use the following options to change the behavior of this command. +Temporal Service Namespace. -- [--address](cli/cmd-options#address) +## no-json-shorthand-payloads -- [--api-key](cli/cmd-options#api-key) +Raw payload output, even if they are JSON. -- [--codec-auth](cli/cmd-options#codec-auth) +## output -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Non-logging data output format. -- [--color](cli/cmd-options#color) +## time-format -- [--command-timeout](cli/cmd-options#command-timeout) +Time format. -- [--env](cli/cmd-options#env) +## tls -- [--env-file](cli/cmd-options#env-file) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## tls-ca-data -- [--log-format](cli/cmd-options#log-format) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--log-level](cli/cmd-options#log-level) +## tls-ca-path -- [--namespace](cli/cmd-options#namespace) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-cert-data -- [--output](cli/cmd-options#output) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--time-format](cli/cmd-options#time-format) +## tls-cert-path -- [--tls](cli/cmd-options#tls) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-disable-host-verification -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Disable TLS host-name verification. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-key-data -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-key-path -- [--tls-key-data](cli/cmd-options#tls-key-data) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-server-name -- [--tls-server-name](cli/cmd-options#tls-server-name) +Override target TLS server name. -## nexusendpointcreate +## nexusendpointupdate -Create a new Nexus Endpoint on the Server. +Update an existing Nexus Endpoint on the Server. An endpoint name is used in workflow code to invoke Nexus operations. The endpoint target may either be a worker, in which case `--target-namespace` and `--target-task-queue` must both be provided, or an external URL, in which case `--target-url` must be provided. -This command will fail if an endpoint with the same name is already registered. +The endpoint is patched; existing fields for which flags are not provided are +left as they were. + +Update only the target task queue: ``` -temporal operator nexus endpoint create \ +temporal operator nexus endpoint update \ + --name your-endpoint \ + --target-task-queue your-other-queue +``` + +Update only the description: + +``` +temporal operator nexus endpoint update \ --name your-endpoint \ - --target-namespace your-namespace \ - --target-task-queue your-task-queue \ --description-file DESCRIPTION.md ``` Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--description](cli/cmd-options#description) +## codec-endpoint -- [--description-file](cli/cmd-options#description-file) +Remote Codec Server endpoint. -- [--env](cli/cmd-options#env) +## color -- [--env-file](cli/cmd-options#env-file) +Output coloring. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## command-timeout -- [--log-format](cli/cmd-options#log-format) +Timeout for the span of a command. -- [--log-level](cli/cmd-options#log-level) +## description -- [--name](cli/cmd-options#name) +Endpoint description in markdown format (encoded using the configured codec server). -- [--namespace](cli/cmd-options#namespace) +## description-file -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Endpoint description file in markdown format (encoded using the configured codec server). -- [--output](cli/cmd-options#output) +## env -- [--target-namespace](cli/cmd-options#target-namespace) +Active environment name (`ENV`). -- [--target-task-queue](cli/cmd-options#target-task-queue) +## env-file -- [--target-url](cli/cmd-options#target-url) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--time-format](cli/cmd-options#time-format) +## grpc-meta -- [--tls](cli/cmd-options#tls) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## log-format -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Log format. Options are: text, json. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## log-level -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## name -- [--tls-key-data](cli/cmd-options#tls-key-data) +Endpoint name. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## namespace -- [--tls-server-name](cli/cmd-options#tls-server-name) +Temporal Service Namespace. -## nexusendpointdelete +## no-json-shorthand-payloads -Delete a Nexus Endpoint configuration from the Server. +Raw payload output, even if they are JSON. -``` -temporal operator nexus endpoint delete --name your-endpoint -``` +## output -Use the following options to change the behavior of this command. +Non-logging data output format. -- [--address](cli/cmd-options#address) +## target-namespace -- [--api-key](cli/cmd-options#api-key) +Namespace in which a handler worker will be polling for Nexus tasks on. -- [--codec-auth](cli/cmd-options#codec-auth) +## target-task-queue -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Task Queue in which a handler worker will be polling for Nexus tasks on. -- [--color](cli/cmd-options#color) +## target-url -- [--command-timeout](cli/cmd-options#command-timeout) +URL to direct Nexus requests to. -- [--env](cli/cmd-options#env) +## time-format -- [--env-file](cli/cmd-options#env-file) +Time format. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## tls -- [--log-format](cli/cmd-options#log-format) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--log-level](cli/cmd-options#log-level) +## tls-ca-data -- [--name](cli/cmd-options#name) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--namespace](cli/cmd-options#namespace) +## tls-ca-path -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--output](cli/cmd-options#output) +## tls-cert-data -- [--time-format](cli/cmd-options#time-format) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls](cli/cmd-options#tls) +## tls-cert-path -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-disable-host-verification -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Disable TLS host-name verification. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-key-data -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-key-path -- [--tls-key-path](cli/cmd-options#tls-key-path) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-server-name -## nexusendpointget +Override target TLS server name. -Get a Nexus Endpoint configuration by name from the Server. +## unset-description + +Unset the description. + +## search-attribute + +Create, list, or remove Search Attributes fields stored in a Workflow +Execution's metadata: ``` -temporal operator nexus endpoint get --name your-endpoint +temporal operator search-attribute create \ + --name YourAttributeName \ + --type Keyword ``` +Supported types include: Text, Keyword, Int, Double, Bool, Datetime, and +KeywordList. + +If you wish to delete a Search Attribute, please contact support +at https://support.temporal.io. + Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--env](cli/cmd-options#env) +## codec-endpoint -- [--env-file](cli/cmd-options#env-file) +Remote Codec Server endpoint. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## color -- [--log-format](cli/cmd-options#log-format) +Output coloring. -- [--log-level](cli/cmd-options#log-level) +## command-timeout -- [--name](cli/cmd-options#name) +Timeout for the span of a command. -- [--namespace](cli/cmd-options#namespace) +## env -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Active environment name (`ENV`). -- [--output](cli/cmd-options#output) +## env-file -- [--time-format](cli/cmd-options#time-format) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls](cli/cmd-options#tls) +## grpc-meta -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## log-format -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Log format. Options are: text, json. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## log-level -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## namespace -- [--tls-key-path](cli/cmd-options#tls-key-path) +Temporal Service Namespace. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## no-json-shorthand-payloads -## nexusendpointlist +Raw payload output, even if they are JSON. -List all Nexus Endpoint configurations on the Server. +## output -``` -temporal operator nexus endpoint list -``` +Non-logging data output format. -Use the following options to change the behavior of this command. +## time-format -- [--address](cli/cmd-options#address) +Time format. -- [--api-key](cli/cmd-options#api-key) +## tls -- [--codec-auth](cli/cmd-options#codec-auth) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## tls-ca-data -- [--color](cli/cmd-options#color) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--command-timeout](cli/cmd-options#command-timeout) +## tls-ca-path -- [--env](cli/cmd-options#env) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--env-file](cli/cmd-options#env-file) +## tls-cert-data -- [--grpc-meta](cli/cmd-options#grpc-meta) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--log-format](cli/cmd-options#log-format) +## tls-cert-path -- [--log-level](cli/cmd-options#log-level) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--namespace](cli/cmd-options#namespace) +## tls-disable-host-verification -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Disable TLS host-name verification. -- [--output](cli/cmd-options#output) +## tls-key-data -- [--time-format](cli/cmd-options#time-format) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls](cli/cmd-options#tls) +## tls-key-path -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-server-name -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Override target TLS server name. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## search-attributecreate -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Add one or more custom Search Attributes: -- [--tls-key-data](cli/cmd-options#tls-key-data) +``` +temporal operator search-attribute create \ + --name YourAttributeName \ + --type Keyword +``` -- [--tls-key-path](cli/cmd-options#tls-key-path) +Use the following options to change the behavior of this command. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## address -## nexusendpointupdate +Temporal Service gRPC endpoint. -Update an existing Nexus Endpoint on the Server. +## api-key -An endpoint name is used in workflow code to invoke Nexus operations. The -endpoint target may either be a worker, in which case `--target-namespace` and -`--target-task-queue` must both be provided, or an external URL, in which case -`--target-url` must be provided. +API key for request. -The endpoint is patched; existing fields for which flags are not provided are -left as they were. +## codec-auth -Update only the target task queue: +Authorization header for Codec Server requests. -``` -temporal operator nexus endpoint update \ - --name your-endpoint \ - --target-task-queue your-other-queue -``` +## codec-endpoint -Update only the description: +Remote Codec Server endpoint. -``` -temporal operator nexus endpoint update \ - --name your-endpoint \ - --description-file DESCRIPTION.md -``` +## color -Use the following options to change the behavior of this command. +Output coloring. -- [--address](cli/cmd-options#address) +## command-timeout -- [--api-key](cli/cmd-options#api-key) +Timeout for the span of a command. -- [--codec-auth](cli/cmd-options#codec-auth) +## env -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Active environment name (`ENV`). -- [--color](cli/cmd-options#color) +## env-file -- [--command-timeout](cli/cmd-options#command-timeout) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--description](cli/cmd-options#description) +## grpc-meta -- [--description-file](cli/cmd-options#description-file) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--env](cli/cmd-options#env) +## log-format -- [--env-file](cli/cmd-options#env-file) +Log format. Options are: text, json. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## log-level -- [--log-format](cli/cmd-options#log-format) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--log-level](cli/cmd-options#log-level) +## name -- [--name](cli/cmd-options#name) +Search Attribute name. -- [--namespace](cli/cmd-options#namespace) +## namespace -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Temporal Service Namespace. -- [--output](cli/cmd-options#output) +## no-json-shorthand-payloads -- [--target-namespace](cli/cmd-options#target-namespace) +Raw payload output, even if they are JSON. -- [--target-task-queue](cli/cmd-options#target-task-queue) +## output -- [--target-url](cli/cmd-options#target-url) +Non-logging data output format. -- [--time-format](cli/cmd-options#time-format) +## time-format -- [--tls](cli/cmd-options#tls) +Time format. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-ca-data -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-ca-path -- [--tls-key-data](cli/cmd-options#tls-key-data) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-cert-data -- [--tls-server-name](cli/cmd-options#tls-server-name) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--unset-description](cli/cmd-options#unset-description) +## tls-cert-path -## search-attribute +Path to x509 certificate. Can't be used with --tls-cert-data. -Create, list, or remove Search Attributes fields stored in a Workflow -Execution's metadata: +## tls-disable-host-verification -``` -temporal operator search-attribute create \ - --name YourAttributeName \ - --type Keyword -``` +Disable TLS host-name verification. -Supported types include: Text, Keyword, Int, Double, Bool, Datetime, and -KeywordList. +## tls-key-data -If you wish to delete a Search Attribute, please contact support -at https://support.temporal.io. +Private certificate key data. Can't be used with --tls-key-path. -Use the following options to change the behavior of this command. +## tls-key-path -- [--address](cli/cmd-options#address) +Path to x509 private key. Can't be used with --tls-key-data. -- [--api-key](cli/cmd-options#api-key) +## tls-server-name -- [--codec-auth](cli/cmd-options#codec-auth) +Override target TLS server name. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## type -- [--color](cli/cmd-options#color) +Search Attribute type. -- [--command-timeout](cli/cmd-options#command-timeout) +## search-attributelist -- [--env](cli/cmd-options#env) +Display a list of active Search Attributes that can be assigned or used with +Workflow Queries. You can manage this list and add attributes as needed: -- [--env-file](cli/cmd-options#env-file) +``` +temporal operator search-attribute list +``` -- [--grpc-meta](cli/cmd-options#grpc-meta) +Use the following options to change the behavior of this command. -- [--log-format](cli/cmd-options#log-format) +## address -- [--log-level](cli/cmd-options#log-level) +Temporal Service gRPC endpoint. -- [--namespace](cli/cmd-options#namespace) +## api-key -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +API key for request. -- [--output](cli/cmd-options#output) +## codec-auth -- [--time-format](cli/cmd-options#time-format) +Authorization header for Codec Server requests. -- [--tls](cli/cmd-options#tls) +## codec-endpoint -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Remote Codec Server endpoint. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## color -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Output coloring. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## command-timeout -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Timeout for the span of a command. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## env -- [--tls-key-path](cli/cmd-options#tls-key-path) +Active environment name (`ENV`). -- [--tls-server-name](cli/cmd-options#tls-server-name) +## env-file -## search-attributecreate +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -Add one or more custom Search Attributes: +## grpc-meta -``` -temporal operator search-attribute create \ - --name YourAttributeName \ - --type Keyword -``` +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -Use the following options to change the behavior of this command. +## log-format -- [--address](cli/cmd-options#address) +Log format. Options are: text, json. -- [--api-key](cli/cmd-options#api-key) +## log-level -- [--codec-auth](cli/cmd-options#codec-auth) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## namespace -- [--color](cli/cmd-options#color) +Temporal Service Namespace. -- [--command-timeout](cli/cmd-options#command-timeout) +## no-json-shorthand-payloads -- [--env](cli/cmd-options#env) +Raw payload output, even if they are JSON. -- [--env-file](cli/cmd-options#env-file) +## output -- [--grpc-meta](cli/cmd-options#grpc-meta) +Non-logging data output format. -- [--log-format](cli/cmd-options#log-format) +## time-format -- [--log-level](cli/cmd-options#log-level) +Time format. -- [--name](cli/cmd-options#name) +## tls -- [--namespace](cli/cmd-options#namespace) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-ca-data -- [--output](cli/cmd-options#output) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--time-format](cli/cmd-options#time-format) +## tls-ca-path -- [--tls](cli/cmd-options#tls) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-cert-data -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-cert-path -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-disable-host-verification -- [--tls-key-data](cli/cmd-options#tls-key-data) +Disable TLS host-name verification. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-key-data -- [--tls-server-name](cli/cmd-options#tls-server-name) +Private certificate key data. Can't be used with --tls-key-path. -- [--type](cli/cmd-options#type) +## tls-key-path -## search-attributelist +Path to x509 private key. Can't be used with --tls-key-data. -Display a list of active Search Attributes that can be assigned or used with -Workflow Queries. You can manage this list and add attributes as needed: +## tls-server-name -``` -temporal operator search-attribute list -``` +Override target TLS server name. -Use the following options to change the behavior of this command. +## search-attributeremove + +Remove custom Search Attributes from the options that can be assigned or used +with Workflow Queries. -- [--address](cli/cmd-options#address) +``` +temporal operator search-attribute remove \ + --name YourAttributeName +``` -- [--api-key](cli/cmd-options#api-key) +Remove attributes without confirmation: -- [--codec-auth](cli/cmd-options#codec-auth) +``` +temporal operator search-attribute remove \ + --name YourAttributeName \ + --yes +``` -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Use the following options to change the behavior of this command. -- [--color](cli/cmd-options#color) +## address -- [--command-timeout](cli/cmd-options#command-timeout) +Temporal Service gRPC endpoint. -- [--env](cli/cmd-options#env) +## api-key -- [--env-file](cli/cmd-options#env-file) +API key for request. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## codec-auth -- [--log-format](cli/cmd-options#log-format) +Authorization header for Codec Server requests. -- [--log-level](cli/cmd-options#log-level) +## codec-endpoint -- [--namespace](cli/cmd-options#namespace) +Remote Codec Server endpoint. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## color -- [--output](cli/cmd-options#output) +Output coloring. -- [--time-format](cli/cmd-options#time-format) +## command-timeout -- [--tls](cli/cmd-options#tls) +Timeout for the span of a command. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## env -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Active environment name (`ENV`). -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## env-file -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## grpc-meta -- [--tls-key-data](cli/cmd-options#tls-key-data) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## log-format -- [--tls-server-name](cli/cmd-options#tls-server-name) +Log format. Options are: text, json. -## search-attributeremove +## log-level -Remove custom Search Attributes from the options that can be assigned or used -with Workflow Queries. +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -``` -temporal operator search-attribute remove \ - --name YourAttributeName -``` +## name -Remove attributes without confirmation: +Search Attribute name. -``` -temporal operator search-attribute remove \ - --name YourAttributeName \ - --yes -``` +## namespace -Use the following options to change the behavior of this command. +Temporal Service Namespace. -- [--address](cli/cmd-options#address) +## no-json-shorthand-payloads -- [--api-key](cli/cmd-options#api-key) +Raw payload output, even if they are JSON. -- [--codec-auth](cli/cmd-options#codec-auth) +## output -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Non-logging data output format. -- [--color](cli/cmd-options#color) +## time-format -- [--command-timeout](cli/cmd-options#command-timeout) +Time format. -- [--env](cli/cmd-options#env) +## tls -- [--env-file](cli/cmd-options#env-file) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## tls-ca-data -- [--log-format](cli/cmd-options#log-format) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--log-level](cli/cmd-options#log-level) +## tls-ca-path -- [--name](cli/cmd-options#name) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--namespace](cli/cmd-options#namespace) +## tls-cert-data -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--output](cli/cmd-options#output) +## tls-cert-path -- [--time-format](cli/cmd-options#time-format) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls](cli/cmd-options#tls) +## tls-disable-host-verification -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Disable TLS host-name verification. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-key-data -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-key-path -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-server-name -- [--tls-key-path](cli/cmd-options#tls-key-path) +Override target TLS server name. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## yes -- [--yes](cli/cmd-options#yes) +Don't prompt to confirm removal. diff --git a/temporalcli/docs/schedule.mdx b/temporalcli/docs/schedule.mdx index 1ecc312c..1d653e12 100644 --- a/temporalcli/docs/schedule.mdx +++ b/temporalcli/docs/schedule.mdx @@ -77,57 +77,109 @@ The policies include: Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--end-time](cli/cmd-options#end-time) +## codec-endpoint -- [--env](cli/cmd-options#env) +Remote Codec Server endpoint. -- [--env-file](cli/cmd-options#env-file) +## color -- [--grpc-meta](cli/cmd-options#grpc-meta) +Output coloring. -- [--log-format](cli/cmd-options#log-format) +## command-timeout -- [--log-level](cli/cmd-options#log-level) +Timeout for the span of a command. -- [--namespace](cli/cmd-options#namespace) +## end-time -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Backfill end time. -- [--output](cli/cmd-options#output) +## env -- [--start-time](cli/cmd-options#start-time) +Active environment name (`ENV`). -- [--time-format](cli/cmd-options#time-format) +## env-file -- [--tls](cli/cmd-options#tls) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## grpc-meta -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## log-format -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Log format. Options are: text, json. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## log-level -- [--tls-key-data](cli/cmd-options#tls-key-data) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## namespace -- [--tls-server-name](cli/cmd-options#tls-server-name) +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## start-time + +Backfill start time. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## create @@ -157,109 +209,213 @@ Schedules support any combination of `--calendar`, `--interval`, and `--cron`: Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## calendar + +Calendar specification in JSON. For example: `{"dayOfWeek":"Fri","hour":"17","minute":"5"}`. + +## catchup-window + +Maximum catch-up time for when the Service is unavailable. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## cron + +Calendar specification in cron string format. For example: `"30 12 * * Fri"`. + +## end-time + +Schedule end time. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## execution-timeout + +Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## input + +Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. + +## input-base64 + +Assume inputs are base64-encoded and attempt to decode them. + +## input-file + +A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. + +## input-meta + +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. + +## interval + +Interval duration. For example, 90m, or 60m/15m to include phase offset. + +## jitter + +Max difference in time from the specification. Vary the start time randomly within this amount. + +## log-format -- [--api-key](cli/cmd-options#api-key) +Log format. Options are: text, json. -- [--calendar](cli/cmd-options#calendar) +## log-level -- [--catchup-window](cli/cmd-options#catchup-window) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--codec-auth](cli/cmd-options#codec-auth) +## memo -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Memo using 'KEY="VALUE"' pairs. Use JSON values. -- [--color](cli/cmd-options#color) +## namespace -- [--command-timeout](cli/cmd-options#command-timeout) +Temporal Service Namespace. -- [--cron](cli/cmd-options#cron) +## no-json-shorthand-payloads -- [--end-time](cli/cmd-options#end-time) +Raw payload output, even if they are JSON. -- [--env](cli/cmd-options#env) +## notes -- [--env-file](cli/cmd-options#env-file) +Initial notes field value. -- [--execution-timeout](cli/cmd-options#execution-timeout) +## output -- [--grpc-meta](cli/cmd-options#grpc-meta) +Non-logging data output format. -- [--input](cli/cmd-options#input) +## overlap-policy -- [--input-base64](cli/cmd-options#input-base64) +Policy for handling overlapping Workflow Executions. -- [--input-file](cli/cmd-options#input-file) +## pause-on-failure -- [--input-meta](cli/cmd-options#input-meta) +Pause schedule after Workflow failures. -- [--interval](cli/cmd-options#interval) +## paused -- [--jitter](cli/cmd-options#jitter) +Pause the Schedule immediately on creation. -- [--log-format](cli/cmd-options#log-format) +## remaining-actions -- [--log-level](cli/cmd-options#log-level) +Total allowed actions. Default is zero (unlimited). -- [--memo](cli/cmd-options#memo) +## run-timeout -- [--namespace](cli/cmd-options#namespace) +Fail a Workflow Run if it lasts longer than `DURATION`. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## schedule-id -- [--notes](cli/cmd-options#notes) +Schedule ID. -- [--output](cli/cmd-options#output) +## schedule-memo -- [--overlap-policy](cli/cmd-options#overlap-policy) +Set schedule memo using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. -- [--pause-on-failure](cli/cmd-options#pause-on-failure) +## schedule-search-attribute -- [--paused](cli/cmd-options#paused) +Set schedule Search Attributes using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. -- [--remaining-actions](cli/cmd-options#remaining-actions) +## search-attribute -- [--run-timeout](cli/cmd-options#run-timeout) +Search Attribute in `KEY=VALUE` format. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. -- [--schedule-id](cli/cmd-options#schedule-id) +## start-time -- [--schedule-memo](cli/cmd-options#schedule-memo) +Schedule start time. -- [--schedule-search-attribute](cli/cmd-options#schedule-search-attribute) +## task-queue -- [--search-attribute](cli/cmd-options#search-attribute) +Workflow Task queue. -- [--start-time](cli/cmd-options#start-time) +## task-timeout -- [--task-queue](cli/cmd-options#task-queue) +Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. -- [--task-timeout](cli/cmd-options#task-timeout) +## time-format -- [--time-format](cli/cmd-options#time-format) +Time format. -- [--time-zone](cli/cmd-options#time-zone) +## time-zone -- [--tls](cli/cmd-options#tls) +Interpret calendar specs with the `TZ` time zone. For a list of time zones, see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-ca-data -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-ca-path -- [--tls-key-data](cli/cmd-options#tls-key-data) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-cert-data -- [--tls-server-name](cli/cmd-options#tls-server-name) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--type](cli/cmd-options#type) +## tls-cert-path -- [--workflow-id](cli/cmd-options#workflow-id) +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## type + +Workflow Type name. + +## workflow-id + +Workflow ID. If not supplied, the Service generates a unique ID. ## delete @@ -276,55 +432,105 @@ workflow delete` with the `TemporalScheduledById` Search Attribute instead. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--api-key](cli/cmd-options#api-key) +## namespace -- [--codec-auth](cli/cmd-options#codec-auth) +Temporal Service Namespace. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## no-json-shorthand-payloads -- [--color](cli/cmd-options#color) +Raw payload output, even if they are JSON. -- [--command-timeout](cli/cmd-options#command-timeout) +## output -- [--env](cli/cmd-options#env) +Non-logging data output format. -- [--env-file](cli/cmd-options#env-file) +## schedule-id -- [--grpc-meta](cli/cmd-options#grpc-meta) +Schedule ID. -- [--log-format](cli/cmd-options#log-format) +## time-format -- [--log-level](cli/cmd-options#log-level) +Time format. -- [--namespace](cli/cmd-options#namespace) +## tls -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--output](cli/cmd-options#output) +## tls-ca-data -- [--schedule-id](cli/cmd-options#schedule-id) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--time-format](cli/cmd-options#time-format) +## tls-ca-path -- [--tls](cli/cmd-options#tls) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-cert-data -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-cert-path -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-disable-host-verification -- [--tls-key-data](cli/cmd-options#tls-key-data) +Disable TLS host-name verification. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-key-data -- [--tls-server-name](cli/cmd-options#tls-server-name) +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## describe @@ -338,55 +544,105 @@ temporal schedule describe \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env -- [--api-key](cli/cmd-options#api-key) +Active environment name (`ENV`). -- [--codec-auth](cli/cmd-options#codec-auth) +## env-file -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--color](cli/cmd-options#color) +## grpc-meta -- [--command-timeout](cli/cmd-options#command-timeout) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--env](cli/cmd-options#env) +## log-format -- [--env-file](cli/cmd-options#env-file) +Log format. Options are: text, json. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## log-level -- [--log-format](cli/cmd-options#log-format) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--log-level](cli/cmd-options#log-level) +## namespace -- [--namespace](cli/cmd-options#namespace) +Temporal Service Namespace. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## no-json-shorthand-payloads -- [--output](cli/cmd-options#output) +Raw payload output, even if they are JSON. -- [--schedule-id](cli/cmd-options#schedule-id) +## output -- [--time-format](cli/cmd-options#time-format) +Non-logging data output format. -- [--tls](cli/cmd-options#tls) +## schedule-id -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Schedule ID. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## time-format -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Time format. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-ca-data -- [--tls-key-path](cli/cmd-options#tls-key-path) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## list @@ -399,59 +655,113 @@ temporal schedule list \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. -- [--api-key](cli/cmd-options#api-key) +## codec-auth -- [--codec-auth](cli/cmd-options#codec-auth) +Authorization header for Codec Server requests. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## codec-endpoint -- [--color](cli/cmd-options#color) +Remote Codec Server endpoint. -- [--command-timeout](cli/cmd-options#command-timeout) +## color -- [--env](cli/cmd-options#env) +Output coloring. -- [--env-file](cli/cmd-options#env-file) +## command-timeout -- [--grpc-meta](cli/cmd-options#grpc-meta) +Timeout for the span of a command. -- [--log-format](cli/cmd-options#log-format) +## env -- [--log-level](cli/cmd-options#log-level) +Active environment name (`ENV`). -- [--long](cli/cmd-options#long) +## env-file -- [--namespace](cli/cmd-options#namespace) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## grpc-meta -- [--output](cli/cmd-options#output) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--query](cli/cmd-options#query) +## log-format -- [--really-long](cli/cmd-options#really-long) +Log format. Options are: text, json. -- [--time-format](cli/cmd-options#time-format) +## log-level -- [--tls](cli/cmd-options#tls) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## long -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Show detailed information. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## namespace -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Temporal Service Namespace. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## no-json-shorthand-payloads -- [--tls-key-data](cli/cmd-options#tls-key-data) +Raw payload output, even if they are JSON. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## output -- [--tls-server-name](cli/cmd-options#tls-server-name) +Non-logging data output format. + +## query + +Filter results using given List Filter. + +## really-long + +Show extensive information in non-table form. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## toggle @@ -479,61 +789,117 @@ also visible on the Service Web UI. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. -- [--api-key](cli/cmd-options#api-key) +## command-timeout -- [--codec-auth](cli/cmd-options#codec-auth) +Timeout for the span of a command. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## env -- [--color](cli/cmd-options#color) +Active environment name (`ENV`). -- [--command-timeout](cli/cmd-options#command-timeout) +## env-file -- [--env](cli/cmd-options#env) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--env-file](cli/cmd-options#env-file) +## grpc-meta -- [--grpc-meta](cli/cmd-options#grpc-meta) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--log-format](cli/cmd-options#log-format) +## log-format -- [--log-level](cli/cmd-options#log-level) +Log format. Options are: text, json. -- [--namespace](cli/cmd-options#namespace) +## log-level -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--output](cli/cmd-options#output) +## namespace -- [--pause](cli/cmd-options#pause) +Temporal Service Namespace. -- [--reason](cli/cmd-options#reason) +## no-json-shorthand-payloads -- [--schedule-id](cli/cmd-options#schedule-id) +Raw payload output, even if they are JSON. -- [--time-format](cli/cmd-options#time-format) +## output -- [--tls](cli/cmd-options#tls) +Non-logging data output format. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## pause -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Pause the Schedule. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## reason -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Reason for pausing or unpausing the Schedule. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## schedule-id -- [--tls-key-data](cli/cmd-options#tls-key-data) +Schedule ID. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## time-format -- [--tls-server-name](cli/cmd-options#tls-server-name) +Time format. -- [--unpause](cli/cmd-options#unpause) +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## unpause + +Unpause the Schedule. ## trigger @@ -546,57 +912,109 @@ temporal schedule trigger \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). -- [--api-key](cli/cmd-options#api-key) +## env-file -- [--codec-auth](cli/cmd-options#codec-auth) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## grpc-meta -- [--color](cli/cmd-options#color) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--command-timeout](cli/cmd-options#command-timeout) +## log-format -- [--env](cli/cmd-options#env) +Log format. Options are: text, json. -- [--env-file](cli/cmd-options#env-file) +## log-level -- [--grpc-meta](cli/cmd-options#grpc-meta) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--log-format](cli/cmd-options#log-format) +## namespace -- [--log-level](cli/cmd-options#log-level) +Temporal Service Namespace. -- [--namespace](cli/cmd-options#namespace) +## no-json-shorthand-payloads -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Raw payload output, even if they are JSON. -- [--output](cli/cmd-options#output) +## output -- [--overlap-policy](cli/cmd-options#overlap-policy) +Non-logging data output format. -- [--schedule-id](cli/cmd-options#schedule-id) +## overlap-policy -- [--time-format](cli/cmd-options#time-format) +Policy for handling overlapping Workflow Executions. -- [--tls](cli/cmd-options#tls) +## schedule-id -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Schedule ID. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## time-format -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Time format. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-ca-data -- [--tls-key-path](cli/cmd-options#tls-key-path) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## update @@ -611,107 +1029,211 @@ temporal schedule update \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## calendar + +Calendar specification in JSON. For example: `{"dayOfWeek":"Fri","hour":"17","minute":"5"}`. + +## catchup-window + +Maximum catch-up time for when the Service is unavailable. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## cron + +Calendar specification in cron string format. For example: `"30 12 * * Fri"`. + +## end-time + +Schedule end time. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## execution-timeout + +Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## input + +Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. + +## input-base64 + +Assume inputs are base64-encoded and attempt to decode them. + +## input-file + +A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. + +## input-meta + +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. + +## interval + +Interval duration. For example, 90m, or 60m/15m to include phase offset. + +## jitter + +Max difference in time from the specification. Vary the start time randomly within this amount. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## memo + +Memo using 'KEY="VALUE"' pairs. Use JSON values. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## notes + +Initial notes field value. + +## output -- [--api-key](cli/cmd-options#api-key) +Non-logging data output format. -- [--calendar](cli/cmd-options#calendar) +## overlap-policy -- [--catchup-window](cli/cmd-options#catchup-window) +Policy for handling overlapping Workflow Executions. -- [--codec-auth](cli/cmd-options#codec-auth) +## pause-on-failure -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Pause schedule after Workflow failures. -- [--color](cli/cmd-options#color) +## paused -- [--command-timeout](cli/cmd-options#command-timeout) +Pause the Schedule immediately on creation. -- [--cron](cli/cmd-options#cron) +## remaining-actions -- [--end-time](cli/cmd-options#end-time) +Total allowed actions. Default is zero (unlimited). -- [--env](cli/cmd-options#env) +## run-timeout -- [--env-file](cli/cmd-options#env-file) +Fail a Workflow Run if it lasts longer than `DURATION`. -- [--execution-timeout](cli/cmd-options#execution-timeout) +## schedule-id -- [--grpc-meta](cli/cmd-options#grpc-meta) +Schedule ID. -- [--input](cli/cmd-options#input) +## schedule-memo -- [--input-base64](cli/cmd-options#input-base64) +Set schedule memo using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. -- [--input-file](cli/cmd-options#input-file) +## schedule-search-attribute -- [--input-meta](cli/cmd-options#input-meta) +Set schedule Search Attributes using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. -- [--interval](cli/cmd-options#interval) +## search-attribute -- [--jitter](cli/cmd-options#jitter) +Search Attribute in `KEY=VALUE` format. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. -- [--log-format](cli/cmd-options#log-format) +## start-time -- [--log-level](cli/cmd-options#log-level) +Schedule start time. -- [--memo](cli/cmd-options#memo) +## task-queue -- [--namespace](cli/cmd-options#namespace) +Workflow Task queue. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## task-timeout -- [--notes](cli/cmd-options#notes) +Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. -- [--output](cli/cmd-options#output) +## time-format -- [--overlap-policy](cli/cmd-options#overlap-policy) +Time format. -- [--pause-on-failure](cli/cmd-options#pause-on-failure) +## time-zone -- [--paused](cli/cmd-options#paused) +Interpret calendar specs with the `TZ` time zone. For a list of time zones, see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. -- [--remaining-actions](cli/cmd-options#remaining-actions) +## tls -- [--run-timeout](cli/cmd-options#run-timeout) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--schedule-id](cli/cmd-options#schedule-id) +## tls-ca-data -- [--schedule-memo](cli/cmd-options#schedule-memo) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--schedule-search-attribute](cli/cmd-options#schedule-search-attribute) +## tls-ca-path -- [--search-attribute](cli/cmd-options#search-attribute) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--start-time](cli/cmd-options#start-time) +## tls-cert-data -- [--task-queue](cli/cmd-options#task-queue) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--task-timeout](cli/cmd-options#task-timeout) +## tls-cert-path -- [--time-format](cli/cmd-options#time-format) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--time-zone](cli/cmd-options#time-zone) +## tls-disable-host-verification -- [--tls](cli/cmd-options#tls) +Disable TLS host-name verification. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-key-data -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-key-path -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-server-name -- [--tls-key-data](cli/cmd-options#tls-key-data) +Override target TLS server name. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## type -- [--tls-server-name](cli/cmd-options#tls-server-name) +Workflow Type name. -- [--type](cli/cmd-options#type) +## workflow-id -- [--workflow-id](cli/cmd-options#workflow-id) +Workflow ID. If not supplied, the Service generates a unique ID. diff --git a/temporalcli/docs/server.mdx b/temporalcli/docs/server.mdx index 598a0d10..f9bc0647 100644 --- a/temporalcli/docs/server.mdx +++ b/temporalcli/docs/server.mdx @@ -51,83 +51,163 @@ temporal server start-dev \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--db-filename](cli/cmd-options#db-filename) +## codec-endpoint -- [--dynamic-config-value](cli/cmd-options#dynamic-config-value) +Remote Codec Server endpoint. -- [--env](cli/cmd-options#env) +## color -- [--env-file](cli/cmd-options#env-file) +Output coloring. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## command-timeout -- [--headless](cli/cmd-options#headless) +Timeout for the span of a command. -- [--http-port](cli/cmd-options#http-port) +## db-filename -- [--ip](cli/cmd-options#ip) +Path to file for persistent Temporal state store. By default, Workflow Executions are lost when the server process dies. -- [--log-config](cli/cmd-options#log-config) +## dynamic-config-value -- [--log-format](cli/cmd-options#log-format) +Dynamic configuration value using `KEY=VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey="YourString"'. Can be passed multiple times. -- [--log-level](cli/cmd-options#log-level) +## env -- [--metrics-port](cli/cmd-options#metrics-port) +Active environment name (`ENV`). -- [--namespace](cli/cmd-options#namespace) +## env-file -- [--namespace](cli/cmd-options#namespace) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## grpc-meta -- [--output](cli/cmd-options#output) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--port](cli/cmd-options#port) +## headless -- [--search-attribute](cli/cmd-options#search-attribute) +Disable the Web UI. -- [--sqlite-pragma](cli/cmd-options#sqlite-pragma) +## http-port -- [--time-format](cli/cmd-options#time-format) +Port for the HTTP API service. Default is off. -- [--tls](cli/cmd-options#tls) +## ip -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +IP address bound to the front-end Service. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## log-config -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Log the server config to stderr. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## log-format -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Log format. Options are: text, json. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## log-level -- [--tls-key-path](cli/cmd-options#tls-key-path) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## metrics-port -- [--ui-asset-path](cli/cmd-options#ui-asset-path) +Port for '/metrics'. Default is off. -- [--ui-codec-endpoint](cli/cmd-options#ui-codec-endpoint) +## namespace -- [--ui-ip](cli/cmd-options#ui-ip) +Temporal Service Namespace. -- [--ui-port](cli/cmd-options#ui-port) +## namespace -- [--ui-public-path](cli/cmd-options#ui-public-path) +Namespaces to be created at launch. The "default" Namespace is always created automatically. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## port + +Port for the front-end gRPC Service. + +## search-attribute + +Search attributes to register using `KEY=VALUE` pairs. Keys must be identifiers, and values must be the search attribute type, which is one of the following: Text, Keyword, Int, Double, Bool, Datetime, KeywordList. + +## sqlite-pragma + +SQLite pragma statements in "PRAGMA=VALUE" format. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## ui-asset-path + +UI custom assets path. + +## ui-codec-endpoint + +UI remote codec HTTP endpoint. + +## ui-ip + +IP address bound to the Web UI. Default is same as '--ip' value. + +## ui-port + +Port for the Web UI. Default is '--port' value + 1000. + +## ui-public-path + +The public base path for the Web UI. Default is `/`. diff --git a/temporalcli/docs/task-queue.mdx b/temporalcli/docs/task-queue.mdx index 253ccde5..8cf47161 100644 --- a/temporalcli/docs/task-queue.mdx +++ b/temporalcli/docs/task-queue.mdx @@ -102,73 +102,141 @@ more conservative than `ClosedWorkflowsOnly`. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--disable-stats](cli/cmd-options#disable-stats) +## codec-endpoint -- [--env](cli/cmd-options#env) +Remote Codec Server endpoint. -- [--env-file](cli/cmd-options#env-file) +## color -- [--grpc-meta](cli/cmd-options#grpc-meta) +Output coloring. -- [--legacy-mode](cli/cmd-options#legacy-mode) +## command-timeout -- [--log-format](cli/cmd-options#log-format) +Timeout for the span of a command. -- [--log-level](cli/cmd-options#log-level) +## disable-stats -- [--namespace](cli/cmd-options#namespace) +Disable task queue statistics. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## env -- [--output](cli/cmd-options#output) +Active environment name (`ENV`). -- [--partitions-legacy](cli/cmd-options#partitions-legacy) +## env-file -- [--report-reachability](cli/cmd-options#report-reachability) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--select-all-active](cli/cmd-options#select-all-active) +## grpc-meta -- [--select-build-id](cli/cmd-options#select-build-id) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--select-unversioned](cli/cmd-options#select-unversioned) +## legacy-mode -- [--task-queue](cli/cmd-options#task-queue) +Enable a legacy mode for servers that do not support rules-based worker versioning. This mode only provides pollers info. -- [--task-queue-type](cli/cmd-options#task-queue-type) +## log-format -- [--task-queue-type-legacy](cli/cmd-options#task-queue-type-legacy) +Log format. Options are: text, json. -- [--time-format](cli/cmd-options#time-format) +## log-level -- [--tls](cli/cmd-options#tls) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## namespace -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Temporal Service Namespace. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## no-json-shorthand-payloads -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Raw payload output, even if they are JSON. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## output -- [--tls-key-data](cli/cmd-options#tls-key-data) +Non-logging data output format. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## partitions-legacy -- [--tls-server-name](cli/cmd-options#tls-server-name) +Query partitions 1 through `N`. Experimental/Temporary feature. Legacy mode only. + +## report-reachability + +Display task reachability information. + +## select-all-active + +Include all active versions. A version is active if it had new tasks or polls recently. + +## select-build-id + +Filter the Task Queue based on Build ID. + +## select-unversioned + +Include the unversioned queue. + +## task-queue + +Task Queue name. + +## task-queue-type + +Task Queue type. If not specified, all types are reported. + +## task-queue-type-legacy + +Task Queue type (legacy mode only). + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## get-build-id-reachability @@ -191,59 +259,113 @@ all Task Queues. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## build-id + +One or more Build ID strings. Can be passed multiple times. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. -- [--api-key](cli/cmd-options#api-key) +## output -- [--build-id](cli/cmd-options#build-id) +Non-logging data output format. -- [--codec-auth](cli/cmd-options#codec-auth) +## reachability-type -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Reachability filter. `open`: reachable by one or more open workflows. `closed`: reachable by one or more closed workflows. `existing`: reachable by either. New Workflow Executions reachable by a Build ID are always reported. -- [--color](cli/cmd-options#color) +## task-queue -- [--command-timeout](cli/cmd-options#command-timeout) +Search only the specified task queue(s). Can be passed multiple times. -- [--env](cli/cmd-options#env) +## time-format -- [--env-file](cli/cmd-options#env-file) +Time format. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## tls -- [--log-format](cli/cmd-options#log-format) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--log-level](cli/cmd-options#log-level) +## tls-ca-data -- [--namespace](cli/cmd-options#namespace) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-ca-path -- [--output](cli/cmd-options#output) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--reachability-type](cli/cmd-options#reachability-type) +## tls-cert-data -- [--task-queue](cli/cmd-options#task-queue) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--time-format](cli/cmd-options#time-format) +## tls-cert-path -- [--tls](cli/cmd-options#tls) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-disable-host-verification -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Disable TLS host-name verification. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-key-data -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-key-path -- [--tls-key-data](cli/cmd-options#tls-key-data) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-server-name -- [--tls-server-name](cli/cmd-options#tls-server-name) +Override target TLS server name. ## get-build-ids @@ -263,57 +385,109 @@ This command is limited to Namespaces that support Worker versioning. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--env](cli/cmd-options#env) +## codec-endpoint -- [--env-file](cli/cmd-options#env-file) +Remote Codec Server endpoint. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## color -- [--log-format](cli/cmd-options#log-format) +Output coloring. -- [--log-level](cli/cmd-options#log-level) +## command-timeout -- [--max-sets](cli/cmd-options#max-sets) +Timeout for the span of a command. -- [--namespace](cli/cmd-options#namespace) +## env -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Active environment name (`ENV`). -- [--output](cli/cmd-options#output) +## env-file -- [--task-queue](cli/cmd-options#task-queue) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--time-format](cli/cmd-options#time-format) +## grpc-meta -- [--tls](cli/cmd-options#tls) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## log-format -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Log format. Options are: text, json. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## log-level -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## max-sets -- [--tls-key-data](cli/cmd-options#tls-key-data) +Max return count. Use 1 for default major version. Use 0 for all sets. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## namespace -- [--tls-server-name](cli/cmd-options#tls-server-name) +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## task-queue + +Task Queue name. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## list-partition @@ -326,55 +500,105 @@ temporal task-queue list-partition \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth -- [--api-key](cli/cmd-options#api-key) +Authorization header for Codec Server requests. -- [--codec-auth](cli/cmd-options#codec-auth) +## codec-endpoint -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Remote Codec Server endpoint. -- [--color](cli/cmd-options#color) +## color -- [--command-timeout](cli/cmd-options#command-timeout) +Output coloring. -- [--env](cli/cmd-options#env) +## command-timeout -- [--env-file](cli/cmd-options#env-file) +Timeout for the span of a command. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## env -- [--log-format](cli/cmd-options#log-format) +Active environment name (`ENV`). -- [--log-level](cli/cmd-options#log-level) +## env-file -- [--namespace](cli/cmd-options#namespace) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## grpc-meta -- [--output](cli/cmd-options#output) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--task-queue](cli/cmd-options#task-queue) +## log-format -- [--time-format](cli/cmd-options#time-format) +Log format. Options are: text, json. -- [--tls](cli/cmd-options#tls) +## log-level -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## namespace -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Temporal Service Namespace. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## no-json-shorthand-payloads -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Raw payload output, even if they are JSON. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## output -- [--tls-key-path](cli/cmd-options#tls-key-path) +Non-logging data output format. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## task-queue + +Task Queue name. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## update-build-ids @@ -392,53 +616,101 @@ temporal task-queue update-build-ids [subcommands] [options] \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. -- [--api-key](cli/cmd-options#api-key) +## command-timeout -- [--codec-auth](cli/cmd-options#codec-auth) +Timeout for the span of a command. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## env -- [--color](cli/cmd-options#color) +Active environment name (`ENV`). -- [--command-timeout](cli/cmd-options#command-timeout) +## env-file -- [--env](cli/cmd-options#env) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--env-file](cli/cmd-options#env-file) +## grpc-meta -- [--grpc-meta](cli/cmd-options#grpc-meta) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--log-format](cli/cmd-options#log-format) +## log-format -- [--log-level](cli/cmd-options#log-level) +Log format. Options are: text, json. -- [--namespace](cli/cmd-options#namespace) +## log-level -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--output](cli/cmd-options#output) +## namespace -- [--time-format](cli/cmd-options#time-format) +Temporal Service Namespace. -- [--tls](cli/cmd-options#tls) +## no-json-shorthand-payloads -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Raw payload output, even if they are JSON. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## output -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Non-logging data output format. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## time-format -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Time format. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls -- [--tls-key-path](cli/cmd-options#tls-key-path) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## update-build-idsadd-new-compatible @@ -459,61 +731,117 @@ This command is limited to Namespaces that support Worker versioning. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## build-id + +Build ID to be added. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). -- [--api-key](cli/cmd-options#api-key) +## env-file -- [--build-id](cli/cmd-options#build-id) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--codec-auth](cli/cmd-options#codec-auth) +## existing-compatible-build-id -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Pre-existing Build ID in this Task Queue. -- [--color](cli/cmd-options#color) +## grpc-meta -- [--command-timeout](cli/cmd-options#command-timeout) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--env](cli/cmd-options#env) +## log-format -- [--env-file](cli/cmd-options#env-file) +Log format. Options are: text, json. -- [--existing-compatible-build-id](cli/cmd-options#existing-compatible-build-id) +## log-level -- [--grpc-meta](cli/cmd-options#grpc-meta) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--log-format](cli/cmd-options#log-format) +## namespace -- [--log-level](cli/cmd-options#log-level) +Temporal Service Namespace. -- [--namespace](cli/cmd-options#namespace) +## no-json-shorthand-payloads -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Raw payload output, even if they are JSON. -- [--output](cli/cmd-options#output) +## output -- [--set-as-default](cli/cmd-options#set-as-default) +Non-logging data output format. -- [--task-queue](cli/cmd-options#task-queue) +## set-as-default -- [--time-format](cli/cmd-options#time-format) +Set the expanded Build ID set as the Task Queue default. -- [--tls](cli/cmd-options#tls) +## task-queue -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Task Queue name. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## time-format -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Time format. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-ca-data -- [--tls-key-path](cli/cmd-options#tls-key-path) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## update-build-idsadd-new-default @@ -539,57 +867,109 @@ temporal task-queue update-build-ids add-new-default \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## build-id + +Build ID to be added. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--api-key](cli/cmd-options#api-key) +## grpc-meta -- [--build-id](cli/cmd-options#build-id) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--codec-auth](cli/cmd-options#codec-auth) +## log-format -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Log format. Options are: text, json. -- [--color](cli/cmd-options#color) +## log-level -- [--command-timeout](cli/cmd-options#command-timeout) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--env](cli/cmd-options#env) +## namespace -- [--env-file](cli/cmd-options#env-file) +Temporal Service Namespace. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## no-json-shorthand-payloads -- [--log-format](cli/cmd-options#log-format) +Raw payload output, even if they are JSON. -- [--log-level](cli/cmd-options#log-level) +## output -- [--namespace](cli/cmd-options#namespace) +Non-logging data output format. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## task-queue -- [--output](cli/cmd-options#output) +Task Queue name. -- [--task-queue](cli/cmd-options#task-queue) +## time-format -- [--time-format](cli/cmd-options#time-format) +Time format. -- [--tls](cli/cmd-options#tls) +## tls -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-ca-data -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-ca-path -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-cert-data -- [--tls-key-path](cli/cmd-options#tls-key-path) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## update-build-idspromote-id-in-set @@ -614,57 +994,109 @@ temporal task-queue update-build-ids promote-id-in-set \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## build-id + +Build ID to set as default. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. -- [--api-key](cli/cmd-options#api-key) +## log-level -- [--build-id](cli/cmd-options#build-id) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--codec-auth](cli/cmd-options#codec-auth) +## namespace -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Temporal Service Namespace. -- [--color](cli/cmd-options#color) +## no-json-shorthand-payloads -- [--command-timeout](cli/cmd-options#command-timeout) +Raw payload output, even if they are JSON. -- [--env](cli/cmd-options#env) +## output -- [--env-file](cli/cmd-options#env-file) +Non-logging data output format. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## task-queue -- [--log-format](cli/cmd-options#log-format) +Task Queue name. -- [--log-level](cli/cmd-options#log-level) +## time-format -- [--namespace](cli/cmd-options#namespace) +Time format. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls -- [--output](cli/cmd-options#output) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--task-queue](cli/cmd-options#task-queue) +## tls-ca-data -- [--time-format](cli/cmd-options#time-format) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls](cli/cmd-options#tls) +## tls-ca-path -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-cert-data -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-cert-path -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-disable-host-verification -- [--tls-key-path](cli/cmd-options#tls-key-path) +Disable TLS host-name verification. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## update-build-idspromote-set @@ -690,57 +1122,109 @@ temporal task-queue update-build-ids promote-set \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## build-id + +Build ID within the promoted set. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. -- [--api-key](cli/cmd-options#api-key) +## no-json-shorthand-payloads -- [--build-id](cli/cmd-options#build-id) +Raw payload output, even if they are JSON. -- [--codec-auth](cli/cmd-options#codec-auth) +## output -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Non-logging data output format. -- [--color](cli/cmd-options#color) +## task-queue -- [--command-timeout](cli/cmd-options#command-timeout) +Task Queue name. -- [--env](cli/cmd-options#env) +## time-format -- [--env-file](cli/cmd-options#env-file) +Time format. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## tls -- [--log-format](cli/cmd-options#log-format) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--log-level](cli/cmd-options#log-level) +## tls-ca-data -- [--namespace](cli/cmd-options#namespace) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-ca-path -- [--output](cli/cmd-options#output) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--task-queue](cli/cmd-options#task-queue) +## tls-cert-data -- [--time-format](cli/cmd-options#time-format) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls](cli/cmd-options#tls) +## tls-cert-path -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-disable-host-verification -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Disable TLS host-name verification. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-key-data -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-key-path -- [--tls-key-path](cli/cmd-options#tls-key-path) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-server-name + +Override target TLS server name. ## versioning @@ -770,55 +1254,105 @@ Task Queues support the following versioning rules and policies: Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--api-key](cli/cmd-options#api-key) +## grpc-meta -- [--codec-auth](cli/cmd-options#codec-auth) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## log-format -- [--color](cli/cmd-options#color) +Log format. Options are: text, json. -- [--command-timeout](cli/cmd-options#command-timeout) +## log-level -- [--env](cli/cmd-options#env) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--env-file](cli/cmd-options#env-file) +## namespace -- [--grpc-meta](cli/cmd-options#grpc-meta) +Temporal Service Namespace. -- [--log-format](cli/cmd-options#log-format) +## no-json-shorthand-payloads -- [--log-level](cli/cmd-options#log-level) +Raw payload output, even if they are JSON. -- [--namespace](cli/cmd-options#namespace) +## output -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Non-logging data output format. -- [--output](cli/cmd-options#output) +## task-queue -- [--task-queue](cli/cmd-options#task-queue) +Task queue name. -- [--time-format](cli/cmd-options#time-format) +## time-format -- [--tls](cli/cmd-options#tls) +Time format. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-ca-data -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-ca-path -- [--tls-key-data](cli/cmd-options#tls-key-data) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-cert-data -- [--tls-server-name](cli/cmd-options#tls-server-name) +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## versioningadd-redirect-rule @@ -839,59 +1373,113 @@ temporal task-queue versioning add-redirect-rule \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. -- [--api-key](cli/cmd-options#api-key) +## codec-endpoint -- [--codec-auth](cli/cmd-options#codec-auth) +Remote Codec Server endpoint. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## color -- [--color](cli/cmd-options#color) +Output coloring. -- [--command-timeout](cli/cmd-options#command-timeout) +## command-timeout -- [--env](cli/cmd-options#env) +Timeout for the span of a command. -- [--env-file](cli/cmd-options#env-file) +## env -- [--grpc-meta](cli/cmd-options#grpc-meta) +Active environment name (`ENV`). -- [--log-format](cli/cmd-options#log-format) +## env-file -- [--log-level](cli/cmd-options#log-level) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--namespace](cli/cmd-options#namespace) +## grpc-meta -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--output](cli/cmd-options#output) +## log-format -- [--source-build-id](cli/cmd-options#source-build-id) +Log format. Options are: text, json. -- [--target-build-id](cli/cmd-options#target-build-id) +## log-level -- [--time-format](cli/cmd-options#time-format) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls](cli/cmd-options#tls) +## namespace -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Temporal Service Namespace. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## no-json-shorthand-payloads -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Raw payload output, even if they are JSON. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## output -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Non-logging data output format. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## source-build-id -- [--tls-key-path](cli/cmd-options#tls-key-path) +Source build ID. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## target-build-id -- [--yes](cli/cmd-options#yes) +Target build ID. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## yes + +Don't prompt to confirm. ## versioningcommit-build-id @@ -923,59 +1511,113 @@ override this validation. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## build-id + +Target build ID. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint -- [--api-key](cli/cmd-options#api-key) +Remote Codec Server endpoint. -- [--build-id](cli/cmd-options#build-id) +## color -- [--codec-auth](cli/cmd-options#codec-auth) +Output coloring. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## command-timeout -- [--color](cli/cmd-options#color) +Timeout for the span of a command. -- [--command-timeout](cli/cmd-options#command-timeout) +## env -- [--env](cli/cmd-options#env) +Active environment name (`ENV`). -- [--env-file](cli/cmd-options#env-file) +## env-file -- [--force](cli/cmd-options#force) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--grpc-meta](cli/cmd-options#grpc-meta) +## force -- [--log-format](cli/cmd-options#log-format) +Bypass recent-poller validation. -- [--log-level](cli/cmd-options#log-level) +## grpc-meta -- [--namespace](cli/cmd-options#namespace) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## log-format -- [--output](cli/cmd-options#output) +Log format. Options are: text, json. -- [--time-format](cli/cmd-options#time-format) +## log-level -- [--tls](cli/cmd-options#tls) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## namespace -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Temporal Service Namespace. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## no-json-shorthand-payloads -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Raw payload output, even if they are JSON. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## output -- [--tls-key-data](cli/cmd-options#tls-key-data) +Non-logging data output format. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## time-format -- [--tls-server-name](cli/cmd-options#tls-server-name) +Time format. -- [--yes](cli/cmd-options#yes) +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## yes + +Don't prompt to confirm. ## versioningdelete-assignment-rule @@ -999,59 +1641,113 @@ Use the `--force` option to override this validation. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. -- [--api-key](cli/cmd-options#api-key) +## env -- [--codec-auth](cli/cmd-options#codec-auth) +Active environment name (`ENV`). -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## env-file -- [--color](cli/cmd-options#color) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--command-timeout](cli/cmd-options#command-timeout) +## force -- [--env](cli/cmd-options#env) +Bypass one-unconditional-rule validation. -- [--env-file](cli/cmd-options#env-file) +## grpc-meta -- [--force](cli/cmd-options#force) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## log-format -- [--log-format](cli/cmd-options#log-format) +Log format. Options are: text, json. -- [--log-level](cli/cmd-options#log-level) +## log-level -- [--namespace](cli/cmd-options#namespace) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## namespace -- [--output](cli/cmd-options#output) +Temporal Service Namespace. -- [--rule-index](cli/cmd-options#rule-index) +## no-json-shorthand-payloads -- [--time-format](cli/cmd-options#time-format) +Raw payload output, even if they are JSON. -- [--tls](cli/cmd-options#tls) +## output -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Non-logging data output format. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## rule-index -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Position of the assignment rule to be replaced. Requests for invalid indices will fail. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## time-format -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Time format. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls -- [--tls-key-path](cli/cmd-options#tls-key-path) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-ca-data -- [--yes](cli/cmd-options#yes) +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## yes + +Don't prompt to confirm. ## versioningdelete-redirect-rule @@ -1070,57 +1766,109 @@ temporal task-queue versioning delete-redirect-rule \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file -- [--api-key](cli/cmd-options#api-key) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--codec-auth](cli/cmd-options#codec-auth) +## grpc-meta -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--color](cli/cmd-options#color) +## log-format -- [--command-timeout](cli/cmd-options#command-timeout) +Log format. Options are: text, json. -- [--env](cli/cmd-options#env) +## log-level -- [--env-file](cli/cmd-options#env-file) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## namespace -- [--log-format](cli/cmd-options#log-format) +Temporal Service Namespace. -- [--log-level](cli/cmd-options#log-level) +## no-json-shorthand-payloads -- [--namespace](cli/cmd-options#namespace) +Raw payload output, even if they are JSON. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## output -- [--output](cli/cmd-options#output) +Non-logging data output format. -- [--source-build-id](cli/cmd-options#source-build-id) +## source-build-id -- [--time-format](cli/cmd-options#time-format) +Source Build ID. -- [--tls](cli/cmd-options#tls) +## time-format -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Time format. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-ca-data -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-ca-path -- [--tls-key-path](cli/cmd-options#tls-key-path) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-cert-data -- [--yes](cli/cmd-options#yes) +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## yes + +Don't prompt to confirm. ## versioningget-rules @@ -1150,53 +1898,101 @@ Task Queues support the following versioning rules: Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format -- [--api-key](cli/cmd-options#api-key) +Log format. Options are: text, json. -- [--codec-auth](cli/cmd-options#codec-auth) +## log-level -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--color](cli/cmd-options#color) +## namespace -- [--command-timeout](cli/cmd-options#command-timeout) +Temporal Service Namespace. -- [--env](cli/cmd-options#env) +## no-json-shorthand-payloads -- [--env-file](cli/cmd-options#env-file) +Raw payload output, even if they are JSON. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## output -- [--log-format](cli/cmd-options#log-format) +Non-logging data output format. -- [--log-level](cli/cmd-options#log-level) +## time-format -- [--namespace](cli/cmd-options#namespace) +Time format. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls -- [--output](cli/cmd-options#output) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--time-format](cli/cmd-options#time-format) +## tls-ca-data -- [--tls](cli/cmd-options#tls) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-ca-path -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-cert-data -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-cert-path -- [--tls-key-data](cli/cmd-options#tls-key-data) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-disable-host-verification -- [--tls-server-name](cli/cmd-options#tls-server-name) +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## versioninginsert-assignment-rule @@ -1219,61 +2015,117 @@ If you do not specify a `--rule-index`, this command inserts at index 0. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## build-id + +Target Build ID. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace -- [--api-key](cli/cmd-options#api-key) +Temporal Service Namespace. -- [--build-id](cli/cmd-options#build-id) +## no-json-shorthand-payloads -- [--codec-auth](cli/cmd-options#codec-auth) +Raw payload output, even if they are JSON. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## output -- [--color](cli/cmd-options#color) +Non-logging data output format. -- [--command-timeout](cli/cmd-options#command-timeout) +## percentage -- [--env](cli/cmd-options#env) +Traffic percent to send to target Build ID. -- [--env-file](cli/cmd-options#env-file) +## rule-index -- [--grpc-meta](cli/cmd-options#grpc-meta) +Insertion position. Ranges from 0 (insert at start) to count (append). Any number greater than the count is treated as "append". -- [--log-format](cli/cmd-options#log-format) +## time-format -- [--log-level](cli/cmd-options#log-level) +Time format. -- [--namespace](cli/cmd-options#namespace) +## tls -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--output](cli/cmd-options#output) +## tls-ca-data -- [--percentage](cli/cmd-options#percentage) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--rule-index](cli/cmd-options#rule-index) +## tls-ca-path -- [--time-format](cli/cmd-options#time-format) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls](cli/cmd-options#tls) +## tls-cert-data -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-cert-path -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-disable-host-verification -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Disable TLS host-name verification. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-key-data -- [--tls-key-path](cli/cmd-options#tls-key-path) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## tls-key-path -- [--yes](cli/cmd-options#yes) +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## yes + +Don't prompt to confirm. ## versioningreplace-assignment-rule @@ -1310,63 +2162,121 @@ Percent may vary between 0 and 100 (default). Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## build-id + +Target Build ID. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## force + +Bypass the validation that one unconditional rule remains. + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace -- [--api-key](cli/cmd-options#api-key) +Temporal Service Namespace. -- [--build-id](cli/cmd-options#build-id) +## no-json-shorthand-payloads -- [--codec-auth](cli/cmd-options#codec-auth) +Raw payload output, even if they are JSON. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## output -- [--color](cli/cmd-options#color) +Non-logging data output format. -- [--command-timeout](cli/cmd-options#command-timeout) +## percentage -- [--env](cli/cmd-options#env) +Divert percent of traffic to target Build ID. -- [--env-file](cli/cmd-options#env-file) +## rule-index -- [--force](cli/cmd-options#force) +Position of the assignment rule to be replaced. Requests for invalid indices will fail. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## time-format -- [--log-format](cli/cmd-options#log-format) +Time format. -- [--log-level](cli/cmd-options#log-level) +## tls -- [--namespace](cli/cmd-options#namespace) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-ca-data -- [--output](cli/cmd-options#output) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--percentage](cli/cmd-options#percentage) +## tls-ca-path -- [--rule-index](cli/cmd-options#rule-index) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--time-format](cli/cmd-options#time-format) +## tls-cert-data -- [--tls](cli/cmd-options#tls) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-cert-path -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-disable-host-verification -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Disable TLS host-name verification. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-key-data -- [--tls-key-data](cli/cmd-options#tls-key-data) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-key-path -- [--tls-server-name](cli/cmd-options#tls-server-name) +Path to x509 private key. Can't be used with --tls-key-data. -- [--yes](cli/cmd-options#yes) +## tls-server-name + +Override target TLS server name. + +## yes + +Don't prompt to confirm. ## versioningreplace-redirect-rule @@ -1387,57 +2297,111 @@ temporal task-queue versioning replace-redirect-rule \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. -- [--api-key](cli/cmd-options#api-key) +## source-build-id -- [--codec-auth](cli/cmd-options#codec-auth) +Source Build ID. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## target-build-id -- [--color](cli/cmd-options#color) +Target Build ID. -- [--command-timeout](cli/cmd-options#command-timeout) +## time-format -- [--env](cli/cmd-options#env) +Time format. -- [--env-file](cli/cmd-options#env-file) +## tls -- [--grpc-meta](cli/cmd-options#grpc-meta) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--log-format](cli/cmd-options#log-format) +## tls-ca-data -- [--log-level](cli/cmd-options#log-level) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--namespace](cli/cmd-options#namespace) +## tls-ca-path -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--output](cli/cmd-options#output) +## tls-cert-data -- [--source-build-id](cli/cmd-options#source-build-id) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--target-build-id](cli/cmd-options#target-build-id) +## tls-cert-path -- [--time-format](cli/cmd-options#time-format) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls](cli/cmd-options#tls) +## tls-disable-host-verification -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Disable TLS host-name verification. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-key-data -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-key-path -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## tls-server-name -- [--tls-key-path](cli/cmd-options#tls-key-path) +Override target TLS server name. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## yes -- [--yes](cli/cmd-options#yes) +Don't prompt to confirm. diff --git a/temporalcli/docs/workflow.mdx b/temporalcli/docs/workflow.mdx index 62d0ce3f..a830a0df 100644 --- a/temporalcli/docs/workflow.mdx +++ b/temporalcli/docs/workflow.mdx @@ -95,65 +95,125 @@ and Query creation. See `temporal batch --help` for a quick reference. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--env](cli/cmd-options#env) +## codec-endpoint -- [--env-file](cli/cmd-options#env-file) +Remote Codec Server endpoint. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## color -- [--log-format](cli/cmd-options#log-format) +Output coloring. -- [--log-level](cli/cmd-options#log-level) +## command-timeout -- [--namespace](cli/cmd-options#namespace) +Timeout for the span of a command. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## env -- [--output](cli/cmd-options#output) +Active environment name (`ENV`). -- [--query](cli/cmd-options#query) +## env-file -- [--reason](cli/cmd-options#reason) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--rps](cli/cmd-options#rps) +## grpc-meta -- [--run-id](cli/cmd-options#run-id) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--time-format](cli/cmd-options#time-format) +## log-format -- [--tls](cli/cmd-options#tls) +Log format. Options are: text, json. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## log-level -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## namespace -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Temporal Service Namespace. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## no-json-shorthand-payloads -- [--tls-key-data](cli/cmd-options#tls-key-data) +Raw payload output, even if they are JSON. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## output -- [--tls-server-name](cli/cmd-options#tls-server-name) +Non-logging data output format. -- [--workflow-id](cli/cmd-options#workflow-id) +## query + +Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. + +## reason + +Reason for batch operation. Only use with --query. Defaults to user name. + +## rps + +Limit batch's requests per second. Only allowed if query is present. + +## run-id + +Run ID. Only use with --workflow-id. Cannot use with --query. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--yes](cli/cmd-options#yes) +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## workflow-id + +Workflow ID. You must set either --workflow-id or --query. + +## yes + +Don't prompt to confirm signaling. Only allowed when --query is present. ## count @@ -170,55 +230,105 @@ and Query creation. See `temporal batch --help` for a quick reference. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. -- [--api-key](cli/cmd-options#api-key) +## api-key -- [--codec-auth](cli/cmd-options#codec-auth) +API key for request. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## codec-auth -- [--color](cli/cmd-options#color) +Authorization header for Codec Server requests. -- [--command-timeout](cli/cmd-options#command-timeout) +## codec-endpoint -- [--env](cli/cmd-options#env) +Remote Codec Server endpoint. -- [--env-file](cli/cmd-options#env-file) +## color -- [--grpc-meta](cli/cmd-options#grpc-meta) +Output coloring. -- [--log-format](cli/cmd-options#log-format) +## command-timeout -- [--log-level](cli/cmd-options#log-level) +Timeout for the span of a command. -- [--namespace](cli/cmd-options#namespace) +## env -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Active environment name (`ENV`). -- [--output](cli/cmd-options#output) +## env-file -- [--query](cli/cmd-options#query) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--time-format](cli/cmd-options#time-format) +## grpc-meta -- [--tls](cli/cmd-options#tls) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## log-format -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Log format. Options are: text, json. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## log-level -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## namespace -- [--tls-key-data](cli/cmd-options#tls-key-data) +Temporal Service Namespace. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## no-json-shorthand-payloads -- [--tls-server-name](cli/cmd-options#tls-server-name) +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## query + +Content for an SQL-like `QUERY` List Filter. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. ## delete @@ -237,65 +347,125 @@ and Query creation. See `temporal batch --help` for a quick reference. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. -- [--api-key](cli/cmd-options#api-key) +## color -- [--codec-auth](cli/cmd-options#codec-auth) +Output coloring. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## command-timeout -- [--color](cli/cmd-options#color) +Timeout for the span of a command. -- [--command-timeout](cli/cmd-options#command-timeout) +## env -- [--env](cli/cmd-options#env) +Active environment name (`ENV`). -- [--env-file](cli/cmd-options#env-file) +## env-file -- [--grpc-meta](cli/cmd-options#grpc-meta) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--log-format](cli/cmd-options#log-format) +## grpc-meta -- [--log-level](cli/cmd-options#log-level) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--namespace](cli/cmd-options#namespace) +## log-format -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Log format. Options are: text, json. -- [--output](cli/cmd-options#output) +## log-level -- [--query](cli/cmd-options#query) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--reason](cli/cmd-options#reason) +## namespace -- [--rps](cli/cmd-options#rps) +Temporal Service Namespace. -- [--run-id](cli/cmd-options#run-id) +## no-json-shorthand-payloads -- [--time-format](cli/cmd-options#time-format) +Raw payload output, even if they are JSON. -- [--tls](cli/cmd-options#tls) +## output -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Non-logging data output format. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## query + +Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. + +## reason + +Reason for batch operation. Only use with --query. Defaults to user name. + +## rps + +Limit batch's requests per second. Only allowed if query is present. + +## run-id + +Run ID. Only use with --workflow-id. Cannot use with --query. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-cert-data -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-cert-path -- [--tls-key-data](cli/cmd-options#tls-key-data) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls-disable-host-verification -- [--tls-server-name](cli/cmd-options#tls-server-name) +Disable TLS host-name verification. -- [--workflow-id](cli/cmd-options#workflow-id) +## tls-key-data -- [--yes](cli/cmd-options#yes) +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## workflow-id + +Workflow ID. You must set either --workflow-id or --query. + +## yes + +Don't prompt to confirm signaling. Only allowed when --query is present. ## describe @@ -316,61 +486,117 @@ temporal workflow describe \ Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color -- [--api-key](cli/cmd-options#api-key) +Output coloring. -- [--codec-auth](cli/cmd-options#codec-auth) +## command-timeout -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Timeout for the span of a command. -- [--color](cli/cmd-options#color) +## env -- [--command-timeout](cli/cmd-options#command-timeout) +Active environment name (`ENV`). -- [--env](cli/cmd-options#env) +## env-file -- [--env-file](cli/cmd-options#env-file) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--grpc-meta](cli/cmd-options#grpc-meta) +## grpc-meta -- [--log-format](cli/cmd-options#log-format) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--log-level](cli/cmd-options#log-level) +## log-format -- [--namespace](cli/cmd-options#namespace) +Log format. Options are: text, json. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## log-level -- [--output](cli/cmd-options#output) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--raw](cli/cmd-options#raw) +## namespace -- [--reset-points](cli/cmd-options#reset-points) +Temporal Service Namespace. -- [--run-id](cli/cmd-options#run-id) +## no-json-shorthand-payloads -- [--time-format](cli/cmd-options#time-format) +Raw payload output, even if they are JSON. -- [--tls](cli/cmd-options#tls) +## output -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Non-logging data output format. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## raw -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Print properties without changing their format. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## reset-points -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Show auto-reset points only. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## run-id -- [--tls-key-path](cli/cmd-options#tls-key-path) +Run ID. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## time-format -- [--workflow-id](cli/cmd-options#workflow-id) +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## workflow-id + +Workflow ID. ## execute @@ -392,1308 +618,2350 @@ format. When using JSON output (`--output json`), this includes the entire Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## cron + +Cron schedule for the Workflow. Deprecated. Use Schedules instead. + +## detailed + +Display events as sections instead of table. Does not apply to JSON output. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## execution-timeout + +Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. + +## fail-existing + +Fail if the Workflow already exists. + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## id-reuse-policy + +Re-use policy for the Workflow ID in new Workflow Executions. + +## input + +Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. + +## input-base64 + +Assume inputs are base64-encoded and attempt to decode them. + +## input-file + +A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. + +## input-meta + +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## memo + +Memo using 'KEY="VALUE"' pairs. Use JSON values. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## run-timeout + +Fail a Workflow Run if it lasts longer than `DURATION`. + +## search-attribute + +Search Attribute in `KEY=VALUE` format. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. + +## start-delay + +Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. + +## task-queue + +Workflow Task queue. + +## task-timeout + +Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## type + +Workflow Type name. + +## workflow-id + +Workflow ID. If not supplied, the Service generates a unique ID. + +## fix-history-json + +Reserialize an Event History JSON file: + +``` +temporal workflow fix-history-json \ + --source /path/to/original.json \ + --target /path/to/reserialized.json +``` + +Use the following options to change the behavior of this command. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## source + +Path to the original file. + +## target + +Path to the results file. When omitted, output is sent to stdout. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## list + +List Workflow Executions. By default, this command returns up to 10 closed +Workflow Executions. The optional `--query` limits the output to Workflows +matching a Query: + +``` +temporal workflow list \ + --query YourQuery` +``` + +Visit https://docs.temporal.io/visibility to read more about Search Attributes +and Query creation. See `temporal batch --help` for a quick reference. + +View a list of archived Workflow Executions: + +``` +temporal workflow list \ + --archived +``` + +Use the following options to change the behavior of this command. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## archived + +Limit output to archived Workflow Executions. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## limit + +Maximum number of Workflow Executions to display. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## query + +Content for an SQL-like `QUERY` List Filter. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## query + +Send a Query to a Workflow Execution by Workflow ID to retrieve its state. +This synchronous operation exposes the internal state of a running Workflow +Execution, which constantly changes. You can query both running and completed +Workflow Executions: + +``` +temporal workflow query \ + --workflow-id YourWorkflowId + --type YourQueryType + --input '{"YourInputKey": "YourInputValue"}' +``` + +Use the following options to change the behavior of this command. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## input + +Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. + +## input-base64 + +Assume inputs are base64-encoded and attempt to decode them. + +## input-file + +A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. + +## input-meta + +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## name + +Query Type/Name. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## reject-condition + +Optional flag for rejecting Queries based on Workflow state. + +## run-id + +Run ID. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## workflow-id + +Workflow ID. + +## reset + +Reset a Workflow Execution so it can resume from a point in its Event History +without losing its progress up to that point: + +``` +temporal workflow reset \ + --workflow-id YourWorkflowId \ + --event-id YourLastEvent +``` + +Start from where the Workflow Execution last continued as new: + +``` +temporal workflow reset \ + --workflow-id YourWorkflowId \ + --type LastContinuedAsNew +``` + +For batch resets, limit your resets to FirstWorkflowTask, LastWorkflowTask, or +BuildId. Do not use Workflow IDs, run IDs, or event IDs with this command. + +Visit https://docs.temporal.io/visibility to read more about Search +Attributes and Query creation. + +Use the following options to change the behavior of this command. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## build-id + +A Build ID. Use only with the BuildId `--type`. Resets the first Workflow task processed by this ID. By default, this reset may be in a prior run, earlier than a Continue as New point. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## event-id + +Event ID to reset to. Event must occur after `WorkflowTaskStarted`. `WorkflowTaskCompleted`, `WorkflowTaskFailed`, etc. are valid. + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## query + +Content for an SQL-like `QUERY` List Filter. + +## reapply-exclude + +Exclude these event types from re-application. + +## reapply-type + +Types of events to re-apply after reset point. Deprecated. Use --reapply-exclude instead. + +## reason + +Reason for reset. + +## run-id + +Run ID. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## type + +The event type for the reset. + +## workflow-id + +Workflow ID. Required for non-batch reset operations. + +## yes + +Don't prompt to confirm. Only allowed when `--query` is present. + +## result + +Wait for and print the result of a Workflow Execution: + +``` +temporal workflow result \ + --workflow-id YourWorkflowId +``` + +Use the following options to change the behavior of this command. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## run-id + +Run ID. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## workflow-id + +Workflow ID. + +## show + +Show a Workflow Execution's Event History. +When using JSON output (`--output json`), you may pass the results to an SDK +to perform a replay: + +``` +temporal workflow show \ + --workflow-id YourWorkflowId + --output json +``` + +Use the following options to change the behavior of this command. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## detailed + +Display events as detailed sections instead of table. Does not apply to JSON output. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## follow + +Follow the Workflow Execution progress in real time. Does not apply to JSON output. + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## run-id + +Run ID. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## workflow-id + +Workflow ID. + +## signal + +Send an asynchronous notification (Signal) to a running Workflow Execution by +its Workflow ID. The Signal is written to the History. When you include +`--input`, that data is available for the Workflow Execution to consume: + +``` +temporal workflow signal \ + --workflow-id YourWorkflowId \ + --name YourSignal \ + --input '{"YourInputKey": "YourInputValue"}' +``` + +Visit https://docs.temporal.io/visibility to read more about Search Attributes +and Query creation. See `temporal batch --help` for a quick reference. + +Use the following options to change the behavior of this command. + +## address + +Temporal Service gRPC endpoint. + +## api-key + +API key for request. + +## codec-auth + +Authorization header for Codec Server requests. + +## codec-endpoint + +Remote Codec Server endpoint. + +## color + +Output coloring. + +## command-timeout + +Timeout for the span of a command. + +## env + +Active environment name (`ENV`). + +## env-file + +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). + +## grpc-meta + +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. + +## input + +Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. + +## input-base64 + +Assume inputs are base64-encoded and attempt to decode them. + +## input-file + +A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. + +## input-meta + +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. + +## log-format + +Log format. Options are: text, json. + +## log-level + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## name + +Signal name. + +## namespace + +Temporal Service Namespace. + +## no-json-shorthand-payloads + +Raw payload output, even if they are JSON. + +## output + +Non-logging data output format. + +## query + +Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. + +## reason + +Reason for batch operation. Only use with --query. Defaults to user name. + +## rps + +Limit batch's requests per second. Only allowed if query is present. + +## run-id + +Run ID. Only use with --workflow-id. Cannot use with --query. + +## time-format + +Time format. + +## tls + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. + +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + +## tls-ca-path + +Path to server CA certificate. Can't be used with --tls-ca-data. + +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + +## tls-cert-path + +Path to x509 certificate. Can't be used with --tls-cert-data. + +## tls-disable-host-verification + +Disable TLS host-name verification. + +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + +## tls-key-path + +Path to x509 private key. Can't be used with --tls-key-data. + +## tls-server-name + +Override target TLS server name. + +## workflow-id + +Workflow ID. You must set either --workflow-id or --query. + +## yes + +Don't prompt to confirm signaling. Only allowed when --query is present. + +## stack + +Perform a Query on a Workflow Execution using a `__stack_trace`-type Query. +Display a stack trace of the threads and routines currently in use by the +Workflow for troubleshooting: -- [--api-key](cli/cmd-options#api-key) +``` +temporal workflow stack \ + --workflow-id YourWorkflowId +``` -- [--codec-auth](cli/cmd-options#codec-auth) +Use the following options to change the behavior of this command. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## address -- [--color](cli/cmd-options#color) +Temporal Service gRPC endpoint. -- [--command-timeout](cli/cmd-options#command-timeout) +## api-key -- [--cron](cli/cmd-options#cron) +API key for request. -- [--detailed](cli/cmd-options#detailed) +## codec-auth -- [--env](cli/cmd-options#env) +Authorization header for Codec Server requests. -- [--env-file](cli/cmd-options#env-file) +## codec-endpoint -- [--execution-timeout](cli/cmd-options#execution-timeout) +Remote Codec Server endpoint. -- [--fail-existing](cli/cmd-options#fail-existing) +## color -- [--grpc-meta](cli/cmd-options#grpc-meta) +Output coloring. -- [--id-reuse-policy](cli/cmd-options#id-reuse-policy) +## command-timeout -- [--input](cli/cmd-options#input) +Timeout for the span of a command. -- [--input-base64](cli/cmd-options#input-base64) +## env -- [--input-file](cli/cmd-options#input-file) +Active environment name (`ENV`). -- [--input-meta](cli/cmd-options#input-meta) +## env-file -- [--log-format](cli/cmd-options#log-format) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--log-level](cli/cmd-options#log-level) +## grpc-meta -- [--memo](cli/cmd-options#memo) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--namespace](cli/cmd-options#namespace) +## log-format -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Log format. Options are: text, json. -- [--output](cli/cmd-options#output) +## log-level -- [--run-timeout](cli/cmd-options#run-timeout) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--search-attribute](cli/cmd-options#search-attribute) +## namespace -- [--start-delay](cli/cmd-options#start-delay) +Temporal Service Namespace. -- [--task-queue](cli/cmd-options#task-queue) +## no-json-shorthand-payloads -- [--task-timeout](cli/cmd-options#task-timeout) +Raw payload output, even if they are JSON. -- [--time-format](cli/cmd-options#time-format) +## output -- [--tls](cli/cmd-options#tls) +Non-logging data output format. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## reject-condition -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Optional flag to reject Queries based on Workflow state. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## run-id -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Run ID. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## time-format -- [--tls-key-data](cli/cmd-options#tls-key-data) +Time format. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls -- [--tls-server-name](cli/cmd-options#tls-server-name) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--type](cli/cmd-options#type) +## tls-ca-data -- [--workflow-id](cli/cmd-options#workflow-id) +Data for server CA certificate. Can't be used with --tls-ca-path. -## fix-history-json +## tls-ca-path -Reserialize an Event History JSON file: +Path to server CA certificate. Can't be used with --tls-ca-data. -``` -temporal workflow fix-history-json \ - --source /path/to/original.json \ - --target /path/to/reserialized.json -``` +## tls-cert-data -Use the following options to change the behavior of this command. +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--address](cli/cmd-options#address) +## tls-cert-path -- [--api-key](cli/cmd-options#api-key) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--codec-auth](cli/cmd-options#codec-auth) +## tls-disable-host-verification -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Disable TLS host-name verification. -- [--color](cli/cmd-options#color) +## tls-key-data -- [--command-timeout](cli/cmd-options#command-timeout) +Private certificate key data. Can't be used with --tls-key-path. -- [--env](cli/cmd-options#env) +## tls-key-path -- [--env-file](cli/cmd-options#env-file) +Path to x509 private key. Can't be used with --tls-key-data. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## tls-server-name -- [--log-format](cli/cmd-options#log-format) +Override target TLS server name. -- [--log-level](cli/cmd-options#log-level) +## workflow-id -- [--namespace](cli/cmd-options#namespace) +Workflow ID. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## start -- [--output](cli/cmd-options#output) +Start a new Workflow Execution. Returns the Workflow- and Run-IDs: -- [--source](cli/cmd-options#source) +``` +temporal workflow start \ + --workflow-id YourWorkflowId \ + --type YourWorkflow \ + --task-queue YourTaskQueue \ + --input '{"some-key": "some-value"}' +``` -- [--target](cli/cmd-options#target) +Use the following options to change the behavior of this command. -- [--time-format](cli/cmd-options#time-format) +## address -- [--tls](cli/cmd-options#tls) +Temporal Service gRPC endpoint. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## api-key -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +API key for request. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## codec-auth -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Authorization header for Codec Server requests. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## codec-endpoint -- [--tls-key-data](cli/cmd-options#tls-key-data) +Remote Codec Server endpoint. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## color -- [--tls-server-name](cli/cmd-options#tls-server-name) +Output coloring. -## list +## command-timeout -List Workflow Executions. By default, this command returns up to 10 closed -Workflow Executions. The optional `--query` limits the output to Workflows -matching a Query: +Timeout for the span of a command. -``` -temporal workflow list \ - --query YourQuery` -``` +## cron -Visit https://docs.temporal.io/visibility to read more about Search Attributes -and Query creation. See `temporal batch --help` for a quick reference. +Cron schedule for the Workflow. Deprecated. Use Schedules instead. -View a list of archived Workflow Executions: +## env -``` -temporal workflow list \ - --archived -``` +Active environment name (`ENV`). -Use the following options to change the behavior of this command. +## env-file -- [--address](cli/cmd-options#address) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--api-key](cli/cmd-options#api-key) +## execution-timeout -- [--archived](cli/cmd-options#archived) +Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. -- [--codec-auth](cli/cmd-options#codec-auth) +## fail-existing -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Fail if the Workflow already exists. -- [--color](cli/cmd-options#color) +## grpc-meta -- [--command-timeout](cli/cmd-options#command-timeout) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--env](cli/cmd-options#env) +## id-reuse-policy -- [--env-file](cli/cmd-options#env-file) +Re-use policy for the Workflow ID in new Workflow Executions. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## input -- [--limit](cli/cmd-options#limit) +Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. -- [--log-format](cli/cmd-options#log-format) +## input-base64 -- [--log-level](cli/cmd-options#log-level) +Assume inputs are base64-encoded and attempt to decode them. -- [--namespace](cli/cmd-options#namespace) +## input-file -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. -- [--output](cli/cmd-options#output) +## input-meta -- [--query](cli/cmd-options#query) +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. -- [--time-format](cli/cmd-options#time-format) +## log-format -- [--tls](cli/cmd-options#tls) +Log format. Options are: text, json. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## log-level -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## memo -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Memo using 'KEY="VALUE"' pairs. Use JSON values. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## namespace -- [--tls-key-data](cli/cmd-options#tls-key-data) +Temporal Service Namespace. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## no-json-shorthand-payloads -- [--tls-server-name](cli/cmd-options#tls-server-name) +Raw payload output, even if they are JSON. -## query +## output -Send a Query to a Workflow Execution by Workflow ID to retrieve its state. -This synchronous operation exposes the internal state of a running Workflow -Execution, which constantly changes. You can query both running and completed -Workflow Executions: +Non-logging data output format. -``` -temporal workflow query \ - --workflow-id YourWorkflowId - --type YourQueryType - --input '{"YourInputKey": "YourInputValue"}' -``` +## run-timeout -Use the following options to change the behavior of this command. +Fail a Workflow Run if it lasts longer than `DURATION`. -- [--address](cli/cmd-options#address) +## search-attribute -- [--api-key](cli/cmd-options#api-key) +Search Attribute in `KEY=VALUE` format. Keys must be identifiers, and values must be JSON values. For example: 'YourKey={"your": "value"}'. Can be passed multiple times. -- [--codec-auth](cli/cmd-options#codec-auth) +## start-delay -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. -- [--color](cli/cmd-options#color) +## task-queue -- [--command-timeout](cli/cmd-options#command-timeout) +Workflow Task queue. -- [--env](cli/cmd-options#env) +## task-timeout -- [--env-file](cli/cmd-options#env-file) +Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## time-format -- [--input](cli/cmd-options#input) +Time format. -- [--input-base64](cli/cmd-options#input-base64) +## tls -- [--input-file](cli/cmd-options#input-file) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--input-meta](cli/cmd-options#input-meta) +## tls-ca-data -- [--log-format](cli/cmd-options#log-format) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--log-level](cli/cmd-options#log-level) +## tls-ca-path -- [--name](cli/cmd-options#name) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--namespace](cli/cmd-options#namespace) +## tls-cert-data -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--output](cli/cmd-options#output) +## tls-cert-path -- [--reject-condition](cli/cmd-options#reject-condition) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--run-id](cli/cmd-options#run-id) +## tls-disable-host-verification -- [--time-format](cli/cmd-options#time-format) +Disable TLS host-name verification. -- [--tls](cli/cmd-options#tls) +## tls-key-data -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-key-path -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-server-name -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Override target TLS server name. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## type -- [--tls-key-path](cli/cmd-options#tls-key-path) +Workflow Type name. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## workflow-id -- [--workflow-id](cli/cmd-options#workflow-id) +Workflow ID. If not supplied, the Service generates a unique ID. -## reset +## terminate -Reset a Workflow Execution so it can resume from a point in its Event History -without losing its progress up to that point: +Terminate a Workflow Execution: ``` -temporal workflow reset \ - --workflow-id YourWorkflowId \ - --event-id YourLastEvent +temporal workflow terminate \ + --reason YourReasonForTermination \ + --workflow-id YourWorkflowId ``` -Start from where the Workflow Execution last continued as new: +The reason is optional and defaults to the current user's name. The reason +is stored in the Event History as part of the `WorkflowExecutionTerminated` +event. This becomes the closing Event in the Workflow Execution's history. + +Executions may be terminated in bulk via a visibility Query list filter: ``` -temporal workflow reset \ - --workflow-id YourWorkflowId \ - --type LastContinuedAsNew +temporal workflow terminate \ + --query YourQuery \ + --reason YourReasonForTermination ``` -For batch resets, limit your resets to FirstWorkflowTask, LastWorkflowTask, or -BuildId. Do not use Workflow IDs, run IDs, or event IDs with this command. +Workflow code cannot see or respond to terminations. To perform clean-up work +in your Workflow code, use `temporal workflow cancel` instead. -Visit https://docs.temporal.io/visibility to read more about Search -Attributes and Query creation. +Visit https://docs.temporal.io/visibility to read more about Search Attributes +and Query creation. See `temporal batch --help` for a quick reference. Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) - -- [--api-key](cli/cmd-options#api-key) - -- [--build-id](cli/cmd-options#build-id) +## address -- [--codec-auth](cli/cmd-options#codec-auth) +Temporal Service gRPC endpoint. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## api-key -- [--color](cli/cmd-options#color) +API key for request. -- [--command-timeout](cli/cmd-options#command-timeout) +## codec-auth -- [--env](cli/cmd-options#env) +Authorization header for Codec Server requests. -- [--env-file](cli/cmd-options#env-file) +## codec-endpoint -- [--event-id](cli/cmd-options#event-id) +Remote Codec Server endpoint. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## color -- [--log-format](cli/cmd-options#log-format) +Output coloring. -- [--log-level](cli/cmd-options#log-level) +## command-timeout -- [--namespace](cli/cmd-options#namespace) +Timeout for the span of a command. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## env -- [--output](cli/cmd-options#output) +Active environment name (`ENV`). -- [--query](cli/cmd-options#query) +## env-file -- [--reapply-exclude](cli/cmd-options#reapply-exclude) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--reapply-type](cli/cmd-options#reapply-type) +## grpc-meta -- [--reason](cli/cmd-options#reason) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--run-id](cli/cmd-options#run-id) +## log-format -- [--time-format](cli/cmd-options#time-format) +Log format. Options are: text, json. -- [--tls](cli/cmd-options#tls) +## log-level -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## namespace -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Temporal Service Namespace. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## no-json-shorthand-payloads -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Raw payload output, even if they are JSON. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## output -- [--tls-key-path](cli/cmd-options#tls-key-path) +Non-logging data output format. -- [--tls-server-name](cli/cmd-options#tls-server-name) - -- [--type](cli/cmd-options#type) - -- [--workflow-id](cli/cmd-options#workflow-id) +## query -- [--yes](cli/cmd-options#yes) +Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. -## result +## reason -Wait for and print the result of a Workflow Execution: +Reason for termination. Defaults to message with the current user's name. -``` -temporal workflow result \ - --workflow-id YourWorkflowId -``` +## rps -Use the following options to change the behavior of this command. +Limit batch's requests per second. Only allowed if query is present. -- [--address](cli/cmd-options#address) +## run-id -- [--api-key](cli/cmd-options#api-key) +Run ID. Can only be set with --workflow-id. Do not use with --query. -- [--codec-auth](cli/cmd-options#codec-auth) +## time-format -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Time format. -- [--color](cli/cmd-options#color) +## tls -- [--command-timeout](cli/cmd-options#command-timeout) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--env](cli/cmd-options#env) +## tls-ca-data -- [--env-file](cli/cmd-options#env-file) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## tls-ca-path -- [--log-format](cli/cmd-options#log-format) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--log-level](cli/cmd-options#log-level) +## tls-cert-data -- [--namespace](cli/cmd-options#namespace) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-cert-path -- [--output](cli/cmd-options#output) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--run-id](cli/cmd-options#run-id) +## tls-disable-host-verification -- [--time-format](cli/cmd-options#time-format) +Disable TLS host-name verification. -- [--tls](cli/cmd-options#tls) +## tls-key-data -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-key-path -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-server-name -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Override target TLS server name. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## workflow-id -- [--tls-key-path](cli/cmd-options#tls-key-path) +Workflow ID. You must set either --workflow-id or --query. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## yes -- [--workflow-id](cli/cmd-options#workflow-id) +Don't prompt to confirm termination. Can only be used with --query. -## show +## trace -Show a Workflow Execution's Event History. -When using JSON output (`--output json`), you may pass the results to an SDK -to perform a replay: +Display the progress of a Workflow Execution and its child workflows with a +real-time trace. This view helps you understand how Workflows are proceeding: ``` -temporal workflow show \ +temporal workflow trace \ --workflow-id YourWorkflowId - --output json ``` Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--detailed](cli/cmd-options#detailed) +## codec-endpoint -- [--env](cli/cmd-options#env) +Remote Codec Server endpoint. -- [--env-file](cli/cmd-options#env-file) +## color -- [--follow](cli/cmd-options#follow) +Output coloring. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## command-timeout -- [--log-format](cli/cmd-options#log-format) +Timeout for the span of a command. -- [--log-level](cli/cmd-options#log-level) +## concurrency -- [--namespace](cli/cmd-options#namespace) +Number of Workflow Histories to fetch at a time. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## depth -- [--output](cli/cmd-options#output) +Set depth for your Child Workflow fetches. Pass -1 to fetch child workflows at any depth. -- [--run-id](cli/cmd-options#run-id) +## env -- [--time-format](cli/cmd-options#time-format) +Active environment name (`ENV`). -- [--tls](cli/cmd-options#tls) +## env-file -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## fold -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Fold away Child Workflows with the specified statuses. Case-insensitive. Ignored if --no-fold supplied. Available values: running, completed, failed, canceled, terminated, timedout, continueasnew. Can be passed multiple times. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## grpc-meta -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## log-format -- [--tls-key-path](cli/cmd-options#tls-key-path) +Log format. Options are: text, json. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## log-level -- [--workflow-id](cli/cmd-options#workflow-id) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -## signal - -Send an asynchronous notification (Signal) to a running Workflow Execution by -its Workflow ID. The Signal is written to the History. When you include -`--input`, that data is available for the Workflow Execution to consume: - -``` -temporal workflow signal \ - --workflow-id YourWorkflowId \ - --name YourSignal \ - --input '{"YourInputKey": "YourInputValue"}' -``` +## namespace -Visit https://docs.temporal.io/visibility to read more about Search Attributes -and Query creation. See `temporal batch --help` for a quick reference. +Temporal Service Namespace. -Use the following options to change the behavior of this command. +## no-fold -- [--address](cli/cmd-options#address) +Disable folding. Fetch and display Child Workflows within the set depth. -- [--api-key](cli/cmd-options#api-key) +## no-json-shorthand-payloads -- [--codec-auth](cli/cmd-options#codec-auth) +Raw payload output, even if they are JSON. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## output -- [--color](cli/cmd-options#color) +Non-logging data output format. -- [--command-timeout](cli/cmd-options#command-timeout) +## run-id -- [--env](cli/cmd-options#env) +Run ID. -- [--env-file](cli/cmd-options#env-file) +## time-format -- [--grpc-meta](cli/cmd-options#grpc-meta) +Time format. -- [--input](cli/cmd-options#input) +## tls -- [--input-base64](cli/cmd-options#input-base64) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--input-file](cli/cmd-options#input-file) +## tls-ca-data -- [--input-meta](cli/cmd-options#input-meta) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--log-format](cli/cmd-options#log-format) +## tls-ca-path -- [--log-level](cli/cmd-options#log-level) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--name](cli/cmd-options#name) +## tls-cert-data -- [--namespace](cli/cmd-options#namespace) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-cert-path -- [--output](cli/cmd-options#output) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--query](cli/cmd-options#query) +## tls-disable-host-verification -- [--reason](cli/cmd-options#reason) +Disable TLS host-name verification. -- [--rps](cli/cmd-options#rps) +## tls-key-data -- [--run-id](cli/cmd-options#run-id) +Private certificate key data. Can't be used with --tls-key-path. -- [--time-format](cli/cmd-options#time-format) +## tls-key-path -- [--tls](cli/cmd-options#tls) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-server-name -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Override target TLS server name. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## workflow-id -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Workflow ID. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## update -- [--tls-key-data](cli/cmd-options#tls-key-data) +An Update is a synchronous call to a Workflow Execution that can change its +state, control its flow, and return a result. -- [--tls-key-path](cli/cmd-options#tls-key-path) +Experimental. -- [--tls-server-name](cli/cmd-options#tls-server-name) +Use the following options to change the behavior of this command. -- [--workflow-id](cli/cmd-options#workflow-id) +## address -- [--yes](cli/cmd-options#yes) +Temporal Service gRPC endpoint. -## stack +## api-key -Perform a Query on a Workflow Execution using a `__stack_trace`-type Query. -Display a stack trace of the threads and routines currently in use by the -Workflow for troubleshooting: +API key for request. -``` -temporal workflow stack \ - --workflow-id YourWorkflowId -``` +## codec-auth -Use the following options to change the behavior of this command. +Authorization header for Codec Server requests. -- [--address](cli/cmd-options#address) +## codec-endpoint -- [--api-key](cli/cmd-options#api-key) +Remote Codec Server endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## color -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Output coloring. -- [--color](cli/cmd-options#color) +## command-timeout -- [--command-timeout](cli/cmd-options#command-timeout) +Timeout for the span of a command. -- [--env](cli/cmd-options#env) +## env -- [--env-file](cli/cmd-options#env-file) +Active environment name (`ENV`). -- [--grpc-meta](cli/cmd-options#grpc-meta) +## env-file -- [--log-format](cli/cmd-options#log-format) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--log-level](cli/cmd-options#log-level) +## grpc-meta -- [--namespace](cli/cmd-options#namespace) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## log-format -- [--output](cli/cmd-options#output) +Log format. Options are: text, json. -- [--reject-condition](cli/cmd-options#reject-condition) +## log-level -- [--run-id](cli/cmd-options#run-id) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--time-format](cli/cmd-options#time-format) +## namespace -- [--tls](cli/cmd-options#tls) +Temporal Service Namespace. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## no-json-shorthand-payloads -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Raw payload output, even if they are JSON. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## output -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Non-logging data output format. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## time-format -- [--tls-key-data](cli/cmd-options#tls-key-data) +Time format. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## tls -- [--tls-server-name](cli/cmd-options#tls-server-name) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--workflow-id](cli/cmd-options#workflow-id) +## tls-ca-data -## start +Data for server CA certificate. Can't be used with --tls-ca-path. -Start a new Workflow Execution. Returns the Workflow- and Run-IDs: +## tls-ca-path -``` -temporal workflow start \ - --workflow-id YourWorkflowId \ - --type YourWorkflow \ - --task-queue YourTaskQueue \ - --input '{"some-key": "some-value"}' -``` +Path to server CA certificate. Can't be used with --tls-ca-data. -Use the following options to change the behavior of this command. +## tls-cert-data -- [--address](cli/cmd-options#address) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--api-key](cli/cmd-options#api-key) +## tls-cert-path -- [--codec-auth](cli/cmd-options#codec-auth) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## tls-disable-host-verification -- [--color](cli/cmd-options#color) +Disable TLS host-name verification. -- [--command-timeout](cli/cmd-options#command-timeout) +## tls-key-data -- [--cron](cli/cmd-options#cron) +Private certificate key data. Can't be used with --tls-key-path. -- [--env](cli/cmd-options#env) +## tls-key-path -- [--env-file](cli/cmd-options#env-file) +Path to x509 private key. Can't be used with --tls-key-data. -- [--execution-timeout](cli/cmd-options#execution-timeout) +## tls-server-name -- [--fail-existing](cli/cmd-options#fail-existing) +Override target TLS server name. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## updatedescribe -- [--id-reuse-policy](cli/cmd-options#id-reuse-policy) +Given a Workflow Execution and an Update ID, return information about its current status, including +a result if it has finished. -- [--input](cli/cmd-options#input) +Experimental. -- [--input-base64](cli/cmd-options#input-base64) +``` +temporal workflow update describe \ + --workflow-id YourWorkflowId \ + --update-id YourUpdateId +``` -- [--input-file](cli/cmd-options#input-file) +Use the following options to change the behavior of this command. -- [--input-meta](cli/cmd-options#input-meta) +## address -- [--log-format](cli/cmd-options#log-format) +Temporal Service gRPC endpoint. -- [--log-level](cli/cmd-options#log-level) +## api-key -- [--memo](cli/cmd-options#memo) +API key for request. -- [--namespace](cli/cmd-options#namespace) +## codec-auth -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Authorization header for Codec Server requests. -- [--output](cli/cmd-options#output) +## codec-endpoint -- [--run-timeout](cli/cmd-options#run-timeout) +Remote Codec Server endpoint. -- [--search-attribute](cli/cmd-options#search-attribute) +## color -- [--start-delay](cli/cmd-options#start-delay) +Output coloring. -- [--task-queue](cli/cmd-options#task-queue) +## command-timeout -- [--task-timeout](cli/cmd-options#task-timeout) +Timeout for the span of a command. -- [--time-format](cli/cmd-options#time-format) +## env -- [--tls](cli/cmd-options#tls) +Active environment name (`ENV`). -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## env-file -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## grpc-meta -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## log-format -- [--tls-key-data](cli/cmd-options#tls-key-data) +Log format. Options are: text, json. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## log-level -- [--tls-server-name](cli/cmd-options#tls-server-name) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--type](cli/cmd-options#type) +## namespace -- [--workflow-id](cli/cmd-options#workflow-id) +Temporal Service Namespace. -## terminate +## no-json-shorthand-payloads -Terminate a Workflow Execution: +Raw payload output, even if they are JSON. -``` -temporal workflow terminate \ - --reason YourReasonForTermination \ - --workflow-id YourWorkflowId -``` +## output -The reason is optional and defaults to the current user's name. The reason -is stored in the Event History as part of the `WorkflowExecutionTerminated` -event. This becomes the closing Event in the Workflow Execution's history. +Non-logging data output format. -Executions may be terminated in bulk via a visibility Query list filter: +## run-id -``` -temporal workflow terminate \ - --query YourQuery \ - --reason YourReasonForTermination -``` +Run ID. If unset, updates the currently-running Workflow Execution. -Workflow code cannot see or respond to terminations. To perform clean-up work -in your Workflow code, use `temporal workflow cancel` instead. +## time-format -Visit https://docs.temporal.io/visibility to read more about Search Attributes -and Query creation. See `temporal batch --help` for a quick reference. +Time format. -Use the following options to change the behavior of this command. +## tls -- [--address](cli/cmd-options#address) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--api-key](cli/cmd-options#api-key) +## tls-ca-data -- [--codec-auth](cli/cmd-options#codec-auth) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## tls-ca-path -- [--color](cli/cmd-options#color) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--command-timeout](cli/cmd-options#command-timeout) +## tls-cert-data -- [--env](cli/cmd-options#env) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--env-file](cli/cmd-options#env-file) +## tls-cert-path -- [--grpc-meta](cli/cmd-options#grpc-meta) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--log-format](cli/cmd-options#log-format) +## tls-disable-host-verification -- [--log-level](cli/cmd-options#log-level) +Disable TLS host-name verification. -- [--namespace](cli/cmd-options#namespace) +## tls-key-data -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Private certificate key data. Can't be used with --tls-key-path. -- [--output](cli/cmd-options#output) +## tls-key-path -- [--query](cli/cmd-options#query) +Path to x509 private key. Can't be used with --tls-key-data. -- [--reason](cli/cmd-options#reason) +## tls-server-name -- [--rps](cli/cmd-options#rps) +Override target TLS server name. -- [--run-id](cli/cmd-options#run-id) +## update-id -- [--time-format](cli/cmd-options#time-format) +Update ID. Must be unique per Workflow Execution. -- [--tls](cli/cmd-options#tls) +## workflow-id -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Workflow ID. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## updateexecute -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Send a message to a Workflow Execution to invoke an Update handler, and wait for +the update to complete or fail. You can also use this to wait for an existing +update to complete, by submitting an existing update ID. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Experimental. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +``` +temporal workflow update execute \ + --workflow-id YourWorkflowId \ + --name YourUpdate \ + --input '{"some-key": "some-value"}' +``` -- [--tls-key-data](cli/cmd-options#tls-key-data) +Use the following options to change the behavior of this command. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## address -- [--tls-server-name](cli/cmd-options#tls-server-name) +Temporal Service gRPC endpoint. -- [--workflow-id](cli/cmd-options#workflow-id) +## api-key -- [--yes](cli/cmd-options#yes) +API key for request. -## trace +## codec-auth -Display the progress of a Workflow Execution and its child workflows with a -real-time trace. This view helps you understand how Workflows are proceeding: +Authorization header for Codec Server requests. -``` -temporal workflow trace \ - --workflow-id YourWorkflowId -``` +## codec-endpoint -Use the following options to change the behavior of this command. +Remote Codec Server endpoint. -- [--address](cli/cmd-options#address) +## color -- [--api-key](cli/cmd-options#api-key) +Output coloring. -- [--codec-auth](cli/cmd-options#codec-auth) +## command-timeout -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Timeout for the span of a command. -- [--color](cli/cmd-options#color) +## env -- [--command-timeout](cli/cmd-options#command-timeout) +Active environment name (`ENV`). -- [--concurrency](cli/cmd-options#concurrency) +## env-file -- [--depth](cli/cmd-options#depth) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--env](cli/cmd-options#env) +## first-execution-run-id -- [--env-file](cli/cmd-options#env-file) +Parent Run ID. The update is sent to the last Workflow Execution in the chain started with this Run ID. -- [--fold](cli/cmd-options#fold) +## grpc-meta -- [--grpc-meta](cli/cmd-options#grpc-meta) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--log-format](cli/cmd-options#log-format) +## input -- [--log-level](cli/cmd-options#log-level) +Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. -- [--namespace](cli/cmd-options#namespace) +## input-base64 -- [--no-fold](cli/cmd-options#no-fold) +Assume inputs are base64-encoded and attempt to decode them. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## input-file -- [--output](cli/cmd-options#output) +A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. -- [--run-id](cli/cmd-options#run-id) +## input-meta -- [--time-format](cli/cmd-options#time-format) +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. -- [--tls](cli/cmd-options#tls) +## log-format -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Log format. Options are: text, json. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## log-level -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## name -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Handler method name. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## namespace -- [--tls-key-path](cli/cmd-options#tls-key-path) +Temporal Service Namespace. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## no-json-shorthand-payloads -- [--workflow-id](cli/cmd-options#workflow-id) +Raw payload output, even if they are JSON. -## update +## output -An Update is a synchronous call to a Workflow Execution that can change its -state, control its flow, and return a result. +Non-logging data output format. -Experimental. +## run-id -Use the following options to change the behavior of this command. +Run ID. If unset, looks for an Update against the currently-running Workflow Execution. -- [--address](cli/cmd-options#address) +## time-format -- [--api-key](cli/cmd-options#api-key) +Time format. -- [--codec-auth](cli/cmd-options#codec-auth) +## tls -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--color](cli/cmd-options#color) +## tls-ca-data -- [--command-timeout](cli/cmd-options#command-timeout) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--env](cli/cmd-options#env) +## tls-ca-path -- [--env-file](cli/cmd-options#env-file) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## tls-cert-data -- [--log-format](cli/cmd-options#log-format) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--log-level](cli/cmd-options#log-level) +## tls-cert-path -- [--namespace](cli/cmd-options#namespace) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-disable-host-verification -- [--output](cli/cmd-options#output) +Disable TLS host-name verification. -- [--time-format](cli/cmd-options#time-format) +## tls-key-data -- [--tls](cli/cmd-options#tls) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-key-path -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-server-name -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Override target TLS server name. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## update-id -- [--tls-key-data](cli/cmd-options#tls-key-data) +Update ID. If unset, defaults to a UUID. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## workflow-id -- [--tls-server-name](cli/cmd-options#tls-server-name) +Workflow ID. -## updatedescribe +## updateresult -Given a Workflow Execution and an Update ID, return information about its current status, including -a result if it has finished. +Given a Workflow Execution and an Update ID, wait for the Update to complete or fail and +print the result. Experimental. ``` -temporal workflow update describe \ +temporal workflow update result \ --workflow-id YourWorkflowId \ --update-id YourUpdateId ``` Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) - -- [--api-key](cli/cmd-options#api-key) +## address -- [--codec-auth](cli/cmd-options#codec-auth) +Temporal Service gRPC endpoint. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## api-key -- [--color](cli/cmd-options#color) +API key for request. -- [--command-timeout](cli/cmd-options#command-timeout) +## codec-auth -- [--env](cli/cmd-options#env) +Authorization header for Codec Server requests. -- [--env-file](cli/cmd-options#env-file) +## codec-endpoint -- [--grpc-meta](cli/cmd-options#grpc-meta) +Remote Codec Server endpoint. -- [--log-format](cli/cmd-options#log-format) +## color -- [--log-level](cli/cmd-options#log-level) +Output coloring. -- [--namespace](cli/cmd-options#namespace) +## command-timeout -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Timeout for the span of a command. -- [--output](cli/cmd-options#output) +## env -- [--run-id](cli/cmd-options#run-id) +Active environment name (`ENV`). -- [--time-format](cli/cmd-options#time-format) +## env-file -- [--tls](cli/cmd-options#tls) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## grpc-meta -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## log-format -- [--tls-cert-path](cli/cmd-options#tls-cert-path) - -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) - -- [--tls-key-data](cli/cmd-options#tls-key-data) - -- [--tls-key-path](cli/cmd-options#tls-key-path) - -- [--tls-server-name](cli/cmd-options#tls-server-name) - -- [--update-id](cli/cmd-options#update-id) - -- [--workflow-id](cli/cmd-options#workflow-id) - -## updateexecute - -Send a message to a Workflow Execution to invoke an Update handler, and wait for -the update to complete or fail. You can also use this to wait for an existing -update to complete, by submitting an existing update ID. - -Experimental. - -``` -temporal workflow update execute \ - --workflow-id YourWorkflowId \ - --name YourUpdate \ - --input '{"some-key": "some-value"}' -``` +Log format. Options are: text, json. -Use the following options to change the behavior of this command. +## log-level -- [--address](cli/cmd-options#address) +Log level. Default is "info" for most commands and "warn" for `server start-dev`. -- [--api-key](cli/cmd-options#api-key) +## namespace -- [--codec-auth](cli/cmd-options#codec-auth) +Temporal Service Namespace. -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +## no-json-shorthand-payloads -- [--color](cli/cmd-options#color) +Raw payload output, even if they are JSON. -- [--command-timeout](cli/cmd-options#command-timeout) +## output -- [--env](cli/cmd-options#env) +Non-logging data output format. -- [--env-file](cli/cmd-options#env-file) +## run-id -- [--first-execution-run-id](cli/cmd-options#first-execution-run-id) +Run ID. If unset, updates the currently-running Workflow Execution. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## time-format -- [--input](cli/cmd-options#input) +Time format. -- [--input-base64](cli/cmd-options#input-base64) +## tls -- [--input-file](cli/cmd-options#input-file) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--input-meta](cli/cmd-options#input-meta) +## tls-ca-data -- [--log-format](cli/cmd-options#log-format) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--log-level](cli/cmd-options#log-level) +## tls-ca-path -- [--name](cli/cmd-options#name) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--namespace](cli/cmd-options#namespace) +## tls-cert-data -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--output](cli/cmd-options#output) +## tls-cert-path -- [--run-id](cli/cmd-options#run-id) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--time-format](cli/cmd-options#time-format) +## tls-disable-host-verification -- [--tls](cli/cmd-options#tls) +Disable TLS host-name verification. -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +## tls-key-data -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +## tls-key-path -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +## tls-server-name -- [--tls-key-data](cli/cmd-options#tls-key-data) +Override target TLS server name. -- [--tls-key-path](cli/cmd-options#tls-key-path) +## update-id -- [--tls-server-name](cli/cmd-options#tls-server-name) +Update ID. Must be unique per Workflow Execution. -- [--update-id](cli/cmd-options#update-id) +## workflow-id -- [--workflow-id](cli/cmd-options#workflow-id) +Workflow ID. -## updateresult +## updatestart -Given a Workflow Execution and an Update ID, wait for the Update to complete or fail and -print the result. +Send a message to a Workflow Execution to invoke an Update handler, and wait for +the update to be accepted or rejected. You can subsequently wait for the update +to complete by using `temporal workflow update execute`. Experimental. ``` -temporal workflow update result \ +temporal workflow update start \ --workflow-id YourWorkflowId \ - --update-id YourUpdateId + --name YourUpdate \ + --input '{"some-key": "some-value"}' ``` Use the following options to change the behavior of this command. -- [--address](cli/cmd-options#address) +## address -- [--api-key](cli/cmd-options#api-key) +Temporal Service gRPC endpoint. -- [--codec-auth](cli/cmd-options#codec-auth) +## api-key -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +API key for request. -- [--color](cli/cmd-options#color) +## codec-auth -- [--command-timeout](cli/cmd-options#command-timeout) +Authorization header for Codec Server requests. -- [--env](cli/cmd-options#env) +## codec-endpoint -- [--env-file](cli/cmd-options#env-file) +Remote Codec Server endpoint. -- [--grpc-meta](cli/cmd-options#grpc-meta) +## color -- [--log-format](cli/cmd-options#log-format) +Output coloring. -- [--log-level](cli/cmd-options#log-level) +## command-timeout -- [--namespace](cli/cmd-options#namespace) +Timeout for the span of a command. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## env -- [--output](cli/cmd-options#output) +Active environment name (`ENV`). -- [--run-id](cli/cmd-options#run-id) +## env-file -- [--time-format](cli/cmd-options#time-format) +Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). -- [--tls](cli/cmd-options#tls) +## first-execution-run-id -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Parent Run ID. The update is sent to the last Workflow Execution in the chain started with this Run ID. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## grpc-meta -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +HTTP headers for requests. format as a `KEY=VALUE` pair May be passed multiple times to set multiple headers. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## input -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## input-base64 -- [--tls-key-path](cli/cmd-options#tls-key-path) +Assume inputs are base64-encoded and attempt to decode them. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## input-file -- [--update-id](cli/cmd-options#update-id) +A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. -- [--workflow-id](cli/cmd-options#workflow-id) +## input-meta -## updatestart +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. -Send a message to a Workflow Execution to invoke an Update handler, and wait for -the update to be accepted or rejected. You can subsequently wait for the update -to complete by using `temporal workflow update execute`. +## log-format -Experimental. +Log format. Options are: text, json. -``` -temporal workflow update start \ - --workflow-id YourWorkflowId \ - --name YourUpdate \ - --input '{"some-key": "some-value"}' -``` +## log-level -Use the following options to change the behavior of this command. +Log level. Default is "info" for most commands and "warn" for `server start-dev`. + +## name + +Handler method name. -- [--address](cli/cmd-options#address) +## namespace -- [--api-key](cli/cmd-options#api-key) +Temporal Service Namespace. -- [--codec-auth](cli/cmd-options#codec-auth) +## no-json-shorthand-payloads -- [--codec-endpoint](cli/cmd-options#codec-endpoint) +Raw payload output, even if they are JSON. -- [--color](cli/cmd-options#color) +## output -- [--command-timeout](cli/cmd-options#command-timeout) +Non-logging data output format. -- [--env](cli/cmd-options#env) +## run-id -- [--env-file](cli/cmd-options#env-file) +Run ID. If unset, looks for an Update against the currently-running Workflow Execution. -- [--first-execution-run-id](cli/cmd-options#first-execution-run-id) +## time-format -- [--grpc-meta](cli/cmd-options#grpc-meta) +Time format. -- [--input](cli/cmd-options#input) +## tls -- [--input-base64](cli/cmd-options#input-base64) +Enable base TLS encryption. Does not have additional options like mTLS or client certs. -- [--input-file](cli/cmd-options#input-file) +## tls-ca-data -- [--input-meta](cli/cmd-options#input-meta) +Data for server CA certificate. Can't be used with --tls-ca-path. -- [--log-format](cli/cmd-options#log-format) +## tls-ca-path -- [--log-level](cli/cmd-options#log-level) +Path to server CA certificate. Can't be used with --tls-ca-data. -- [--name](cli/cmd-options#name) +## tls-cert-data -- [--namespace](cli/cmd-options#namespace) +Data for x509 certificate. Can't be used with --tls-cert-path. -- [--no-json-shorthand-payloads](cli/cmd-options#no-json-shorthand-payloads) +## tls-cert-path -- [--output](cli/cmd-options#output) +Path to x509 certificate. Can't be used with --tls-cert-data. -- [--run-id](cli/cmd-options#run-id) +## tls-disable-host-verification -- [--time-format](cli/cmd-options#time-format) +Disable TLS host-name verification. -- [--tls](cli/cmd-options#tls) +## tls-key-data -- [--tls-ca-data](cli/cmd-options#tls-ca-data) +Private certificate key data. Can't be used with --tls-key-path. -- [--tls-ca-path](cli/cmd-options#tls-ca-path) +## tls-key-path -- [--tls-cert-data](cli/cmd-options#tls-cert-data) +Path to x509 private key. Can't be used with --tls-key-data. -- [--tls-cert-path](cli/cmd-options#tls-cert-path) +## tls-server-name -- [--tls-disable-host-verification](cli/cmd-options#tls-disable-host-verification) +Override target TLS server name. -- [--tls-key-data](cli/cmd-options#tls-key-data) +## update-id -- [--tls-key-path](cli/cmd-options#tls-key-path) +Update ID. If unset, defaults to a UUID. -- [--tls-server-name](cli/cmd-options#tls-server-name) +## wait-for-stage -- [--update-id](cli/cmd-options#update-id) +Update stage to wait for. The only option is `accepted`, but this option is required. This is to allow a future version of the CLI to choose a default value. -- [--wait-for-stage](cli/cmd-options#wait-for-stage) +## workflow-id -- [--workflow-id](cli/cmd-options#workflow-id) +Workflow ID.