From 7a2abdf9e74cf121dd00fa453810d46f218dbae2 Mon Sep 17 00:00:00 2001 From: feedmeapples Date: Mon, 28 Nov 2022 14:48:38 -0500 Subject: [PATCH 01/68] doc tool --- cmd/doc/main.go | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 cmd/doc/main.go diff --git a/cmd/doc/main.go b/cmd/doc/main.go new file mode 100644 index 00000000..686a0a49 --- /dev/null +++ b/cmd/doc/main.go @@ -0,0 +1,45 @@ +// The MIT License +// +// Copyright (c) 2022 Temporal Technologies Inc. All rights reserved. +// +// Copyright (c) 2020 Uber Technologies, Inc. +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in +// all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +// THE SOFTWARE. + +package main + +import ( + "log" + "os" + + "github.com/temporalio/cli/app" +) + +func main() { + doc, err := app.BuildApp("").ToMarkdown() + if err != nil { + log.Fatal(err) + } + + path := "cli.md" + err = os.WriteFile(path, []byte(doc), 0644) + if err != nil { + log.Fatal(err) + } +} From ec461aa0cd5ded6273ad73eb2ddf1d6fa23e4d78 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Mon, 9 Jan 2023 15:51:03 -0600 Subject: [PATCH 02/68] wrote something. asking for advice --- cli.md | 2063 +++++++++++++++++++++++++++++++++++++++++++++++ cmd/doc/main.go | 95 ++- go.mod | 5 +- go.sum | 2 + 4 files changed, 2161 insertions(+), 4 deletions(-) create mode 100644 cli.md diff --git a/cli.md b/cli.md new file mode 100644 index 00000000..c733fb23 --- /dev/null +++ b/cli.md @@ -0,0 +1,2063 @@ +# NAME + +temporal - Temporal command-line interface and development server + +# SYNOPSIS + +temporal + +**Usage**: + +``` +temporal [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...] +``` + +# COMMANDS + +## server + +Commands for managing Temporal server + +### start-dev + +Start Temporal development server + +**--config, -c**="": config dir path + +**--db-filename, -f**="": File in which to persist Temporal state + +**--dynamic-config-value**="": dynamic config value, as KEY=JSON_VALUE (meaning strings need quotes) + +**--headless**: disable the temporal web UI + +**--ip**="": IPv4 address to bind the frontend service to instead of localhost (default: 127.0.0.1) + +**--log-format**="": customize the log formatting (allowed: ["json" "pretty"]) (default: json) + +**--log-level**="": customize the log level (allowed: ["debug" "info" "warn" "error" "fatal"]) (default: info) + +**--metrics-port**="": Port for the metrics listener (default: 0) + +**--namespace, -n**="": Specify namespaces that should be pre-created. Namespace 'default' is auto created + +**--port, -p**="": Port for the temporal-frontend GRPC service (default: 7233) + +**--sqlite-pragma**="": specify sqlite pragma statements in pragma=value format (allowed: ["journal_mode" "synchronous"]) + +**--ui-asset-path**="": UI Custom Assets path + +**--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint + +**--ui-ip**="": IPv4 address to bind the web UI to instead of localhost + +**--ui-port**="": port for the temporal web UI (default: 0) + +## workflow + +Operations on Workflows + +### start + +Start a new Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of the month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) + │ │ │ │ │ + * * * * * + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value + +**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Workflow type name + +**--workflow-id, -w**="": Workflow Id + +### execute + +Start a new Workflow Execution and print progress + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of the month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) + │ │ │ │ │ + * * * * * + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value + +**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Workflow type name + +**--workflow-id, -w**="": Workflow Id + +### describe + +Show information about a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--raw**: Print properties as they are stored + +**--reset-points**: Only show auto-reset points + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### list + +List Workflow Executions based on a Query + +**--address**="": host:port for Temporal frontend service + +**--archived**: List archived Workflow Executions (EXPERIMENTAL) + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### show + +Show Event History for a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--follow, -f**: Follow the progress of Workflow Execution + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 500) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--output-filename**="": Serialize history event to a file + +**--pager**="": pager to use: less, more, favoritePager.. + +**--reset-points**: Only show events that are eligible for reset + +**--run-id, -r**="": Run Id + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### query + +Query a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space + +**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": The query type you want to run + +**--workflow-id, -w**="": Workflow Id + +### stack + +Query a Workflow Execution with __stack_trace as the query type + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space + +**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### signal + +Signal Workflow Execution by Id or List Filter + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Input for the signal (JSON) + +**--input-file**="": Input for the signal from file (JSON) + +**--name**="": Signal Name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for signaling with List Filter + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Signal Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### count + +Count Workflow Executions (requires ElasticSearch to be enabled) + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### cancel + +Cancel a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for canceling with List Filter + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Cancel Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### terminate + +Terminate Workflow Execution by Id or List Filter + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for termination + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Terminate Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### delete + +Delete a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### reset + +Reset a Workflow Execution by event Id or reset type + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--event-id**="": The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) + +**--reason**="": Reason to reset + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask + +**--workflow-id, -w**="": Workflow Id + +### reset-batch + +Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--dry-run**: Simulate reset without resetting any Workflow Executions + +**--env**="": Env name to read the client environment variables from (default: default) + +**--exclude-file**="": Input file that specifies Workflow Executions to exclude from resetting + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input-file**="": Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id + +**--input-parallelism**="": Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) + +**--input-separator**="": Separator for the input file. The default is a tab ( ) (default: ) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--non-deterministic**: Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error + +**--query, -q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query + +**--reason**="": Reason for resetting the Workflow Executions + +**--skip-base-is-not-current**: Skip a Workflow Execution if the base Run is not the current Run + +**--skip-current-open**: Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask + +### trace + +Trace progress of a Workflow Execution and its children + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--concurrency**="": Request concurrency (default: 10) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--depth**="": Number of child workflows to expand, -1 to expand all child workflows (default: -1) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fold**="": Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-fold**: Disable folding. All child workflows within the set depth will be fetched and displayed + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +## activity + +Operations on Activities of Workflows + +### complete + +Complete an activity + +**--activity-id**="": The Activity Id to complete + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--identity**="": Specify operator's identity + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--result**="": Set the result value of completion + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### fail + +Fail an activity + +**--activity-id**="": The Activity Id to fail + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--detail**="": Detail to fail the Activity + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--identity**="": Specify operator's identity + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reason**="": Reason to fail the Activity + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +## task-queue + +Operations on Task Queues + +### describe + +Describe the Workers that have recently polled on this Task Queue + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--task-queue, -t**="": Task Queue name + +**--task-queue-type**="": Task Queue type [workflow|activity] (default: workflow) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list-partition + +List the Task Queue's partitions and which matching node they are assigned to + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--task-queue, -t**="": Task Queue name + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## schedule + +Operations on Schedules + +### create + +Create a new schedule + +**--address**="": host:port for Temporal frontend service + +**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} + +**--catchup-window**="": Maximum allowed catch-up time if server is down + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + +**--end-time**="": Overall schedule end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset + +**--jitter**="": Jitter duration + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + +**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--notes**="": Initial value of notes field + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--pause**: Initial value of paused state + +**--pause-on-failure**: Pause schedule after any workflow failure + +**--remaining-actions**="": Total number of actions allowed (default: 0) + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--schedule-id, -s**="": Schedule Id + +**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + +**--start-time**="": Overall schedule start time + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-zone**="": Time zone (IANA name) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +**--workflow-type**="": Workflow type name + +### update + +Updates a schedule with a new definition (full replacement, not patch) + +**--address**="": host:port for Temporal frontend service + +**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} + +**--catchup-window**="": Maximum allowed catch-up time if server is down + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + +**--end-time**="": Overall schedule end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset + +**--jitter**="": Jitter duration + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + +**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--notes**="": Initial value of notes field + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--pause**: Initial value of paused state + +**--pause-on-failure**: Pause schedule after any workflow failure + +**--remaining-actions**="": Total number of actions allowed (default: 0) + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--schedule-id, -s**="": Schedule Id + +**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + +**--start-time**="": Overall schedule start time + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-zone**="": Time zone (IANA name) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +**--workflow-type**="": Workflow type name + +### toggle + +Pauses or unpauses a schedule + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--pause**: Pauses the schedule + +**--reason**="": Free-form text to describe reason for pause/unpause (default: (no reason provided)) + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--unpause**: Unpauses the schedule + +### trigger + +Triggers an immediate action + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### backfill + +Backfills a past time range of actions + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--end-time**="": Backfill end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--schedule-id, -s**="": Schedule Id + +**--start-time**="": Backfill start time + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### describe + +Get schedule configuration and current state + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--raw**: Print raw data as json (prefer this over -o json for scripting) + +**--schedule-id, -s**="": Schedule Id + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### delete + +Deletes a schedule + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list + +Lists schedules + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## batch + +Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs + +### describe + +Describe a batch operation job + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--job-id**="": Batch Job Id + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list + +List batch operation jobs + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### terminate + +Stop a batch operation job + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--job-id**="": Batch Job Id + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reason**="": Reason to stop the batch job + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## operator + +Operation on Temporal server + +### namespace + +Operations on namespaces + +#### describe + +Describe a Namespace by name or Id + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--namespace-id**="": Namespace Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### list + +List all Namespaces + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### register + +Register a new Namespace + +**--active-cluster**="": Active cluster name + +**--address**="": host:port for Temporal frontend service + +**--cluster**="": Cluster name + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--data**="": Namespace data in a format key=value + +**--description**="": Namespace description + +**--email**="": Owner email + +**--env**="": Env name to read the client environment variables from (default: default) + +**--global**="": Flag to indicate whether namespace is a global namespace + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--retention**="": Workflow Execution retention + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + +#### update + +Update a Namespace + +**--active-cluster**="": Active cluster name + +**--address**="": host:port for Temporal frontend service + +**--cluster**="": Cluster name + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--data**="": Namespace data in a format key=value + +**--description**="": Namespace description + +**--email**="": Owner email + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--promote-global**: Promote local namespace to global namespace + +**--reason**="": Reason for the operation + +**--retention**="": Workflow Execution retention + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + +#### delete + +Delete existing Namespace + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--yes, -y**: Confirm all prompts + +### search-attribute + +Operations on search attributes + +#### create + +Add custom search attributes + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Search attribute name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] + +**--yes, -y**: Confirm all prompts + +#### list + +List search attributes that can be used in list workflow query + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### remove + +Remove custom search attributes metadata only (Elasticsearch index schema is not modified) + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Search attribute name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--yes, -y**: Confirm all prompts + +### cluster + +Operations on a Temporal cluster + +#### health + +Check health of frontend service + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### describe + +Show information about the cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### system + +Show information about the system and capabilities + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### upsert + +Add or update a remote cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--enable-connection**: Enable cross cluster connection + +**--env**="": Env name to read the client environment variables from (default: default) + +**--frontend-address**="": Frontend address of the remote cluster + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### list + +List all remote clusters + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### remove + +Remove a remote cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Frontend address of the remote cluster + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## env + +Manage client environment configurations + +### get + +Print environment properties + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### set + +Set environment property + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### delete + +Delete environment or environment property + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## completion + +Output shell completion code for the specified shell (zsh, bash) + +### bash + +bash completion output + +### zsh + +zsh completion output diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 686a0a49..926f94e5 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -25,21 +25,110 @@ package main import ( + "bufio" + "fmt" "log" "os" + "strings" "github.com/temporalio/cli/app" ) +// currently writes to one big file. +// todo: create separate files and folders. +// todo: elaborate on each file func main() { doc, err := app.BuildApp("").ToMarkdown() if err != nil { log.Fatal(err) } - path := "cli.md" - err = os.WriteFile(path, []byte(doc), 0644) + appFile, err := os.Open(doc) if err != nil { - log.Fatal(err) + fmt.Println(err) + return + } + + defer appFile.Close() + + // create scanner + scanner := bufio.NewScanner(appFile) + + // track header for file and folder creation + var header string + var path string + + // read line + for scanner.Scan() { + line := scanner.Text() + + // directory creation + if strings.HasPrefix(line, "##") { + header = strings.TrimSpace(line[1:]) + path = fmt.Sprintf("/docs/", header) + + error_dir := os.Mkdir("path", 0750) + + // error check + if error_dir != nil { + log.Fatal(error_dir) + } + + // create index file here + headerFile, err := os.Create(header + ".md") + + // error check + if err != nil { + log.Fatal(err) + } + + // index file creation + for (!strings.HasPrefix(line, "**")) { + _, err := headerFile.WriteString(line + "\n") + if err != nil { + fmt.Println(err) + return + } + } + defer headerFile.Close() + + + // create files within directory + // TODO: special case for operator commands + } else if strings.HasPrefix(line, "###") { + header = strings.TrimSpace(line[1:]) + headerFile, err := os.Create(header + ".md") + + // error check + if err != nil { + log.Fatal(err) + } + + // file creation + for (!strings.HasPrefix(line, "**")) { + _, err := headerFile.WriteString(line + "\n") + if err != nil { + fmt.Println(err) + return + } + } + defer headerFile.Close() + + } else { + + } } + + + + + + // all other levels go in that directory + + + + + + + } diff --git a/go.mod b/go.mod index 9bcb0d35..5421c309 100644 --- a/go.mod +++ b/go.mod @@ -22,7 +22,10 @@ require ( google.golang.org/grpc v1.51.0 ) -require cloud.google.com/go/compute/metadata v0.2.1 // indirect +require ( + cloud.google.com/go/compute/metadata v0.2.1 // indirect + github.com/gomarkdown/markdown v0.0.0-20221013030248-663e2500819c // indirect +) require ( cloud.google.com/go v0.105.0 // indirect diff --git a/go.sum b/go.sum index dfa747ee..8430af4b 100644 --- a/go.sum +++ b/go.sum @@ -530,6 +530,8 @@ github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiu github.com/golang/snappy v0.0.3/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= github.com/golang/snappy v0.0.4 h1:yAGX7huGHXlcLOEtBnF4w7FQwA26wojNCwOYAEhLjQM= github.com/golang/snappy v0.0.4/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= +github.com/gomarkdown/markdown v0.0.0-20221013030248-663e2500819c h1:iyaGYbCmcYK0Ja9a3OUa2Fo+EaN0cbLu0eKpBwPFzc8= +github.com/gomarkdown/markdown v0.0.0-20221013030248-663e2500819c/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA= github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= From 32c620969fd8d97d288ad1154b3190f9d5bc5102 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Mon, 9 Jan 2023 16:32:02 -0600 Subject: [PATCH 03/68] moved around some things. committing basics --- cli.md | 2063 ----------------------------------------------- cmd/doc/main.go | 39 +- 2 files changed, 25 insertions(+), 2077 deletions(-) delete mode 100644 cli.md diff --git a/cli.md b/cli.md deleted file mode 100644 index c733fb23..00000000 --- a/cli.md +++ /dev/null @@ -1,2063 +0,0 @@ -# NAME - -temporal - Temporal command-line interface and development server - -# SYNOPSIS - -temporal - -**Usage**: - -``` -temporal [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...] -``` - -# COMMANDS - -## server - -Commands for managing Temporal server - -### start-dev - -Start Temporal development server - -**--config, -c**="": config dir path - -**--db-filename, -f**="": File in which to persist Temporal state - -**--dynamic-config-value**="": dynamic config value, as KEY=JSON_VALUE (meaning strings need quotes) - -**--headless**: disable the temporal web UI - -**--ip**="": IPv4 address to bind the frontend service to instead of localhost (default: 127.0.0.1) - -**--log-format**="": customize the log formatting (allowed: ["json" "pretty"]) (default: json) - -**--log-level**="": customize the log level (allowed: ["debug" "info" "warn" "error" "fatal"]) (default: info) - -**--metrics-port**="": Port for the metrics listener (default: 0) - -**--namespace, -n**="": Specify namespaces that should be pre-created. Namespace 'default' is auto created - -**--port, -p**="": Port for the temporal-frontend GRPC service (default: 7233) - -**--sqlite-pragma**="": specify sqlite pragma statements in pragma=value format (allowed: ["journal_mode" "synchronous"]) - -**--ui-asset-path**="": UI Custom Assets path - -**--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint - -**--ui-ip**="": IPv4 address to bind the web UI to instead of localhost - -**--ui-port**="": port for the temporal web UI (default: 0) - -## workflow - -Operations on Workflows - -### start - -Start a new Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: - ┌───────────── minute (0 - 59) - │ ┌───────────── hour (0 - 23) - │ │ ┌───────────── day of the month (1 - 31) - │ │ │ ┌───────────── month (1 - 12) - │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) - │ │ │ │ │ - * * * * * - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value - -**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Workflow type name - -**--workflow-id, -w**="": Workflow Id - -### execute - -Start a new Workflow Execution and print progress - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: - ┌───────────── minute (0 - 59) - │ ┌───────────── hour (0 - 23) - │ │ ┌───────────── day of the month (1 - 31) - │ │ │ ┌───────────── month (1 - 12) - │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) - │ │ │ │ │ - * * * * * - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value - -**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Workflow type name - -**--workflow-id, -w**="": Workflow Id - -### describe - -Show information about a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--raw**: Print properties as they are stored - -**--reset-points**: Only show auto-reset points - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### list - -List Workflow Executions based on a Query - -**--address**="": host:port for Temporal frontend service - -**--archived**: List archived Workflow Executions (EXPERIMENTAL) - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### show - -Show Event History for a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--follow, -f**: Follow the progress of Workflow Execution - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 500) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--output-filename**="": Serialize history event to a file - -**--pager**="": pager to use: less, more, favoritePager.. - -**--reset-points**: Only show events that are eligible for reset - -**--run-id, -r**="": Run Id - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### query - -Query a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space - -**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": The query type you want to run - -**--workflow-id, -w**="": Workflow Id - -### stack - -Query a Workflow Execution with __stack_trace as the query type - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space - -**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### signal - -Signal Workflow Execution by Id or List Filter - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Input for the signal (JSON) - -**--input-file**="": Input for the signal from file (JSON) - -**--name**="": Signal Name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for signaling with List Filter - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Signal Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### count - -Count Workflow Executions (requires ElasticSearch to be enabled) - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### cancel - -Cancel a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for canceling with List Filter - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Cancel Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### terminate - -Terminate Workflow Execution by Id or List Filter - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for termination - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Terminate Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### delete - -Delete a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### reset - -Reset a Workflow Execution by event Id or reset type - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--event-id**="": The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) - -**--reason**="": Reason to reset - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask - -**--workflow-id, -w**="": Workflow Id - -### reset-batch - -Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--dry-run**: Simulate reset without resetting any Workflow Executions - -**--env**="": Env name to read the client environment variables from (default: default) - -**--exclude-file**="": Input file that specifies Workflow Executions to exclude from resetting - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input-file**="": Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id - -**--input-parallelism**="": Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) - -**--input-separator**="": Separator for the input file. The default is a tab ( ) (default: ) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--non-deterministic**: Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error - -**--query, -q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query - -**--reason**="": Reason for resetting the Workflow Executions - -**--skip-base-is-not-current**: Skip a Workflow Execution if the base Run is not the current Run - -**--skip-current-open**: Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask - -### trace - -Trace progress of a Workflow Execution and its children - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--concurrency**="": Request concurrency (default: 10) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--depth**="": Number of child workflows to expand, -1 to expand all child workflows (default: -1) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fold**="": Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-fold**: Disable folding. All child workflows within the set depth will be fetched and displayed - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -## activity - -Operations on Activities of Workflows - -### complete - -Complete an activity - -**--activity-id**="": The Activity Id to complete - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--identity**="": Specify operator's identity - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--result**="": Set the result value of completion - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### fail - -Fail an activity - -**--activity-id**="": The Activity Id to fail - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--detail**="": Detail to fail the Activity - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--identity**="": Specify operator's identity - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reason**="": Reason to fail the Activity - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -## task-queue - -Operations on Task Queues - -### describe - -Describe the Workers that have recently polled on this Task Queue - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--task-queue, -t**="": Task Queue name - -**--task-queue-type**="": Task Queue type [workflow|activity] (default: workflow) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list-partition - -List the Task Queue's partitions and which matching node they are assigned to - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--task-queue, -t**="": Task Queue name - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## schedule - -Operations on Schedules - -### create - -Create a new schedule - -**--address**="": host:port for Temporal frontend service - -**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} - -**--catchup-window**="": Maximum allowed catch-up time if server is down - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" - -**--end-time**="": Overall schedule end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset - -**--jitter**="": Jitter duration - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value - -**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--notes**="": Initial value of notes field - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--pause**: Initial value of paused state - -**--pause-on-failure**: Pause schedule after any workflow failure - -**--remaining-actions**="": Total number of actions allowed (default: 0) - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--schedule-id, -s**="": Schedule Id - -**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value - -**--start-time**="": Overall schedule start time - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-zone**="": Time zone (IANA name) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -**--workflow-type**="": Workflow type name - -### update - -Updates a schedule with a new definition (full replacement, not patch) - -**--address**="": host:port for Temporal frontend service - -**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} - -**--catchup-window**="": Maximum allowed catch-up time if server is down - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" - -**--end-time**="": Overall schedule end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset - -**--jitter**="": Jitter duration - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value - -**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--notes**="": Initial value of notes field - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--pause**: Initial value of paused state - -**--pause-on-failure**: Pause schedule after any workflow failure - -**--remaining-actions**="": Total number of actions allowed (default: 0) - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--schedule-id, -s**="": Schedule Id - -**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value - -**--start-time**="": Overall schedule start time - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-zone**="": Time zone (IANA name) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -**--workflow-type**="": Workflow type name - -### toggle - -Pauses or unpauses a schedule - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--pause**: Pauses the schedule - -**--reason**="": Free-form text to describe reason for pause/unpause (default: (no reason provided)) - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--unpause**: Unpauses the schedule - -### trigger - -Triggers an immediate action - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### backfill - -Backfills a past time range of actions - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--end-time**="": Backfill end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--schedule-id, -s**="": Schedule Id - -**--start-time**="": Backfill start time - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### describe - -Get schedule configuration and current state - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--raw**: Print raw data as json (prefer this over -o json for scripting) - -**--schedule-id, -s**="": Schedule Id - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### delete - -Deletes a schedule - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list - -Lists schedules - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## batch - -Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs - -### describe - -Describe a batch operation job - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--job-id**="": Batch Job Id - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list - -List batch operation jobs - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### terminate - -Stop a batch operation job - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--job-id**="": Batch Job Id - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reason**="": Reason to stop the batch job - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## operator - -Operation on Temporal server - -### namespace - -Operations on namespaces - -#### describe - -Describe a Namespace by name or Id - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--namespace-id**="": Namespace Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### list - -List all Namespaces - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### register - -Register a new Namespace - -**--active-cluster**="": Active cluster name - -**--address**="": host:port for Temporal frontend service - -**--cluster**="": Cluster name - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--data**="": Namespace data in a format key=value - -**--description**="": Namespace description - -**--email**="": Owner email - -**--env**="": Env name to read the client environment variables from (default: default) - -**--global**="": Flag to indicate whether namespace is a global namespace - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" - -**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--retention**="": Workflow Execution retention - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" - -**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) - -#### update - -Update a Namespace - -**--active-cluster**="": Active cluster name - -**--address**="": host:port for Temporal frontend service - -**--cluster**="": Cluster name - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--data**="": Namespace data in a format key=value - -**--description**="": Namespace description - -**--email**="": Owner email - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" - -**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--promote-global**: Promote local namespace to global namespace - -**--reason**="": Reason for the operation - -**--retention**="": Workflow Execution retention - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" - -**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) - -#### delete - -Delete existing Namespace - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--yes, -y**: Confirm all prompts - -### search-attribute - -Operations on search attributes - -#### create - -Add custom search attributes - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Search attribute name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] - -**--yes, -y**: Confirm all prompts - -#### list - -List search attributes that can be used in list workflow query - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### remove - -Remove custom search attributes metadata only (Elasticsearch index schema is not modified) - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Search attribute name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--yes, -y**: Confirm all prompts - -### cluster - -Operations on a Temporal cluster - -#### health - -Check health of frontend service - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### describe - -Show information about the cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### system - -Show information about the system and capabilities - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### upsert - -Add or update a remote cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--enable-connection**: Enable cross cluster connection - -**--env**="": Env name to read the client environment variables from (default: default) - -**--frontend-address**="": Frontend address of the remote cluster - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### list - -List all remote clusters - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### remove - -Remove a remote cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Frontend address of the remote cluster - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## env - -Manage client environment configurations - -### get - -Print environment properties - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### set - -Set environment property - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### delete - -Delete environment or environment property - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## completion - -Output shell completion code for the specified shell (zsh, bash) - -### bash - -bash completion output - -### zsh - -zsh completion output diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 926f94e5..77027de8 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -29,7 +29,7 @@ import ( "fmt" "log" "os" - "strings" + "time" "github.com/temporalio/cli/app" ) @@ -38,31 +38,38 @@ import ( // todo: create separate files and folders. // todo: elaborate on each file func main() { + // build app and convert to Markdown doc, err := app.BuildApp("").ToMarkdown() if err != nil { log.Fatal(err) } - - appFile, err := os.Open(doc) + path := "cli.md" + err = os.WriteFile(path, []byte(doc), 0644) if err != nil { fmt.Println(err) - return } - defer appFile.Close() + // open file for scanner + readFile, err := os.Open(path) + if err != nil { + fmt.Println(err) + } // create scanner - scanner := bufio.NewScanner(appFile) + scanner := bufio.NewScanner(readFile) + scanner.Split(bufio.ScanLines) - // track header for file and folder creation - var header string - var path string + // track header for file and folder creation + //var header string + //var path string // read line for scanner.Scan() { line := scanner.Text() + fmt.Println(line) + time.Sleep(2 * time.Millisecond) - // directory creation + /*// directory creation if strings.HasPrefix(line, "##") { header = strings.TrimSpace(line[1:]) path = fmt.Sprintf("/docs/", header) @@ -116,19 +123,23 @@ func main() { } else { - } + }*/ } + //close and remove big file + readFile.Close() + e := os.Remove("cli.md") + if err != nil { + log.Fatal(e) + } - // all other levels go in that directory - + } -} From 7473f364e35454987a1cfde42a6b6e2e38bc9d37 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Mon, 9 Jan 2023 16:42:13 -0600 Subject: [PATCH 04/68] framework is there. --- cmd/doc/main.go | 31 ++++++++++++------------------- 1 file changed, 12 insertions(+), 19 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 77027de8..6d2175d0 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -29,7 +29,7 @@ import ( "fmt" "log" "os" - "time" + "strings" "github.com/temporalio/cli/app" ) @@ -61,20 +61,19 @@ func main() { // track header for file and folder creation - //var header string - //var path string + var header string + // read line for scanner.Scan() { line := scanner.Text() - fmt.Println(line) - time.Sleep(2 * time.Millisecond) - - /*// directory creation - if strings.HasPrefix(line, "##") { - header = strings.TrimSpace(line[1:]) - path = fmt.Sprintf("/docs/", header) + + // directory creation + if strings.HasPrefix(line, "## ") { + header = strings.TrimSpace(line[2:]) + path = "/docs/" + header - error_dir := os.Mkdir("path", 0750) + fmt.Println(path) + /*error_dir := os.Mkdir("path", 0750) // error check if error_dir != nil { @@ -134,12 +133,6 @@ func main() { if err != nil { log.Fatal(e) } +} - - - - - - - } - +} \ No newline at end of file From 4cf033763e91d39f0e23b004c656ef484d3641b4 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Mon, 9 Jan 2023 17:05:02 -0600 Subject: [PATCH 05/68] simulate creating folders --- cli.md | 2063 +++++++++++++++++++++++++++++++++++++++++++++++ cmd/doc/main.go | 52 +- 2 files changed, 2091 insertions(+), 24 deletions(-) create mode 100644 cli.md diff --git a/cli.md b/cli.md new file mode 100644 index 00000000..3e370b5f --- /dev/null +++ b/cli.md @@ -0,0 +1,2063 @@ +# NAME + +temporal - Temporal command-line interface and development server + +# SYNOPSIS + +temporal + +**Usage**: + +``` +temporal [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...] +``` + +# COMMANDS + +## server + +Commands for managing Temporal server + +### start-dev + +Start Temporal development server + +**--config, -c**="": config dir path + +**--db-filename, -f**="": File in which to persist Temporal state + +**--dynamic-config-value**="": dynamic config value, as KEY=JSON_VALUE (meaning strings need quotes) + +**--headless**: disable the temporal web UI + +**--ip**="": IPv4 address to bind the frontend service to instead of localhost (default: 127.0.0.1) + +**--log-format**="": customize the log formatting (allowed: ["json" "pretty"]) (default: json) + +**--log-level**="": customize the log level (allowed: ["debug" "info" "warn" "error" "fatal"]) (default: info) + +**--metrics-port**="": Port for the metrics listener (default: 0) + +**--namespace, -n**="": Specify namespaces that should be pre-created. Namespace 'default' is auto created + +**--port, -p**="": Port for the temporal-frontend GRPC service (default: 7233) + +**--sqlite-pragma**="": specify sqlite pragma statements in pragma=value format (allowed: ["journal_mode" "synchronous"]) + +**--ui-asset-path**="": UI Custom Assets path + +**--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint + +**--ui-ip**="": IPv4 address to bind the web UI to instead of localhost + +**--ui-port**="": port for the temporal web UI (default: 0) + +## workflow + +Operations on Workflows + +### start + +Start a new Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of the month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) + │ │ │ │ │ + * * * * * + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value + +**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Workflow type name + +**--workflow-id, -w**="": Workflow Id + +### execute + +Start a new Workflow Execution and print progress + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of the month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) + │ │ │ │ │ + * * * * * + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value + +**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Workflow type name + +**--workflow-id, -w**="": Workflow Id + +### describe + +Show information about a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--raw**: Print properties as they are stored + +**--reset-points**: Only show auto-reset points + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### list + +List Workflow Executions based on a Query + +**--address**="": host:port for Temporal frontend service + +**--archived**: List archived Workflow Executions (EXPERIMENTAL) + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### show + +Show Event History for a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--follow, -f**: Follow the progress of Workflow Execution + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 500) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--output-filename**="": Serialize history event to a file + +**--pager**="": pager to use: less, more, favoritePager.. + +**--reset-points**: Only show events that are eligible for reset + +**--run-id, -r**="": Run Id + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### query + +Query a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space + +**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": The query type you want to run + +**--workflow-id, -w**="": Workflow Id + +### stack + +Query a Workflow Execution with __stack_trace as the query type + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space + +**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### signal + +Signal Workflow Execution by Id or List Filter + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Input for the signal (JSON) + +**--input-file**="": Input for the signal from file (JSON) + +**--name**="": Signal Name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for signaling with List Filter + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Signal Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### count + +Count Workflow Executions (requires ElasticSearch to be enabled) + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### cancel + +Cancel a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for canceling with List Filter + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Cancel Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### terminate + +Terminate Workflow Execution by Id or List Filter + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for termination + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Terminate Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### delete + +Delete a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### reset + +Reset a Workflow Execution by event Id or reset type + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--event-id**="": The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) + +**--reason**="": Reason to reset + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew + +**--workflow-id, -w**="": Workflow Id + +### reset-batch + +Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--dry-run**: Simulate reset without resetting any Workflow Executions + +**--env**="": Env name to read the client environment variables from (default: default) + +**--exclude-file**="": Input file that specifies Workflow Executions to exclude from resetting + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input-file**="": Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id + +**--input-parallelism**="": Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) + +**--input-separator**="": Separator for the input file. The default is a tab ( ) (default: ) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--non-deterministic**: Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error + +**--query, -q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query + +**--reason**="": Reason for resetting the Workflow Executions + +**--skip-base-is-not-current**: Skip a Workflow Execution if the base Run is not the current Run + +**--skip-current-open**: Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew + +### trace + +Trace progress of a Workflow Execution and its children + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--concurrency**="": Request concurrency (default: 10) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--depth**="": Number of child workflows to expand, -1 to expand all child workflows (default: -1) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fold**="": Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-fold**: Disable folding. All child workflows within the set depth will be fetched and displayed + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +## activity + +Operations on Activities of Workflows + +### complete + +Complete an activity + +**--activity-id**="": The Activity Id to complete + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--identity**="": Specify operator's identity + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--result**="": Set the result value of completion + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### fail + +Fail an activity + +**--activity-id**="": The Activity Id to fail + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--detail**="": Detail to fail the Activity + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--identity**="": Specify operator's identity + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reason**="": Reason to fail the Activity + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +## task-queue + +Operations on Task Queues + +### describe + +Describe the Workers that have recently polled on this Task Queue + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--task-queue, -t**="": Task Queue name + +**--task-queue-type**="": Task Queue type [workflow|activity] (default: workflow) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list-partition + +List the Task Queue's partitions and which matching node they are assigned to + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--task-queue, -t**="": Task Queue name + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## schedule + +Operations on Schedules + +### create + +Create a new schedule + +**--address**="": host:port for Temporal frontend service + +**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} + +**--catchup-window**="": Maximum allowed catch-up time if server is down + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + +**--end-time**="": Overall schedule end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset + +**--jitter**="": Jitter duration + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + +**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--notes**="": Initial value of notes field + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--pause**: Initial value of paused state + +**--pause-on-failure**: Pause schedule after any workflow failure + +**--remaining-actions**="": Total number of actions allowed (default: 0) + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--schedule-id, -s**="": Schedule Id + +**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + +**--start-time**="": Overall schedule start time + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-zone**="": Time zone (IANA name) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +**--workflow-type**="": Workflow type name + +### update + +Updates a schedule with a new definition (full replacement, not patch) + +**--address**="": host:port for Temporal frontend service + +**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} + +**--catchup-window**="": Maximum allowed catch-up time if server is down + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + +**--end-time**="": Overall schedule end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset + +**--jitter**="": Jitter duration + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + +**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--notes**="": Initial value of notes field + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--pause**: Initial value of paused state + +**--pause-on-failure**: Pause schedule after any workflow failure + +**--remaining-actions**="": Total number of actions allowed (default: 0) + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--schedule-id, -s**="": Schedule Id + +**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + +**--start-time**="": Overall schedule start time + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-zone**="": Time zone (IANA name) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +**--workflow-type**="": Workflow type name + +### toggle + +Pauses or unpauses a schedule + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--pause**: Pauses the schedule + +**--reason**="": Free-form text to describe reason for pause/unpause (default: (no reason provided)) + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--unpause**: Unpauses the schedule + +### trigger + +Triggers an immediate action + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### backfill + +Backfills a past time range of actions + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--end-time**="": Backfill end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--schedule-id, -s**="": Schedule Id + +**--start-time**="": Backfill start time + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### describe + +Get schedule configuration and current state + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--raw**: Print raw data as json (prefer this over -o json for scripting) + +**--schedule-id, -s**="": Schedule Id + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### delete + +Deletes a schedule + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list + +Lists schedules + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## batch + +Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs + +### describe + +Describe a batch operation job + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--job-id**="": Batch Job Id + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list + +List batch operation jobs + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### terminate + +Stop a batch operation job + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--job-id**="": Batch Job Id + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reason**="": Reason to stop the batch job + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## operator + +Operation on Temporal server + +### namespace + +Operations on namespaces + +#### describe + +Describe a Namespace by name or Id + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--namespace-id**="": Namespace Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### list + +List all Namespaces + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### register + +Register a new Namespace + +**--active-cluster**="": Active cluster name + +**--address**="": host:port for Temporal frontend service + +**--cluster**="": Cluster name + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--data**="": Namespace data in a format key=value + +**--description**="": Namespace description + +**--email**="": Owner email + +**--env**="": Env name to read the client environment variables from (default: default) + +**--global**="": Flag to indicate whether namespace is a global namespace + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--retention**="": Workflow Execution retention + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + +#### update + +Update a Namespace + +**--active-cluster**="": Active cluster name + +**--address**="": host:port for Temporal frontend service + +**--cluster**="": Cluster name + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--data**="": Namespace data in a format key=value + +**--description**="": Namespace description + +**--email**="": Owner email + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--promote-global**: Promote local namespace to global namespace + +**--reason**="": Reason for the operation + +**--retention**="": Workflow Execution retention + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + +#### delete + +Delete existing Namespace + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--yes, -y**: Confirm all prompts + +### search-attribute + +Operations on search attributes + +#### create + +Add custom search attributes + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Search attribute name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] + +**--yes, -y**: Confirm all prompts + +#### list + +List search attributes that can be used in list workflow query + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### remove + +Remove custom search attributes metadata only (Elasticsearch index schema is not modified) + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Search attribute name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--yes, -y**: Confirm all prompts + +### cluster + +Operations on a Temporal cluster + +#### health + +Check health of frontend service + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### describe + +Show information about the cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### system + +Show information about the system and capabilities + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### upsert + +Add or update a remote cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--enable-connection**: Enable cross cluster connection + +**--env**="": Env name to read the client environment variables from (default: default) + +**--frontend-address**="": Frontend address of the remote cluster + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### list + +List all remote clusters + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### remove + +Remove a remote cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Frontend address of the remote cluster + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## env + +Manage client environment configurations + +### get + +Print environment properties + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### set + +Set environment property + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### delete + +Delete environment or environment property + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## completion + +Output shell completion code for the specified shell (zsh, bash) + +### bash + +bash completion output + +### zsh + +zsh completion output diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 6d2175d0..60cbc03b 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -40,20 +40,15 @@ import ( func main() { // build app and convert to Markdown doc, err := app.BuildApp("").ToMarkdown() - if err != nil { - log.Fatal(err) - } + fatal_check(err) + path := "cli.md" err = os.WriteFile(path, []byte(doc), 0644) - if err != nil { - fmt.Println(err) - } + print_check(err) // open file for scanner readFile, err := os.Open(path) - if err != nil { - fmt.Println(err) - } + print_check(err) // create scanner scanner := bufio.NewScanner(readFile) @@ -70,17 +65,15 @@ func main() { // directory creation if strings.HasPrefix(line, "## ") { header = strings.TrimSpace(line[2:]) - path = "/docs/" + header + path_docs := "/docs/" + header + + fmt.Println(path_docs) + + //err := os.MkdirAll(path_docs, os.ModePerm) + //print_check(err) - fmt.Println(path) - /*error_dir := os.Mkdir("path", 0750) - - // error check - if error_dir != nil { - log.Fatal(error_dir) - } - // create index file here + /*// create index file here headerFile, err := os.Create(header + ".md") // error check @@ -119,20 +112,31 @@ func main() { } } defer headerFile.Close() - - } else { - - }*/ +*/ + } else { + continue + } } //close and remove big file readFile.Close() - e := os.Remove("cli.md") - if err != nil { + //e := os.Remove("cli.md") + //fatal_check(e) +} + + + +func fatal_check(e error) { + if e != nil { log.Fatal(e) } + } +func print_check(e error) { + if e != nil { + log.Println(e) + } } \ No newline at end of file From 474228f3bbc5c42955edafe7ab7f803d60ac265d Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Mon, 9 Jan 2023 17:06:11 -0600 Subject: [PATCH 06/68] final commit for today. --- cli.md | 2063 ----------------------------------------------- cmd/doc/main.go | 6 +- 2 files changed, 3 insertions(+), 2066 deletions(-) delete mode 100644 cli.md diff --git a/cli.md b/cli.md deleted file mode 100644 index 3e370b5f..00000000 --- a/cli.md +++ /dev/null @@ -1,2063 +0,0 @@ -# NAME - -temporal - Temporal command-line interface and development server - -# SYNOPSIS - -temporal - -**Usage**: - -``` -temporal [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...] -``` - -# COMMANDS - -## server - -Commands for managing Temporal server - -### start-dev - -Start Temporal development server - -**--config, -c**="": config dir path - -**--db-filename, -f**="": File in which to persist Temporal state - -**--dynamic-config-value**="": dynamic config value, as KEY=JSON_VALUE (meaning strings need quotes) - -**--headless**: disable the temporal web UI - -**--ip**="": IPv4 address to bind the frontend service to instead of localhost (default: 127.0.0.1) - -**--log-format**="": customize the log formatting (allowed: ["json" "pretty"]) (default: json) - -**--log-level**="": customize the log level (allowed: ["debug" "info" "warn" "error" "fatal"]) (default: info) - -**--metrics-port**="": Port for the metrics listener (default: 0) - -**--namespace, -n**="": Specify namespaces that should be pre-created. Namespace 'default' is auto created - -**--port, -p**="": Port for the temporal-frontend GRPC service (default: 7233) - -**--sqlite-pragma**="": specify sqlite pragma statements in pragma=value format (allowed: ["journal_mode" "synchronous"]) - -**--ui-asset-path**="": UI Custom Assets path - -**--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint - -**--ui-ip**="": IPv4 address to bind the web UI to instead of localhost - -**--ui-port**="": port for the temporal web UI (default: 0) - -## workflow - -Operations on Workflows - -### start - -Start a new Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: - ┌───────────── minute (0 - 59) - │ ┌───────────── hour (0 - 23) - │ │ ┌───────────── day of the month (1 - 31) - │ │ │ ┌───────────── month (1 - 12) - │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) - │ │ │ │ │ - * * * * * - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value - -**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Workflow type name - -**--workflow-id, -w**="": Workflow Id - -### execute - -Start a new Workflow Execution and print progress - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: - ┌───────────── minute (0 - 59) - │ ┌───────────── hour (0 - 23) - │ │ ┌───────────── day of the month (1 - 31) - │ │ │ ┌───────────── month (1 - 12) - │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) - │ │ │ │ │ - * * * * * - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value - -**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Workflow type name - -**--workflow-id, -w**="": Workflow Id - -### describe - -Show information about a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--raw**: Print properties as they are stored - -**--reset-points**: Only show auto-reset points - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### list - -List Workflow Executions based on a Query - -**--address**="": host:port for Temporal frontend service - -**--archived**: List archived Workflow Executions (EXPERIMENTAL) - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### show - -Show Event History for a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--follow, -f**: Follow the progress of Workflow Execution - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 500) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--output-filename**="": Serialize history event to a file - -**--pager**="": pager to use: less, more, favoritePager.. - -**--reset-points**: Only show events that are eligible for reset - -**--run-id, -r**="": Run Id - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### query - -Query a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space - -**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": The query type you want to run - -**--workflow-id, -w**="": Workflow Id - -### stack - -Query a Workflow Execution with __stack_trace as the query type - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space - -**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### signal - -Signal Workflow Execution by Id or List Filter - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Input for the signal (JSON) - -**--input-file**="": Input for the signal from file (JSON) - -**--name**="": Signal Name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for signaling with List Filter - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Signal Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### count - -Count Workflow Executions (requires ElasticSearch to be enabled) - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### cancel - -Cancel a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for canceling with List Filter - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Cancel Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### terminate - -Terminate Workflow Execution by Id or List Filter - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for termination - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Terminate Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### delete - -Delete a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### reset - -Reset a Workflow Execution by event Id or reset type - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--event-id**="": The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) - -**--reason**="": Reason to reset - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew - -**--workflow-id, -w**="": Workflow Id - -### reset-batch - -Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--dry-run**: Simulate reset without resetting any Workflow Executions - -**--env**="": Env name to read the client environment variables from (default: default) - -**--exclude-file**="": Input file that specifies Workflow Executions to exclude from resetting - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input-file**="": Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id - -**--input-parallelism**="": Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) - -**--input-separator**="": Separator for the input file. The default is a tab ( ) (default: ) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--non-deterministic**: Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error - -**--query, -q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query - -**--reason**="": Reason for resetting the Workflow Executions - -**--skip-base-is-not-current**: Skip a Workflow Execution if the base Run is not the current Run - -**--skip-current-open**: Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew - -### trace - -Trace progress of a Workflow Execution and its children - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--concurrency**="": Request concurrency (default: 10) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--depth**="": Number of child workflows to expand, -1 to expand all child workflows (default: -1) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fold**="": Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-fold**: Disable folding. All child workflows within the set depth will be fetched and displayed - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -## activity - -Operations on Activities of Workflows - -### complete - -Complete an activity - -**--activity-id**="": The Activity Id to complete - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--identity**="": Specify operator's identity - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--result**="": Set the result value of completion - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### fail - -Fail an activity - -**--activity-id**="": The Activity Id to fail - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--detail**="": Detail to fail the Activity - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--identity**="": Specify operator's identity - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reason**="": Reason to fail the Activity - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -## task-queue - -Operations on Task Queues - -### describe - -Describe the Workers that have recently polled on this Task Queue - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--task-queue, -t**="": Task Queue name - -**--task-queue-type**="": Task Queue type [workflow|activity] (default: workflow) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list-partition - -List the Task Queue's partitions and which matching node they are assigned to - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--task-queue, -t**="": Task Queue name - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## schedule - -Operations on Schedules - -### create - -Create a new schedule - -**--address**="": host:port for Temporal frontend service - -**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} - -**--catchup-window**="": Maximum allowed catch-up time if server is down - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" - -**--end-time**="": Overall schedule end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset - -**--jitter**="": Jitter duration - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value - -**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--notes**="": Initial value of notes field - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--pause**: Initial value of paused state - -**--pause-on-failure**: Pause schedule after any workflow failure - -**--remaining-actions**="": Total number of actions allowed (default: 0) - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--schedule-id, -s**="": Schedule Id - -**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value - -**--start-time**="": Overall schedule start time - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-zone**="": Time zone (IANA name) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -**--workflow-type**="": Workflow type name - -### update - -Updates a schedule with a new definition (full replacement, not patch) - -**--address**="": host:port for Temporal frontend service - -**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} - -**--catchup-window**="": Maximum allowed catch-up time if server is down - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" - -**--end-time**="": Overall schedule end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset - -**--jitter**="": Jitter duration - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value - -**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--notes**="": Initial value of notes field - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--pause**: Initial value of paused state - -**--pause-on-failure**: Pause schedule after any workflow failure - -**--remaining-actions**="": Total number of actions allowed (default: 0) - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--schedule-id, -s**="": Schedule Id - -**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value - -**--start-time**="": Overall schedule start time - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-zone**="": Time zone (IANA name) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -**--workflow-type**="": Workflow type name - -### toggle - -Pauses or unpauses a schedule - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--pause**: Pauses the schedule - -**--reason**="": Free-form text to describe reason for pause/unpause (default: (no reason provided)) - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--unpause**: Unpauses the schedule - -### trigger - -Triggers an immediate action - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### backfill - -Backfills a past time range of actions - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--end-time**="": Backfill end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--schedule-id, -s**="": Schedule Id - -**--start-time**="": Backfill start time - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### describe - -Get schedule configuration and current state - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--raw**: Print raw data as json (prefer this over -o json for scripting) - -**--schedule-id, -s**="": Schedule Id - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### delete - -Deletes a schedule - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list - -Lists schedules - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## batch - -Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs - -### describe - -Describe a batch operation job - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--job-id**="": Batch Job Id - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list - -List batch operation jobs - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### terminate - -Stop a batch operation job - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--job-id**="": Batch Job Id - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reason**="": Reason to stop the batch job - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## operator - -Operation on Temporal server - -### namespace - -Operations on namespaces - -#### describe - -Describe a Namespace by name or Id - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--namespace-id**="": Namespace Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### list - -List all Namespaces - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### register - -Register a new Namespace - -**--active-cluster**="": Active cluster name - -**--address**="": host:port for Temporal frontend service - -**--cluster**="": Cluster name - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--data**="": Namespace data in a format key=value - -**--description**="": Namespace description - -**--email**="": Owner email - -**--env**="": Env name to read the client environment variables from (default: default) - -**--global**="": Flag to indicate whether namespace is a global namespace - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" - -**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--retention**="": Workflow Execution retention - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" - -**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) - -#### update - -Update a Namespace - -**--active-cluster**="": Active cluster name - -**--address**="": host:port for Temporal frontend service - -**--cluster**="": Cluster name - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--data**="": Namespace data in a format key=value - -**--description**="": Namespace description - -**--email**="": Owner email - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" - -**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--promote-global**: Promote local namespace to global namespace - -**--reason**="": Reason for the operation - -**--retention**="": Workflow Execution retention - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" - -**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) - -#### delete - -Delete existing Namespace - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--yes, -y**: Confirm all prompts - -### search-attribute - -Operations on search attributes - -#### create - -Add custom search attributes - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Search attribute name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] - -**--yes, -y**: Confirm all prompts - -#### list - -List search attributes that can be used in list workflow query - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### remove - -Remove custom search attributes metadata only (Elasticsearch index schema is not modified) - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Search attribute name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--yes, -y**: Confirm all prompts - -### cluster - -Operations on a Temporal cluster - -#### health - -Check health of frontend service - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### describe - -Show information about the cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### system - -Show information about the system and capabilities - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### upsert - -Add or update a remote cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--enable-connection**: Enable cross cluster connection - -**--env**="": Env name to read the client environment variables from (default: default) - -**--frontend-address**="": Frontend address of the remote cluster - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### list - -List all remote clusters - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### remove - -Remove a remote cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Frontend address of the remote cluster - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## env - -Manage client environment configurations - -### get - -Print environment properties - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### set - -Set environment property - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### delete - -Delete environment or environment property - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## completion - -Output shell completion code for the specified shell (zsh, bash) - -### bash - -bash completion output - -### zsh - -zsh completion output diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 60cbc03b..7f247789 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -122,12 +122,12 @@ func main() { //close and remove big file readFile.Close() - //e := os.Remove("cli.md") - //fatal_check(e) + e := os.Remove("cli.md") + fatal_check(e) } - +// I got sick of putting these code blocks everywhere, so now they're functions. func fatal_check(e error) { if e != nil { log.Fatal(e) From 2abf4a2d735f4bf6e16ae5f994a9eff03cf2814a Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 10:15:01 -0600 Subject: [PATCH 07/68] trying out directory creation --- cmd/doc/main.go | 51 ++++++++++++++++++++----------------------------- 1 file changed, 21 insertions(+), 30 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 7f247789..4e50b314 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -26,7 +26,6 @@ package main import ( "bufio" - "fmt" "log" "os" "strings" @@ -34,7 +33,6 @@ import ( "github.com/temporalio/cli/app" ) -// currently writes to one big file. // todo: create separate files and folders. // todo: elaborate on each file func main() { @@ -57,44 +55,38 @@ func main() { // track header for file and folder creation var header string + var headerFile *os.File // read line for scanner.Scan() { line := scanner.Text() - // directory creation if strings.HasPrefix(line, "## ") { header = strings.TrimSpace(line[2:]) - path_docs := "/docs/" + header + path_docs := "docs/" + header + //fmt.Println(path_docs) - fmt.Println(path_docs) + err := os.MkdirAll(path_docs, os.ModePerm) + print_check(err) - //err := os.MkdirAll(path_docs, os.ModePerm) - //print_check(err) + // create index file here + headerFile, err = os.Create(header + ".md") + print_check(err) - /*// create index file here - headerFile, err := os.Create(header + ".md") - - // error check - if err != nil { - log.Fatal(err) - } + } else if strings.HasPrefix(line, "### "){ + header = strings.TrimSpace(line[3:]) + headerFile, err = os.Create(header + ".md") + print_check(err) - // index file creation - for (!strings.HasPrefix(line, "**")) { - _, err := headerFile.WriteString(line + "\n") - if err != nil { - fmt.Println(err) - return - } - } - defer headerFile.Close() + } else { + continue + } - // create files within directory + /*// create files within directory // TODO: special case for operator commands - } else if strings.HasPrefix(line, "###") { + } else { header = strings.TrimSpace(line[1:]) headerFile, err := os.Create(header + ".md") @@ -112,11 +104,9 @@ func main() { } } defer headerFile.Close() -*/ - } else { - continue - } - } + + */ + //close and remove big file @@ -125,6 +115,7 @@ func main() { e := os.Remove("cli.md") fatal_check(e) } +} // I got sick of putting these code blocks everywhere, so now they're functions. From 8de34823c139b4e99a1af94d3c532ee2900d82d6 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 10:19:43 -0600 Subject: [PATCH 08/68] folders created. now for files --- cli.md | 2063 +++++++++++++++++++++++++++++++++++++++++++++++ cmd/doc/main.go | 25 +- 2 files changed, 2073 insertions(+), 15 deletions(-) create mode 100644 cli.md diff --git a/cli.md b/cli.md new file mode 100644 index 00000000..a2133a6e --- /dev/null +++ b/cli.md @@ -0,0 +1,2063 @@ +# NAME + +temporal - Temporal command-line interface and development server + +# SYNOPSIS + +temporal + +**Usage**: + +``` +temporal [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...] +``` + +# COMMANDS + +## server + +Commands for managing Temporal server + +### start-dev + +Start Temporal development server + +**--config, -c**="": config dir path + +**--db-filename, -f**="": File in which to persist Temporal state + +**--dynamic-config-value**="": dynamic config value, as KEY=JSON_VALUE (meaning strings need quotes) + +**--headless**: disable the temporal web UI + +**--ip**="": IPv4 address to bind the frontend service to instead of localhost (default: 127.0.0.1) + +**--log-format**="": customize the log formatting (allowed: ["json" "pretty"]) (default: json) + +**--log-level**="": customize the log level (allowed: ["debug" "info" "warn" "error" "fatal"]) (default: info) + +**--metrics-port**="": Port for the metrics listener (default: 0) + +**--namespace, -n**="": Specify namespaces that should be pre-created. Namespace 'default' is auto created + +**--port, -p**="": Port for the temporal-frontend GRPC service (default: 7233) + +**--sqlite-pragma**="": specify sqlite pragma statements in pragma=value format (allowed: ["journal_mode" "synchronous"]) + +**--ui-asset-path**="": UI Custom Assets path + +**--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint + +**--ui-ip**="": IPv4 address to bind the web UI to instead of localhost + +**--ui-port**="": port for the temporal web UI (default: 0) + +## workflow + +Operations on Workflows + +### start + +Start a new Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of the month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) + │ │ │ │ │ + * * * * * + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value + +**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Workflow type name + +**--workflow-id, -w**="": Workflow Id + +### execute + +Start a new Workflow Execution and print progress + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of the month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) + │ │ │ │ │ + * * * * * + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value + +**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Workflow type name + +**--workflow-id, -w**="": Workflow Id + +### describe + +Show information about a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--raw**: Print properties as they are stored + +**--reset-points**: Only show auto-reset points + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### list + +List Workflow Executions based on a Query + +**--address**="": host:port for Temporal frontend service + +**--archived**: List archived Workflow Executions (EXPERIMENTAL) + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### show + +Show Event History for a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--follow, -f**: Follow the progress of Workflow Execution + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 500) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--output-filename**="": Serialize history event to a file + +**--pager**="": pager to use: less, more, favoritePager.. + +**--reset-points**: Only show events that are eligible for reset + +**--run-id, -r**="": Run Id + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### query + +Query a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space + +**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": The query type you want to run + +**--workflow-id, -w**="": Workflow Id + +### stack + +Query a Workflow Execution with __stack_trace as the query type + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space + +**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### signal + +Signal Workflow Execution by Id or List Filter + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Input for the signal (JSON) + +**--input-file**="": Input for the signal from file (JSON) + +**--name**="": Signal Name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for signaling with List Filter + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Signal Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### count + +Count Workflow Executions (requires ElasticSearch to be enabled) + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### cancel + +Cancel a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for canceling with List Filter + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Cancel Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### terminate + +Terminate Workflow Execution by Id or List Filter + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for termination + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Terminate Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### delete + +Delete a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### reset + +Reset a Workflow Execution by event Id or reset type + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--event-id**="": The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) + +**--reason**="": Reason to reset + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew + +**--workflow-id, -w**="": Workflow Id + +### reset-batch + +Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--dry-run**: Simulate reset without resetting any Workflow Executions + +**--env**="": Env name to read the client environment variables from (default: default) + +**--exclude-file**="": Input file that specifies Workflow Executions to exclude from resetting + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input-file**="": Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id + +**--input-parallelism**="": Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) + +**--input-separator**="": Separator for the input file. The default is a tab ( ) (default: ) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--non-deterministic**: Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error + +**--query, -q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query + +**--reason**="": Reason for resetting the Workflow Executions + +**--skip-base-is-not-current**: Skip a Workflow Execution if the base Run is not the current Run + +**--skip-current-open**: Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask + +### trace + +Trace progress of a Workflow Execution and its children + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--concurrency**="": Request concurrency (default: 10) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--depth**="": Number of child workflows to expand, -1 to expand all child workflows (default: -1) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fold**="": Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-fold**: Disable folding. All child workflows within the set depth will be fetched and displayed + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +## activity + +Operations on Activities of Workflows + +### complete + +Complete an activity + +**--activity-id**="": The Activity Id to complete + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--identity**="": Specify operator's identity + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--result**="": Set the result value of completion + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### fail + +Fail an activity + +**--activity-id**="": The Activity Id to fail + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--detail**="": Detail to fail the Activity + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--identity**="": Specify operator's identity + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reason**="": Reason to fail the Activity + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +## task-queue + +Operations on Task Queues + +### describe + +Describe the Workers that have recently polled on this Task Queue + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--task-queue, -t**="": Task Queue name + +**--task-queue-type**="": Task Queue type [workflow|activity] (default: workflow) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list-partition + +List the Task Queue's partitions and which matching node they are assigned to + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--task-queue, -t**="": Task Queue name + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## schedule + +Operations on Schedules + +### create + +Create a new schedule + +**--address**="": host:port for Temporal frontend service + +**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} + +**--catchup-window**="": Maximum allowed catch-up time if server is down + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + +**--end-time**="": Overall schedule end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset + +**--jitter**="": Jitter duration + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + +**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--notes**="": Initial value of notes field + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--pause**: Initial value of paused state + +**--pause-on-failure**: Pause schedule after any workflow failure + +**--remaining-actions**="": Total number of actions allowed (default: 0) + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--schedule-id, -s**="": Schedule Id + +**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + +**--start-time**="": Overall schedule start time + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-zone**="": Time zone (IANA name) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +**--workflow-type**="": Workflow type name + +### update + +Updates a schedule with a new definition (full replacement, not patch) + +**--address**="": host:port for Temporal frontend service + +**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} + +**--catchup-window**="": Maximum allowed catch-up time if server is down + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + +**--end-time**="": Overall schedule end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset + +**--jitter**="": Jitter duration + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + +**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--notes**="": Initial value of notes field + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--pause**: Initial value of paused state + +**--pause-on-failure**: Pause schedule after any workflow failure + +**--remaining-actions**="": Total number of actions allowed (default: 0) + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--schedule-id, -s**="": Schedule Id + +**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + +**--start-time**="": Overall schedule start time + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-zone**="": Time zone (IANA name) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +**--workflow-type**="": Workflow type name + +### toggle + +Pauses or unpauses a schedule + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--pause**: Pauses the schedule + +**--reason**="": Free-form text to describe reason for pause/unpause (default: (no reason provided)) + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--unpause**: Unpauses the schedule + +### trigger + +Triggers an immediate action + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### backfill + +Backfills a past time range of actions + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--end-time**="": Backfill end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--schedule-id, -s**="": Schedule Id + +**--start-time**="": Backfill start time + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### describe + +Get schedule configuration and current state + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--raw**: Print raw data as json (prefer this over -o json for scripting) + +**--schedule-id, -s**="": Schedule Id + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### delete + +Deletes a schedule + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list + +Lists schedules + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## batch + +Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs + +### describe + +Describe a batch operation job + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--job-id**="": Batch Job Id + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list + +List batch operation jobs + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### terminate + +Stop a batch operation job + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--job-id**="": Batch Job Id + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reason**="": Reason to stop the batch job + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## operator + +Operation on Temporal server + +### namespace + +Operations on namespaces + +#### describe + +Describe a Namespace by name or Id + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--namespace-id**="": Namespace Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### list + +List all Namespaces + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### register + +Register a new Namespace + +**--active-cluster**="": Active cluster name + +**--address**="": host:port for Temporal frontend service + +**--cluster**="": Cluster name + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--data**="": Namespace data in a format key=value + +**--description**="": Namespace description + +**--email**="": Owner email + +**--env**="": Env name to read the client environment variables from (default: default) + +**--global**="": Flag to indicate whether namespace is a global namespace + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--retention**="": Workflow Execution retention + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + +#### update + +Update a Namespace + +**--active-cluster**="": Active cluster name + +**--address**="": host:port for Temporal frontend service + +**--cluster**="": Cluster name + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--data**="": Namespace data in a format key=value + +**--description**="": Namespace description + +**--email**="": Owner email + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--promote-global**: Promote local namespace to global namespace + +**--reason**="": Reason for the operation + +**--retention**="": Workflow Execution retention + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + +#### delete + +Delete existing Namespace + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--yes, -y**: Confirm all prompts + +### search-attribute + +Operations on search attributes + +#### create + +Add custom search attributes + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Search attribute name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] + +**--yes, -y**: Confirm all prompts + +#### list + +List search attributes that can be used in list workflow query + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### remove + +Remove custom search attributes metadata only (Elasticsearch index schema is not modified) + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Search attribute name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--yes, -y**: Confirm all prompts + +### cluster + +Operations on a Temporal cluster + +#### health + +Check health of frontend service + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### describe + +Show information about the cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### system + +Show information about the system and capabilities + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### upsert + +Add or update a remote cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--enable-connection**: Enable cross cluster connection + +**--env**="": Env name to read the client environment variables from (default: default) + +**--frontend-address**="": Frontend address of the remote cluster + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### list + +List all remote clusters + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### remove + +Remove a remote cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Frontend address of the remote cluster + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## env + +Manage client environment configurations + +### get + +Print environment properties + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### set + +Set environment property + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### delete + +Delete environment or environment property + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +## completion + +Output shell completion code for the specified shell (zsh, bash) + +### bash + +bash completion output + +### zsh + +zsh completion output diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 4e50b314..85bb2b3f 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -55,12 +55,12 @@ func main() { // track header for file and folder creation var header string - var headerFile *os.File + //var headerFile *os.File + // read line for scanner.Scan() { line := scanner.Text() - if strings.HasPrefix(line, "## ") { header = strings.TrimSpace(line[2:]) path_docs := "docs/" + header @@ -70,18 +70,13 @@ func main() { print_check(err) // create index file here - headerFile, err = os.Create(header + ".md") - print_check(err) + //headerFile, err = os.Create(header + ".md") + //print_check(err) - } else if strings.HasPrefix(line, "### "){ - header = strings.TrimSpace(line[3:]) - headerFile, err = os.Create(header + ".md") - print_check(err) - - } else { - continue - } + } else { + continue + } /*// create files within directory @@ -110,10 +105,10 @@ func main() { //close and remove big file - readFile.Close() + //readFile.Close() - e := os.Remove("cli.md") - fatal_check(e) + //e := os.Remove("cli.md") + //fatal_check(e) } } From d86693379646e5b872669d2fca088a863020e6a0 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 10:26:46 -0600 Subject: [PATCH 09/68] made files and directories for level 2 H's --- cli.md | 2 +- cmd/doc/main.go | 19 +- docs/activity/activity.md | 85 ++++ docs/batch/batch.md | 117 ++++++ docs/completion/completion.md | 10 + docs/env/env.md | 93 +++++ docs/operator/operator.md | 523 +++++++++++++++++++++++++ docs/schedule/schedule.md | 391 +++++++++++++++++++ docs/server/server.md | 37 ++ docs/task-queue/task-queue.md | 77 ++++ docs/workflow/workflow.md | 705 ++++++++++++++++++++++++++++++++++ 11 files changed, 2050 insertions(+), 9 deletions(-) create mode 100644 docs/activity/activity.md create mode 100644 docs/batch/batch.md create mode 100644 docs/completion/completion.md create mode 100644 docs/env/env.md create mode 100644 docs/operator/operator.md create mode 100644 docs/schedule/schedule.md create mode 100644 docs/server/server.md create mode 100644 docs/task-queue/task-queue.md create mode 100644 docs/workflow/workflow.md diff --git a/cli.md b/cli.md index a2133a6e..f698dacc 100644 --- a/cli.md +++ b/cli.md @@ -644,7 +644,7 @@ Reset a Workflow Execution by event Id or reset type **--namespace, -n**="": Temporal workflow namespace (default: default) -**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) +**--reapply-type**="": Event types to reapply after the reset point: None, , Signal. (default: All) **--reason**="": Reason to reset diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 85bb2b3f..f4f6f509 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -28,6 +28,7 @@ import ( "bufio" "log" "os" + "path/filepath" "strings" "github.com/temporalio/cli/app" @@ -55,7 +56,7 @@ func main() { // track header for file and folder creation var header string - //var headerFile *os.File + var headerFile *os.File // read line @@ -66,17 +67,20 @@ func main() { path_docs := "docs/" + header //fmt.Println(path_docs) - err := os.MkdirAll(path_docs, os.ModePerm) + err := os.MkdirAll(path_docs, os.ModeAppend) print_check(err) // create index file here - //headerFile, err = os.Create(header + ".md") - //print_check(err) + headerFile, err = os.Create(filepath.Join(path_docs, header + ".md")) + print_check(err) - } else { - continue - } + } else if !strings.HasPrefix(line, "# "){ + _, err := headerFile.WriteString(line + "\n") + print_check(err) + } else { + continue + } /*// create files within directory @@ -112,7 +116,6 @@ func main() { } } - // I got sick of putting these code blocks everywhere, so now they're functions. func fatal_check(e error) { if e != nil { diff --git a/docs/activity/activity.md b/docs/activity/activity.md new file mode 100644 index 00000000..5b4ddb13 --- /dev/null +++ b/docs/activity/activity.md @@ -0,0 +1,85 @@ + +Operations on Activities of Workflows + +### complete + +Complete an activity + +**--activity-id**="": The Activity Id to complete + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--identity**="": Specify operator's identity + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--result**="": Set the result value of completion + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### fail + +Fail an activity + +**--activity-id**="": The Activity Id to fail + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--detail**="": Detail to fail the Activity + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--identity**="": Specify operator's identity + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reason**="": Reason to fail the Activity + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + diff --git a/docs/batch/batch.md b/docs/batch/batch.md new file mode 100644 index 00000000..8a75381d --- /dev/null +++ b/docs/batch/batch.md @@ -0,0 +1,117 @@ + +Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs + +### describe + +Describe a batch operation job + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--job-id**="": Batch Job Id + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list + +List batch operation jobs + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### terminate + +Stop a batch operation job + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--job-id**="": Batch Job Id + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reason**="": Reason to stop the batch job + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/completion/completion.md b/docs/completion/completion.md new file mode 100644 index 00000000..2231c57f --- /dev/null +++ b/docs/completion/completion.md @@ -0,0 +1,10 @@ + +Output shell completion code for the specified shell (zsh, bash) + +### bash + +bash completion output + +### zsh + +zsh completion output diff --git a/docs/env/env.md b/docs/env/env.md new file mode 100644 index 00000000..32b043a8 --- /dev/null +++ b/docs/env/env.md @@ -0,0 +1,93 @@ + +Manage client environment configurations + +### get + +Print environment properties + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### set + +Set environment property + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### delete + +Delete environment or environment property + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/operator/operator.md b/docs/operator/operator.md new file mode 100644 index 00000000..25543bfa --- /dev/null +++ b/docs/operator/operator.md @@ -0,0 +1,523 @@ + +Operation on Temporal server + +### namespace + +Operations on namespaces + +#### describe + +Describe a Namespace by name or Id + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--namespace-id**="": Namespace Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### list + +List all Namespaces + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### register + +Register a new Namespace + +**--active-cluster**="": Active cluster name + +**--address**="": host:port for Temporal frontend service + +**--cluster**="": Cluster name + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--data**="": Namespace data in a format key=value + +**--description**="": Namespace description + +**--email**="": Owner email + +**--env**="": Env name to read the client environment variables from (default: default) + +**--global**="": Flag to indicate whether namespace is a global namespace + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--retention**="": Workflow Execution retention + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + +#### update + +Update a Namespace + +**--active-cluster**="": Active cluster name + +**--address**="": host:port for Temporal frontend service + +**--cluster**="": Cluster name + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--data**="": Namespace data in a format key=value + +**--description**="": Namespace description + +**--email**="": Owner email + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--promote-global**: Promote local namespace to global namespace + +**--reason**="": Reason for the operation + +**--retention**="": Workflow Execution retention + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + +#### delete + +Delete existing Namespace + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--yes, -y**: Confirm all prompts + +### search-attribute + +Operations on search attributes + +#### create + +Add custom search attributes + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Search attribute name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] + +**--yes, -y**: Confirm all prompts + +#### list + +List search attributes that can be used in list workflow query + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### remove + +Remove custom search attributes metadata only (Elasticsearch index schema is not modified) + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Search attribute name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--yes, -y**: Confirm all prompts + +### cluster + +Operations on a Temporal cluster + +#### health + +Check health of frontend service + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### describe + +Show information about the cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### system + +Show information about the system and capabilities + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### upsert + +Add or update a remote cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--enable-connection**: Enable cross cluster connection + +**--env**="": Env name to read the client environment variables from (default: default) + +**--frontend-address**="": Frontend address of the remote cluster + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### list + +List all remote clusters + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### remove + +Remove a remote cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Frontend address of the remote cluster + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/schedule/schedule.md b/docs/schedule/schedule.md new file mode 100644 index 00000000..400c7a4b --- /dev/null +++ b/docs/schedule/schedule.md @@ -0,0 +1,391 @@ + +Operations on Schedules + +### create + +Create a new schedule + +**--address**="": host:port for Temporal frontend service + +**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} + +**--catchup-window**="": Maximum allowed catch-up time if server is down + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + +**--end-time**="": Overall schedule end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset + +**--jitter**="": Jitter duration + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + +**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--notes**="": Initial value of notes field + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--pause**: Initial value of paused state + +**--pause-on-failure**: Pause schedule after any workflow failure + +**--remaining-actions**="": Total number of actions allowed (default: 0) + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--schedule-id, -s**="": Schedule Id + +**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + +**--start-time**="": Overall schedule start time + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-zone**="": Time zone (IANA name) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +**--workflow-type**="": Workflow type name + +### update + +Updates a schedule with a new definition (full replacement, not patch) + +**--address**="": host:port for Temporal frontend service + +**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} + +**--catchup-window**="": Maximum allowed catch-up time if server is down + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + +**--end-time**="": Overall schedule end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset + +**--jitter**="": Jitter duration + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + +**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--notes**="": Initial value of notes field + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--pause**: Initial value of paused state + +**--pause-on-failure**: Pause schedule after any workflow failure + +**--remaining-actions**="": Total number of actions allowed (default: 0) + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--schedule-id, -s**="": Schedule Id + +**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + +**--start-time**="": Overall schedule start time + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-zone**="": Time zone (IANA name) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +**--workflow-type**="": Workflow type name + +### toggle + +Pauses or unpauses a schedule + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--pause**: Pauses the schedule + +**--reason**="": Free-form text to describe reason for pause/unpause (default: (no reason provided)) + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--unpause**: Unpauses the schedule + +### trigger + +Triggers an immediate action + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### backfill + +Backfills a past time range of actions + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--end-time**="": Backfill end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--schedule-id, -s**="": Schedule Id + +**--start-time**="": Backfill start time + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### describe + +Get schedule configuration and current state + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--raw**: Print raw data as json (prefer this over -o json for scripting) + +**--schedule-id, -s**="": Schedule Id + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### delete + +Deletes a schedule + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list + +Lists schedules + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/server/server.md b/docs/server/server.md new file mode 100644 index 00000000..fc0a4c07 --- /dev/null +++ b/docs/server/server.md @@ -0,0 +1,37 @@ + +Commands for managing Temporal server + +### start-dev + +Start Temporal development server + +**--config, -c**="": config dir path + +**--db-filename, -f**="": File in which to persist Temporal state + +**--dynamic-config-value**="": dynamic config value, as KEY=JSON_VALUE (meaning strings need quotes) + +**--headless**: disable the temporal web UI + +**--ip**="": IPv4 address to bind the frontend service to instead of localhost (default: 127.0.0.1) + +**--log-format**="": customize the log formatting (allowed: ["json" "pretty"]) (default: json) + +**--log-level**="": customize the log level (allowed: ["debug" "info" "warn" "error" "fatal"]) (default: info) + +**--metrics-port**="": Port for the metrics listener (default: 0) + +**--namespace, -n**="": Specify namespaces that should be pre-created. Namespace 'default' is auto created + +**--port, -p**="": Port for the temporal-frontend GRPC service (default: 7233) + +**--sqlite-pragma**="": specify sqlite pragma statements in pragma=value format (allowed: ["journal_mode" "synchronous"]) + +**--ui-asset-path**="": UI Custom Assets path + +**--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint + +**--ui-ip**="": IPv4 address to bind the web UI to instead of localhost + +**--ui-port**="": port for the temporal web UI (default: 0) + diff --git a/docs/task-queue/task-queue.md b/docs/task-queue/task-queue.md new file mode 100644 index 00000000..ab5433f8 --- /dev/null +++ b/docs/task-queue/task-queue.md @@ -0,0 +1,77 @@ + +Operations on Task Queues + +### describe + +Describe the Workers that have recently polled on this Task Queue + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--task-queue, -t**="": Task Queue name + +**--task-queue-type**="": Task Queue type [workflow|activity] (default: workflow) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list-partition + +List the Task Queue's partitions and which matching node they are assigned to + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--task-queue, -t**="": Task Queue name + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/workflow/workflow.md b/docs/workflow/workflow.md new file mode 100644 index 00000000..098ca58f --- /dev/null +++ b/docs/workflow/workflow.md @@ -0,0 +1,705 @@ + +Operations on Workflows + +### start + +Start a new Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of the month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) + │ │ │ │ │ + * * * * * + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value + +**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Workflow type name + +**--workflow-id, -w**="": Workflow Id + +### execute + +Start a new Workflow Execution and print progress + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of the month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) + │ │ │ │ │ + * * * * * + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value + +**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Workflow type name + +**--workflow-id, -w**="": Workflow Id + +### describe + +Show information about a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--raw**: Print properties as they are stored + +**--reset-points**: Only show auto-reset points + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### list + +List Workflow Executions based on a Query + +**--address**="": host:port for Temporal frontend service + +**--archived**: List archived Workflow Executions (EXPERIMENTAL) + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### show + +Show Event History for a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--follow, -f**: Follow the progress of Workflow Execution + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 500) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--output-filename**="": Serialize history event to a file + +**--pager**="": pager to use: less, more, favoritePager.. + +**--reset-points**: Only show events that are eligible for reset + +**--run-id, -r**="": Run Id + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### query + +Query a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space + +**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": The query type you want to run + +**--workflow-id, -w**="": Workflow Id + +### stack + +Query a Workflow Execution with __stack_trace as the query type + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space + +**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### signal + +Signal Workflow Execution by Id or List Filter + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Input for the signal (JSON) + +**--input-file**="": Input for the signal from file (JSON) + +**--name**="": Signal Name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for signaling with List Filter + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Signal Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### count + +Count Workflow Executions (requires ElasticSearch to be enabled) + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### cancel + +Cancel a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for canceling with List Filter + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Cancel Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### terminate + +Terminate Workflow Execution by Id or List Filter + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for termination + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Terminate Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### delete + +Delete a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### reset + +Reset a Workflow Execution by event Id or reset type + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--event-id**="": The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reapply-type**="": Event types to reapply after the reset point: None, , Signal. (default: All) + +**--reason**="": Reason to reset + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew + +**--workflow-id, -w**="": Workflow Id + +### reset-batch + +Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--dry-run**: Simulate reset without resetting any Workflow Executions + +**--env**="": Env name to read the client environment variables from (default: default) + +**--exclude-file**="": Input file that specifies Workflow Executions to exclude from resetting + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input-file**="": Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id + +**--input-parallelism**="": Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) + +**--input-separator**="": Separator for the input file. The default is a tab ( ) (default: ) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--non-deterministic**: Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error + +**--query, -q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query + +**--reason**="": Reason for resetting the Workflow Executions + +**--skip-base-is-not-current**: Skip a Workflow Execution if the base Run is not the current Run + +**--skip-current-open**: Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask + +### trace + +Trace progress of a Workflow Execution and its children + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--concurrency**="": Request concurrency (default: 10) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--depth**="": Number of child workflows to expand, -1 to expand all child workflows (default: -1) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fold**="": Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-fold**: Disable folding. All child workflows within the set depth will be fetched and displayed + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + From 9abe264e245e5f0190056e4cef3e87146baf52da Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 11:01:58 -0600 Subject: [PATCH 10/68] edit --- cmd/doc/main.go | 31 ++----------------------------- 1 file changed, 2 insertions(+), 29 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index f4f6f509..a6175e9e 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -67,7 +67,7 @@ func main() { path_docs := "docs/" + header //fmt.Println(path_docs) - err := os.MkdirAll(path_docs, os.ModeAppend) + err := os.MkdirAll(path_docs, 077) print_check(err) // create index file here @@ -82,35 +82,8 @@ func main() { continue } - - /*// create files within directory - // TODO: special case for operator commands - } else { - header = strings.TrimSpace(line[1:]) - headerFile, err := os.Create(header + ".md") - - // error check - if err != nil { - log.Fatal(err) - } - - // file creation - for (!strings.HasPrefix(line, "**")) { - _, err := headerFile.WriteString(line + "\n") - if err != nil { - fmt.Println(err) - return - } - } - defer headerFile.Close() - - */ - - - //close and remove big file - //readFile.Close() - + //defer readFile.Close() //e := os.Remove("cli.md") //fatal_check(e) } From d1fa1e63a0d1955de2f0ed768c0cb966cf59ea5c Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 11:03:06 -0600 Subject: [PATCH 11/68] file permissions updated --- docs/activity/activity.md | 85 ---- docs/batch/batch.md | 117 ------ docs/completion/completion.md | 10 - docs/env/env.md | 93 ----- docs/operator/operator.md | 523 ------------------------- docs/schedule/schedule.md | 391 ------------------- docs/server/server.md | 37 -- docs/task-queue/task-queue.md | 77 ---- docs/workflow/workflow.md | 705 ---------------------------------- 9 files changed, 2038 deletions(-) delete mode 100644 docs/activity/activity.md delete mode 100644 docs/batch/batch.md delete mode 100644 docs/completion/completion.md delete mode 100644 docs/env/env.md delete mode 100644 docs/operator/operator.md delete mode 100644 docs/schedule/schedule.md delete mode 100644 docs/server/server.md delete mode 100644 docs/task-queue/task-queue.md delete mode 100644 docs/workflow/workflow.md diff --git a/docs/activity/activity.md b/docs/activity/activity.md deleted file mode 100644 index 5b4ddb13..00000000 --- a/docs/activity/activity.md +++ /dev/null @@ -1,85 +0,0 @@ - -Operations on Activities of Workflows - -### complete - -Complete an activity - -**--activity-id**="": The Activity Id to complete - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--identity**="": Specify operator's identity - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--result**="": Set the result value of completion - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### fail - -Fail an activity - -**--activity-id**="": The Activity Id to fail - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--detail**="": Detail to fail the Activity - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--identity**="": Specify operator's identity - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reason**="": Reason to fail the Activity - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - diff --git a/docs/batch/batch.md b/docs/batch/batch.md deleted file mode 100644 index 8a75381d..00000000 --- a/docs/batch/batch.md +++ /dev/null @@ -1,117 +0,0 @@ - -Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs - -### describe - -Describe a batch operation job - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--job-id**="": Batch Job Id - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list - -List batch operation jobs - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### terminate - -Stop a batch operation job - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--job-id**="": Batch Job Id - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reason**="": Reason to stop the batch job - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - diff --git a/docs/completion/completion.md b/docs/completion/completion.md deleted file mode 100644 index 2231c57f..00000000 --- a/docs/completion/completion.md +++ /dev/null @@ -1,10 +0,0 @@ - -Output shell completion code for the specified shell (zsh, bash) - -### bash - -bash completion output - -### zsh - -zsh completion output diff --git a/docs/env/env.md b/docs/env/env.md deleted file mode 100644 index 32b043a8..00000000 --- a/docs/env/env.md +++ /dev/null @@ -1,93 +0,0 @@ - -Manage client environment configurations - -### get - -Print environment properties - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### set - -Set environment property - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### delete - -Delete environment or environment property - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - diff --git a/docs/operator/operator.md b/docs/operator/operator.md deleted file mode 100644 index 25543bfa..00000000 --- a/docs/operator/operator.md +++ /dev/null @@ -1,523 +0,0 @@ - -Operation on Temporal server - -### namespace - -Operations on namespaces - -#### describe - -Describe a Namespace by name or Id - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--namespace-id**="": Namespace Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### list - -List all Namespaces - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### register - -Register a new Namespace - -**--active-cluster**="": Active cluster name - -**--address**="": host:port for Temporal frontend service - -**--cluster**="": Cluster name - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--data**="": Namespace data in a format key=value - -**--description**="": Namespace description - -**--email**="": Owner email - -**--env**="": Env name to read the client environment variables from (default: default) - -**--global**="": Flag to indicate whether namespace is a global namespace - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" - -**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--retention**="": Workflow Execution retention - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" - -**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) - -#### update - -Update a Namespace - -**--active-cluster**="": Active cluster name - -**--address**="": host:port for Temporal frontend service - -**--cluster**="": Cluster name - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--data**="": Namespace data in a format key=value - -**--description**="": Namespace description - -**--email**="": Owner email - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" - -**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--promote-global**: Promote local namespace to global namespace - -**--reason**="": Reason for the operation - -**--retention**="": Workflow Execution retention - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" - -**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) - -#### delete - -Delete existing Namespace - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--yes, -y**: Confirm all prompts - -### search-attribute - -Operations on search attributes - -#### create - -Add custom search attributes - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Search attribute name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] - -**--yes, -y**: Confirm all prompts - -#### list - -List search attributes that can be used in list workflow query - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### remove - -Remove custom search attributes metadata only (Elasticsearch index schema is not modified) - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Search attribute name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--yes, -y**: Confirm all prompts - -### cluster - -Operations on a Temporal cluster - -#### health - -Check health of frontend service - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### describe - -Show information about the cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### system - -Show information about the system and capabilities - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### upsert - -Add or update a remote cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--enable-connection**: Enable cross cluster connection - -**--env**="": Env name to read the client environment variables from (default: default) - -**--frontend-address**="": Frontend address of the remote cluster - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### list - -List all remote clusters - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### remove - -Remove a remote cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Frontend address of the remote cluster - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - diff --git a/docs/schedule/schedule.md b/docs/schedule/schedule.md deleted file mode 100644 index 400c7a4b..00000000 --- a/docs/schedule/schedule.md +++ /dev/null @@ -1,391 +0,0 @@ - -Operations on Schedules - -### create - -Create a new schedule - -**--address**="": host:port for Temporal frontend service - -**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} - -**--catchup-window**="": Maximum allowed catch-up time if server is down - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" - -**--end-time**="": Overall schedule end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset - -**--jitter**="": Jitter duration - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value - -**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--notes**="": Initial value of notes field - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--pause**: Initial value of paused state - -**--pause-on-failure**: Pause schedule after any workflow failure - -**--remaining-actions**="": Total number of actions allowed (default: 0) - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--schedule-id, -s**="": Schedule Id - -**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value - -**--start-time**="": Overall schedule start time - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-zone**="": Time zone (IANA name) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -**--workflow-type**="": Workflow type name - -### update - -Updates a schedule with a new definition (full replacement, not patch) - -**--address**="": host:port for Temporal frontend service - -**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} - -**--catchup-window**="": Maximum allowed catch-up time if server is down - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" - -**--end-time**="": Overall schedule end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset - -**--jitter**="": Jitter duration - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value - -**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--notes**="": Initial value of notes field - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--pause**: Initial value of paused state - -**--pause-on-failure**: Pause schedule after any workflow failure - -**--remaining-actions**="": Total number of actions allowed (default: 0) - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--schedule-id, -s**="": Schedule Id - -**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value - -**--start-time**="": Overall schedule start time - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-zone**="": Time zone (IANA name) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -**--workflow-type**="": Workflow type name - -### toggle - -Pauses or unpauses a schedule - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--pause**: Pauses the schedule - -**--reason**="": Free-form text to describe reason for pause/unpause (default: (no reason provided)) - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--unpause**: Unpauses the schedule - -### trigger - -Triggers an immediate action - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### backfill - -Backfills a past time range of actions - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--end-time**="": Backfill end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--schedule-id, -s**="": Schedule Id - -**--start-time**="": Backfill start time - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### describe - -Get schedule configuration and current state - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--raw**: Print raw data as json (prefer this over -o json for scripting) - -**--schedule-id, -s**="": Schedule Id - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### delete - -Deletes a schedule - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list - -Lists schedules - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - diff --git a/docs/server/server.md b/docs/server/server.md deleted file mode 100644 index fc0a4c07..00000000 --- a/docs/server/server.md +++ /dev/null @@ -1,37 +0,0 @@ - -Commands for managing Temporal server - -### start-dev - -Start Temporal development server - -**--config, -c**="": config dir path - -**--db-filename, -f**="": File in which to persist Temporal state - -**--dynamic-config-value**="": dynamic config value, as KEY=JSON_VALUE (meaning strings need quotes) - -**--headless**: disable the temporal web UI - -**--ip**="": IPv4 address to bind the frontend service to instead of localhost (default: 127.0.0.1) - -**--log-format**="": customize the log formatting (allowed: ["json" "pretty"]) (default: json) - -**--log-level**="": customize the log level (allowed: ["debug" "info" "warn" "error" "fatal"]) (default: info) - -**--metrics-port**="": Port for the metrics listener (default: 0) - -**--namespace, -n**="": Specify namespaces that should be pre-created. Namespace 'default' is auto created - -**--port, -p**="": Port for the temporal-frontend GRPC service (default: 7233) - -**--sqlite-pragma**="": specify sqlite pragma statements in pragma=value format (allowed: ["journal_mode" "synchronous"]) - -**--ui-asset-path**="": UI Custom Assets path - -**--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint - -**--ui-ip**="": IPv4 address to bind the web UI to instead of localhost - -**--ui-port**="": port for the temporal web UI (default: 0) - diff --git a/docs/task-queue/task-queue.md b/docs/task-queue/task-queue.md deleted file mode 100644 index ab5433f8..00000000 --- a/docs/task-queue/task-queue.md +++ /dev/null @@ -1,77 +0,0 @@ - -Operations on Task Queues - -### describe - -Describe the Workers that have recently polled on this Task Queue - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--task-queue, -t**="": Task Queue name - -**--task-queue-type**="": Task Queue type [workflow|activity] (default: workflow) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list-partition - -List the Task Queue's partitions and which matching node they are assigned to - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--task-queue, -t**="": Task Queue name - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - diff --git a/docs/workflow/workflow.md b/docs/workflow/workflow.md deleted file mode 100644 index 098ca58f..00000000 --- a/docs/workflow/workflow.md +++ /dev/null @@ -1,705 +0,0 @@ - -Operations on Workflows - -### start - -Start a new Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: - ┌───────────── minute (0 - 59) - │ ┌───────────── hour (0 - 23) - │ │ ┌───────────── day of the month (1 - 31) - │ │ │ ┌───────────── month (1 - 12) - │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) - │ │ │ │ │ - * * * * * - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value - -**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Workflow type name - -**--workflow-id, -w**="": Workflow Id - -### execute - -Start a new Workflow Execution and print progress - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: - ┌───────────── minute (0 - 59) - │ ┌───────────── hour (0 - 23) - │ │ ┌───────────── day of the month (1 - 31) - │ │ │ ┌───────────── month (1 - 12) - │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) - │ │ │ │ │ - * * * * * - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value - -**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Workflow type name - -**--workflow-id, -w**="": Workflow Id - -### describe - -Show information about a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--raw**: Print properties as they are stored - -**--reset-points**: Only show auto-reset points - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### list - -List Workflow Executions based on a Query - -**--address**="": host:port for Temporal frontend service - -**--archived**: List archived Workflow Executions (EXPERIMENTAL) - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### show - -Show Event History for a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--follow, -f**: Follow the progress of Workflow Execution - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 500) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--output-filename**="": Serialize history event to a file - -**--pager**="": pager to use: less, more, favoritePager.. - -**--reset-points**: Only show events that are eligible for reset - -**--run-id, -r**="": Run Id - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### query - -Query a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space - -**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": The query type you want to run - -**--workflow-id, -w**="": Workflow Id - -### stack - -Query a Workflow Execution with __stack_trace as the query type - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space - -**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### signal - -Signal Workflow Execution by Id or List Filter - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Input for the signal (JSON) - -**--input-file**="": Input for the signal from file (JSON) - -**--name**="": Signal Name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for signaling with List Filter - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Signal Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### count - -Count Workflow Executions (requires ElasticSearch to be enabled) - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### cancel - -Cancel a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for canceling with List Filter - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Cancel Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### terminate - -Terminate Workflow Execution by Id or List Filter - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for termination - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Terminate Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### delete - -Delete a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### reset - -Reset a Workflow Execution by event Id or reset type - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--event-id**="": The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reapply-type**="": Event types to reapply after the reset point: None, , Signal. (default: All) - -**--reason**="": Reason to reset - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew - -**--workflow-id, -w**="": Workflow Id - -### reset-batch - -Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--dry-run**: Simulate reset without resetting any Workflow Executions - -**--env**="": Env name to read the client environment variables from (default: default) - -**--exclude-file**="": Input file that specifies Workflow Executions to exclude from resetting - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input-file**="": Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id - -**--input-parallelism**="": Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) - -**--input-separator**="": Separator for the input file. The default is a tab ( ) (default: ) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--non-deterministic**: Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error - -**--query, -q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query - -**--reason**="": Reason for resetting the Workflow Executions - -**--skip-base-is-not-current**: Skip a Workflow Execution if the base Run is not the current Run - -**--skip-current-open**: Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask - -### trace - -Trace progress of a Workflow Execution and its children - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--concurrency**="": Request concurrency (default: 10) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--depth**="": Number of child workflows to expand, -1 to expand all child workflows (default: -1) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fold**="": Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-fold**: Disable folding. All child workflows within the set depth will be fetched and displayed - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - From d52aa2483911adc44650c2f817aa4323b582021b Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 11:05:34 -0600 Subject: [PATCH 12/68] found correct permissions --- cli.md | 4 +- cmd/doc/main.go | 2 +- docs/activity/activity.md | 85 ++++ docs/batch/batch.md | 117 ++++++ docs/completion/completion.md | 10 + docs/env/env.md | 93 +++++ docs/operator/operator.md | 523 +++++++++++++++++++++++++ docs/schedule/schedule.md | 391 +++++++++++++++++++ docs/server/server.md | 37 ++ docs/task-queue/task-queue.md | 77 ++++ docs/workflow/workflow.md | 705 ++++++++++++++++++++++++++++++++++ 11 files changed, 2041 insertions(+), 3 deletions(-) create mode 100644 docs/activity/activity.md create mode 100644 docs/batch/batch.md create mode 100644 docs/completion/completion.md create mode 100644 docs/env/env.md create mode 100644 docs/operator/operator.md create mode 100644 docs/schedule/schedule.md create mode 100644 docs/server/server.md create mode 100644 docs/task-queue/task-queue.md create mode 100644 docs/workflow/workflow.md diff --git a/cli.md b/cli.md index f698dacc..3e370b5f 100644 --- a/cli.md +++ b/cli.md @@ -644,7 +644,7 @@ Reset a Workflow Execution by event Id or reset type **--namespace, -n**="": Temporal workflow namespace (default: default) -**--reapply-type**="": Event types to reapply after the reset point: None, , Signal. (default: All) +**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) **--reason**="": Reason to reset @@ -714,7 +714,7 @@ Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkf **--tls-server-name**="": Override for target server name -**--type**="": Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask +**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew ### trace diff --git a/cmd/doc/main.go b/cmd/doc/main.go index a6175e9e..a4158511 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -67,7 +67,7 @@ func main() { path_docs := "docs/" + header //fmt.Println(path_docs) - err := os.MkdirAll(path_docs, 077) + err := os.MkdirAll(path_docs, os.ModePerm) print_check(err) // create index file here diff --git a/docs/activity/activity.md b/docs/activity/activity.md new file mode 100644 index 00000000..5b4ddb13 --- /dev/null +++ b/docs/activity/activity.md @@ -0,0 +1,85 @@ + +Operations on Activities of Workflows + +### complete + +Complete an activity + +**--activity-id**="": The Activity Id to complete + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--identity**="": Specify operator's identity + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--result**="": Set the result value of completion + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### fail + +Fail an activity + +**--activity-id**="": The Activity Id to fail + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--detail**="": Detail to fail the Activity + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--identity**="": Specify operator's identity + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reason**="": Reason to fail the Activity + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + diff --git a/docs/batch/batch.md b/docs/batch/batch.md new file mode 100644 index 00000000..8a75381d --- /dev/null +++ b/docs/batch/batch.md @@ -0,0 +1,117 @@ + +Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs + +### describe + +Describe a batch operation job + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--job-id**="": Batch Job Id + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list + +List batch operation jobs + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### terminate + +Stop a batch operation job + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--job-id**="": Batch Job Id + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reason**="": Reason to stop the batch job + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/completion/completion.md b/docs/completion/completion.md new file mode 100644 index 00000000..2231c57f --- /dev/null +++ b/docs/completion/completion.md @@ -0,0 +1,10 @@ + +Output shell completion code for the specified shell (zsh, bash) + +### bash + +bash completion output + +### zsh + +zsh completion output diff --git a/docs/env/env.md b/docs/env/env.md new file mode 100644 index 00000000..32b043a8 --- /dev/null +++ b/docs/env/env.md @@ -0,0 +1,93 @@ + +Manage client environment configurations + +### get + +Print environment properties + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### set + +Set environment property + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### delete + +Delete environment or environment property + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/operator/operator.md b/docs/operator/operator.md new file mode 100644 index 00000000..25543bfa --- /dev/null +++ b/docs/operator/operator.md @@ -0,0 +1,523 @@ + +Operation on Temporal server + +### namespace + +Operations on namespaces + +#### describe + +Describe a Namespace by name or Id + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--namespace-id**="": Namespace Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### list + +List all Namespaces + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### register + +Register a new Namespace + +**--active-cluster**="": Active cluster name + +**--address**="": host:port for Temporal frontend service + +**--cluster**="": Cluster name + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--data**="": Namespace data in a format key=value + +**--description**="": Namespace description + +**--email**="": Owner email + +**--env**="": Env name to read the client environment variables from (default: default) + +**--global**="": Flag to indicate whether namespace is a global namespace + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--retention**="": Workflow Execution retention + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + +#### update + +Update a Namespace + +**--active-cluster**="": Active cluster name + +**--address**="": host:port for Temporal frontend service + +**--cluster**="": Cluster name + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--data**="": Namespace data in a format key=value + +**--description**="": Namespace description + +**--email**="": Owner email + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--promote-global**: Promote local namespace to global namespace + +**--reason**="": Reason for the operation + +**--retention**="": Workflow Execution retention + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + +#### delete + +Delete existing Namespace + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--yes, -y**: Confirm all prompts + +### search-attribute + +Operations on search attributes + +#### create + +Add custom search attributes + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Search attribute name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] + +**--yes, -y**: Confirm all prompts + +#### list + +List search attributes that can be used in list workflow query + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### remove + +Remove custom search attributes metadata only (Elasticsearch index schema is not modified) + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Search attribute name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--yes, -y**: Confirm all prompts + +### cluster + +Operations on a Temporal cluster + +#### health + +Check health of frontend service + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### describe + +Show information about the cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### system + +Show information about the system and capabilities + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### upsert + +Add or update a remote cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--enable-connection**: Enable cross cluster connection + +**--env**="": Env name to read the client environment variables from (default: default) + +**--frontend-address**="": Frontend address of the remote cluster + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### list + +List all remote clusters + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### remove + +Remove a remote cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Frontend address of the remote cluster + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/schedule/schedule.md b/docs/schedule/schedule.md new file mode 100644 index 00000000..400c7a4b --- /dev/null +++ b/docs/schedule/schedule.md @@ -0,0 +1,391 @@ + +Operations on Schedules + +### create + +Create a new schedule + +**--address**="": host:port for Temporal frontend service + +**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} + +**--catchup-window**="": Maximum allowed catch-up time if server is down + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + +**--end-time**="": Overall schedule end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset + +**--jitter**="": Jitter duration + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + +**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--notes**="": Initial value of notes field + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--pause**: Initial value of paused state + +**--pause-on-failure**: Pause schedule after any workflow failure + +**--remaining-actions**="": Total number of actions allowed (default: 0) + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--schedule-id, -s**="": Schedule Id + +**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + +**--start-time**="": Overall schedule start time + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-zone**="": Time zone (IANA name) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +**--workflow-type**="": Workflow type name + +### update + +Updates a schedule with a new definition (full replacement, not patch) + +**--address**="": host:port for Temporal frontend service + +**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} + +**--catchup-window**="": Maximum allowed catch-up time if server is down + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + +**--end-time**="": Overall schedule end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset + +**--jitter**="": Jitter duration + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + +**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--notes**="": Initial value of notes field + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--pause**: Initial value of paused state + +**--pause-on-failure**: Pause schedule after any workflow failure + +**--remaining-actions**="": Total number of actions allowed (default: 0) + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--schedule-id, -s**="": Schedule Id + +**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + +**--start-time**="": Overall schedule start time + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-zone**="": Time zone (IANA name) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +**--workflow-type**="": Workflow type name + +### toggle + +Pauses or unpauses a schedule + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--pause**: Pauses the schedule + +**--reason**="": Free-form text to describe reason for pause/unpause (default: (no reason provided)) + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--unpause**: Unpauses the schedule + +### trigger + +Triggers an immediate action + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### backfill + +Backfills a past time range of actions + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--end-time**="": Backfill end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--schedule-id, -s**="": Schedule Id + +**--start-time**="": Backfill start time + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### describe + +Get schedule configuration and current state + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--raw**: Print raw data as json (prefer this over -o json for scripting) + +**--schedule-id, -s**="": Schedule Id + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### delete + +Deletes a schedule + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list + +Lists schedules + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/server/server.md b/docs/server/server.md new file mode 100644 index 00000000..fc0a4c07 --- /dev/null +++ b/docs/server/server.md @@ -0,0 +1,37 @@ + +Commands for managing Temporal server + +### start-dev + +Start Temporal development server + +**--config, -c**="": config dir path + +**--db-filename, -f**="": File in which to persist Temporal state + +**--dynamic-config-value**="": dynamic config value, as KEY=JSON_VALUE (meaning strings need quotes) + +**--headless**: disable the temporal web UI + +**--ip**="": IPv4 address to bind the frontend service to instead of localhost (default: 127.0.0.1) + +**--log-format**="": customize the log formatting (allowed: ["json" "pretty"]) (default: json) + +**--log-level**="": customize the log level (allowed: ["debug" "info" "warn" "error" "fatal"]) (default: info) + +**--metrics-port**="": Port for the metrics listener (default: 0) + +**--namespace, -n**="": Specify namespaces that should be pre-created. Namespace 'default' is auto created + +**--port, -p**="": Port for the temporal-frontend GRPC service (default: 7233) + +**--sqlite-pragma**="": specify sqlite pragma statements in pragma=value format (allowed: ["journal_mode" "synchronous"]) + +**--ui-asset-path**="": UI Custom Assets path + +**--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint + +**--ui-ip**="": IPv4 address to bind the web UI to instead of localhost + +**--ui-port**="": port for the temporal web UI (default: 0) + diff --git a/docs/task-queue/task-queue.md b/docs/task-queue/task-queue.md new file mode 100644 index 00000000..ab5433f8 --- /dev/null +++ b/docs/task-queue/task-queue.md @@ -0,0 +1,77 @@ + +Operations on Task Queues + +### describe + +Describe the Workers that have recently polled on this Task Queue + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--task-queue, -t**="": Task Queue name + +**--task-queue-type**="": Task Queue type [workflow|activity] (default: workflow) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### list-partition + +List the Task Queue's partitions and which matching node they are assigned to + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--task-queue, -t**="": Task Queue name + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/workflow/workflow.md b/docs/workflow/workflow.md new file mode 100644 index 00000000..28900a9f --- /dev/null +++ b/docs/workflow/workflow.md @@ -0,0 +1,705 @@ + +Operations on Workflows + +### start + +Start a new Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of the month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) + │ │ │ │ │ + * * * * * + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value + +**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Workflow type name + +**--workflow-id, -w**="": Workflow Id + +### execute + +Start a new Workflow Execution and print progress + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of the month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) + │ │ │ │ │ + * * * * * + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value + +**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Workflow type name + +**--workflow-id, -w**="": Workflow Id + +### describe + +Show information about a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--raw**: Print properties as they are stored + +**--reset-points**: Only show auto-reset points + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### list + +List Workflow Executions based on a Query + +**--address**="": host:port for Temporal frontend service + +**--archived**: List archived Workflow Executions (EXPERIMENTAL) + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### show + +Show Event History for a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--follow, -f**: Follow the progress of Workflow Execution + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 500) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--output-filename**="": Serialize history event to a file + +**--pager**="": pager to use: less, more, favoritePager.. + +**--reset-points**: Only show events that are eligible for reset + +**--run-id, -r**="": Run Id + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### query + +Query a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space + +**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": The query type you want to run + +**--workflow-id, -w**="": Workflow Id + +### stack + +Query a Workflow Execution with __stack_trace as the query type + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space + +**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### signal + +Signal Workflow Execution by Id or List Filter + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Input for the signal (JSON) + +**--input-file**="": Input for the signal from file (JSON) + +**--name**="": Signal Name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for signaling with List Filter + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Signal Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### count + +Count Workflow Executions (requires ElasticSearch to be enabled) + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +### cancel + +Cancel a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for canceling with List Filter + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Cancel Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### terminate + +Terminate Workflow Execution by Id or List Filter + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for termination + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Terminate Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + +### delete + +Delete a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +### reset + +Reset a Workflow Execution by event Id or reset type + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--event-id**="": The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) + +**--reason**="": Reason to reset + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew + +**--workflow-id, -w**="": Workflow Id + +### reset-batch + +Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--dry-run**: Simulate reset without resetting any Workflow Executions + +**--env**="": Env name to read the client environment variables from (default: default) + +**--exclude-file**="": Input file that specifies Workflow Executions to exclude from resetting + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input-file**="": Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id + +**--input-parallelism**="": Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) + +**--input-separator**="": Separator for the input file. The default is a tab ( ) (default: ) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--non-deterministic**: Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error + +**--query, -q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query + +**--reason**="": Reason for resetting the Workflow Executions + +**--skip-base-is-not-current**: Skip a Workflow Execution if the base Run is not the current Run + +**--skip-current-open**: Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew + +### trace + +Trace progress of a Workflow Execution and its children + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--concurrency**="": Request concurrency (default: 10) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--depth**="": Number of child workflows to expand, -1 to expand all child workflows (default: -1) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fold**="": Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-fold**: Disable folding. All child workflows within the set depth will be fetched and displayed + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + From 5c01fe10e7dc8e24ade246b829d418a3a395b2f3 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 11:59:51 -0600 Subject: [PATCH 13/68] keeping up with main edits --- cli.md | 30 +++++++++++++++--------------- docs/server/server.md | 26 +++++++++++++------------- docs/workflow/workflow.md | 4 ++-- 3 files changed, 30 insertions(+), 30 deletions(-) diff --git a/cli.md b/cli.md index 3e370b5f..b3dc4d25 100644 --- a/cli.md +++ b/cli.md @@ -22,35 +22,35 @@ Commands for managing Temporal server Start Temporal development server -**--config, -c**="": config dir path +**--config, -c**="": Path to config directory -**--db-filename, -f**="": File in which to persist Temporal state +**--db-filename, -f**="": File in which to persist Temporal state (by default, Workflows are lost when the process dies) -**--dynamic-config-value**="": dynamic config value, as KEY=JSON_VALUE (meaning strings need quotes) +**--dynamic-config-value**="": Dynamic config value, as KEY=JSON_VALUE (string values need quotes) -**--headless**: disable the temporal web UI +**--headless**: Disable the Web UI -**--ip**="": IPv4 address to bind the frontend service to instead of localhost (default: 127.0.0.1) +**--ip**="": IPv4 address to bind the frontend service to (default: 127.0.0.1) -**--log-format**="": customize the log formatting (allowed: ["json" "pretty"]) (default: json) +**--log-format**="": Set the log formatting. Options: ["json", "pretty"]. (default: json) -**--log-level**="": customize the log level (allowed: ["debug" "info" "warn" "error" "fatal"]) (default: info) +**--log-level**="": Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) -**--metrics-port**="": Port for the metrics listener (default: 0) +**--metrics-port**="": Port for /metrics (default: 0) -**--namespace, -n**="": Specify namespaces that should be pre-created. Namespace 'default' is auto created +**--namespace, -n**="": Specify namespaces that should be pre-created (namespace "default" is always created) -**--port, -p**="": Port for the temporal-frontend GRPC service (default: 7233) +**--port, -p**="": Port for the frontend gRPC service (default: 7233) -**--sqlite-pragma**="": specify sqlite pragma statements in pragma=value format (allowed: ["journal_mode" "synchronous"]) +**--sqlite-pragma**="": Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. **--ui-asset-path**="": UI Custom Assets path **--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint -**--ui-ip**="": IPv4 address to bind the web UI to instead of localhost +**--ui-ip**="": IPv4 address to bind the Web UI to -**--ui-port**="": port for the temporal web UI (default: 0) +**--ui-port**="": Port for the Web UI (default: 0) ## workflow @@ -666,7 +666,7 @@ Reset a Workflow Execution by event Id or reset type ### reset-batch -Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Reset a batch of Workflow Executions by reset type: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask **--address**="": host:port for Temporal frontend service @@ -714,7 +714,7 @@ Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkf **--tls-server-name**="": Override for target server name -**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +**--type**="": Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask ### trace diff --git a/docs/server/server.md b/docs/server/server.md index fc0a4c07..0a7264e4 100644 --- a/docs/server/server.md +++ b/docs/server/server.md @@ -5,33 +5,33 @@ Commands for managing Temporal server Start Temporal development server -**--config, -c**="": config dir path +**--config, -c**="": Path to config directory -**--db-filename, -f**="": File in which to persist Temporal state +**--db-filename, -f**="": File in which to persist Temporal state (by default, Workflows are lost when the process dies) -**--dynamic-config-value**="": dynamic config value, as KEY=JSON_VALUE (meaning strings need quotes) +**--dynamic-config-value**="": Dynamic config value, as KEY=JSON_VALUE (string values need quotes) -**--headless**: disable the temporal web UI +**--headless**: Disable the Web UI -**--ip**="": IPv4 address to bind the frontend service to instead of localhost (default: 127.0.0.1) +**--ip**="": IPv4 address to bind the frontend service to (default: 127.0.0.1) -**--log-format**="": customize the log formatting (allowed: ["json" "pretty"]) (default: json) +**--log-format**="": Set the log formatting. Options: ["json", "pretty"]. (default: json) -**--log-level**="": customize the log level (allowed: ["debug" "info" "warn" "error" "fatal"]) (default: info) +**--log-level**="": Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) -**--metrics-port**="": Port for the metrics listener (default: 0) +**--metrics-port**="": Port for /metrics (default: 0) -**--namespace, -n**="": Specify namespaces that should be pre-created. Namespace 'default' is auto created +**--namespace, -n**="": Specify namespaces that should be pre-created (namespace "default" is always created) -**--port, -p**="": Port for the temporal-frontend GRPC service (default: 7233) +**--port, -p**="": Port for the frontend gRPC service (default: 7233) -**--sqlite-pragma**="": specify sqlite pragma statements in pragma=value format (allowed: ["journal_mode" "synchronous"]) +**--sqlite-pragma**="": Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. **--ui-asset-path**="": UI Custom Assets path **--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint -**--ui-ip**="": IPv4 address to bind the web UI to instead of localhost +**--ui-ip**="": IPv4 address to bind the Web UI to -**--ui-port**="": port for the temporal web UI (default: 0) +**--ui-port**="": Port for the Web UI (default: 0) diff --git a/docs/workflow/workflow.md b/docs/workflow/workflow.md index 28900a9f..1ac88ac9 100644 --- a/docs/workflow/workflow.md +++ b/docs/workflow/workflow.md @@ -611,7 +611,7 @@ Reset a Workflow Execution by event Id or reset type ### reset-batch -Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Reset a batch of Workflow Executions by reset type: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask **--address**="": host:port for Temporal frontend service @@ -659,7 +659,7 @@ Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkf **--tls-server-name**="": Override for target server name -**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +**--type**="": Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask ### trace From a9935329d426209cb59f7bcb7e81e9a38744e6bd Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 12:12:15 -0600 Subject: [PATCH 14/68] renamed files --- cli.md | 2063 ------------------- cmd/doc/main.go | 11 +- docs/activity/{activity.md => index.md} | 0 docs/batch/{batch.md => index.md} | 0 docs/completion/{completion.md => index.md} | 0 docs/env/{env.md => index.md} | 0 docs/operator/{operator.md => index.md} | 0 docs/schedule/{schedule.md => index.md} | 0 docs/server/{server.md => index.md} | 0 docs/task-queue/{task-queue.md => index.md} | 0 docs/workflow/{workflow.md => index.md} | 4 +- 11 files changed, 7 insertions(+), 2071 deletions(-) delete mode 100644 cli.md rename docs/activity/{activity.md => index.md} (100%) rename docs/batch/{batch.md => index.md} (100%) rename docs/completion/{completion.md => index.md} (100%) rename docs/env/{env.md => index.md} (100%) rename docs/operator/{operator.md => index.md} (100%) rename docs/schedule/{schedule.md => index.md} (100%) rename docs/server/{server.md => index.md} (100%) rename docs/task-queue/{task-queue.md => index.md} (100%) rename docs/workflow/{workflow.md => index.md} (99%) diff --git a/cli.md b/cli.md deleted file mode 100644 index b3dc4d25..00000000 --- a/cli.md +++ /dev/null @@ -1,2063 +0,0 @@ -# NAME - -temporal - Temporal command-line interface and development server - -# SYNOPSIS - -temporal - -**Usage**: - -``` -temporal [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...] -``` - -# COMMANDS - -## server - -Commands for managing Temporal server - -### start-dev - -Start Temporal development server - -**--config, -c**="": Path to config directory - -**--db-filename, -f**="": File in which to persist Temporal state (by default, Workflows are lost when the process dies) - -**--dynamic-config-value**="": Dynamic config value, as KEY=JSON_VALUE (string values need quotes) - -**--headless**: Disable the Web UI - -**--ip**="": IPv4 address to bind the frontend service to (default: 127.0.0.1) - -**--log-format**="": Set the log formatting. Options: ["json", "pretty"]. (default: json) - -**--log-level**="": Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) - -**--metrics-port**="": Port for /metrics (default: 0) - -**--namespace, -n**="": Specify namespaces that should be pre-created (namespace "default" is always created) - -**--port, -p**="": Port for the frontend gRPC service (default: 7233) - -**--sqlite-pragma**="": Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. - -**--ui-asset-path**="": UI Custom Assets path - -**--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint - -**--ui-ip**="": IPv4 address to bind the Web UI to - -**--ui-port**="": Port for the Web UI (default: 0) - -## workflow - -Operations on Workflows - -### start - -Start a new Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: - ┌───────────── minute (0 - 59) - │ ┌───────────── hour (0 - 23) - │ │ ┌───────────── day of the month (1 - 31) - │ │ │ ┌───────────── month (1 - 12) - │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) - │ │ │ │ │ - * * * * * - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value - -**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Workflow type name - -**--workflow-id, -w**="": Workflow Id - -### execute - -Start a new Workflow Execution and print progress - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: - ┌───────────── minute (0 - 59) - │ ┌───────────── hour (0 - 23) - │ │ ┌───────────── day of the month (1 - 31) - │ │ │ ┌───────────── month (1 - 12) - │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) - │ │ │ │ │ - * * * * * - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value - -**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Workflow type name - -**--workflow-id, -w**="": Workflow Id - -### describe - -Show information about a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--raw**: Print properties as they are stored - -**--reset-points**: Only show auto-reset points - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### list - -List Workflow Executions based on a Query - -**--address**="": host:port for Temporal frontend service - -**--archived**: List archived Workflow Executions (EXPERIMENTAL) - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### show - -Show Event History for a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--follow, -f**: Follow the progress of Workflow Execution - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 500) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--output-filename**="": Serialize history event to a file - -**--pager**="": pager to use: less, more, favoritePager.. - -**--reset-points**: Only show events that are eligible for reset - -**--run-id, -r**="": Run Id - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### query - -Query a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space - -**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": The query type you want to run - -**--workflow-id, -w**="": Workflow Id - -### stack - -Query a Workflow Execution with __stack_trace as the query type - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space - -**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### signal - -Signal Workflow Execution by Id or List Filter - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Input for the signal (JSON) - -**--input-file**="": Input for the signal from file (JSON) - -**--name**="": Signal Name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for signaling with List Filter - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Signal Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### count - -Count Workflow Executions (requires ElasticSearch to be enabled) - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### cancel - -Cancel a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for canceling with List Filter - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Cancel Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### terminate - -Terminate Workflow Execution by Id or List Filter - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for termination - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Terminate Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### delete - -Delete a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### reset - -Reset a Workflow Execution by event Id or reset type - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--event-id**="": The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) - -**--reason**="": Reason to reset - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew - -**--workflow-id, -w**="": Workflow Id - -### reset-batch - -Reset a batch of Workflow Executions by reset type: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--dry-run**: Simulate reset without resetting any Workflow Executions - -**--env**="": Env name to read the client environment variables from (default: default) - -**--exclude-file**="": Input file that specifies Workflow Executions to exclude from resetting - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input-file**="": Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id - -**--input-parallelism**="": Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) - -**--input-separator**="": Separator for the input file. The default is a tab ( ) (default: ) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--non-deterministic**: Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error - -**--query, -q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query - -**--reason**="": Reason for resetting the Workflow Executions - -**--skip-base-is-not-current**: Skip a Workflow Execution if the base Run is not the current Run - -**--skip-current-open**: Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask - -### trace - -Trace progress of a Workflow Execution and its children - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--concurrency**="": Request concurrency (default: 10) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--depth**="": Number of child workflows to expand, -1 to expand all child workflows (default: -1) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fold**="": Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-fold**: Disable folding. All child workflows within the set depth will be fetched and displayed - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -## activity - -Operations on Activities of Workflows - -### complete - -Complete an activity - -**--activity-id**="": The Activity Id to complete - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--identity**="": Specify operator's identity - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--result**="": Set the result value of completion - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### fail - -Fail an activity - -**--activity-id**="": The Activity Id to fail - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--detail**="": Detail to fail the Activity - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--identity**="": Specify operator's identity - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reason**="": Reason to fail the Activity - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -## task-queue - -Operations on Task Queues - -### describe - -Describe the Workers that have recently polled on this Task Queue - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--task-queue, -t**="": Task Queue name - -**--task-queue-type**="": Task Queue type [workflow|activity] (default: workflow) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list-partition - -List the Task Queue's partitions and which matching node they are assigned to - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--task-queue, -t**="": Task Queue name - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## schedule - -Operations on Schedules - -### create - -Create a new schedule - -**--address**="": host:port for Temporal frontend service - -**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} - -**--catchup-window**="": Maximum allowed catch-up time if server is down - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" - -**--end-time**="": Overall schedule end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset - -**--jitter**="": Jitter duration - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value - -**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--notes**="": Initial value of notes field - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--pause**: Initial value of paused state - -**--pause-on-failure**: Pause schedule after any workflow failure - -**--remaining-actions**="": Total number of actions allowed (default: 0) - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--schedule-id, -s**="": Schedule Id - -**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value - -**--start-time**="": Overall schedule start time - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-zone**="": Time zone (IANA name) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -**--workflow-type**="": Workflow type name - -### update - -Updates a schedule with a new definition (full replacement, not patch) - -**--address**="": host:port for Temporal frontend service - -**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} - -**--catchup-window**="": Maximum allowed catch-up time if server is down - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" - -**--end-time**="": Overall schedule end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset - -**--jitter**="": Jitter duration - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value - -**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--notes**="": Initial value of notes field - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--pause**: Initial value of paused state - -**--pause-on-failure**: Pause schedule after any workflow failure - -**--remaining-actions**="": Total number of actions allowed (default: 0) - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--schedule-id, -s**="": Schedule Id - -**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value - -**--start-time**="": Overall schedule start time - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-zone**="": Time zone (IANA name) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -**--workflow-type**="": Workflow type name - -### toggle - -Pauses or unpauses a schedule - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--pause**: Pauses the schedule - -**--reason**="": Free-form text to describe reason for pause/unpause (default: (no reason provided)) - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--unpause**: Unpauses the schedule - -### trigger - -Triggers an immediate action - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### backfill - -Backfills a past time range of actions - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--end-time**="": Backfill end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--schedule-id, -s**="": Schedule Id - -**--start-time**="": Backfill start time - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### describe - -Get schedule configuration and current state - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--raw**: Print raw data as json (prefer this over -o json for scripting) - -**--schedule-id, -s**="": Schedule Id - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### delete - -Deletes a schedule - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list - -Lists schedules - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## batch - -Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs - -### describe - -Describe a batch operation job - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--job-id**="": Batch Job Id - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list - -List batch operation jobs - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### terminate - -Stop a batch operation job - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--job-id**="": Batch Job Id - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reason**="": Reason to stop the batch job - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## operator - -Operation on Temporal server - -### namespace - -Operations on namespaces - -#### describe - -Describe a Namespace by name or Id - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--namespace-id**="": Namespace Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### list - -List all Namespaces - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### register - -Register a new Namespace - -**--active-cluster**="": Active cluster name - -**--address**="": host:port for Temporal frontend service - -**--cluster**="": Cluster name - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--data**="": Namespace data in a format key=value - -**--description**="": Namespace description - -**--email**="": Owner email - -**--env**="": Env name to read the client environment variables from (default: default) - -**--global**="": Flag to indicate whether namespace is a global namespace - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" - -**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--retention**="": Workflow Execution retention - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" - -**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) - -#### update - -Update a Namespace - -**--active-cluster**="": Active cluster name - -**--address**="": host:port for Temporal frontend service - -**--cluster**="": Cluster name - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--data**="": Namespace data in a format key=value - -**--description**="": Namespace description - -**--email**="": Owner email - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" - -**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--promote-global**: Promote local namespace to global namespace - -**--reason**="": Reason for the operation - -**--retention**="": Workflow Execution retention - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" - -**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) - -#### delete - -Delete existing Namespace - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--yes, -y**: Confirm all prompts - -### search-attribute - -Operations on search attributes - -#### create - -Add custom search attributes - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Search attribute name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] - -**--yes, -y**: Confirm all prompts - -#### list - -List search attributes that can be used in list workflow query - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### remove - -Remove custom search attributes metadata only (Elasticsearch index schema is not modified) - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Search attribute name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--yes, -y**: Confirm all prompts - -### cluster - -Operations on a Temporal cluster - -#### health - -Check health of frontend service - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### describe - -Show information about the cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### system - -Show information about the system and capabilities - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### upsert - -Add or update a remote cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--enable-connection**: Enable cross cluster connection - -**--env**="": Env name to read the client environment variables from (default: default) - -**--frontend-address**="": Frontend address of the remote cluster - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### list - -List all remote clusters - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### remove - -Remove a remote cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Frontend address of the remote cluster - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## env - -Manage client environment configurations - -### get - -Print environment properties - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### set - -Set environment property - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### delete - -Delete environment or environment property - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -## completion - -Output shell completion code for the specified shell (zsh, bash) - -### bash - -bash completion output - -### zsh - -zsh completion output diff --git a/cmd/doc/main.go b/cmd/doc/main.go index a4158511..fa8d14cb 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -65,13 +65,12 @@ func main() { if strings.HasPrefix(line, "## ") { header = strings.TrimSpace(line[2:]) path_docs := "docs/" + header - //fmt.Println(path_docs) err := os.MkdirAll(path_docs, os.ModePerm) print_check(err) // create index file here - headerFile, err = os.Create(filepath.Join(path_docs, header + ".md")) + headerFile, err = os.Create(filepath.Join(path_docs, "index.md")) print_check(err) @@ -82,11 +81,11 @@ func main() { continue } + } //close and remove big file - //defer readFile.Close() - //e := os.Remove("cli.md") - //fatal_check(e) -} + readFile.Close() + e := os.Remove("cli.md") + fatal_check(e) } // I got sick of putting these code blocks everywhere, so now they're functions. diff --git a/docs/activity/activity.md b/docs/activity/index.md similarity index 100% rename from docs/activity/activity.md rename to docs/activity/index.md diff --git a/docs/batch/batch.md b/docs/batch/index.md similarity index 100% rename from docs/batch/batch.md rename to docs/batch/index.md diff --git a/docs/completion/completion.md b/docs/completion/index.md similarity index 100% rename from docs/completion/completion.md rename to docs/completion/index.md diff --git a/docs/env/env.md b/docs/env/index.md similarity index 100% rename from docs/env/env.md rename to docs/env/index.md diff --git a/docs/operator/operator.md b/docs/operator/index.md similarity index 100% rename from docs/operator/operator.md rename to docs/operator/index.md diff --git a/docs/schedule/schedule.md b/docs/schedule/index.md similarity index 100% rename from docs/schedule/schedule.md rename to docs/schedule/index.md diff --git a/docs/server/server.md b/docs/server/index.md similarity index 100% rename from docs/server/server.md rename to docs/server/index.md diff --git a/docs/task-queue/task-queue.md b/docs/task-queue/index.md similarity index 100% rename from docs/task-queue/task-queue.md rename to docs/task-queue/index.md diff --git a/docs/workflow/workflow.md b/docs/workflow/index.md similarity index 99% rename from docs/workflow/workflow.md rename to docs/workflow/index.md index 1ac88ac9..8d1bf91f 100644 --- a/docs/workflow/workflow.md +++ b/docs/workflow/index.md @@ -611,7 +611,7 @@ Reset a Workflow Execution by event Id or reset type ### reset-batch -Reset a batch of Workflow Executions by reset type: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew **--address**="": host:port for Temporal frontend service @@ -659,7 +659,7 @@ Reset a batch of Workflow Executions by reset type: LastContinuedAsNew, FirstWor **--tls-server-name**="": Override for target server name -**--type**="": Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +**--type**="": Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask ### trace From 08dcb2d7a34e7fd8ade0842eb53f6b6ebac949e7 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 12:32:23 -0600 Subject: [PATCH 15/68] tertiary files created and written to --- cmd/doc/main.go | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index fa8d14cb..8338c018 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -58,23 +58,30 @@ func main() { var header string var headerFile *os.File - // read line for scanner.Scan() { line := scanner.Text() if strings.HasPrefix(line, "## ") { header = strings.TrimSpace(line[2:]) path_docs := "docs/" + header - + + //create directory err := os.MkdirAll(path_docs, os.ModePerm) print_check(err) // create index file here headerFile, err = os.Create(filepath.Join(path_docs, "index.md")) print_check(err) - - } else if !strings.HasPrefix(line, "# "){ + } else if strings.HasPrefix(line, "### "){ + path_docs := "docs/" + header + fileName := strings.TrimSpace(line[3:]) + + //create file within directory + headerFile, err = os.Create(filepath.Join(path_docs, fileName + ".md")) + print_check(err) + + } else if !strings.HasPrefix(line, "# ") { _, err := headerFile.WriteString(line + "\n") print_check(err) } else { @@ -93,7 +100,6 @@ func fatal_check(e error) { if e != nil { log.Fatal(e) } - } func print_check(e error) { From bcf769277d1713257033c84e4caf1bb40f74e997 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 12:32:31 -0600 Subject: [PATCH 16/68] tertiary files --- docs/activity/complete.md | 39 ++ docs/activity/fail.md | 41 ++ docs/activity/index.md | 82 ---- docs/batch/describe.md | 37 ++ docs/batch/index.md | 114 ----- docs/batch/list.md | 41 ++ docs/batch/terminate.md | 33 ++ docs/completion/bash.md | 3 + docs/completion/index.md | 7 - docs/completion/zsh.md | 2 + docs/env/delete.md | 29 ++ docs/env/get.md | 29 ++ docs/env/index.md | 90 ---- docs/env/set.md | 29 ++ docs/operator/cluster.md | 209 +++++++++ docs/operator/index.md | 520 ---------------------- docs/operator/namespace.md | 203 +++++++++ docs/operator/search-attribute.md | 105 +++++ docs/schedule/backfill.md | 37 ++ docs/schedule/create.md | 81 ++++ docs/schedule/delete.md | 31 ++ docs/schedule/describe.md | 39 ++ docs/schedule/index.md | 388 ----------------- docs/schedule/list.md | 41 ++ docs/schedule/toggle.md | 37 ++ docs/schedule/trigger.md | 33 ++ docs/schedule/update.md | 81 ++++ docs/server/index.md | 34 -- docs/server/start-dev.md | 33 ++ docs/task-queue/describe.md | 39 ++ docs/task-queue/index.md | 74 ---- docs/task-queue/list-partition.md | 33 ++ docs/workflow/cancel.md | 39 ++ docs/workflow/count.md | 31 ++ docs/workflow/delete.md | 33 ++ docs/workflow/describe.md | 37 ++ docs/workflow/execute.md | 76 ++++ docs/workflow/index.md | 702 ------------------------------ docs/workflow/list.md | 45 ++ docs/workflow/query.md | 41 ++ docs/workflow/reset-batch.md | 51 +++ docs/workflow/reset.md | 41 ++ docs/workflow/show.md | 53 +++ docs/workflow/signal.md | 45 ++ docs/workflow/stack.md | 39 ++ docs/workflow/start.md | 76 ++++ docs/workflow/terminate.md | 39 ++ docs/workflow/trace.md | 41 ++ 48 files changed, 1972 insertions(+), 2011 deletions(-) create mode 100644 docs/activity/complete.md create mode 100644 docs/activity/fail.md create mode 100644 docs/batch/describe.md create mode 100644 docs/batch/list.md create mode 100644 docs/batch/terminate.md create mode 100644 docs/completion/bash.md create mode 100644 docs/completion/zsh.md create mode 100644 docs/env/delete.md create mode 100644 docs/env/get.md create mode 100644 docs/env/set.md create mode 100644 docs/operator/cluster.md create mode 100644 docs/operator/namespace.md create mode 100644 docs/operator/search-attribute.md create mode 100644 docs/schedule/backfill.md create mode 100644 docs/schedule/create.md create mode 100644 docs/schedule/delete.md create mode 100644 docs/schedule/describe.md create mode 100644 docs/schedule/list.md create mode 100644 docs/schedule/toggle.md create mode 100644 docs/schedule/trigger.md create mode 100644 docs/schedule/update.md create mode 100644 docs/server/start-dev.md create mode 100644 docs/task-queue/describe.md create mode 100644 docs/task-queue/list-partition.md create mode 100644 docs/workflow/cancel.md create mode 100644 docs/workflow/count.md create mode 100644 docs/workflow/delete.md create mode 100644 docs/workflow/describe.md create mode 100644 docs/workflow/execute.md create mode 100644 docs/workflow/list.md create mode 100644 docs/workflow/query.md create mode 100644 docs/workflow/reset-batch.md create mode 100644 docs/workflow/reset.md create mode 100644 docs/workflow/show.md create mode 100644 docs/workflow/signal.md create mode 100644 docs/workflow/stack.md create mode 100644 docs/workflow/start.md create mode 100644 docs/workflow/terminate.md create mode 100644 docs/workflow/trace.md diff --git a/docs/activity/complete.md b/docs/activity/complete.md new file mode 100644 index 00000000..6561451b --- /dev/null +++ b/docs/activity/complete.md @@ -0,0 +1,39 @@ + +Complete an activity + +**--activity-id**="": The Activity Id to complete + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--identity**="": Specify operator's identity + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--result**="": Set the result value of completion + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + diff --git a/docs/activity/fail.md b/docs/activity/fail.md new file mode 100644 index 00000000..3ff94382 --- /dev/null +++ b/docs/activity/fail.md @@ -0,0 +1,41 @@ + +Fail an activity + +**--activity-id**="": The Activity Id to fail + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--detail**="": Detail to fail the Activity + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--identity**="": Specify operator's identity + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reason**="": Reason to fail the Activity + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + diff --git a/docs/activity/index.md b/docs/activity/index.md index 5b4ddb13..df291ff3 100644 --- a/docs/activity/index.md +++ b/docs/activity/index.md @@ -1,85 +1,3 @@ Operations on Activities of Workflows -### complete - -Complete an activity - -**--activity-id**="": The Activity Id to complete - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--identity**="": Specify operator's identity - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--result**="": Set the result value of completion - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### fail - -Fail an activity - -**--activity-id**="": The Activity Id to fail - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--detail**="": Detail to fail the Activity - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--identity**="": Specify operator's identity - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reason**="": Reason to fail the Activity - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - diff --git a/docs/batch/describe.md b/docs/batch/describe.md new file mode 100644 index 00000000..3f84f22a --- /dev/null +++ b/docs/batch/describe.md @@ -0,0 +1,37 @@ + +Describe a batch operation job + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--job-id**="": Batch Job Id + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/batch/index.md b/docs/batch/index.md index 8a75381d..31d0bf1d 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -1,117 +1,3 @@ Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs -### describe - -Describe a batch operation job - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--job-id**="": Batch Job Id - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list - -List batch operation jobs - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### terminate - -Stop a batch operation job - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--job-id**="": Batch Job Id - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reason**="": Reason to stop the batch job - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - diff --git a/docs/batch/list.md b/docs/batch/list.md new file mode 100644 index 00000000..07dcbcd6 --- /dev/null +++ b/docs/batch/list.md @@ -0,0 +1,41 @@ + +List batch operation jobs + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md new file mode 100644 index 00000000..06fef2c3 --- /dev/null +++ b/docs/batch/terminate.md @@ -0,0 +1,33 @@ + +Stop a batch operation job + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--job-id**="": Batch Job Id + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reason**="": Reason to stop the batch job + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/completion/bash.md b/docs/completion/bash.md new file mode 100644 index 00000000..c00d25e7 --- /dev/null +++ b/docs/completion/bash.md @@ -0,0 +1,3 @@ + +bash completion output + diff --git a/docs/completion/index.md b/docs/completion/index.md index 2231c57f..1bd364c8 100644 --- a/docs/completion/index.md +++ b/docs/completion/index.md @@ -1,10 +1,3 @@ Output shell completion code for the specified shell (zsh, bash) -### bash - -bash completion output - -### zsh - -zsh completion output diff --git a/docs/completion/zsh.md b/docs/completion/zsh.md new file mode 100644 index 00000000..7121892b --- /dev/null +++ b/docs/completion/zsh.md @@ -0,0 +1,2 @@ + +zsh completion output diff --git a/docs/env/delete.md b/docs/env/delete.md new file mode 100644 index 00000000..dec8b5a7 --- /dev/null +++ b/docs/env/delete.md @@ -0,0 +1,29 @@ + +Delete environment or environment property + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/env/get.md b/docs/env/get.md new file mode 100644 index 00000000..0061abdc --- /dev/null +++ b/docs/env/get.md @@ -0,0 +1,29 @@ + +Print environment properties + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/env/index.md b/docs/env/index.md index 32b043a8..fa4b7c69 100644 --- a/docs/env/index.md +++ b/docs/env/index.md @@ -1,93 +1,3 @@ Manage client environment configurations -### get - -Print environment properties - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### set - -Set environment property - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### delete - -Delete environment or environment property - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - diff --git a/docs/env/set.md b/docs/env/set.md new file mode 100644 index 00000000..b158ac6b --- /dev/null +++ b/docs/env/set.md @@ -0,0 +1,29 @@ + +Set environment property + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md new file mode 100644 index 00000000..e08bac23 --- /dev/null +++ b/docs/operator/cluster.md @@ -0,0 +1,209 @@ + +Operations on a Temporal cluster + +#### health + +Check health of frontend service + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### describe + +Show information about the cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### system + +Show information about the system and capabilities + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### upsert + +Add or update a remote cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--enable-connection**: Enable cross cluster connection + +**--env**="": Env name to read the client environment variables from (default: default) + +**--frontend-address**="": Frontend address of the remote cluster + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### list + +List all remote clusters + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### remove + +Remove a remote cluster + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Frontend address of the remote cluster + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/operator/index.md b/docs/operator/index.md index 25543bfa..0c9921cb 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -1,523 +1,3 @@ Operation on Temporal server -### namespace - -Operations on namespaces - -#### describe - -Describe a Namespace by name or Id - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--namespace-id**="": Namespace Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### list - -List all Namespaces - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### register - -Register a new Namespace - -**--active-cluster**="": Active cluster name - -**--address**="": host:port for Temporal frontend service - -**--cluster**="": Cluster name - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--data**="": Namespace data in a format key=value - -**--description**="": Namespace description - -**--email**="": Owner email - -**--env**="": Env name to read the client environment variables from (default: default) - -**--global**="": Flag to indicate whether namespace is a global namespace - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" - -**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--retention**="": Workflow Execution retention - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" - -**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) - -#### update - -Update a Namespace - -**--active-cluster**="": Active cluster name - -**--address**="": host:port for Temporal frontend service - -**--cluster**="": Cluster name - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--data**="": Namespace data in a format key=value - -**--description**="": Namespace description - -**--email**="": Owner email - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" - -**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--promote-global**: Promote local namespace to global namespace - -**--reason**="": Reason for the operation - -**--retention**="": Workflow Execution retention - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" - -**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) - -#### delete - -Delete existing Namespace - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--yes, -y**: Confirm all prompts - -### search-attribute - -Operations on search attributes - -#### create - -Add custom search attributes - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Search attribute name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] - -**--yes, -y**: Confirm all prompts - -#### list - -List search attributes that can be used in list workflow query - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### remove - -Remove custom search attributes metadata only (Elasticsearch index schema is not modified) - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Search attribute name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--yes, -y**: Confirm all prompts - -### cluster - -Operations on a Temporal cluster - -#### health - -Check health of frontend service - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### describe - -Show information about the cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### system - -Show information about the system and capabilities - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### upsert - -Add or update a remote cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--enable-connection**: Enable cross cluster connection - -**--env**="": Env name to read the client environment variables from (default: default) - -**--frontend-address**="": Frontend address of the remote cluster - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### list - -List all remote clusters - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -#### remove - -Remove a remote cluster - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--name**="": Frontend address of the remote cluster - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md new file mode 100644 index 00000000..2c5ba740 --- /dev/null +++ b/docs/operator/namespace.md @@ -0,0 +1,203 @@ + +Operations on namespaces + +#### describe + +Describe a Namespace by name or Id + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--namespace-id**="": Namespace Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### list + +List all Namespaces + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### register + +Register a new Namespace + +**--active-cluster**="": Active cluster name + +**--address**="": host:port for Temporal frontend service + +**--cluster**="": Cluster name + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--data**="": Namespace data in a format key=value + +**--description**="": Namespace description + +**--email**="": Owner email + +**--env**="": Env name to read the client environment variables from (default: default) + +**--global**="": Flag to indicate whether namespace is a global namespace + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--retention**="": Workflow Execution retention + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + +#### update + +Update a Namespace + +**--active-cluster**="": Active cluster name + +**--address**="": host:port for Temporal frontend service + +**--cluster**="": Cluster name + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--data**="": Namespace data in a format key=value + +**--description**="": Namespace description + +**--email**="": Owner email + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--promote-global**: Promote local namespace to global namespace + +**--reason**="": Reason for the operation + +**--retention**="": Workflow Execution retention + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + +#### delete + +Delete existing Namespace + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--yes, -y**: Confirm all prompts + diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md new file mode 100644 index 00000000..f9b7f216 --- /dev/null +++ b/docs/operator/search-attribute.md @@ -0,0 +1,105 @@ + +Operations on search attributes + +#### create + +Add custom search attributes + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Search attribute name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] + +**--yes, -y**: Confirm all prompts + +#### list + +List search attributes that can be used in list workflow query + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +#### remove + +Remove custom search attributes metadata only (Elasticsearch index schema is not modified) + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--name**="": Search attribute name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--yes, -y**: Confirm all prompts + diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md new file mode 100644 index 00000000..0a2a1c0d --- /dev/null +++ b/docs/schedule/backfill.md @@ -0,0 +1,37 @@ + +Backfills a past time range of actions + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--end-time**="": Backfill end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--schedule-id, -s**="": Schedule Id + +**--start-time**="": Backfill start time + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/schedule/create.md b/docs/schedule/create.md new file mode 100644 index 00000000..f518d7f4 --- /dev/null +++ b/docs/schedule/create.md @@ -0,0 +1,81 @@ + +Create a new schedule + +**--address**="": host:port for Temporal frontend service + +**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} + +**--catchup-window**="": Maximum allowed catch-up time if server is down + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + +**--end-time**="": Overall schedule end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset + +**--jitter**="": Jitter duration + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + +**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--notes**="": Initial value of notes field + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--pause**: Initial value of paused state + +**--pause-on-failure**: Pause schedule after any workflow failure + +**--remaining-actions**="": Total number of actions allowed (default: 0) + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--schedule-id, -s**="": Schedule Id + +**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + +**--start-time**="": Overall schedule start time + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-zone**="": Time zone (IANA name) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +**--workflow-type**="": Workflow type name + diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md new file mode 100644 index 00000000..bfb5b6ec --- /dev/null +++ b/docs/schedule/delete.md @@ -0,0 +1,31 @@ + +Deletes a schedule + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md new file mode 100644 index 00000000..2f980504 --- /dev/null +++ b/docs/schedule/describe.md @@ -0,0 +1,39 @@ + +Get schedule configuration and current state + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--raw**: Print raw data as json (prefer this over -o json for scripting) + +**--schedule-id, -s**="": Schedule Id + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/schedule/index.md b/docs/schedule/index.md index 400c7a4b..35fa93ed 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -1,391 +1,3 @@ Operations on Schedules -### create - -Create a new schedule - -**--address**="": host:port for Temporal frontend service - -**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} - -**--catchup-window**="": Maximum allowed catch-up time if server is down - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" - -**--end-time**="": Overall schedule end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset - -**--jitter**="": Jitter duration - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value - -**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--notes**="": Initial value of notes field - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--pause**: Initial value of paused state - -**--pause-on-failure**: Pause schedule after any workflow failure - -**--remaining-actions**="": Total number of actions allowed (default: 0) - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--schedule-id, -s**="": Schedule Id - -**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value - -**--start-time**="": Overall schedule start time - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-zone**="": Time zone (IANA name) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -**--workflow-type**="": Workflow type name - -### update - -Updates a schedule with a new definition (full replacement, not patch) - -**--address**="": host:port for Temporal frontend service - -**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} - -**--catchup-window**="": Maximum allowed catch-up time if server is down - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" - -**--end-time**="": Overall schedule end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset - -**--jitter**="": Jitter duration - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value - -**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--notes**="": Initial value of notes field - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--pause**: Initial value of paused state - -**--pause-on-failure**: Pause schedule after any workflow failure - -**--remaining-actions**="": Total number of actions allowed (default: 0) - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--schedule-id, -s**="": Schedule Id - -**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value - -**--start-time**="": Overall schedule start time - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-zone**="": Time zone (IANA name) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -**--workflow-type**="": Workflow type name - -### toggle - -Pauses or unpauses a schedule - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--pause**: Pauses the schedule - -**--reason**="": Free-form text to describe reason for pause/unpause (default: (no reason provided)) - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--unpause**: Unpauses the schedule - -### trigger - -Triggers an immediate action - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### backfill - -Backfills a past time range of actions - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--end-time**="": Backfill end time - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll - -**--schedule-id, -s**="": Schedule Id - -**--start-time**="": Backfill start time - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### describe - -Get schedule configuration and current state - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--raw**: Print raw data as json (prefer this over -o json for scripting) - -**--schedule-id, -s**="": Schedule Id - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### delete - -Deletes a schedule - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--schedule-id, -s**="": Schedule Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list - -Lists schedules - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - diff --git a/docs/schedule/list.md b/docs/schedule/list.md new file mode 100644 index 00000000..e448169f --- /dev/null +++ b/docs/schedule/list.md @@ -0,0 +1,41 @@ + +Lists schedules + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md new file mode 100644 index 00000000..ec5f2a61 --- /dev/null +++ b/docs/schedule/toggle.md @@ -0,0 +1,37 @@ + +Pauses or unpauses a schedule + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--pause**: Pauses the schedule + +**--reason**="": Free-form text to describe reason for pause/unpause (default: (no reason provided)) + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--unpause**: Unpauses the schedule + diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md new file mode 100644 index 00000000..417a8d95 --- /dev/null +++ b/docs/schedule/trigger.md @@ -0,0 +1,33 @@ + +Triggers an immediate action + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--schedule-id, -s**="": Schedule Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/schedule/update.md b/docs/schedule/update.md new file mode 100644 index 00000000..b4a08c32 --- /dev/null +++ b/docs/schedule/update.md @@ -0,0 +1,81 @@ + +Updates a schedule with a new definition (full replacement, not patch) + +**--address**="": host:port for Temporal frontend service + +**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} + +**--catchup-window**="": Maximum allowed catch-up time if server is down + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + +**--end-time**="": Overall schedule end time + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset + +**--jitter**="": Jitter duration + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + +**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--notes**="": Initial value of notes field + +**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + +**--pause**: Initial value of paused state + +**--pause-on-failure**: Pause schedule after any workflow failure + +**--remaining-actions**="": Total number of actions allowed (default: 0) + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--schedule-id, -s**="": Schedule Id + +**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + +**--start-time**="": Overall schedule start time + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-zone**="": Time zone (IANA name) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + +**--workflow-type**="": Workflow type name + diff --git a/docs/server/index.md b/docs/server/index.md index 0a7264e4..4ca8eaa4 100644 --- a/docs/server/index.md +++ b/docs/server/index.md @@ -1,37 +1,3 @@ Commands for managing Temporal server -### start-dev - -Start Temporal development server - -**--config, -c**="": Path to config directory - -**--db-filename, -f**="": File in which to persist Temporal state (by default, Workflows are lost when the process dies) - -**--dynamic-config-value**="": Dynamic config value, as KEY=JSON_VALUE (string values need quotes) - -**--headless**: Disable the Web UI - -**--ip**="": IPv4 address to bind the frontend service to (default: 127.0.0.1) - -**--log-format**="": Set the log formatting. Options: ["json", "pretty"]. (default: json) - -**--log-level**="": Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) - -**--metrics-port**="": Port for /metrics (default: 0) - -**--namespace, -n**="": Specify namespaces that should be pre-created (namespace "default" is always created) - -**--port, -p**="": Port for the frontend gRPC service (default: 7233) - -**--sqlite-pragma**="": Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. - -**--ui-asset-path**="": UI Custom Assets path - -**--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint - -**--ui-ip**="": IPv4 address to bind the Web UI to - -**--ui-port**="": Port for the Web UI (default: 0) - diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md new file mode 100644 index 00000000..7ac61fb0 --- /dev/null +++ b/docs/server/start-dev.md @@ -0,0 +1,33 @@ + +Start Temporal development server + +**--config, -c**="": Path to config directory + +**--db-filename, -f**="": File in which to persist Temporal state (by default, Workflows are lost when the process dies) + +**--dynamic-config-value**="": Dynamic config value, as KEY=JSON_VALUE (string values need quotes) + +**--headless**: Disable the Web UI + +**--ip**="": IPv4 address to bind the frontend service to (default: 127.0.0.1) + +**--log-format**="": Set the log formatting. Options: ["json", "pretty"]. (default: json) + +**--log-level**="": Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) + +**--metrics-port**="": Port for /metrics (default: 0) + +**--namespace, -n**="": Specify namespaces that should be pre-created (namespace "default" is always created) + +**--port, -p**="": Port for the frontend gRPC service (default: 7233) + +**--sqlite-pragma**="": Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. + +**--ui-asset-path**="": UI Custom Assets path + +**--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint + +**--ui-ip**="": IPv4 address to bind the Web UI to + +**--ui-port**="": Port for the Web UI (default: 0) + diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md new file mode 100644 index 00000000..3e964b54 --- /dev/null +++ b/docs/task-queue/describe.md @@ -0,0 +1,39 @@ + +Describe the Workers that have recently polled on this Task Queue + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--task-queue, -t**="": Task Queue name + +**--task-queue-type**="": Task Queue type [workflow|activity] (default: workflow) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/task-queue/index.md b/docs/task-queue/index.md index ab5433f8..d5a179ea 100644 --- a/docs/task-queue/index.md +++ b/docs/task-queue/index.md @@ -1,77 +1,3 @@ Operations on Task Queues -### describe - -Describe the Workers that have recently polled on this Task Queue - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--task-queue, -t**="": Task Queue name - -**--task-queue-type**="": Task Queue type [workflow|activity] (default: workflow) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### list-partition - -List the Task Queue's partitions and which matching node they are assigned to - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--task-queue, -t**="": Task Queue name - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md new file mode 100644 index 00000000..2efa65eb --- /dev/null +++ b/docs/task-queue/list-partition.md @@ -0,0 +1,33 @@ + +List the Task Queue's partitions and which matching node they are assigned to + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--task-queue, -t**="": Task Queue name + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md new file mode 100644 index 00000000..24c0388c --- /dev/null +++ b/docs/workflow/cancel.md @@ -0,0 +1,39 @@ + +Cancel a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for canceling with List Filter + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Cancel Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + diff --git a/docs/workflow/count.md b/docs/workflow/count.md new file mode 100644 index 00000000..512de48d --- /dev/null +++ b/docs/workflow/count.md @@ -0,0 +1,31 @@ + +Count Workflow Executions (requires ElasticSearch to be enabled) + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md new file mode 100644 index 00000000..e4769c64 --- /dev/null +++ b/docs/workflow/delete.md @@ -0,0 +1,33 @@ + +Delete a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md new file mode 100644 index 00000000..e2c9c234 --- /dev/null +++ b/docs/workflow/describe.md @@ -0,0 +1,37 @@ + +Show information about a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--raw**: Print properties as they are stored + +**--reset-points**: Only show auto-reset points + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md new file mode 100644 index 00000000..54520d45 --- /dev/null +++ b/docs/workflow/execute.md @@ -0,0 +1,76 @@ + +Start a new Workflow Execution and print progress + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of the month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) + │ │ │ │ │ + * * * * * + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value + +**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Workflow type name + +**--workflow-id, -w**="": Workflow Id + diff --git a/docs/workflow/index.md b/docs/workflow/index.md index 8d1bf91f..35fdc933 100644 --- a/docs/workflow/index.md +++ b/docs/workflow/index.md @@ -1,705 +1,3 @@ Operations on Workflows -### start - -Start a new Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: - ┌───────────── minute (0 - 59) - │ ┌───────────── hour (0 - 23) - │ │ ┌───────────── day of the month (1 - 31) - │ │ │ ┌───────────── month (1 - 12) - │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) - │ │ │ │ │ - * * * * * - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value - -**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Workflow type name - -**--workflow-id, -w**="": Workflow Id - -### execute - -Start a new Workflow Execution and print progress - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: - ┌───────────── minute (0 - 59) - │ ┌───────────── hour (0 - 23) - │ │ ┌───────────── day of the month (1 - 31) - │ │ │ ┌───────────── month (1 - 12) - │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) - │ │ │ │ │ - * * * * * - -**--env**="": Env name to read the client environment variables from (default: default) - -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning - -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values - -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 0) - -**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value - -**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) - -**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value - -**--task-queue, -t**="": Task queue - -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Workflow type name - -**--workflow-id, -w**="": Workflow Id - -### describe - -Show information about a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--raw**: Print properties as they are stored - -**--reset-points**: Only show auto-reset points - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### list - -List Workflow Executions based on a Query - -**--address**="": host:port for Temporal frontend service - -**--archived**: List archived Workflow Executions (EXPERIMENTAL) - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--pager**="": pager to use: less, more, favoritePager.. - -**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### show - -Show Event History for a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields - -**--follow, -f**: Follow the progress of Workflow Execution - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--limit**="": number of items to print (default: 0) - -**--max-field-length**="": Maximum length for each attribute field (default: 500) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-pager, -P**: disable interactive pager - -**--output, -o**="": format output as: table, json, card. (default: table) - -**--output-filename**="": Serialize history event to a file - -**--pager**="": pager to use: less, more, favoritePager.. - -**--reset-points**: Only show events that are eligible for reset - -**--run-id, -r**="": Run Id - -**--time-format**="": format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### query - -Query a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space - -**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": The query type you want to run - -**--workflow-id, -w**="": Workflow Id - -### stack - -Query a Workflow Execution with __stack_trace as the query type - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space - -**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### signal - -Signal Workflow Execution by Id or List Filter - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input, -i**="": Input for the signal (JSON) - -**--input-file**="": Input for the signal from file (JSON) - -**--name**="": Signal Name - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for signaling with List Filter - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Signal Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### count - -Count Workflow Executions (requires ElasticSearch to be enabled) - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -### cancel - -Cancel a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for canceling with List Filter - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Cancel Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### terminate - -Terminate Workflow Execution by Id or List Filter - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--query, -q**="": Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ - -**--reason**="": Reason for termination - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Terminate Workflow Execution by Id - -**--yes, -y**: Confirm all prompts - -### delete - -Delete a Workflow Execution - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - -### reset - -Reset a Workflow Execution by event Id or reset type - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--event-id**="": The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) - -**--reason**="": Reason to reset - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew - -**--workflow-id, -w**="": Workflow Id - -### reset-batch - -Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--dry-run**: Simulate reset without resetting any Workflow Executions - -**--env**="": Env name to read the client environment variables from (default: default) - -**--exclude-file**="": Input file that specifies Workflow Executions to exclude from resetting - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--input-file**="": Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id - -**--input-parallelism**="": Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) - -**--input-separator**="": Separator for the input file. The default is a tab ( ) (default: ) - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--non-deterministic**: Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error - -**--query, -q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query - -**--reason**="": Reason for resetting the Workflow Executions - -**--skip-base-is-not-current**: Skip a Workflow Execution if the base Run is not the current Run - -**--skip-current-open**: Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--type**="": Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask - -### trace - -Trace progress of a Workflow Execution and its children - -**--address**="": host:port for Temporal frontend service - -**--codec-auth**="": Authorization header to set for requests to Codec Server - -**--codec-endpoint**="": Remote Codec Server Endpoint - -**--color**="": when to use color: auto, always, never. (default: auto) - -**--concurrency**="": Request concurrency (default: 10) - -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) - -**--depth**="": Number of child workflows to expand, -1 to expand all child workflows (default: -1) - -**--env**="": Env name to read the client environment variables from (default: default) - -**--fold**="": Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) - -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value - -**--namespace, -n**="": Temporal workflow namespace (default: default) - -**--no-fold**: Disable folding. All child workflows within the set depth will be fetched and displayed - -**--run-id, -r**="": Run Id - -**--tls-ca-path**="": Path to server CA certificate - -**--tls-cert-path**="": Path to x509 certificate - -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) - -**--tls-key-path**="": Path to private key - -**--tls-server-name**="": Override for target server name - -**--workflow-id, -w**="": Workflow Id - diff --git a/docs/workflow/list.md b/docs/workflow/list.md new file mode 100644 index 00000000..e8807e6a --- /dev/null +++ b/docs/workflow/list.md @@ -0,0 +1,45 @@ + +List Workflow Executions based on a Query + +**--address**="": host:port for Temporal frontend service + +**--archived**: List archived Workflow Executions (EXPERIMENTAL) + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + diff --git a/docs/workflow/query.md b/docs/workflow/query.md new file mode 100644 index 00000000..8d1e3490 --- /dev/null +++ b/docs/workflow/query.md @@ -0,0 +1,41 @@ + +Query a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space + +**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": The query type you want to run + +**--workflow-id, -w**="": Workflow Id + diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md new file mode 100644 index 00000000..51d0a285 --- /dev/null +++ b/docs/workflow/reset-batch.md @@ -0,0 +1,51 @@ + +Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--dry-run**: Simulate reset without resetting any Workflow Executions + +**--env**="": Env name to read the client environment variables from (default: default) + +**--exclude-file**="": Input file that specifies Workflow Executions to exclude from resetting + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input-file**="": Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id + +**--input-parallelism**="": Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) + +**--input-separator**="": Separator for the input file. The default is a tab ( ) (default: ) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--non-deterministic**: Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error + +**--query, -q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query + +**--reason**="": Reason for resetting the Workflow Executions + +**--skip-base-is-not-current**: Skip a Workflow Execution if the base Run is not the current Run + +**--skip-current-open**: Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask + diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md new file mode 100644 index 00000000..8a533cb5 --- /dev/null +++ b/docs/workflow/reset.md @@ -0,0 +1,41 @@ + +Reset a Workflow Execution by event Id or reset type + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--event-id**="": The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) + +**--reason**="": Reason to reset + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask + +**--workflow-id, -w**="": Workflow Id + diff --git a/docs/workflow/show.md b/docs/workflow/show.md new file mode 100644 index 00000000..c052db7e --- /dev/null +++ b/docs/workflow/show.md @@ -0,0 +1,53 @@ + +Show Event History for a Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--follow, -f**: Follow the progress of Workflow Execution + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 500) + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--output-filename**="": Serialize history event to a file + +**--pager**="": pager to use: less, more, favoritePager.. + +**--reset-points**: Only show events that are eligible for reset + +**--run-id, -r**="": Run Id + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md new file mode 100644 index 00000000..27cf0fa4 --- /dev/null +++ b/docs/workflow/signal.md @@ -0,0 +1,45 @@ + +Signal Workflow Execution by Id or List Filter + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Input for the signal (JSON) + +**--input-file**="": Input for the signal from file (JSON) + +**--name**="": Signal Name + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for signaling with List Filter + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Signal Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md new file mode 100644 index 00000000..78d40152 --- /dev/null +++ b/docs/workflow/stack.md @@ -0,0 +1,39 @@ + +Query a Workflow Execution with __stack_trace as the query type + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space + +**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + diff --git a/docs/workflow/start.md b/docs/workflow/start.md new file mode 100644 index 00000000..d7324563 --- /dev/null +++ b/docs/workflow/start.md @@ -0,0 +1,76 @@ + +Start a new Workflow Execution + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of the month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) + │ │ │ │ │ + * * * * * + +**--env**="": Env name to read the client environment variables from (default: default) + +**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) + +**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning + +**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values + +**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file + +**--limit**="": number of items to print (default: 0) + +**--max-field-length**="": Maximum length for each attribute field (default: 0) + +**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value + +**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-pager, -P**: disable interactive pager + +**--output, -o**="": format output as: table, json, card. (default: table) + +**--pager**="": pager to use: less, more, favoritePager.. + +**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) + +**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value + +**--task-queue, -t**="": Task queue + +**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) + +**--time-format**="": format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--type**="": Workflow type name + +**--workflow-id, -w**="": Workflow Id + diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md new file mode 100644 index 00000000..f5a76bb7 --- /dev/null +++ b/docs/workflow/terminate.md @@ -0,0 +1,39 @@ + +Terminate Workflow Execution by Id or List Filter + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--query, -q**="": Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ + +**--reason**="": Reason for termination + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Terminate Workflow Execution by Id + +**--yes, -y**: Confirm all prompts + diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md new file mode 100644 index 00000000..8eb801e0 --- /dev/null +++ b/docs/workflow/trace.md @@ -0,0 +1,41 @@ + +Trace progress of a Workflow Execution and its children + +**--address**="": host:port for Temporal frontend service + +**--codec-auth**="": Authorization header to set for requests to Codec Server + +**--codec-endpoint**="": Remote Codec Server Endpoint + +**--color**="": when to use color: auto, always, never. (default: auto) + +**--concurrency**="": Request concurrency (default: 10) + +**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) + +**--depth**="": Number of child workflows to expand, -1 to expand all child workflows (default: -1) + +**--env**="": Env name to read the client environment variables from (default: default) + +**--fold**="": Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) + +**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value + +**--namespace, -n**="": Temporal workflow namespace (default: default) + +**--no-fold**: Disable folding. All child workflows within the set depth will be fetched and displayed + +**--run-id, -r**="": Run Id + +**--tls-ca-path**="": Path to server CA certificate + +**--tls-cert-path**="": Path to x509 certificate + +**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) + +**--tls-key-path**="": Path to private key + +**--tls-server-name**="": Override for target server name + +**--workflow-id, -w**="": Workflow Id + From 1d4e6311f797c145fe93df8dd3e8845c719a7e67 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 12:54:01 -0600 Subject: [PATCH 17/68] headers for each file --- cmd/doc/main.go | 14 +++++++++++--- docs/activity/complete.md | 1 + docs/activity/fail.md | 1 + docs/activity/index.md | 1 + docs/batch/describe.md | 1 + docs/batch/index.md | 1 + docs/batch/list.md | 1 + docs/batch/terminate.md | 1 + docs/completion/bash.md | 1 + docs/completion/index.md | 1 + docs/completion/zsh.md | 1 + docs/env/delete.md | 1 + docs/env/get.md | 1 + docs/env/index.md | 1 + docs/env/set.md | 1 + docs/operator/cluster.md | 1 + docs/operator/index.md | 1 + docs/operator/namespace.md | 1 + docs/operator/search-attribute.md | 1 + docs/schedule/backfill.md | 1 + docs/schedule/create.md | 1 + docs/schedule/delete.md | 1 + docs/schedule/describe.md | 1 + docs/schedule/index.md | 1 + docs/schedule/list.md | 1 + docs/schedule/toggle.md | 1 + docs/schedule/trigger.md | 1 + docs/schedule/update.md | 1 + docs/server/index.md | 1 + docs/server/start-dev.md | 1 + docs/task-queue/describe.md | 1 + docs/task-queue/index.md | 1 + docs/task-queue/list-partition.md | 1 + docs/workflow/cancel.md | 1 + docs/workflow/count.md | 1 + docs/workflow/delete.md | 1 + docs/workflow/describe.md | 1 + docs/workflow/execute.md | 1 + docs/workflow/index.md | 1 + docs/workflow/list.md | 1 + docs/workflow/query.md | 1 + docs/workflow/reset-batch.md | 5 +++-- docs/workflow/reset.md | 5 +++-- docs/workflow/show.md | 1 + docs/workflow/signal.md | 1 + docs/workflow/stack.md | 1 + docs/workflow/start.md | 1 + docs/workflow/terminate.md | 1 + docs/workflow/trace.md | 1 + 49 files changed, 63 insertions(+), 7 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 8338c018..659a4c80 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -34,7 +34,6 @@ import ( "github.com/temporalio/cli/app" ) -// todo: create separate files and folders. // todo: elaborate on each file func main() { // build app and convert to Markdown @@ -73,6 +72,8 @@ func main() { headerFile, err = os.Create(filepath.Join(path_docs, "index.md")) print_check(err) + write_line(headerFile, line) + } else if strings.HasPrefix(line, "### "){ path_docs := "docs/" + header fileName := strings.TrimSpace(line[3:]) @@ -80,10 +81,11 @@ func main() { //create file within directory headerFile, err = os.Create(filepath.Join(path_docs, fileName + ".md")) print_check(err) + //h1 for page + write_line(headerFile, line) } else if !strings.HasPrefix(line, "# ") { - _, err := headerFile.WriteString(line + "\n") - print_check(err) + write_line(headerFile, line) } else { continue } @@ -95,6 +97,12 @@ func main() { fatal_check(e) } +// write line to current file +func write_line(fileName *os.File, line string) { + _, err := fileName.WriteString(line + "\n") + print_check(err) +} + // I got sick of putting these code blocks everywhere, so now they're functions. func fatal_check(e error) { if e != nil { diff --git a/docs/activity/complete.md b/docs/activity/complete.md index 6561451b..4b2b1580 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -1,3 +1,4 @@ +### complete Complete an activity diff --git a/docs/activity/fail.md b/docs/activity/fail.md index 3ff94382..563b97e5 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -1,3 +1,4 @@ +### fail Fail an activity diff --git a/docs/activity/index.md b/docs/activity/index.md index df291ff3..02514c96 100644 --- a/docs/activity/index.md +++ b/docs/activity/index.md @@ -1,3 +1,4 @@ +## activity Operations on Activities of Workflows diff --git a/docs/batch/describe.md b/docs/batch/describe.md index 3f84f22a..19a245f8 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -1,3 +1,4 @@ +### describe Describe a batch operation job diff --git a/docs/batch/index.md b/docs/batch/index.md index 31d0bf1d..754c2b01 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -1,3 +1,4 @@ +## batch Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs diff --git a/docs/batch/list.md b/docs/batch/list.md index 07dcbcd6..0ed79299 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -1,3 +1,4 @@ +### list List batch operation jobs diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index 06fef2c3..02f78291 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -1,3 +1,4 @@ +### terminate Stop a batch operation job diff --git a/docs/completion/bash.md b/docs/completion/bash.md index c00d25e7..0ea5d8d1 100644 --- a/docs/completion/bash.md +++ b/docs/completion/bash.md @@ -1,3 +1,4 @@ +### bash bash completion output diff --git a/docs/completion/index.md b/docs/completion/index.md index 1bd364c8..830921f1 100644 --- a/docs/completion/index.md +++ b/docs/completion/index.md @@ -1,3 +1,4 @@ +## completion Output shell completion code for the specified shell (zsh, bash) diff --git a/docs/completion/zsh.md b/docs/completion/zsh.md index 7121892b..5285e9ff 100644 --- a/docs/completion/zsh.md +++ b/docs/completion/zsh.md @@ -1,2 +1,3 @@ +### zsh zsh completion output diff --git a/docs/env/delete.md b/docs/env/delete.md index dec8b5a7..84e4aa4e 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -1,3 +1,4 @@ +### delete Delete environment or environment property diff --git a/docs/env/get.md b/docs/env/get.md index 0061abdc..d074775a 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -1,3 +1,4 @@ +### get Print environment properties diff --git a/docs/env/index.md b/docs/env/index.md index fa4b7c69..ada0329f 100644 --- a/docs/env/index.md +++ b/docs/env/index.md @@ -1,3 +1,4 @@ +## env Manage client environment configurations diff --git a/docs/env/set.md b/docs/env/set.md index b158ac6b..37c8ab16 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -1,3 +1,4 @@ +### set Set environment property diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index e08bac23..355dd3f8 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -1,3 +1,4 @@ +### cluster Operations on a Temporal cluster diff --git a/docs/operator/index.md b/docs/operator/index.md index 0c9921cb..c9523cf7 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -1,3 +1,4 @@ +## operator Operation on Temporal server diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index 2c5ba740..1922aabb 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -1,3 +1,4 @@ +### namespace Operations on namespaces diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index f9b7f216..c82054fe 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -1,3 +1,4 @@ +### search-attribute Operations on search attributes diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md index 0a2a1c0d..b43fdb33 100644 --- a/docs/schedule/backfill.md +++ b/docs/schedule/backfill.md @@ -1,3 +1,4 @@ +### backfill Backfills a past time range of actions diff --git a/docs/schedule/create.md b/docs/schedule/create.md index f518d7f4..993defb5 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -1,3 +1,4 @@ +### create Create a new schedule diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md index bfb5b6ec..e78febb1 100644 --- a/docs/schedule/delete.md +++ b/docs/schedule/delete.md @@ -1,3 +1,4 @@ +### delete Deletes a schedule diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 2f980504..04986e3a 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -1,3 +1,4 @@ +### describe Get schedule configuration and current state diff --git a/docs/schedule/index.md b/docs/schedule/index.md index 35fa93ed..b8d4efff 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -1,3 +1,4 @@ +## schedule Operations on Schedules diff --git a/docs/schedule/list.md b/docs/schedule/list.md index e448169f..f8b79664 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -1,3 +1,4 @@ +### list Lists schedules diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md index ec5f2a61..283484fb 100644 --- a/docs/schedule/toggle.md +++ b/docs/schedule/toggle.md @@ -1,3 +1,4 @@ +### toggle Pauses or unpauses a schedule diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md index 417a8d95..e64103db 100644 --- a/docs/schedule/trigger.md +++ b/docs/schedule/trigger.md @@ -1,3 +1,4 @@ +### trigger Triggers an immediate action diff --git a/docs/schedule/update.md b/docs/schedule/update.md index b4a08c32..ea7df2f9 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -1,3 +1,4 @@ +### update Updates a schedule with a new definition (full replacement, not patch) diff --git a/docs/server/index.md b/docs/server/index.md index 4ca8eaa4..eebf9911 100644 --- a/docs/server/index.md +++ b/docs/server/index.md @@ -1,3 +1,4 @@ +## server Commands for managing Temporal server diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index 7ac61fb0..992d77ae 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -1,3 +1,4 @@ +### start-dev Start Temporal development server diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index 3e964b54..83ae22d2 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -1,3 +1,4 @@ +### describe Describe the Workers that have recently polled on this Task Queue diff --git a/docs/task-queue/index.md b/docs/task-queue/index.md index d5a179ea..7f0bc243 100644 --- a/docs/task-queue/index.md +++ b/docs/task-queue/index.md @@ -1,3 +1,4 @@ +## task-queue Operations on Task Queues diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index 2efa65eb..a3e42b7e 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -1,3 +1,4 @@ +### list-partition List the Task Queue's partitions and which matching node they are assigned to diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index 24c0388c..d2329932 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -1,3 +1,4 @@ +### cancel Cancel a Workflow Execution diff --git a/docs/workflow/count.md b/docs/workflow/count.md index 512de48d..9d0130ea 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -1,3 +1,4 @@ +### count Count Workflow Executions (requires ElasticSearch to be enabled) diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index e4769c64..9aacaf70 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -1,3 +1,4 @@ +### delete Delete a Workflow Execution diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index e2c9c234..254ef10d 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -1,3 +1,4 @@ +### describe Show information about a Workflow Execution diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index 54520d45..35b65775 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -1,3 +1,4 @@ +### execute Start a new Workflow Execution and print progress diff --git a/docs/workflow/index.md b/docs/workflow/index.md index 35fdc933..b44c5ffc 100644 --- a/docs/workflow/index.md +++ b/docs/workflow/index.md @@ -1,3 +1,4 @@ +## workflow Operations on Workflows diff --git a/docs/workflow/list.md b/docs/workflow/list.md index e8807e6a..6110ab17 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -1,3 +1,4 @@ +### list List Workflow Executions based on a Query diff --git a/docs/workflow/query.md b/docs/workflow/query.md index 8d1e3490..2ef57bf9 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -1,3 +1,4 @@ +### query Query a Workflow Execution diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 51d0a285..0637f163 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -1,5 +1,6 @@ +### reset-batch -Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Reset a batch of Workflow Executions by reset type: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask **--address**="": host:port for Temporal frontend service @@ -47,5 +48,5 @@ Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkf **--tls-server-name**="": Override for target server name -**--type**="": Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 8a533cb5..eab79e11 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -1,3 +1,4 @@ +### reset Reset a Workflow Execution by event Id or reset type @@ -19,7 +20,7 @@ Reset a Workflow Execution by event Id or reset type **--namespace, -n**="": Temporal workflow namespace (default: default) -**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) +**--reapply-type**="": Event types to reapply after the reset point: None, , Signal. (default: All) **--reason**="": Reason to reset @@ -35,7 +36,7 @@ Reset a Workflow Execution by event Id or reset type **--tls-server-name**="": Override for target server name -**--type**="": Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew **--workflow-id, -w**="": Workflow Id diff --git a/docs/workflow/show.md b/docs/workflow/show.md index c052db7e..5a85b743 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -1,3 +1,4 @@ +### show Show Event History for a Workflow Execution diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index 27cf0fa4..398519e8 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -1,3 +1,4 @@ +### signal Signal Workflow Execution by Id or List Filter diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index 78d40152..287cd48b 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -1,3 +1,4 @@ +### stack Query a Workflow Execution with __stack_trace as the query type diff --git a/docs/workflow/start.md b/docs/workflow/start.md index d7324563..d8c757a8 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -1,3 +1,4 @@ +### start Start a new Workflow Execution diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index f5a76bb7..cc1b127e 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -1,3 +1,4 @@ +### terminate Terminate Workflow Execution by Id or List Filter diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index 8eb801e0..f458758b 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -1,3 +1,4 @@ +### trace Trace progress of a Workflow Execution and its children From ace027c72d7f153e1f8a7ed3360c1d2409797e7c Mon Sep 17 00:00:00 2001 From: Patrick Rachford Date: Tue, 10 Jan 2023 11:42:59 -0800 Subject: [PATCH 18/68] adds error messages --- cmd/doc/main.go | 146 +++++++++++++++-------------------- docs/workflow/reset-batch.md | 2 +- docs/workflow/reset.md | 2 +- 3 files changed, 65 insertions(+), 85 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 659a4c80..1785baa7 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -1,117 +1,97 @@ -// The MIT License -// -// Copyright (c) 2022 Temporal Technologies Inc. All rights reserved. -// -// Copyright (c) 2020 Uber Technologies, Inc. -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in -// all copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -// THE SOFTWARE. - package main import ( "bufio" - "log" "os" "path/filepath" "strings" + log "github.com/sirupsen/logrus" "github.com/temporalio/cli/app" ) -// todo: elaborate on each file +const ( + docsPath = "docs" + cliFile = "cli.md" + filePerm = 0644 + indexFile = "index.md" +) + +// `BuildApp` takes a string and returns a `*App` and an error func main() { - // build app and convert to Markdown doc, err := app.BuildApp("").ToMarkdown() - fatal_check(err) - - path := "cli.md" - err = os.WriteFile(path, []byte(doc), 0644) - print_check(err) + if err != nil { + log.Fatalf("Error when trying to build app: %v", err) + } - // open file for scanner - readFile, err := os.Open(path) - print_check(err) + err = os.WriteFile(cliFile, []byte(doc), filePerm) + if err != nil { + log.Fatalf("Error when trying to write markdown to %s file: %v", cliFile, err) + } - // create scanner + readFile, err := os.Open(cliFile) + if err != nil { + log.Fatalf("Error when trying to open %s file: %v", cliFile, err) + } scanner := bufio.NewScanner(readFile) scanner.Split(bufio.ScanLines) + var currentHeader string + var currentHeaderFile *os.File + createdFiles := make(map[string]*os.File) - // track header for file and folder creation - var header string - var headerFile *os.File - - // read line for scanner.Scan() { line := scanner.Text() if strings.HasPrefix(line, "## ") { - header = strings.TrimSpace(line[2:]) - path_docs := "docs/" + header - - //create directory - err := os.MkdirAll(path_docs, os.ModePerm) - print_check(err) - - // create index file here - headerFile, err = os.Create(filepath.Join(path_docs, "index.md")) - print_check(err) - - write_line(headerFile, line) - - } else if strings.HasPrefix(line, "### "){ - path_docs := "docs/" + header + currentHeader = strings.TrimSpace(line[2:]) + path := filepath.Join(docsPath, currentHeader) + + err := os.MkdirAll(path, os.ModePerm) + if err != nil { + log.Printf("Error when trying to create directory %s: %v", path, err) + continue + } + + headerIndexFile := filepath.Join(path, indexFile) + currentHeaderFile, err = os.Create(headerIndexFile) + if err != nil { + log.Printf("Error when trying to create file %s: %v", headerIndexFile, err) + continue + } + createdFiles[headerIndexFile] = currentHeaderFile + writeLine(currentHeaderFile, line) + + } else if strings.HasPrefix(line, "### ") { + path := filepath.Join(docsPath, currentHeader) fileName := strings.TrimSpace(line[3:]) - //create file within directory - headerFile, err = os.Create(filepath.Join(path_docs, fileName + ".md")) - print_check(err) - //h1 for page - write_line(headerFile, line) - + filePath := filepath.Join(path, fileName+".md") + // check if already created file + currentHeaderFile = createdFiles[filePath] + if currentHeaderFile == nil { + currentHeaderFile, err = os.Create(filePath) + if err != nil { + log.Printf("Error when trying to create file %s: %v", filePath, err) + continue + } + createdFiles[filePath] = currentHeaderFile + } + writeLine(currentHeaderFile, line) } else if !strings.HasPrefix(line, "# ") { - write_line(headerFile, line) + writeLine(currentHeaderFile, line) } else { continue } - } - //close and remove big file + // close file descriptor after for loop has completed readFile.Close() - e := os.Remove("cli.md") - fatal_check(e) + defer os.Remove(cliFile) } -// write line to current file -func write_line(fileName *os.File, line string) { - _, err := fileName.WriteString(line + "\n") - print_check(err) -} - -// I got sick of putting these code blocks everywhere, so now they're functions. -func fatal_check(e error) { - if e != nil { - log.Fatal(e) +// It takes a file and a string, and writes the string to the file +func writeLine(file *os.File, line string) { + _, err := file.WriteString(line + "\n") + if err != nil { + log.Printf("Error when trying to write to file: %v", err) } } - -func print_check(e error) { - if e != nil { - log.Println(e) - } -} \ No newline at end of file diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 0637f163..b5b5e27a 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -1,6 +1,6 @@ ### reset-batch -Reset a batch of Workflow Executions by reset type: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask +Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew **--address**="": host:port for Temporal frontend service diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index eab79e11..608f716a 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -20,7 +20,7 @@ Reset a Workflow Execution by event Id or reset type **--namespace, -n**="": Temporal workflow namespace (default: default) -**--reapply-type**="": Event types to reapply after the reset point: None, , Signal. (default: All) +**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) **--reason**="": Reason to reset From d2ca3ee3dc5a672c3c698433e4e8552c114e6e41 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 14:50:31 -0600 Subject: [PATCH 19/68] basic formatting achieved --- cmd/doc/main.go | 11 ++ docs/activity/complete.md | 54 ++++-- docs/activity/fail.md | 57 ++++--- docs/batch/describe.md | 51 ++++-- docs/batch/list.md | 57 ++++--- docs/batch/terminate.md | 45 +++-- docs/env/delete.md | 39 +++-- docs/env/get.md | 39 +++-- docs/env/set.md | 39 +++-- docs/operator/cluster.md | 273 ++++++++++++++++++++---------- docs/operator/namespace.md | 270 +++++++++++++++++++---------- docs/operator/search-attribute.md | 135 ++++++++++----- docs/schedule/backfill.md | 51 ++++-- docs/schedule/create.md | 117 ++++++++----- docs/schedule/delete.md | 42 +++-- docs/schedule/describe.md | 54 ++++-- docs/schedule/list.md | 57 ++++--- docs/schedule/toggle.md | 51 ++++-- docs/schedule/trigger.md | 45 +++-- docs/schedule/update.md | 117 ++++++++----- docs/server/start-dev.md | 45 +++-- docs/task-queue/describe.md | 54 ++++-- docs/task-queue/list-partition.md | 45 +++-- docs/workflow/cancel.md | 54 ++++-- docs/workflow/count.md | 42 +++-- docs/workflow/delete.md | 45 +++-- docs/workflow/describe.md | 51 ++++-- docs/workflow/execute.md | 99 +++++++---- docs/workflow/list.md | 63 ++++--- docs/workflow/query.md | 57 ++++--- docs/workflow/reset-batch.md | 72 +++++--- docs/workflow/reset.md | 57 ++++--- docs/workflow/show.md | 75 +++++--- docs/workflow/signal.md | 63 ++++--- docs/workflow/stack.md | 54 ++++-- docs/workflow/start.md | 99 +++++++---- docs/workflow/terminate.md | 54 ++++-- docs/workflow/trace.md | 57 ++++--- 38 files changed, 1797 insertions(+), 893 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 1785baa7..6d144a88 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -77,6 +77,17 @@ func main() { createdFiles[filePath] = currentHeaderFile } writeLine(currentHeaderFile, line) + } else if strings.HasPrefix(line, "**--") { + // split into term and definition + term, definition, found := strings.Cut(line, ":") + + // TODO: separate terms and aliases + + // write to file + writeLine(currentHeaderFile,strings.TrimSuffix(term, "=\"\"")) + writeLine(currentHeaderFile, strings.TrimSpace(definition)) + log.Info(found) + } else if !strings.HasPrefix(line, "# ") { writeLine(currentHeaderFile, line) } else { diff --git a/docs/activity/complete.md b/docs/activity/complete.md index 4b2b1580..e22d3301 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -2,39 +2,57 @@ Complete an activity -**--activity-id**="": The Activity Id to complete +**--activity-id** +The Activity Id to complete -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--identity**="": Specify operator's identity +**--identity** +Specify operator's identity -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--result**="": Set the result value of completion +**--result** +Set the result value of completion -**--run-id, -r**="": Run Id +**--run-id, -r** +Run Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id diff --git a/docs/activity/fail.md b/docs/activity/fail.md index 563b97e5..4b9a65b8 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -2,41 +2,60 @@ Fail an activity -**--activity-id**="": The Activity Id to fail +**--activity-id** +The Activity Id to fail -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--detail**="": Detail to fail the Activity +**--detail** +Detail to fail the Activity -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--identity**="": Specify operator's identity +**--identity** +Specify operator's identity -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--reason**="": Reason to fail the Activity +**--reason** +Reason to fail the Activity -**--run-id, -r**="": Run Id +**--run-id, -r** +Run Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id diff --git a/docs/batch/describe.md b/docs/batch/describe.md index 19a245f8..6236e988 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -2,37 +2,54 @@ Describe a batch operation job -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields +**--fields** +customize fields to print. Set to 'long' to automatically print more of main fields -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--job-id**="": Batch Job Id +**--job-id** +Batch Job Id -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--time-format**="": format time as: relative, iso, raw. (default: relative) +**--time-format** +format time as: relative, iso, raw. (default: relative) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/batch/list.md b/docs/batch/list.md index 0ed79299..05f06c03 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -2,41 +2,60 @@ List batch operation jobs -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields +**--fields** +customize fields to print. Set to 'long' to automatically print more of main fields -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--limit**="": number of items to print (default: 0) +**--limit** +number of items to print (default: 0) -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--no-pager, -P**: disable interactive pager +**--no-pager, -P** +disable interactive pager -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--pager**="": pager to use: less, more, favoritePager.. +**--pager** +pager to use: less, more, favoritePager.. -**--time-format**="": format time as: relative, iso, raw. (default: relative) +**--time-format** +format time as: relative, iso, raw. (default: relative) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index 02f78291..21c9457d 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -2,33 +2,48 @@ Stop a batch operation job -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--job-id**="": Batch Job Id +**--job-id** +Batch Job Id -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--reason**="": Reason to stop the batch job +**--reason** +Reason to stop the batch job -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/env/delete.md b/docs/env/delete.md index 84e4aa4e..28b8209c 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -2,29 +2,42 @@ Delete environment or environment property -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/env/get.md b/docs/env/get.md index d074775a..fce9bc3e 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -2,29 +2,42 @@ Print environment properties -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/env/set.md b/docs/env/set.md index 37c8ab16..acf29e81 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -2,29 +2,42 @@ Set environment property -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index 355dd3f8..15d00c87 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -6,205 +6,296 @@ Operations on a Temporal cluster Check health of frontend service -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name #### describe Show information about the cluster -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields +**--fields** +customize fields to print. Set to 'long' to automatically print more of main fields -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name #### system Show information about the system and capabilities -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields +**--fields** +customize fields to print. Set to 'long' to automatically print more of main fields -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name #### upsert Add or update a remote cluster -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--enable-connection**: Enable cross cluster connection +**--enable-connection** +Enable cross cluster connection -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--frontend-address**="": Frontend address of the remote cluster +**--frontend-address** +Frontend address of the remote cluster -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name #### list List all remote clusters -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields +**--fields** +customize fields to print. Set to 'long' to automatically print more of main fields -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--limit**="": number of items to print (default: 0) +**--limit** +number of items to print (default: 0) -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--no-pager, -P**: disable interactive pager +**--no-pager, -P** +disable interactive pager -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--pager**="": pager to use: less, more, favoritePager.. +**--pager** +pager to use: less, more, favoritePager.. -**--time-format**="": format time as: relative, iso, raw. (default: relative) +**--time-format** +format time as: relative, iso, raw. (default: relative) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name #### remove Remove a remote cluster -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--name**="": Frontend address of the remote cluster +**--name** +Frontend address of the remote cluster -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index 1922aabb..cee034fd 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -6,199 +6,289 @@ Operations on namespaces Describe a Namespace by name or Id -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--namespace-id**="": Namespace Id +**--namespace-id** +Namespace Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name #### list List all Namespaces -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name #### register Register a new Namespace -**--active-cluster**="": Active cluster name +**--active-cluster** +Active cluster name -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--cluster**="": Cluster name +**--cluster** +Cluster name -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--data**="": Namespace data in a format key=value +**--data** +Namespace data in a format key=value -**--description**="": Namespace description +**--description** +Namespace description -**--email**="": Owner email +**--email** +Owner email -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--global**="": Flag to indicate whether namespace is a global namespace +**--global** +Flag to indicate whether namespace is a global namespace -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" +**--history-archival-state** +Flag to set history archival state, valid values are "disabled" and "enabled" -**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) +**--history-uri** +Optionally specify history archival URI (cannot be changed after first time archival is enabled) -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--retention**="": Workflow Execution retention +**--retention** +Workflow Execution retention -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" +**--visibility-archival-state** +Flag to set visibility archival state, valid values are "disabled" and "enabled" -**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) +**--visibility-uri** +Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) #### update Update a Namespace -**--active-cluster**="": Active cluster name +**--active-cluster** +Active cluster name -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--cluster**="": Cluster name +**--cluster** +Cluster name -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--data**="": Namespace data in a format key=value +**--data** +Namespace data in a format key=value -**--description**="": Namespace description +**--description** +Namespace description -**--email**="": Owner email +**--email** +Owner email -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--history-archival-state**="": Flag to set history archival state, valid values are "disabled" and "enabled" +**--history-archival-state** +Flag to set history archival state, valid values are "disabled" and "enabled" -**--history-uri**="": Optionally specify history archival URI (cannot be changed after first time archival is enabled) +**--history-uri** +Optionally specify history archival URI (cannot be changed after first time archival is enabled) -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--promote-global**: Promote local namespace to global namespace +**--promote-global** +Promote local namespace to global namespace -**--reason**="": Reason for the operation +**--reason** +Reason for the operation -**--retention**="": Workflow Execution retention +**--retention** +Workflow Execution retention -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--visibility-archival-state**="": Flag to set visibility archival state, valid values are "disabled" and "enabled" +**--visibility-archival-state** +Flag to set visibility archival state, valid values are "disabled" and "enabled" -**--visibility-uri**="": Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) +**--visibility-uri** +Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) #### delete Delete existing Namespace -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--yes, -y**: Confirm all prompts +**--yes, -y** +Confirm all prompts diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index c82054fe..88c8bfb9 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -6,101 +6,146 @@ Operations on search attributes Add custom search attributes -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--name**="": Search attribute name +**--name** +Search attribute name -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--type**="": Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] +**--type** +Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] -**--yes, -y**: Confirm all prompts +**--yes, -y** +Confirm all prompts #### list List search attributes that can be used in list workflow query -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name #### remove Remove custom search attributes metadata only (Elasticsearch index schema is not modified) -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--name**="": Search attribute name +**--name** +Search attribute name -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--yes, -y**: Confirm all prompts +**--yes, -y** +Confirm all prompts diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md index b43fdb33..62c80782 100644 --- a/docs/schedule/backfill.md +++ b/docs/schedule/backfill.md @@ -2,37 +2,54 @@ Backfills a past time range of actions -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--end-time**="": Backfill end time +**--end-time** +Backfill end time -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll +**--overlap-policy** +Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll -**--schedule-id, -s**="": Schedule Id +**--schedule-id, -s** +Schedule Id -**--start-time**="": Backfill start time +**--start-time** +Backfill start time -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/schedule/create.md b/docs/schedule/create.md index 993defb5..bb679d9b 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -2,81 +2,120 @@ Create a new schedule -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} +**--calendar** +Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} -**--catchup-window**="": Maximum allowed catch-up time if server is down +**--catchup-window** +Maximum allowed catch-up time if server is down -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" +**--cron** +Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" -**--end-time**="": Overall schedule end time +**--end-time** +Overall schedule end time -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) +**--execution-timeout** +Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values +**--input, -i** +Optional input for the Workflow in JSON format. Pass "null" for null values -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file +**--input-file** +Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file -**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset +**--interval** +Interval duration, e.g. 90m, or 90m/13m to include phase offset -**--jitter**="": Jitter duration +**--jitter** +Jitter duration -**--max-field-length**="": Maximum length for each attribute field (default: 0) +**--max-field-length** +Maximum length for each attribute field (default: 0) -**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value +**--memo** +Set a memo on a schedule. Format: key=value. Use valid JSON formats for value -**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value +**--memo-file** +Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--notes**="": Initial value of notes field +**--notes** +Initial value of notes field -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll +**--overlap-policy** +Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll -**--pause**: Initial value of paused state +**--pause** +Initial value of paused state -**--pause-on-failure**: Pause schedule after any workflow failure +**--pause-on-failure** +Pause schedule after any workflow failure -**--remaining-actions**="": Total number of actions allowed (default: 0) +**--remaining-actions** +Total number of actions allowed (default: 0) -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) +**--run-timeout** +Single workflow run timeout (seconds) (default: 0) -**--schedule-id, -s**="": Schedule Id +**--schedule-id, -s** +Schedule Id -**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value +**--search-attribute** +Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value -**--start-time**="": Overall schedule start time +**--start-time** +Overall schedule start time -**--task-queue, -t**="": Task queue +**--task-queue, -t** +Task queue -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) +**--task-timeout** +Workflow task start to close timeout (seconds) (default: 10) -**--time-zone**="": Time zone (IANA name) +**--time-zone** +Time zone (IANA name) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id -**--workflow-type**="": Workflow type name +**--workflow-type** +Workflow type name diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md index e78febb1..ef792576 100644 --- a/docs/schedule/delete.md +++ b/docs/schedule/delete.md @@ -2,31 +2,45 @@ Deletes a schedule -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--schedule-id, -s**="": Schedule Id +**--schedule-id, -s** +Schedule Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 04986e3a..8c58230d 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -2,39 +2,57 @@ Get schedule configuration and current state -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields +**--fields** +customize fields to print. Set to 'long' to automatically print more of main fields -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--raw**: Print raw data as json (prefer this over -o json for scripting) +**--raw** +Print raw data as json (prefer this over -o json for scripting) -**--schedule-id, -s**="": Schedule Id +**--schedule-id, -s** +Schedule Id -**--time-format**="": format time as: relative, iso, raw. (default: relative) +**--time-format** +format time as: relative, iso, raw. (default: relative) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/schedule/list.md b/docs/schedule/list.md index f8b79664..3ec20f34 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -2,41 +2,60 @@ Lists schedules -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields +**--fields** +customize fields to print. Set to 'long' to automatically print more of main fields -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--limit**="": number of items to print (default: 0) +**--limit** +number of items to print (default: 0) -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--no-pager, -P**: disable interactive pager +**--no-pager, -P** +disable interactive pager -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--pager**="": pager to use: less, more, favoritePager.. +**--pager** +pager to use: less, more, favoritePager.. -**--time-format**="": format time as: relative, iso, raw. (default: relative) +**--time-format** +format time as: relative, iso, raw. (default: relative) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md index 283484fb..c78118d6 100644 --- a/docs/schedule/toggle.md +++ b/docs/schedule/toggle.md @@ -2,37 +2,54 @@ Pauses or unpauses a schedule -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--pause**: Pauses the schedule +**--pause** +Pauses the schedule -**--reason**="": Free-form text to describe reason for pause/unpause (default: (no reason provided)) +**--reason** +Free-form text to describe reason for pause/unpause (default: (no reason provided)) -**--schedule-id, -s**="": Schedule Id +**--schedule-id, -s** +Schedule Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--unpause**: Unpauses the schedule +**--unpause** +Unpauses the schedule diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md index e64103db..7d5631a3 100644 --- a/docs/schedule/trigger.md +++ b/docs/schedule/trigger.md @@ -2,33 +2,48 @@ Triggers an immediate action -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll +**--overlap-policy** +Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll -**--schedule-id, -s**="": Schedule Id +**--schedule-id, -s** +Schedule Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/schedule/update.md b/docs/schedule/update.md index ea7df2f9..d228add5 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -2,81 +2,120 @@ Updates a schedule with a new definition (full replacement, not patch) -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--calendar**="": Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} +**--calendar** +Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} -**--catchup-window**="": Maximum allowed catch-up time if server is down +**--catchup-window** +Maximum allowed catch-up time if server is down -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--cron**="": Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" +**--cron** +Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" -**--end-time**="": Overall schedule end time +**--end-time** +Overall schedule end time -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) +**--execution-timeout** +Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values +**--input, -i** +Optional input for the Workflow in JSON format. Pass "null" for null values -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file +**--input-file** +Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file -**--interval**="": Interval duration, e.g. 90m, or 90m/13m to include phase offset +**--interval** +Interval duration, e.g. 90m, or 90m/13m to include phase offset -**--jitter**="": Jitter duration +**--jitter** +Jitter duration -**--max-field-length**="": Maximum length for each attribute field (default: 0) +**--max-field-length** +Maximum length for each attribute field (default: 0) -**--memo**="": Set a memo on a schedule. Format: key=value. Use valid JSON formats for value +**--memo** +Set a memo on a schedule. Format: key=value. Use valid JSON formats for value -**--memo-file**="": Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value +**--memo-file** +Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--notes**="": Initial value of notes field +**--notes** +Initial value of notes field -**--overlap-policy**="": Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll +**--overlap-policy** +Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll -**--pause**: Initial value of paused state +**--pause** +Initial value of paused state -**--pause-on-failure**: Pause schedule after any workflow failure +**--pause-on-failure** +Pause schedule after any workflow failure -**--remaining-actions**="": Total number of actions allowed (default: 0) +**--remaining-actions** +Total number of actions allowed (default: 0) -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) +**--run-timeout** +Single workflow run timeout (seconds) (default: 0) -**--schedule-id, -s**="": Schedule Id +**--schedule-id, -s** +Schedule Id -**--search-attribute**="": Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value +**--search-attribute** +Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value -**--start-time**="": Overall schedule start time +**--start-time** +Overall schedule start time -**--task-queue, -t**="": Task queue +**--task-queue, -t** +Task queue -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) +**--task-timeout** +Workflow task start to close timeout (seconds) (default: 10) -**--time-zone**="": Time zone (IANA name) +**--time-zone** +Time zone (IANA name) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id -**--workflow-type**="": Workflow type name +**--workflow-type** +Workflow type name diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index 992d77ae..ce430241 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -2,33 +2,48 @@ Start Temporal development server -**--config, -c**="": Path to config directory +**--config, -c** +Path to config directory -**--db-filename, -f**="": File in which to persist Temporal state (by default, Workflows are lost when the process dies) +**--db-filename, -f** +File in which to persist Temporal state (by default, Workflows are lost when the process dies) -**--dynamic-config-value**="": Dynamic config value, as KEY=JSON_VALUE (string values need quotes) +**--dynamic-config-value** +Dynamic config value, as KEY=JSON_VALUE (string values need quotes) -**--headless**: Disable the Web UI +**--headless** +Disable the Web UI -**--ip**="": IPv4 address to bind the frontend service to (default: 127.0.0.1) +**--ip** +IPv4 address to bind the frontend service to (default: 127.0.0.1) -**--log-format**="": Set the log formatting. Options: ["json", "pretty"]. (default: json) +**--log-format** +Set the log formatting. Options: ["json", "pretty"]. (default: json) -**--log-level**="": Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) +**--log-level** +Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) -**--metrics-port**="": Port for /metrics (default: 0) +**--metrics-port** +Port for /metrics (default: 0) -**--namespace, -n**="": Specify namespaces that should be pre-created (namespace "default" is always created) +**--namespace, -n** +Specify namespaces that should be pre-created (namespace "default" is always created) -**--port, -p**="": Port for the frontend gRPC service (default: 7233) +**--port, -p** +Port for the frontend gRPC service (default: 7233) -**--sqlite-pragma**="": Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. +**--sqlite-pragma** +Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. -**--ui-asset-path**="": UI Custom Assets path +**--ui-asset-path** +UI Custom Assets path -**--ui-codec-endpoint**="": UI Remote data converter HTTP endpoint +**--ui-codec-endpoint** +UI Remote data converter HTTP endpoint -**--ui-ip**="": IPv4 address to bind the Web UI to +**--ui-ip** +IPv4 address to bind the Web UI to -**--ui-port**="": Port for the Web UI (default: 0) +**--ui-port** +Port for the Web UI (default: 0) diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index 83ae22d2..eacf1b22 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -2,39 +2,57 @@ Describe the Workers that have recently polled on this Task Queue -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields +**--fields** +customize fields to print. Set to 'long' to automatically print more of main fields -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--task-queue, -t**="": Task Queue name +**--task-queue, -t** +Task Queue name -**--task-queue-type**="": Task Queue type [workflow|activity] (default: workflow) +**--task-queue-type** +Task Queue type [workflow|activity] (default: workflow) -**--time-format**="": format time as: relative, iso, raw. (default: relative) +**--time-format** +format time as: relative, iso, raw. (default: relative) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index a3e42b7e..11c828a3 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -2,33 +2,48 @@ List the Task Queue's partitions and which matching node they are assigned to -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--task-queue, -t**="": Task Queue name +**--task-queue, -t** +Task Queue name -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index d2329932..fff0b306 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -2,39 +2,57 @@ Cancel a Workflow Execution -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--query, -q**="": Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ +**--query, -q** +Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ -**--reason**="": Reason for canceling with List Filter +**--reason** +Reason for canceling with List Filter -**--run-id, -r**="": Run Id +**--run-id, -r** +Run Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--workflow-id, -w**="": Cancel Workflow Execution by Id +**--workflow-id, -w** +Cancel Workflow Execution by Id -**--yes, -y**: Confirm all prompts +**--yes, -y** +Confirm all prompts diff --git a/docs/workflow/count.md b/docs/workflow/count.md index 9d0130ea..a306f8fc 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -2,31 +2,45 @@ Count Workflow Executions (requires ElasticSearch to be enabled) -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details +**--query, -q** +Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index 9aacaf70..bd438872 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -2,33 +2,48 @@ Delete a Workflow Execution -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--run-id, -r**="": Run Id +**--run-id, -r** +Run Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index 254ef10d..a58d4820 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -2,37 +2,54 @@ Show information about a Workflow Execution -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--raw**: Print properties as they are stored +**--raw** +Print properties as they are stored -**--reset-points**: Only show auto-reset points +**--reset-points** +Only show auto-reset points -**--run-id, -r**="": Run Id +**--run-id, -r** +Run Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index 35b65775..c37ff332 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -2,17 +2,23 @@ Start a new Workflow Execution and print progress -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: +**--cron** +Optional cron schedule for the Workflow. Cron spec is as following: ┌───────────── minute (0 - 59) │ ┌───────────── hour (0 - 23) │ │ ┌───────────── day of the month (1 - 31) @@ -21,57 +27,84 @@ Start a new Workflow Execution and print progress │ │ │ │ │ * * * * * -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) +**--execution-timeout** +Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields +**--fields** +customize fields to print. Set to 'long' to automatically print more of main fields -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning +**--id-reuse-policy** +Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values +**--input, -i** +Optional input for the Workflow in JSON format. Pass "null" for null values -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file +**--input-file** +Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file -**--limit**="": number of items to print (default: 0) +**--limit** +number of items to print (default: 0) -**--max-field-length**="": Maximum length for each attribute field (default: 0) +**--max-field-length** +Maximum length for each attribute field (default: 0) -**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value +**--memo** +Pass a memo in a format key=value. Use valid JSON formats for value -**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value +**--memo-file** +Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--no-pager, -P**: disable interactive pager +**--no-pager, -P** +disable interactive pager -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--pager**="": pager to use: less, more, favoritePager.. +**--pager** +pager to use: less, more, favoritePager.. -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) +**--run-timeout** +Single workflow run timeout (seconds) (default: 0) -**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value +**--search-attribute** +Pass Search Attribute in a format key=value. Use valid JSON formats for value -**--task-queue, -t**="": Task queue +**--task-queue, -t** +Task queue -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) +**--task-timeout** +Workflow task start to close timeout (seconds) (default: 10) -**--time-format**="": format time as: relative, iso, raw. (default: relative) +**--time-format** +format time as: relative, iso, raw. (default: relative) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--type**="": Workflow type name +**--type** +Workflow type name -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id diff --git a/docs/workflow/list.md b/docs/workflow/list.md index 6110ab17..b95c88a9 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -2,45 +2,66 @@ List Workflow Executions based on a Query -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--archived**: List archived Workflow Executions (EXPERIMENTAL) +**--archived** +List archived Workflow Executions (EXPERIMENTAL) -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields +**--fields** +customize fields to print. Set to 'long' to automatically print more of main fields -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--limit**="": number of items to print (default: 0) +**--limit** +number of items to print (default: 0) -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--no-pager, -P**: disable interactive pager +**--no-pager, -P** +disable interactive pager -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--pager**="": pager to use: less, more, favoritePager.. +**--pager** +pager to use: less, more, favoritePager.. -**--query, -q**="": Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details +**--query, -q** +Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details -**--time-format**="": format time as: relative, iso, raw. (default: relative) +**--time-format** +format time as: relative, iso, raw. (default: relative) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name diff --git a/docs/workflow/query.md b/docs/workflow/query.md index 2ef57bf9..6bf72bb1 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -2,41 +2,60 @@ Query a Workflow Execution -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space +**--input, -i** +Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space -**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line +**--input-file** +Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" +**--reject-condition** +Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" -**--run-id, -r**="": Run Id +**--run-id, -r** +Run Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--type**="": The query type you want to run +**--type** +The query type you want to run -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index b5b5e27a..03837fa6 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -2,51 +2,75 @@ Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--dry-run**: Simulate reset without resetting any Workflow Executions +**--dry-run** +Simulate reset without resetting any Workflow Executions -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--exclude-file**="": Input file that specifies Workflow Executions to exclude from resetting +**--exclude-file** +Input file that specifies Workflow Executions to exclude from resetting -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--input-file**="": Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id +**--input-file** +Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id -**--input-parallelism**="": Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) +**--input-parallelism** +Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) -**--input-separator**="": Separator for the input file. The default is a tab ( ) (default: ) +**--input-separator** +Separator for the input file. The default is a tab ( ) (default: ) -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--non-deterministic**: Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error +**--non-deterministic** +Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error -**--query, -q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query +**--query, -q** +Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query -**--reason**="": Reason for resetting the Workflow Executions +**--reason** +Reason for resetting the Workflow Executions -**--skip-base-is-not-current**: Skip a Workflow Execution if the base Run is not the current Run +**--skip-base-is-not-current** +Skip a Workflow Execution if the base Run is not the current Run -**--skip-current-open**: Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run +**--skip-current-open** +Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +**--type** +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 608f716a..89a01ea8 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -2,41 +2,60 @@ Reset a Workflow Execution by event Id or reset type -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--event-id**="": The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others +**--event-id** +The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--reapply-type**="": Event types to reapply after the reset point: , Signal, None. (default: All) +**--reapply-type** +Event types to reapply after the reset point: , Signal, None. (default: All) -**--reason**="": Reason to reset +**--reason** +Reason to reset -**--run-id, -r**="": Run Id +**--run-id, -r** +Run Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--type**="": Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +**--type** +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id diff --git a/docs/workflow/show.md b/docs/workflow/show.md index 5a85b743..0e130708 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -2,53 +2,78 @@ Show Event History for a Workflow Execution -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields +**--fields** +customize fields to print. Set to 'long' to automatically print more of main fields -**--follow, -f**: Follow the progress of Workflow Execution +**--follow, -f** +Follow the progress of Workflow Execution -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--limit**="": number of items to print (default: 0) +**--limit** +number of items to print (default: 0) -**--max-field-length**="": Maximum length for each attribute field (default: 500) +**--max-field-length** +Maximum length for each attribute field (default: 500) -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--no-pager, -P**: disable interactive pager +**--no-pager, -P** +disable interactive pager -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--output-filename**="": Serialize history event to a file +**--output-filename** +Serialize history event to a file -**--pager**="": pager to use: less, more, favoritePager.. +**--pager** +pager to use: less, more, favoritePager.. -**--reset-points**: Only show events that are eligible for reset +**--reset-points** +Only show events that are eligible for reset -**--run-id, -r**="": Run Id +**--run-id, -r** +Run Id -**--time-format**="": format time as: relative, iso, raw. (default: relative) +**--time-format** +format time as: relative, iso, raw. (default: relative) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index 398519e8..fa7606bc 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -2,45 +2,66 @@ Signal Workflow Execution by Id or List Filter -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--input, -i**="": Input for the signal (JSON) +**--input, -i** +Input for the signal (JSON) -**--input-file**="": Input for the signal from file (JSON) +**--input-file** +Input for the signal from file (JSON) -**--name**="": Signal Name +**--name** +Signal Name -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--query, -q**="": Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ +**--query, -q** +Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ -**--reason**="": Reason for signaling with List Filter +**--reason** +Reason for signaling with List Filter -**--run-id, -r**="": Run Id +**--run-id, -r** +Run Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--workflow-id, -w**="": Signal Workflow Execution by Id +**--workflow-id, -w** +Signal Workflow Execution by Id -**--yes, -y**: Confirm all prompts +**--yes, -y** +Confirm all prompts diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index 287cd48b..dc02abb3 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -2,39 +2,57 @@ Query a Workflow Execution with __stack_trace as the query type -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--input, -i**="": Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space +**--input, -i** +Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space -**--input-file**="": Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line +**--input-file** +Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--reject-condition**="": Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" +**--reject-condition** +Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" -**--run-id, -r**="": Run Id +**--run-id, -r** +Run Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id diff --git a/docs/workflow/start.md b/docs/workflow/start.md index d8c757a8..3b5e719b 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -2,17 +2,23 @@ Start a new Workflow Execution -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--cron**="": Optional cron schedule for the Workflow. Cron spec is as following: +**--cron** +Optional cron schedule for the Workflow. Cron spec is as following: ┌───────────── minute (0 - 59) │ ┌───────────── hour (0 - 23) │ │ ┌───────────── day of the month (1 - 31) @@ -21,57 +27,84 @@ Start a new Workflow Execution │ │ │ │ │ * * * * * -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--execution-timeout**="": Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) +**--execution-timeout** +Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) -**--fields**="": customize fields to print. Set to 'long' to automatically print more of main fields +**--fields** +customize fields to print. Set to 'long' to automatically print more of main fields -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--id-reuse-policy**="": Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning +**--id-reuse-policy** +Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning -**--input, -i**="": Optional input for the Workflow in JSON format. Pass "null" for null values +**--input, -i** +Optional input for the Workflow in JSON format. Pass "null" for null values -**--input-file**="": Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file +**--input-file** +Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file -**--limit**="": number of items to print (default: 0) +**--limit** +number of items to print (default: 0) -**--max-field-length**="": Maximum length for each attribute field (default: 0) +**--max-field-length** +Maximum length for each attribute field (default: 0) -**--memo**="": Pass a memo in a format key=value. Use valid JSON formats for value +**--memo** +Pass a memo in a format key=value. Use valid JSON formats for value -**--memo-file**="": Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value +**--memo-file** +Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--no-pager, -P**: disable interactive pager +**--no-pager, -P** +disable interactive pager -**--output, -o**="": format output as: table, json, card. (default: table) +**--output, -o** +format output as: table, json, card. (default: table) -**--pager**="": pager to use: less, more, favoritePager.. +**--pager** +pager to use: less, more, favoritePager.. -**--run-timeout**="": Single workflow run timeout (seconds) (default: 0) +**--run-timeout** +Single workflow run timeout (seconds) (default: 0) -**--search-attribute**="": Pass Search Attribute in a format key=value. Use valid JSON formats for value +**--search-attribute** +Pass Search Attribute in a format key=value. Use valid JSON formats for value -**--task-queue, -t**="": Task queue +**--task-queue, -t** +Task queue -**--task-timeout**="": Workflow task start to close timeout (seconds) (default: 10) +**--task-timeout** +Workflow task start to close timeout (seconds) (default: 10) -**--time-format**="": format time as: relative, iso, raw. (default: relative) +**--time-format** +format time as: relative, iso, raw. (default: relative) -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--type**="": Workflow type name +**--type** +Workflow type name -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index cc1b127e..22cde926 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -2,39 +2,57 @@ Terminate Workflow Execution by Id or List Filter -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--query, -q**="": Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ +**--query, -q** +Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ -**--reason**="": Reason for termination +**--reason** +Reason for termination -**--run-id, -r**="": Run Id +**--run-id, -r** +Run Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--workflow-id, -w**="": Terminate Workflow Execution by Id +**--workflow-id, -w** +Terminate Workflow Execution by Id -**--yes, -y**: Confirm all prompts +**--yes, -y** +Confirm all prompts diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index f458758b..9662170f 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -2,41 +2,60 @@ Trace progress of a Workflow Execution and its children -**--address**="": host:port for Temporal frontend service +**--address** +host:port for Temporal frontend service -**--codec-auth**="": Authorization header to set for requests to Codec Server +**--codec-auth** +Authorization header to set for requests to Codec Server -**--codec-endpoint**="": Remote Codec Server Endpoint +**--codec-endpoint** +Remote Codec Server Endpoint -**--color**="": when to use color: auto, always, never. (default: auto) +**--color** +when to use color: auto, always, never. (default: auto) -**--concurrency**="": Request concurrency (default: 10) +**--concurrency** +Request concurrency (default: 10) -**--context-timeout**="": Optional timeout for context of RPC call in seconds (default: 5) +**--context-timeout** +Optional timeout for context of RPC call in seconds (default: 5) -**--depth**="": Number of child workflows to expand, -1 to expand all child workflows (default: -1) +**--depth** +Number of child workflows to expand, -1 to expand all child workflows (default: -1) -**--env**="": Env name to read the client environment variables from (default: default) +**--env** +Env name to read the client environment variables from (default: default) -**--fold**="": Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) +**--fold** +Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) -**--grpc-meta**="": gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +**--grpc-meta** +gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n**="": Temporal workflow namespace (default: default) +**--namespace, -n** +Temporal workflow namespace (default: default) -**--no-fold**: Disable folding. All child workflows within the set depth will be fetched and displayed +**--no-fold** +Disable folding. All child workflows within the set depth will be fetched and displayed -**--run-id, -r**="": Run Id +**--run-id, -r** +Run Id -**--tls-ca-path**="": Path to server CA certificate +**--tls-ca-path** +Path to server CA certificate -**--tls-cert-path**="": Path to x509 certificate +**--tls-cert-path** +Path to x509 certificate -**--tls-disable-host-verification**: Disable tls host name verification (tls must be enabled) +**--tls-disable-host-verification** +Disable tls host name verification (tls must be enabled) -**--tls-key-path**="": Path to private key +**--tls-key-path** +Path to private key -**--tls-server-name**="": Override for target server name +**--tls-server-name** +Override for target server name -**--workflow-id, -w**="": Workflow Id +**--workflow-id, -w** +Workflow Id From 2851825aed7551f07bd71ace33877030444371cd Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 15:15:10 -0600 Subject: [PATCH 20/68] separates aliases from terms --- cmd/doc/main.go | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 6d144a88..b81d631c 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -80,11 +80,16 @@ func main() { } else if strings.HasPrefix(line, "**--") { // split into term and definition term, definition, found := strings.Cut(line, ":") + + // write to file + term = strings.TrimSuffix(term, "=\"\"") // TODO: separate terms and aliases - - // write to file - writeLine(currentHeaderFile,strings.TrimSuffix(term, "=\"\"")) + if strings.Contains(term, ",") { + makeAlias(currentHeaderFile, term) + } else { + writeLine(currentHeaderFile, term) + } writeLine(currentHeaderFile, strings.TrimSpace(definition)) log.Info(found) @@ -106,3 +111,10 @@ func writeLine(file *os.File, line string) { log.Printf("Error when trying to write to file: %v", err) } } + +// separates aliases from terms +func makeAlias(file *os.File, line string) { + termArray := strings.Split(line, ",") + writeLine(file, termArray[0] + "**") + writeLine(file, "Alias: **" + strings.TrimSpace(termArray[1])) +} From d4d4dc3dbe3d2d8c78b658f52298d8685469cf68 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 10 Jan 2023 15:15:14 -0600 Subject: [PATCH 21/68] minor fix --- docs/activity/complete.md | 9 ++++++--- docs/activity/fail.md | 9 ++++++--- docs/batch/describe.md | 6 ++++-- docs/batch/list.md | 9 ++++++--- docs/batch/terminate.md | 3 ++- docs/env/delete.md | 3 ++- docs/env/get.md | 3 ++- docs/env/set.md | 3 ++- docs/operator/cluster.md | 30 ++++++++++++++++++++---------- docs/operator/namespace.md | 18 ++++++++++++------ docs/operator/search-attribute.md | 18 ++++++++++++------ docs/schedule/backfill.md | 6 ++++-- docs/schedule/create.md | 15 ++++++++++----- docs/schedule/delete.md | 6 ++++-- docs/schedule/describe.md | 9 ++++++--- docs/schedule/list.md | 9 ++++++--- docs/schedule/toggle.md | 6 ++++-- docs/schedule/trigger.md | 6 ++++-- docs/schedule/update.md | 15 ++++++++++----- docs/server/start-dev.md | 12 ++++++++---- docs/task-queue/describe.md | 9 ++++++--- docs/task-queue/list-partition.md | 9 ++++++--- docs/workflow/cancel.md | 15 ++++++++++----- docs/workflow/count.md | 6 ++++-- docs/workflow/delete.md | 9 ++++++--- docs/workflow/describe.md | 9 ++++++--- docs/workflow/execute.md | 18 ++++++++++++------ docs/workflow/list.md | 12 ++++++++---- docs/workflow/query.md | 12 ++++++++---- docs/workflow/reset-batch.md | 6 ++++-- docs/workflow/reset.md | 11 +++++++---- docs/workflow/show.md | 18 ++++++++++++------ docs/workflow/signal.md | 18 ++++++++++++------ docs/workflow/stack.md | 12 ++++++++---- docs/workflow/start.md | 18 ++++++++++++------ docs/workflow/terminate.md | 15 ++++++++++----- docs/workflow/trace.md | 9 ++++++--- 37 files changed, 267 insertions(+), 134 deletions(-) diff --git a/docs/activity/complete.md b/docs/activity/complete.md index e22d3301..fdd12672 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -29,13 +29,15 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--identity** Specify operator's identity -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--result** Set the result value of completion -**--run-id, -r** +**--run-id** +Alias: ** -r** Run Id **--tls-ca-path** @@ -53,6 +55,7 @@ Path to private key **--tls-server-name** Override for target server name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id diff --git a/docs/activity/fail.md b/docs/activity/fail.md index 4b9a65b8..f0a14cd1 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -32,13 +32,15 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--identity** Specify operator's identity -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--reason** Reason to fail the Activity -**--run-id, -r** +**--run-id** +Alias: ** -r** Run Id **--tls-ca-path** @@ -56,6 +58,7 @@ Path to private key **--tls-server-name** Override for target server name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id diff --git a/docs/batch/describe.md b/docs/batch/describe.md index 6236e988..8d0926bd 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -29,10 +29,12 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--job-id** Batch Job Id -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) **--time-format** diff --git a/docs/batch/list.md b/docs/batch/list.md index 05f06c03..f2ee1756 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -29,13 +29,16 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--limit** number of items to print (default: 0) -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--no-pager, -P** +**--no-pager** +Alias: ** -P** disable interactive pager -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) **--pager** diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index 21c9457d..4aefee1e 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -26,7 +26,8 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--job-id** Batch Job Id -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--reason** diff --git a/docs/env/delete.md b/docs/env/delete.md index 28b8209c..dcbd1fae 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -23,7 +23,8 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--tls-ca-path** diff --git a/docs/env/get.md b/docs/env/get.md index fce9bc3e..5cabe3ea 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -23,7 +23,8 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--tls-ca-path** diff --git a/docs/env/set.md b/docs/env/set.md index acf29e81..8d47be16 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -23,7 +23,8 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--tls-ca-path** diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index 15d00c87..dd0f0e16 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -27,7 +27,8 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--tls-ca-path** @@ -73,10 +74,12 @@ customize fields to print. Set to 'long' to automatically print more of main fie **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) **--tls-ca-path** @@ -122,10 +125,12 @@ customize fields to print. Set to 'long' to automatically print more of main fie **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) **--tls-ca-path** @@ -174,7 +179,8 @@ Frontend address of the remote cluster **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--tls-ca-path** @@ -223,13 +229,16 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--limit** number of items to print (default: 0) -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--no-pager, -P** +**--no-pager** +Alias: ** -P** disable interactive pager -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) **--pager** @@ -281,7 +290,8 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--name** Frontend address of the remote cluster -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--tls-ca-path** diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index cee034fd..f709b68d 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -27,7 +27,8 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--namespace-id** @@ -73,7 +74,8 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--tls-ca-path** @@ -140,7 +142,8 @@ Flag to set history archival state, valid values are "disabled" and "enabled" **--history-uri** Optionally specify history archival URI (cannot be changed after first time archival is enabled) -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--retention** @@ -213,7 +216,8 @@ Flag to set history archival state, valid values are "disabled" and "enabled" **--history-uri** Optionally specify history archival URI (cannot be changed after first time archival is enabled) -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--promote-global** @@ -271,7 +275,8 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--tls-ca-path** @@ -289,6 +294,7 @@ Path to private key **--tls-server-name** Override for target server name -**--yes, -y** +**--yes** +Alias: ** -y** Confirm all prompts diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index 88c8bfb9..97145ca6 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -30,7 +30,8 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--name** Search attribute name -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--tls-ca-path** @@ -51,7 +52,8 @@ Override for target server name **--type** Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] -**--yes, -y** +**--yes** +Alias: ** -y** Confirm all prompts #### list @@ -79,10 +81,12 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) **--tls-ca-path** @@ -128,7 +132,8 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--name** Search attribute name -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--tls-ca-path** @@ -146,6 +151,7 @@ Path to private key **--tls-server-name** Override for target server name -**--yes, -y** +**--yes** +Alias: ** -y** Confirm all prompts diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md index 62c80782..5de5b6a5 100644 --- a/docs/schedule/backfill.md +++ b/docs/schedule/backfill.md @@ -26,13 +26,15 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--overlap-policy** Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll -**--schedule-id, -s** +**--schedule-id** +Alias: ** -s** Schedule Id **--start-time** diff --git a/docs/schedule/create.md b/docs/schedule/create.md index bb679d9b..f2e433d5 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -38,7 +38,8 @@ Workflow Execution timeout, including retries and continue-as-new (seconds) (def **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--input, -i** +**--input** +Alias: ** -i** Optional input for the Workflow in JSON format. Pass "null" for null values **--input-file** @@ -59,7 +60,8 @@ Set a memo on a schedule. Format: key=value. Use valid JSON formats for value **--memo-file** Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--notes** @@ -80,7 +82,8 @@ Total number of actions allowed (default: 0) **--run-timeout** Single workflow run timeout (seconds) (default: 0) -**--schedule-id, -s** +**--schedule-id** +Alias: ** -s** Schedule Id **--search-attribute** @@ -89,7 +92,8 @@ Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats fo **--start-time** Overall schedule start time -**--task-queue, -t** +**--task-queue** +Alias: ** -t** Task queue **--task-timeout** @@ -113,7 +117,8 @@ Path to private key **--tls-server-name** Override for target server name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id **--workflow-type** diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md index ef792576..ae590ddc 100644 --- a/docs/schedule/delete.md +++ b/docs/schedule/delete.md @@ -23,10 +23,12 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--schedule-id, -s** +**--schedule-id** +Alias: ** -s** Schedule Id **--tls-ca-path** diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 8c58230d..9d2d019d 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -26,16 +26,19 @@ customize fields to print. Set to 'long' to automatically print more of main fie **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) **--raw** Print raw data as json (prefer this over -o json for scripting) -**--schedule-id, -s** +**--schedule-id** +Alias: ** -s** Schedule Id **--time-format** diff --git a/docs/schedule/list.md b/docs/schedule/list.md index 3ec20f34..5e138026 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -29,13 +29,16 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--limit** number of items to print (default: 0) -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--no-pager, -P** +**--no-pager** +Alias: ** -P** disable interactive pager -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) **--pager** diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md index c78118d6..0abee183 100644 --- a/docs/schedule/toggle.md +++ b/docs/schedule/toggle.md @@ -23,7 +23,8 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--pause** @@ -32,7 +33,8 @@ Pauses the schedule **--reason** Free-form text to describe reason for pause/unpause (default: (no reason provided)) -**--schedule-id, -s** +**--schedule-id** +Alias: ** -s** Schedule Id **--tls-ca-path** diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md index 7d5631a3..3b239e27 100644 --- a/docs/schedule/trigger.md +++ b/docs/schedule/trigger.md @@ -23,13 +23,15 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--overlap-policy** Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll -**--schedule-id, -s** +**--schedule-id** +Alias: ** -s** Schedule Id **--tls-ca-path** diff --git a/docs/schedule/update.md b/docs/schedule/update.md index d228add5..fb331d2e 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -38,7 +38,8 @@ Workflow Execution timeout, including retries and continue-as-new (seconds) (def **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--input, -i** +**--input** +Alias: ** -i** Optional input for the Workflow in JSON format. Pass "null" for null values **--input-file** @@ -59,7 +60,8 @@ Set a memo on a schedule. Format: key=value. Use valid JSON formats for value **--memo-file** Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--notes** @@ -80,7 +82,8 @@ Total number of actions allowed (default: 0) **--run-timeout** Single workflow run timeout (seconds) (default: 0) -**--schedule-id, -s** +**--schedule-id** +Alias: ** -s** Schedule Id **--search-attribute** @@ -89,7 +92,8 @@ Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats fo **--start-time** Overall schedule start time -**--task-queue, -t** +**--task-queue** +Alias: ** -t** Task queue **--task-timeout** @@ -113,7 +117,8 @@ Path to private key **--tls-server-name** Override for target server name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id **--workflow-type** diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index ce430241..ba992bab 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -2,10 +2,12 @@ Start Temporal development server -**--config, -c** +**--config** +Alias: ** -c** Path to config directory -**--db-filename, -f** +**--db-filename** +Alias: ** -f** File in which to persist Temporal state (by default, Workflows are lost when the process dies) **--dynamic-config-value** @@ -26,10 +28,12 @@ Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: i **--metrics-port** Port for /metrics (default: 0) -**--namespace, -n** +**--namespace** +Alias: ** -n** Specify namespaces that should be pre-created (namespace "default" is always created) -**--port, -p** +**--port** +Alias: ** -p** Port for the frontend gRPC service (default: 7233) **--sqlite-pragma** diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index eacf1b22..5fea43f2 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -26,13 +26,16 @@ customize fields to print. Set to 'long' to automatically print more of main fie **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) -**--task-queue, -t** +**--task-queue** +Alias: ** -t** Task Queue name **--task-queue-type** diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index 11c828a3..32fef0bd 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -23,13 +23,16 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) -**--task-queue, -t** +**--task-queue** +Alias: ** -t** Task Queue name **--tls-ca-path** diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index fff0b306..cd647731 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -23,16 +23,19 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--query, -q** +**--query** +Alias: ** -q** Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ **--reason** Reason for canceling with List Filter -**--run-id, -r** +**--run-id** +Alias: ** -r** Run Id **--tls-ca-path** @@ -50,9 +53,11 @@ Path to private key **--tls-server-name** Override for target server name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Cancel Workflow Execution by Id -**--yes, -y** +**--yes** +Alias: ** -y** Confirm all prompts diff --git a/docs/workflow/count.md b/docs/workflow/count.md index a306f8fc..0db0aaeb 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -23,10 +23,12 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--query, -q** +**--query** +Alias: ** -q** Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details **--tls-ca-path** diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index bd438872..22749a61 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -23,10 +23,12 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--run-id, -r** +**--run-id** +Alias: ** -r** Run Id **--tls-ca-path** @@ -44,6 +46,7 @@ Path to private key **--tls-server-name** Override for target server name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index a58d4820..58a6600e 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -23,7 +23,8 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--raw** @@ -32,7 +33,8 @@ Print properties as they are stored **--reset-points** Only show auto-reset points -**--run-id, -r** +**--run-id** +Alias: ** -r** Run Id **--tls-ca-path** @@ -50,6 +52,7 @@ Path to private key **--tls-server-name** Override for target server name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index c37ff332..a112ab67 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -42,7 +42,8 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--id-reuse-policy** Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning -**--input, -i** +**--input** +Alias: ** -i** Optional input for the Workflow in JSON format. Pass "null" for null values **--input-file** @@ -60,13 +61,16 @@ Pass a memo in a format key=value. Use valid JSON formats for value **--memo-file** Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--no-pager, -P** +**--no-pager** +Alias: ** -P** disable interactive pager -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) **--pager** @@ -78,7 +82,8 @@ Single workflow run timeout (seconds) (default: 0) **--search-attribute** Pass Search Attribute in a format key=value. Use valid JSON formats for value -**--task-queue, -t** +**--task-queue** +Alias: ** -t** Task queue **--task-timeout** @@ -105,6 +110,7 @@ Override for target server name **--type** Workflow type name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id diff --git a/docs/workflow/list.md b/docs/workflow/list.md index b95c88a9..4b37dc99 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -32,19 +32,23 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--limit** number of items to print (default: 0) -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--no-pager, -P** +**--no-pager** +Alias: ** -P** disable interactive pager -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) **--pager** pager to use: less, more, favoritePager.. -**--query, -q** +**--query** +Alias: ** -q** Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details **--time-format** diff --git a/docs/workflow/query.md b/docs/workflow/query.md index 6bf72bb1..0ff8a62f 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -23,19 +23,22 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--input, -i** +**--input** +Alias: ** -i** Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space **--input-file** Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--reject-condition** Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" -**--run-id, -r** +**--run-id** +Alias: ** -r** Run Id **--tls-ca-path** @@ -56,6 +59,7 @@ Override for target server name **--type** The query type you want to run -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 03837fa6..9f0ee59d 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -38,13 +38,15 @@ Number of goroutines to run in parallel. Each goroutine processes one line for e **--input-separator** Separator for the input file. The default is a tab ( ) (default: ) -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--non-deterministic** Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error -**--query, -q** +**--query** +Alias: ** -q** Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query **--reason** diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 89a01ea8..333ce3d0 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -26,16 +26,18 @@ The eventId of any event after WorkflowTaskStarted you want to reset to (exclusi **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--reapply-type** -Event types to reapply after the reset point: , Signal, None. (default: All) +Event types to reapply after the reset point: Signal, None, . (default: All) **--reason** Reason to reset -**--run-id, -r** +**--run-id** +Alias: ** -r** Run Id **--tls-ca-path** @@ -56,6 +58,7 @@ Override for target server name **--type** Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id diff --git a/docs/workflow/show.md b/docs/workflow/show.md index 0e130708..f7173e44 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -23,7 +23,8 @@ Env name to read the client environment variables from (default: default) **--fields** customize fields to print. Set to 'long' to automatically print more of main fields -**--follow, -f** +**--follow** +Alias: ** -f** Follow the progress of Workflow Execution **--grpc-meta** @@ -35,13 +36,16 @@ number of items to print (default: 0) **--max-field-length** Maximum length for each attribute field (default: 500) -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--no-pager, -P** +**--no-pager** +Alias: ** -P** disable interactive pager -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) **--output-filename** @@ -53,7 +57,8 @@ pager to use: less, more, favoritePager.. **--reset-points** Only show events that are eligible for reset -**--run-id, -r** +**--run-id** +Alias: ** -r** Run Id **--time-format** @@ -74,6 +79,7 @@ Path to private key **--tls-server-name** Override for target server name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index fa7606bc..78b40efc 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -23,7 +23,8 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--input, -i** +**--input** +Alias: ** -i** Input for the signal (JSON) **--input-file** @@ -32,16 +33,19 @@ Input for the signal from file (JSON) **--name** Signal Name -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--query, -q** +**--query** +Alias: ** -q** Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ **--reason** Reason for signaling with List Filter -**--run-id, -r** +**--run-id** +Alias: ** -r** Run Id **--tls-ca-path** @@ -59,9 +63,11 @@ Path to private key **--tls-server-name** Override for target server name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Signal Workflow Execution by Id -**--yes, -y** +**--yes** +Alias: ** -y** Confirm all prompts diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index dc02abb3..320369c3 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -23,19 +23,22 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--input, -i** +**--input** +Alias: ** -i** Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space **--input-file** Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--reject-condition** Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" -**--run-id, -r** +**--run-id** +Alias: ** -r** Run Id **--tls-ca-path** @@ -53,6 +56,7 @@ Path to private key **--tls-server-name** Override for target server name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id diff --git a/docs/workflow/start.md b/docs/workflow/start.md index 3b5e719b..e579cf07 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -42,7 +42,8 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--id-reuse-policy** Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning -**--input, -i** +**--input** +Alias: ** -i** Optional input for the Workflow in JSON format. Pass "null" for null values **--input-file** @@ -60,13 +61,16 @@ Pass a memo in a format key=value. Use valid JSON formats for value **--memo-file** Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--no-pager, -P** +**--no-pager** +Alias: ** -P** disable interactive pager -**--output, -o** +**--output** +Alias: ** -o** format output as: table, json, card. (default: table) **--pager** @@ -78,7 +82,8 @@ Single workflow run timeout (seconds) (default: 0) **--search-attribute** Pass Search Attribute in a format key=value. Use valid JSON formats for value -**--task-queue, -t** +**--task-queue** +Alias: ** -t** Task queue **--task-timeout** @@ -105,6 +110,7 @@ Override for target server name **--type** Workflow type name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index 22cde926..dfd8302a 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -23,16 +23,19 @@ Env name to read the client environment variables from (default: default) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) -**--query, -q** +**--query** +Alias: ** -q** Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ **--reason** Reason for termination -**--run-id, -r** +**--run-id** +Alias: ** -r** Run Id **--tls-ca-path** @@ -50,9 +53,11 @@ Path to private key **--tls-server-name** Override for target server name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Terminate Workflow Execution by Id -**--yes, -y** +**--yes** +Alias: ** -y** Confirm all prompts diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index 9662170f..8ce7812a 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -32,13 +32,15 @@ Statuses for which child workflows will be folded in (this will reduce the numbe **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value -**--namespace, -n** +**--namespace** +Alias: ** -n** Temporal workflow namespace (default: default) **--no-fold** Disable folding. All child workflows within the set depth will be fetched and displayed -**--run-id, -r** +**--run-id** +Alias: ** -r** Run Id **--tls-ca-path** @@ -56,6 +58,7 @@ Path to private key **--tls-server-name** Override for target server name -**--workflow-id, -w** +**--workflow-id** +Alias: ** -w** Workflow Id From c2f56320ef4d2a4bf4e66de92402975b70303836 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 11 Jan 2023 08:31:54 -0600 Subject: [PATCH 22/68] minor change to trim space --- docs/activity/complete.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/activity/complete.md b/docs/activity/complete.md index fdd12672..e3fa6503 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -30,14 +30,14 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f Specify operator's identity **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--result** Set the result value of completion **--run-id** -Alias: ** -r** +Alias: **-r** Run Id **--tls-ca-path** @@ -56,6 +56,6 @@ Path to private key Override for target server name **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id From f0ba227960011922cd115cb8ae39fc22fc79b5ee Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 11 Jan 2023 08:32:01 -0600 Subject: [PATCH 23/68] trimspace --- docs/activity/fail.md | 6 +++--- docs/batch/describe.md | 4 ++-- docs/batch/list.md | 6 +++--- docs/batch/terminate.md | 2 +- docs/env/delete.md | 2 +- docs/env/get.md | 2 +- docs/env/set.md | 2 +- docs/operator/cluster.md | 20 ++++++++++---------- docs/operator/namespace.md | 12 ++++++------ docs/operator/search-attribute.md | 12 ++++++------ docs/schedule/backfill.md | 4 ++-- docs/schedule/create.md | 10 +++++----- docs/schedule/delete.md | 4 ++-- docs/schedule/describe.md | 6 +++--- docs/schedule/list.md | 6 +++--- docs/schedule/toggle.md | 4 ++-- docs/schedule/trigger.md | 4 ++-- docs/schedule/update.md | 10 +++++----- docs/server/start-dev.md | 8 ++++---- docs/task-queue/describe.md | 6 +++--- docs/task-queue/list-partition.md | 6 +++--- docs/workflow/cancel.md | 10 +++++----- docs/workflow/count.md | 4 ++-- docs/workflow/delete.md | 6 +++--- docs/workflow/describe.md | 6 +++--- docs/workflow/execute.md | 12 ++++++------ docs/workflow/list.md | 8 ++++---- docs/workflow/query.md | 8 ++++---- docs/workflow/reset-batch.md | 4 ++-- docs/workflow/reset.md | 8 ++++---- docs/workflow/show.md | 12 ++++++------ docs/workflow/signal.md | 12 ++++++------ docs/workflow/stack.md | 8 ++++---- docs/workflow/start.md | 12 ++++++------ docs/workflow/terminate.md | 10 +++++----- docs/workflow/trace.md | 6 +++--- 36 files changed, 131 insertions(+), 131 deletions(-) diff --git a/docs/activity/fail.md b/docs/activity/fail.md index f0a14cd1..0c4eb96f 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -33,14 +33,14 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f Specify operator's identity **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--reason** Reason to fail the Activity **--run-id** -Alias: ** -r** +Alias: **-r** Run Id **--tls-ca-path** @@ -59,6 +59,6 @@ Path to private key Override for target server name **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id diff --git a/docs/batch/describe.md b/docs/batch/describe.md index 8d0926bd..59cc1135 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -30,11 +30,11 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f Batch Job Id **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--time-format** diff --git a/docs/batch/list.md b/docs/batch/list.md index f2ee1756..d93ce72b 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -30,15 +30,15 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f number of items to print (default: 0) **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--no-pager** -Alias: ** -P** +Alias: **-P** disable interactive pager **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--pager** diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index 4aefee1e..d2090cdb 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -27,7 +27,7 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f Batch Job Id **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--reason** diff --git a/docs/env/delete.md b/docs/env/delete.md index dcbd1fae..2952cff1 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -24,7 +24,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--tls-ca-path** diff --git a/docs/env/get.md b/docs/env/get.md index 5cabe3ea..c0661133 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -24,7 +24,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--tls-ca-path** diff --git a/docs/env/set.md b/docs/env/set.md index 8d47be16..de6ae897 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -24,7 +24,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--tls-ca-path** diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index dd0f0e16..77e0ff85 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -28,7 +28,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--tls-ca-path** @@ -75,11 +75,11 @@ customize fields to print. Set to 'long' to automatically print more of main fie gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--tls-ca-path** @@ -126,11 +126,11 @@ customize fields to print. Set to 'long' to automatically print more of main fie gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--tls-ca-path** @@ -180,7 +180,7 @@ Frontend address of the remote cluster gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--tls-ca-path** @@ -230,15 +230,15 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f number of items to print (default: 0) **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--no-pager** -Alias: ** -P** +Alias: **-P** disable interactive pager **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--pager** @@ -291,7 +291,7 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f Frontend address of the remote cluster **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--tls-ca-path** diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index f709b68d..fdf26234 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -28,7 +28,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--namespace-id** @@ -75,7 +75,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--tls-ca-path** @@ -143,7 +143,7 @@ Flag to set history archival state, valid values are "disabled" and "enabled" Optionally specify history archival URI (cannot be changed after first time archival is enabled) **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--retention** @@ -217,7 +217,7 @@ Flag to set history archival state, valid values are "disabled" and "enabled" Optionally specify history archival URI (cannot be changed after first time archival is enabled) **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--promote-global** @@ -276,7 +276,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--tls-ca-path** @@ -295,6 +295,6 @@ Path to private key Override for target server name **--yes** -Alias: ** -y** +Alias: **-y** Confirm all prompts diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index 97145ca6..db3fddb0 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -31,7 +31,7 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f Search attribute name **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--tls-ca-path** @@ -53,7 +53,7 @@ Override for target server name Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] **--yes** -Alias: ** -y** +Alias: **-y** Confirm all prompts #### list @@ -82,11 +82,11 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--tls-ca-path** @@ -133,7 +133,7 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f Search attribute name **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--tls-ca-path** @@ -152,6 +152,6 @@ Path to private key Override for target server name **--yes** -Alias: ** -y** +Alias: **-y** Confirm all prompts diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md index 5de5b6a5..3ca8b199 100644 --- a/docs/schedule/backfill.md +++ b/docs/schedule/backfill.md @@ -27,14 +27,14 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--overlap-policy** Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll **--schedule-id** -Alias: ** -s** +Alias: **-s** Schedule Id **--start-time** diff --git a/docs/schedule/create.md b/docs/schedule/create.md index f2e433d5..b18b60b6 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -39,7 +39,7 @@ Workflow Execution timeout, including retries and continue-as-new (seconds) (def gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--input** -Alias: ** -i** +Alias: **-i** Optional input for the Workflow in JSON format. Pass "null" for null values **--input-file** @@ -61,7 +61,7 @@ Set a memo on a schedule. Format: key=value. Use valid JSON formats for value Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--notes** @@ -83,7 +83,7 @@ Total number of actions allowed (default: 0) Single workflow run timeout (seconds) (default: 0) **--schedule-id** -Alias: ** -s** +Alias: **-s** Schedule Id **--search-attribute** @@ -93,7 +93,7 @@ Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats fo Overall schedule start time **--task-queue** -Alias: ** -t** +Alias: **-t** Task queue **--task-timeout** @@ -118,7 +118,7 @@ Path to private key Override for target server name **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id **--workflow-type** diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md index ae590ddc..154ef46e 100644 --- a/docs/schedule/delete.md +++ b/docs/schedule/delete.md @@ -24,11 +24,11 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--schedule-id** -Alias: ** -s** +Alias: **-s** Schedule Id **--tls-ca-path** diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 9d2d019d..2a3890df 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -27,18 +27,18 @@ customize fields to print. Set to 'long' to automatically print more of main fie gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--raw** Print raw data as json (prefer this over -o json for scripting) **--schedule-id** -Alias: ** -s** +Alias: **-s** Schedule Id **--time-format** diff --git a/docs/schedule/list.md b/docs/schedule/list.md index 5e138026..913df0e5 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -30,15 +30,15 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f number of items to print (default: 0) **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--no-pager** -Alias: ** -P** +Alias: **-P** disable interactive pager **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--pager** diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md index 0abee183..974552e2 100644 --- a/docs/schedule/toggle.md +++ b/docs/schedule/toggle.md @@ -24,7 +24,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--pause** @@ -34,7 +34,7 @@ Pauses the schedule Free-form text to describe reason for pause/unpause (default: (no reason provided)) **--schedule-id** -Alias: ** -s** +Alias: **-s** Schedule Id **--tls-ca-path** diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md index 3b239e27..c830d3ed 100644 --- a/docs/schedule/trigger.md +++ b/docs/schedule/trigger.md @@ -24,14 +24,14 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--overlap-policy** Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll **--schedule-id** -Alias: ** -s** +Alias: **-s** Schedule Id **--tls-ca-path** diff --git a/docs/schedule/update.md b/docs/schedule/update.md index fb331d2e..69c9779a 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -39,7 +39,7 @@ Workflow Execution timeout, including retries and continue-as-new (seconds) (def gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--input** -Alias: ** -i** +Alias: **-i** Optional input for the Workflow in JSON format. Pass "null" for null values **--input-file** @@ -61,7 +61,7 @@ Set a memo on a schedule. Format: key=value. Use valid JSON formats for value Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--notes** @@ -83,7 +83,7 @@ Total number of actions allowed (default: 0) Single workflow run timeout (seconds) (default: 0) **--schedule-id** -Alias: ** -s** +Alias: **-s** Schedule Id **--search-attribute** @@ -93,7 +93,7 @@ Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats fo Overall schedule start time **--task-queue** -Alias: ** -t** +Alias: **-t** Task queue **--task-timeout** @@ -118,7 +118,7 @@ Path to private key Override for target server name **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id **--workflow-type** diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index ba992bab..9a634eeb 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -3,11 +3,11 @@ Start Temporal development server **--config** -Alias: ** -c** +Alias: **-c** Path to config directory **--db-filename** -Alias: ** -f** +Alias: **-f** File in which to persist Temporal state (by default, Workflows are lost when the process dies) **--dynamic-config-value** @@ -29,11 +29,11 @@ Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: i Port for /metrics (default: 0) **--namespace** -Alias: ** -n** +Alias: **-n** Specify namespaces that should be pre-created (namespace "default" is always created) **--port** -Alias: ** -p** +Alias: **-p** Port for the frontend gRPC service (default: 7233) **--sqlite-pragma** diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index 5fea43f2..1092845e 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -27,15 +27,15 @@ customize fields to print. Set to 'long' to automatically print more of main fie gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--task-queue** -Alias: ** -t** +Alias: **-t** Task Queue name **--task-queue-type** diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index 32fef0bd..87b573b5 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -24,15 +24,15 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--task-queue** -Alias: ** -t** +Alias: **-t** Task Queue name **--tls-ca-path** diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index cd647731..5f024c72 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -24,18 +24,18 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--query** -Alias: ** -q** +Alias: **-q** Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ **--reason** Reason for canceling with List Filter **--run-id** -Alias: ** -r** +Alias: **-r** Run Id **--tls-ca-path** @@ -54,10 +54,10 @@ Path to private key Override for target server name **--workflow-id** -Alias: ** -w** +Alias: **-w** Cancel Workflow Execution by Id **--yes** -Alias: ** -y** +Alias: **-y** Confirm all prompts diff --git a/docs/workflow/count.md b/docs/workflow/count.md index 0db0aaeb..dde8b270 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -24,11 +24,11 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--query** -Alias: ** -q** +Alias: **-q** Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details **--tls-ca-path** diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index 22749a61..be9b46fe 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -24,11 +24,11 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--run-id** -Alias: ** -r** +Alias: **-r** Run Id **--tls-ca-path** @@ -47,6 +47,6 @@ Path to private key Override for target server name **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index 58a6600e..6ab97a15 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -24,7 +24,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--raw** @@ -34,7 +34,7 @@ Print properties as they are stored Only show auto-reset points **--run-id** -Alias: ** -r** +Alias: **-r** Run Id **--tls-ca-path** @@ -53,6 +53,6 @@ Path to private key Override for target server name **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index a112ab67..eedd1569 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -43,7 +43,7 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning **--input** -Alias: ** -i** +Alias: **-i** Optional input for the Workflow in JSON format. Pass "null" for null values **--input-file** @@ -62,15 +62,15 @@ Pass a memo in a format key=value. Use valid JSON formats for value Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--no-pager** -Alias: ** -P** +Alias: **-P** disable interactive pager **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--pager** @@ -83,7 +83,7 @@ Single workflow run timeout (seconds) (default: 0) Pass Search Attribute in a format key=value. Use valid JSON formats for value **--task-queue** -Alias: ** -t** +Alias: **-t** Task queue **--task-timeout** @@ -111,6 +111,6 @@ Override for target server name Workflow type name **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id diff --git a/docs/workflow/list.md b/docs/workflow/list.md index 4b37dc99..84dbad5e 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -33,22 +33,22 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f number of items to print (default: 0) **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--no-pager** -Alias: ** -P** +Alias: **-P** disable interactive pager **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--pager** pager to use: less, more, favoritePager.. **--query** -Alias: ** -q** +Alias: **-q** Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details **--time-format** diff --git a/docs/workflow/query.md b/docs/workflow/query.md index 0ff8a62f..66f7d6a2 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -24,21 +24,21 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--input** -Alias: ** -i** +Alias: **-i** Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space **--input-file** Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--reject-condition** Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" **--run-id** -Alias: ** -r** +Alias: **-r** Run Id **--tls-ca-path** @@ -60,6 +60,6 @@ Override for target server name The query type you want to run **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 9f0ee59d..fb3534d4 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -39,14 +39,14 @@ Number of goroutines to run in parallel. Each goroutine processes one line for e Separator for the input file. The default is a tab ( ) (default: ) **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--non-deterministic** Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error **--query** -Alias: ** -q** +Alias: **-q** Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query **--reason** diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 333ce3d0..58bb3ea9 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -27,17 +27,17 @@ The eventId of any event after WorkflowTaskStarted you want to reset to (exclusi gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--reapply-type** -Event types to reapply after the reset point: Signal, None, . (default: All) +Event types to reapply after the reset point: , Signal, None. (default: All) **--reason** Reason to reset **--run-id** -Alias: ** -r** +Alias: **-r** Run Id **--tls-ca-path** @@ -59,6 +59,6 @@ Override for target server name Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id diff --git a/docs/workflow/show.md b/docs/workflow/show.md index f7173e44..3e32269a 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -24,7 +24,7 @@ Env name to read the client environment variables from (default: default) customize fields to print. Set to 'long' to automatically print more of main fields **--follow** -Alias: ** -f** +Alias: **-f** Follow the progress of Workflow Execution **--grpc-meta** @@ -37,15 +37,15 @@ number of items to print (default: 0) Maximum length for each attribute field (default: 500) **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--no-pager** -Alias: ** -P** +Alias: **-P** disable interactive pager **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--output-filename** @@ -58,7 +58,7 @@ pager to use: less, more, favoritePager.. Only show events that are eligible for reset **--run-id** -Alias: ** -r** +Alias: **-r** Run Id **--time-format** @@ -80,6 +80,6 @@ Path to private key Override for target server name **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index 78b40efc..66922d00 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -24,7 +24,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--input** -Alias: ** -i** +Alias: **-i** Input for the signal (JSON) **--input-file** @@ -34,18 +34,18 @@ Input for the signal from file (JSON) Signal Name **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--query** -Alias: ** -q** +Alias: **-q** Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ **--reason** Reason for signaling with List Filter **--run-id** -Alias: ** -r** +Alias: **-r** Run Id **--tls-ca-path** @@ -64,10 +64,10 @@ Path to private key Override for target server name **--workflow-id** -Alias: ** -w** +Alias: **-w** Signal Workflow Execution by Id **--yes** -Alias: ** -y** +Alias: **-y** Confirm all prompts diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index 320369c3..1715c60c 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -24,21 +24,21 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--input** -Alias: ** -i** +Alias: **-i** Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space **--input-file** Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--reject-condition** Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" **--run-id** -Alias: ** -r** +Alias: **-r** Run Id **--tls-ca-path** @@ -57,6 +57,6 @@ Path to private key Override for target server name **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id diff --git a/docs/workflow/start.md b/docs/workflow/start.md index e579cf07..41904430 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -43,7 +43,7 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning **--input** -Alias: ** -i** +Alias: **-i** Optional input for the Workflow in JSON format. Pass "null" for null values **--input-file** @@ -62,15 +62,15 @@ Pass a memo in a format key=value. Use valid JSON formats for value Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--no-pager** -Alias: ** -P** +Alias: **-P** disable interactive pager **--output** -Alias: ** -o** +Alias: **-o** format output as: table, json, card. (default: table) **--pager** @@ -83,7 +83,7 @@ Single workflow run timeout (seconds) (default: 0) Pass Search Attribute in a format key=value. Use valid JSON formats for value **--task-queue** -Alias: ** -t** +Alias: **-t** Task queue **--task-timeout** @@ -111,6 +111,6 @@ Override for target server name Workflow type name **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index dfd8302a..0e574234 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -24,18 +24,18 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--query** -Alias: ** -q** +Alias: **-q** Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ **--reason** Reason for termination **--run-id** -Alias: ** -r** +Alias: **-r** Run Id **--tls-ca-path** @@ -54,10 +54,10 @@ Path to private key Override for target server name **--workflow-id** -Alias: ** -w** +Alias: **-w** Terminate Workflow Execution by Id **--yes** -Alias: ** -y** +Alias: **-y** Confirm all prompts diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index 8ce7812a..d80da9e7 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -33,14 +33,14 @@ Statuses for which child workflows will be folded in (this will reduce the numbe gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--namespace** -Alias: ** -n** +Alias: **-n** Temporal workflow namespace (default: default) **--no-fold** Disable folding. All child workflows within the set depth will be fetched and displayed **--run-id** -Alias: ** -r** +Alias: **-r** Run Id **--tls-ca-path** @@ -59,6 +59,6 @@ Path to private key Override for target server name **--workflow-id** -Alias: ** -w** +Alias: **-w** Workflow Id From 76b4fd46816504f0e39c69e1041176926563d5df Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 17 Jan 2023 11:08:31 -0600 Subject: [PATCH 24/68] edited Temporal term grammar --- activity/activity.go | 26 ++++---- app/app.go | 4 +- batch/batch.go | 8 +-- cluster/cluster.go | 22 +++---- docs/activity/complete.md | 12 ++-- docs/activity/fail.md | 14 ++--- docs/batch/describe.md | 2 +- docs/batch/index.md | 2 +- docs/batch/list.md | 2 +- docs/batch/terminate.md | 4 +- docs/operator/cluster.md | 24 ++++---- docs/operator/namespace.md | 12 ++-- docs/operator/search-attribute.md | 14 ++--- docs/schedule/create.md | 10 ++-- docs/schedule/update.md | 10 ++-- docs/server/start-dev.md | 26 ++++---- docs/task-queue/describe.md | 2 +- docs/task-queue/list-partition.md | 2 +- docs/workflow/cancel.md | 10 ++-- docs/workflow/count.md | 2 +- docs/workflow/delete.md | 2 +- docs/workflow/describe.md | 6 +- docs/workflow/execute.md | 2 +- docs/workflow/list.md | 2 +- docs/workflow/query.md | 4 +- docs/workflow/reset-batch.md | 22 +++---- docs/workflow/reset.md | 8 +-- docs/workflow/show.md | 2 +- docs/workflow/signal.md | 14 ++--- docs/workflow/stack.md | 2 +- docs/workflow/start.md | 2 +- docs/workflow/terminate.md | 10 ++-- docs/workflow/trace.md | 8 +-- namespace/namespace.go | 12 ++-- schedule/schedule.go | 10 ++-- searchattribute/search_attribute.go | 14 ++--- server/commands.go | 26 ++++---- taskqueue/task_queue.go | 4 +- workflow/workflow.go | 92 ++++++++++++++--------------- 39 files changed, 225 insertions(+), 225 deletions(-) diff --git a/activity/activity.go b/activity/activity.go index c13a8b0b..7d0dbc2a 100644 --- a/activity/activity.go +++ b/activity/activity.go @@ -9,37 +9,37 @@ func NewActivityCommands() []*cli.Command { return []*cli.Command{ { Name: "complete", - Usage: "Complete an activity", + Usage: "Complete an Activity.", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, Aliases: common.FlagWorkflowIDAlias, - Usage: "Workflow Id", + Usage: "Identifies the Workflow that the Activity is running on.", Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagRunID, Aliases: common.FlagRunIDAlias, - Usage: "Run Id", + Usage: "Identifies the current Workflow Run.", Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagActivityID, - Usage: "The Activity Id to complete", + Usage: "Identifies the Activity to be completed.", Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagResult, - Usage: "Set the result value of completion", + Usage: "Set the result value of Activity completion.", Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagIdentity, - Usage: "Specify operator's identity", + Usage: "Specify operator's identity.", Required: true, Category: common.CategoryMain, }, @@ -50,43 +50,43 @@ func NewActivityCommands() []*cli.Command { }, { Name: "fail", - Usage: "Fail an activity", + Usage: "Fail an Activity.", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, Aliases: common.FlagWorkflowIDAlias, - Usage: "Workflow Id", + Usage: "Identifies the Workflow that the Activity is running on.", Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagRunID, Aliases: common.FlagRunIDAlias, - Usage: "Run Id", + Usage: "Identifies the current Workflow Run.", Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagActivityID, - Usage: "The Activity Id to fail", + Usage: "Identifies the Activity to fail.", Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason to fail the Activity", + Usage: "Reason to fail the Activity.", Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagDetail, - Usage: "Detail to fail the Activity", + Usage: "Detail to fail the Activity.", Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagIdentity, - Usage: "Specify operator's identity", + Usage: "Specify the operator's identity.", Required: true, Category: common.CategoryMain, }, diff --git a/app/app.go b/app/app.go index dda359b2..406ddf5a 100644 --- a/app/app.go +++ b/app/app.go @@ -118,7 +118,7 @@ var clientCommands = []*cli.Command{ { Name: "batch", - Usage: "Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs", + Usage: "Operations on Batch jobs. Use Workflow commands with --query flag to start batch jobs", Subcommands: batch.NewBatchCommands(), }, { @@ -137,7 +137,7 @@ var clientCommands = []*cli.Command{ }, { Name: "cluster", - Usage: "Operations on a Temporal cluster", + Usage: "Operations on a Temporal Cluster", Subcommands: cluster.NewClusterCommands(), }, }, diff --git a/batch/batch.go b/batch/batch.go index 1f94b94a..22750abd 100644 --- a/batch/batch.go +++ b/batch/batch.go @@ -9,7 +9,7 @@ func NewBatchCommands() []*cli.Command { return []*cli.Command{ { Name: "describe", - Usage: "Describe a batch operation job", + Usage: "Describe a Batch operation job.", Flags: append([]cli.Flag{ &cli.StringFlag{ Name: common.FlagJobID, @@ -24,7 +24,7 @@ func NewBatchCommands() []*cli.Command { }, { Name: "list", - Usage: "List batch operation jobs", + Usage: "List Batch operation jobs.", Flags: common.FlagsForPaginationAndRendering, ArgsUsage: " ", Action: func(c *cli.Context) error { @@ -33,7 +33,7 @@ func NewBatchCommands() []*cli.Command { }, { Name: "terminate", - Usage: "Stop a batch operation job", + Usage: "Stop a Batch operation job.", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagJobID, @@ -43,7 +43,7 @@ func NewBatchCommands() []*cli.Command { }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason to stop the batch job", + Usage: "Reason to stop the Batch job.", Required: true, Category: common.CategoryMain, }, diff --git a/cluster/cluster.go b/cluster/cluster.go index 67e8454f..3eb879c4 100644 --- a/cluster/cluster.go +++ b/cluster/cluster.go @@ -10,14 +10,14 @@ func NewClusterCommands() []*cli.Command { return []*cli.Command{ { Name: "health", - Usage: "Check health of frontend service", + Usage: "Check health of frontend service.", Action: func(c *cli.Context) error { return HealthCheck(c) }, }, { Name: "describe", - Usage: "Show information about the cluster", + Usage: "Show information about the Cluster.", ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ @@ -29,7 +29,7 @@ func NewClusterCommands() []*cli.Command { }, &cli.StringFlag{ Name: output.FlagFields, - Usage: "customize fields to print. Set to 'long' to automatically print more of main fields", + Usage: "Customize fields to print. Set to 'long' to automatically print more of main fields.", Category: common.CategoryDisplay, }, }, @@ -39,7 +39,7 @@ func NewClusterCommands() []*cli.Command { }, { Name: "system", - Usage: "Show information about the system and capabilities", + Usage: "Show information about the system and its capabilities.", ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ @@ -51,7 +51,7 @@ func NewClusterCommands() []*cli.Command { }, &cli.StringFlag{ Name: output.FlagFields, - Usage: "customize fields to print. Set to 'long' to automatically print more of main fields", + Usage: "Customize fields to print. Set to 'long' to automatically print more of main fields.", Category: common.CategoryDisplay, }, }, @@ -61,17 +61,17 @@ func NewClusterCommands() []*cli.Command { }, { Name: "upsert", - Usage: "Add or update a remote cluster", + Usage: "Add or update a remote Cluster.", ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagClusterAddress, - Usage: "Frontend address of the remote cluster", + Usage: "Frontend address of the remote Cluster.", Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagClusterEnableConnection, - Usage: "Enable cross cluster connection", + Usage: "Enable cross-cluster connection.", Category: common.CategoryMain, }, }, @@ -81,7 +81,7 @@ func NewClusterCommands() []*cli.Command { }, { Name: "list", - Usage: "List all remote clusters", + Usage: "List all remote Clusters.", ArgsUsage: " ", Flags: common.FlagsForPaginationAndRendering, Action: func(c *cli.Context) error { @@ -90,12 +90,12 @@ func NewClusterCommands() []*cli.Command { }, { Name: "remove", - Usage: "Remove a remote cluster", + Usage: "Remove a remote Cluster.", ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagName, - Usage: "Frontend address of the remote cluster", + Usage: "Frontend address of the remote Cluster.", Required: true, Category: common.CategoryMain, }, diff --git a/docs/activity/complete.md b/docs/activity/complete.md index e3fa6503..3fa6514d 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -1,9 +1,9 @@ ### complete -Complete an activity +Complete an Activity. **--activity-id** -The Activity Id to complete +Identifies the Activity to be completed. **--address** host:port for Temporal frontend service @@ -27,18 +27,18 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--identity** -Specify operator's identity +Specify operator's identity. **--namespace** Alias: **-n** Temporal workflow namespace (default: default) **--result** -Set the result value of completion +Set the result value of Activity completion. **--run-id** Alias: **-r** -Run Id +Identifies the current Workflow Run. **--tls-ca-path** Path to server CA certificate @@ -57,5 +57,5 @@ Override for target server name **--workflow-id** Alias: **-w** -Workflow Id +Identifies the Workflow that the Activity is running on. diff --git a/docs/activity/fail.md b/docs/activity/fail.md index 0c4eb96f..74175488 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -1,9 +1,9 @@ ### fail -Fail an activity +Fail an Activity. **--activity-id** -The Activity Id to fail +Identifies the Activity to fail. **--address** host:port for Temporal frontend service @@ -21,7 +21,7 @@ when to use color: auto, always, never. (default: auto) Optional timeout for context of RPC call in seconds (default: 5) **--detail** -Detail to fail the Activity +Detail to fail the Activity. **--env** Env name to read the client environment variables from (default: default) @@ -30,18 +30,18 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--identity** -Specify operator's identity +Specify the operator's identity. **--namespace** Alias: **-n** Temporal workflow namespace (default: default) **--reason** -Reason to fail the Activity +Reason to fail the Activity. **--run-id** Alias: **-r** -Run Id +Identifies the current Workflow Run. **--tls-ca-path** Path to server CA certificate @@ -60,5 +60,5 @@ Override for target server name **--workflow-id** Alias: **-w** -Workflow Id +Identifies the Workflow that the Activity is running on. diff --git a/docs/batch/describe.md b/docs/batch/describe.md index 59cc1135..edfdbde6 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -1,6 +1,6 @@ ### describe -Describe a batch operation job +Describe a Batch operation job. **--address** host:port for Temporal frontend service diff --git a/docs/batch/index.md b/docs/batch/index.md index 754c2b01..f9564643 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -1,4 +1,4 @@ ## batch -Operations on Batch jobs. Use workflow commands with --query flag to start batch jobs +Operations on Batch jobs. Use Workflow commands with --query flag to start batch jobs diff --git a/docs/batch/list.md b/docs/batch/list.md index d93ce72b..62f1119b 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -1,6 +1,6 @@ ### list -List batch operation jobs +List Batch operation jobs. **--address** host:port for Temporal frontend service diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index d2090cdb..46c2342b 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -1,6 +1,6 @@ ### terminate -Stop a batch operation job +Stop a Batch operation job. **--address** host:port for Temporal frontend service @@ -31,7 +31,7 @@ Alias: **-n** Temporal workflow namespace (default: default) **--reason** -Reason to stop the batch job +Reason to stop the Batch job. **--tls-ca-path** Path to server CA certificate diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index 77e0ff85..0e7be121 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -1,10 +1,10 @@ ### cluster -Operations on a Temporal cluster +Operations on a Temporal Cluster #### health -Check health of frontend service +Check health of frontend service. **--address** host:port for Temporal frontend service @@ -48,7 +48,7 @@ Override for target server name #### describe -Show information about the cluster +Show information about the Cluster. **--address** host:port for Temporal frontend service @@ -69,7 +69,7 @@ Optional timeout for context of RPC call in seconds (default: 5) Env name to read the client environment variables from (default: default) **--fields** -customize fields to print. Set to 'long' to automatically print more of main fields +Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value @@ -99,7 +99,7 @@ Override for target server name #### system -Show information about the system and capabilities +Show information about the system and its capabilities. **--address** host:port for Temporal frontend service @@ -120,7 +120,7 @@ Optional timeout for context of RPC call in seconds (default: 5) Env name to read the client environment variables from (default: default) **--fields** -customize fields to print. Set to 'long' to automatically print more of main fields +Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value @@ -150,7 +150,7 @@ Override for target server name #### upsert -Add or update a remote cluster +Add or update a remote Cluster. **--address** host:port for Temporal frontend service @@ -168,13 +168,13 @@ when to use color: auto, always, never. (default: auto) Optional timeout for context of RPC call in seconds (default: 5) **--enable-connection** -Enable cross cluster connection +Enable cross-cluster connection. **--env** Env name to read the client environment variables from (default: default) **--frontend-address** -Frontend address of the remote cluster +Frontend address of the remote Cluster. **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value @@ -200,7 +200,7 @@ Override for target server name #### list -List all remote clusters +List all remote Clusters. **--address** host:port for Temporal frontend service @@ -264,7 +264,7 @@ Override for target server name #### remove -Remove a remote cluster +Remove a remote Cluster. **--address** host:port for Temporal frontend service @@ -288,7 +288,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--name** -Frontend address of the remote cluster +Frontend address of the remote Cluster. **--namespace** Alias: **-n** diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index fdf26234..d160576e 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -4,7 +4,7 @@ Operations on namespaces #### describe -Describe a Namespace by name or Id +Describe a Namespace by name or Id. **--address** host:port for Temporal frontend service @@ -51,7 +51,7 @@ Override for target server name #### list -List all Namespaces +List all Namespaces. **--address** host:port for Temporal frontend service @@ -95,7 +95,7 @@ Override for target server name #### register -Register a new Namespace +Register a new Namespace. **--active-cluster** Active cluster name @@ -172,7 +172,7 @@ Optionally specify visibility archival URI (cannot be changed after first time a #### update -Update a Namespace +Update a Namespace. **--active-cluster** Active cluster name @@ -252,7 +252,7 @@ Optionally specify visibility archival URI (cannot be changed after first time a #### delete -Delete existing Namespace +Delete existing Namespace. **--address** host:port for Temporal frontend service @@ -296,5 +296,5 @@ Override for target server name **--yes** Alias: **-y** -Confirm all prompts +Confirm all prompts. diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index db3fddb0..5a8d1ae0 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -4,7 +4,7 @@ Operations on search attributes #### create -Add custom search attributes +Add custom search attributes. **--address** host:port for Temporal frontend service @@ -28,7 +28,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--name** -Search attribute name +Search attribute name. **--namespace** Alias: **-n** @@ -54,11 +54,11 @@ Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] **--yes** Alias: **-y** -Confirm all prompts +Confirm all prompts. #### list -List search attributes that can be used in list workflow query +List search attributes that can be used in list Workflow Query. **--address** host:port for Temporal frontend service @@ -106,7 +106,7 @@ Override for target server name #### remove -Remove custom search attributes metadata only (Elasticsearch index schema is not modified) +Remove custom search attributes metadata only (Elasticsearch index schema is not modified). **--address** host:port for Temporal frontend service @@ -130,7 +130,7 @@ Env name to read the client environment variables from (default: default) gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--name** -Search attribute name +Search attribute name. **--namespace** Alias: **-n** @@ -153,5 +153,5 @@ Override for target server name **--yes** Alias: **-y** -Confirm all prompts +Confirm all prompts. diff --git a/docs/schedule/create.md b/docs/schedule/create.md index b18b60b6..0a50e916 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -27,7 +27,7 @@ Optional timeout for context of RPC call in seconds (default: 5) Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" **--end-time** -Overall schedule end time +Overall schedule end time. **--env** Env name to read the client environment variables from (default: default) @@ -46,10 +46,10 @@ Optional input for the Workflow in JSON format. Pass "null" for null values Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file **--interval** -Interval duration, e.g. 90m, or 90m/13m to include phase offset +Interval duration, e.g. 90m, or 90m/13m to include phase offset. **--jitter** -Jitter duration +Jitter duration. **--max-field-length** Maximum length for each attribute field (default: 0) @@ -90,7 +90,7 @@ Schedule Id Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value **--start-time** -Overall schedule start time +Overall schedule start time. **--task-queue** Alias: **-t** @@ -100,7 +100,7 @@ Task queue Workflow task start to close timeout (seconds) (default: 10) **--time-zone** -Time zone (IANA name) +Time zone (IANA name). **--tls-ca-path** Path to server CA certificate diff --git a/docs/schedule/update.md b/docs/schedule/update.md index 69c9779a..b4c349ed 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -27,7 +27,7 @@ Optional timeout for context of RPC call in seconds (default: 5) Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" **--end-time** -Overall schedule end time +Overall schedule end time. **--env** Env name to read the client environment variables from (default: default) @@ -46,10 +46,10 @@ Optional input for the Workflow in JSON format. Pass "null" for null values Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file **--interval** -Interval duration, e.g. 90m, or 90m/13m to include phase offset +Interval duration, e.g. 90m, or 90m/13m to include phase offset. **--jitter** -Jitter duration +Jitter duration. **--max-field-length** Maximum length for each attribute field (default: 0) @@ -90,7 +90,7 @@ Schedule Id Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value **--start-time** -Overall schedule start time +Overall schedule start time. **--task-queue** Alias: **-t** @@ -100,7 +100,7 @@ Task queue Workflow task start to close timeout (seconds) (default: 10) **--time-zone** -Time zone (IANA name) +Time zone (IANA name). **--tls-ca-path** Path to server CA certificate diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index 9a634eeb..de67ab70 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -1,23 +1,23 @@ ### start-dev -Start Temporal development server +Start Temporal development server. **--config** Alias: **-c** -Path to config directory +Path to config directory. **--db-filename** Alias: **-f** -File in which to persist Temporal state (by default, Workflows are lost when the process dies) +File in which to persist Temporal state (by default, Workflows are lost when the process dies). **--dynamic-config-value** -Dynamic config value, as KEY=JSON_VALUE (string values need quotes) +Dynamic config value, as KEY=JSON_VALUE (string values need quotes). **--headless** -Disable the Web UI +Disable the Web UI. **--ip** -IPv4 address to bind the frontend service to (default: 127.0.0.1) +IPv4 address to bind the frontend service to. (default: 127.0.0.1) **--log-format** Set the log formatting. Options: ["json", "pretty"]. (default: json) @@ -26,28 +26,28 @@ Set the log formatting. Options: ["json", "pretty"]. (default: json) Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) **--metrics-port** -Port for /metrics (default: 0) +Port for /metrics. (default: 0) **--namespace** Alias: **-n** -Specify namespaces that should be pre-created (namespace "default" is always created) +Specify namespaces that should be pre-created (namespace "default" is always created). **--port** Alias: **-p** -Port for the frontend gRPC service (default: 7233) +Port for the frontend gRPC service. (default: 7233) **--sqlite-pragma** Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. **--ui-asset-path** -UI Custom Assets path +UI Custom Assets path. **--ui-codec-endpoint** -UI Remote data converter HTTP endpoint +UI Remote data converter HTTP endpoint. **--ui-ip** -IPv4 address to bind the Web UI to +IPv4 address to bind the Web UI to. **--ui-port** -Port for the Web UI (default: 0) +Port for the Web UI. (default: 0) diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index 1092845e..a6c915c8 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -36,7 +36,7 @@ format output as: table, json, card. (default: table) **--task-queue** Alias: **-t** -Task Queue name +Task Queue name. **--task-queue-type** Task Queue type [workflow|activity] (default: workflow) diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index 87b573b5..3c470285 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -33,7 +33,7 @@ format output as: table, json, card. (default: table) **--task-queue** Alias: **-t** -Task Queue name +Task Queue name. **--tls-ca-path** Path to server CA certificate diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index 5f024c72..96425707 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -1,6 +1,6 @@ ### cancel -Cancel a Workflow Execution +Cancel a Workflow Execution. **--address** host:port for Temporal frontend service @@ -29,10 +29,10 @@ Temporal workflow namespace (default: default) **--query** Alias: **-q** -Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ +Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/. **--reason** -Reason for canceling with List Filter +Reason for canceling with List Filter. **--run-id** Alias: **-r** @@ -55,9 +55,9 @@ Override for target server name **--workflow-id** Alias: **-w** -Cancel Workflow Execution by Id +Cancel Workflow Execution by Id. **--yes** Alias: **-y** -Confirm all prompts +Confirm all prompts. diff --git a/docs/workflow/count.md b/docs/workflow/count.md index dde8b270..79a0e02a 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -1,6 +1,6 @@ ### count -Count Workflow Executions (requires ElasticSearch to be enabled) +Count Workflow Executions (requires ElasticSearch to be enabled). **--address** host:port for Temporal frontend service diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index be9b46fe..bf7b3963 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -1,6 +1,6 @@ ### delete -Delete a Workflow Execution +Delete a Workflow Execution. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index 6ab97a15..d1e8f586 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -1,6 +1,6 @@ ### describe -Show information about a Workflow Execution +Show information about a Workflow Execution. **--address** host:port for Temporal frontend service @@ -28,10 +28,10 @@ Alias: **-n** Temporal workflow namespace (default: default) **--raw** -Print properties as they are stored +Print properties as they are stored. **--reset-points** -Only show auto-reset points +Only show auto-reset points. **--run-id** Alias: **-r** diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index eedd1569..1c67a87f 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -1,6 +1,6 @@ ### execute -Start a new Workflow Execution and print progress +Start a new Workflow Execution and prints its progress. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/list.md b/docs/workflow/list.md index 84dbad5e..58951ab1 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -1,6 +1,6 @@ ### list -List Workflow Executions based on a Query +List Workflow Executions based on a Query. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/query.md b/docs/workflow/query.md index 66f7d6a2..99c3804d 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -1,6 +1,6 @@ ### query -Query a Workflow Execution +Query a Workflow Execution. **--address** host:port for Temporal frontend service @@ -57,7 +57,7 @@ Path to private key Override for target server name **--type** -The query type you want to run +The query type you want to run. **--workflow-id** Alias: **-w** diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index fb3534d4..05a89ac8 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -1,6 +1,6 @@ ### reset-batch -Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Reset a batch of Workflow Executions by reset type: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask **--address** host:port for Temporal frontend service @@ -18,45 +18,45 @@ when to use color: auto, always, never. (default: auto) Optional timeout for context of RPC call in seconds (default: 5) **--dry-run** -Simulate reset without resetting any Workflow Executions +Simulate reset without resetting any Workflow Executions. **--env** Env name to read the client environment variables from (default: default) **--exclude-file** -Input file that specifies Workflow Executions to exclude from resetting +Input file that specifies Workflow Executions to exclude from resetting. **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value **--input-file** -Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id +Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id. **--input-parallelism** -Number of goroutines to run in parallel. Each goroutine processes one line for every second (default: 1) +Number of goroutines to run in parallel. Each goroutine processes one line for every second. (default: 1) **--input-separator** -Separator for the input file. The default is a tab ( ) (default: ) +Separator for the input file. The default is a tab ( ). (default: ) **--namespace** Alias: **-n** Temporal workflow namespace (default: default) **--non-deterministic** -Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error +Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error. **--query** Alias: **-q** -Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query +Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query. **--reason** -Reason for resetting the Workflow Executions +Reason for resetting the Workflow Executions. **--skip-base-is-not-current** -Skip a Workflow Execution if the base Run is not the current Run +Skip a Workflow Execution if the base Run is not the current Run. **--skip-current-open** -Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run +Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run. **--tls-ca-path** Path to server CA certificate diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 58bb3ea9..5de07caa 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -1,6 +1,6 @@ ### reset -Reset a Workflow Execution by event Id or reset type +Reset a Workflow Execution by Event Id or reset type. **--address** host:port for Temporal frontend service @@ -21,7 +21,7 @@ Optional timeout for context of RPC call in seconds (default: 5) Env name to read the client environment variables from (default: default) **--event-id** -The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others +The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others. **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value @@ -34,7 +34,7 @@ Temporal workflow namespace (default: default) Event types to reapply after the reset point: , Signal, None. (default: All) **--reason** -Reason to reset +Reason to reset. **--run-id** Alias: **-r** @@ -56,7 +56,7 @@ Path to private key Override for target server name **--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask **--workflow-id** Alias: **-w** diff --git a/docs/workflow/show.md b/docs/workflow/show.md index 3e32269a..3446e0a7 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -1,6 +1,6 @@ ### show -Show Event History for a Workflow Execution +Show Event History for a Workflow Execution. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index 66922d00..fc166a9c 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -1,6 +1,6 @@ ### signal -Signal Workflow Execution by Id or List Filter +Signal Workflow Execution by Id or List Filter. **--address** host:port for Temporal frontend service @@ -25,10 +25,10 @@ gRPC metadata to send with requests. Format: key=value. Use valid JSON formats f **--input** Alias: **-i** -Input for the signal (JSON) +Input for the signal (JSON). **--input-file** -Input for the signal from file (JSON) +Input for the signal from file (JSON). **--name** Signal Name @@ -39,10 +39,10 @@ Temporal workflow namespace (default: default) **--query** Alias: **-q** -Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ +Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/. **--reason** -Reason for signaling with List Filter +Reason for signaling with List Filter. **--run-id** Alias: **-r** @@ -65,9 +65,9 @@ Override for target server name **--workflow-id** Alias: **-w** -Signal Workflow Execution by Id +Signal Workflow Execution by Id. **--yes** Alias: **-y** -Confirm all prompts +Confirm all prompts. diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index 1715c60c..9a5116a5 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -1,6 +1,6 @@ ### stack -Query a Workflow Execution with __stack_trace as the query type +Query a Workflow Execution with __stack_trace as the query type. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/start.md b/docs/workflow/start.md index 41904430..0888e9a5 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -1,6 +1,6 @@ ### start -Start a new Workflow Execution +Start a new Workflow Execution. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index 0e574234..0c836cf0 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -1,6 +1,6 @@ ### terminate -Terminate Workflow Execution by Id or List Filter +Terminate Workflow Execution by Id or List Filter. **--address** host:port for Temporal frontend service @@ -29,10 +29,10 @@ Temporal workflow namespace (default: default) **--query** Alias: **-q** -Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/ +Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/. **--reason** -Reason for termination +Reason for termination. **--run-id** Alias: **-r** @@ -55,9 +55,9 @@ Override for target server name **--workflow-id** Alias: **-w** -Terminate Workflow Execution by Id +Terminate Workflow Execution by Id. **--yes** Alias: **-y** -Confirm all prompts +Confirm all prompts. diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index d80da9e7..706e7cf0 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -1,6 +1,6 @@ ### trace -Trace progress of a Workflow Execution and its children +Trace progress of a Workflow Execution and its children. **--address** host:port for Temporal frontend service @@ -21,13 +21,13 @@ Request concurrency (default: 10) Optional timeout for context of RPC call in seconds (default: 5) **--depth** -Number of child workflows to expand, -1 to expand all child workflows (default: -1) +Number of Child Workflows to expand, -1 to expand all Child Workflows. (default: -1) **--env** Env name to read the client environment variables from (default: default) **--fold** -Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied (default: completed,canceled,terminated) +Statuses for which Child Workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied. (default: completed,canceled,terminated) **--grpc-meta** gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value @@ -37,7 +37,7 @@ Alias: **-n** Temporal workflow namespace (default: default) **--no-fold** -Disable folding. All child workflows within the set depth will be fetched and displayed +Disable folding. All Child Workflows within the set depth will be fetched and displayed. **--run-id** Alias: **-r** diff --git a/namespace/namespace.go b/namespace/namespace.go index a7046997..5b87d355 100644 --- a/namespace/namespace.go +++ b/namespace/namespace.go @@ -17,7 +17,7 @@ func NewNamespaceCommands() []*cli.Command { return []*cli.Command{ { Name: "describe", - Usage: "Describe a Namespace by name or Id", + Usage: "Describe a Namespace by name or Id.", Flags: describeNamespaceFlags, ArgsUsage: "namespace_name", Action: func(c *cli.Context) error { @@ -26,7 +26,7 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "list", - Usage: "List all Namespaces", + Usage: "List all Namespaces.", ArgsUsage: " ", Action: func(c *cli.Context) error { return ListNamespaces(c) @@ -34,7 +34,7 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "register", - Usage: "Register a new Namespace", + Usage: "Register a new Namespace.", Flags: registerNamespaceFlags, ArgsUsage: "namespace_name [cluster_name...]", Action: func(c *cli.Context) error { @@ -43,7 +43,7 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "update", - Usage: "Update a Namespace", + Usage: "Update a Namespace.", Flags: updateNamespaceFlags, ArgsUsage: "namespace_name [cluster_name...]", Action: func(c *cli.Context) error { @@ -52,12 +52,12 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "delete", - Usage: "Delete existing Namespace", + Usage: "Delete existing Namespace.", Flags: []cli.Flag{ &cli.BoolFlag{ Name: common.FlagYes, Aliases: common.FlagYesAlias, - Usage: "Confirm all prompts", + Usage: "Confirm all prompts.", Category: common.CategoryMain, }, }, diff --git a/schedule/schedule.go b/schedule/schedule.go index 153367cf..a927f9eb 100644 --- a/schedule/schedule.go +++ b/schedule/schedule.go @@ -33,27 +33,27 @@ func NewScheduleCommands() []*cli.Command { }, &cli.StringSliceFlag{ Name: common.FlagInterval, - Usage: "Interval duration, e.g. 90m, or 90m/13m to include phase offset", + Usage: "Interval duration, e.g. 90m, or 90m/13m to include phase offset.", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagStartTime, - Usage: "Overall schedule start time", + Usage: "Overall schedule start time.", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagEndTime, - Usage: "Overall schedule end time", + Usage: "Overall schedule end time.", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagJitter, - Usage: "Jitter duration", + Usage: "Jitter duration.", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagTimeZone, - Usage: "Time zone (IANA name)", + Usage: "Time zone (IANA name).", Category: common.CategoryMain, }, } diff --git a/searchattribute/search_attribute.go b/searchattribute/search_attribute.go index e76453be..0972d234 100644 --- a/searchattribute/search_attribute.go +++ b/searchattribute/search_attribute.go @@ -13,12 +13,12 @@ func NewSearchAttributeCommands() []*cli.Command { return []*cli.Command{ { Name: "create", - Usage: "Add custom search attributes", + Usage: "Add custom search attributes.", Flags: []cli.Flag{ &cli.StringSliceFlag{ Name: common.FlagName, Required: true, - Usage: "Search attribute name", + Usage: "Search attribute name.", Category: common.CategoryMain, }, &cli.StringSliceFlag{ @@ -30,7 +30,7 @@ func NewSearchAttributeCommands() []*cli.Command { &cli.BoolFlag{ Name: common.FlagYes, Aliases: common.FlagYesAlias, - Usage: "Confirm all prompts", + Usage: "Confirm all prompts.", Category: common.CategoryMain, }, }, @@ -40,7 +40,7 @@ func NewSearchAttributeCommands() []*cli.Command { }, { Name: "list", - Usage: "List search attributes that can be used in list workflow query", + Usage: "List search attributes that can be used in list Workflow Query.", Flags: []cli.Flag{ &cli.StringFlag{ Name: output.FlagOutput, @@ -56,18 +56,18 @@ func NewSearchAttributeCommands() []*cli.Command { }, { Name: "remove", - Usage: "Remove custom search attributes metadata only (Elasticsearch index schema is not modified)", + Usage: "Remove custom search attributes metadata only (Elasticsearch index schema is not modified).", Flags: []cli.Flag{ &cli.StringSliceFlag{ Name: common.FlagName, Required: true, - Usage: "Search attribute name", + Usage: "Search attribute name.", Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagYes, Aliases: common.FlagYesAlias, - Usage: "Confirm all prompts", + Usage: "Confirm all prompts.", Category: common.CategoryMain, }, }, diff --git a/server/commands.go b/server/commands.go index a366ed87..a9052fc1 100644 --- a/server/commands.go +++ b/server/commands.go @@ -50,62 +50,62 @@ func NewServerCommands(defaultCfg *sconfig.Config) []*cli.Command { return []*cli.Command{ { Name: "start-dev", - Usage: "Start Temporal development server", + Usage: "Start Temporal development server.", ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagDBPath, Aliases: []string{"f"}, Value: defaultCfg.DatabaseFilePath, - Usage: "File in which to persist Temporal state (by default, Workflows are lost when the process dies)", + Usage: "File in which to persist Temporal state (by default, Workflows are lost when the process dies).", }, &cli.StringSliceFlag{ Name: common.FlagNamespace, Aliases: common.FlagNamespaceAlias, - Usage: `Specify namespaces that should be pre-created (namespace "default" is always created)`, + Usage: `Specify namespaces that should be pre-created (namespace "default" is always created).`, EnvVars: nil, Value: nil, }, &cli.IntFlag{ Name: common.FlagPort, Aliases: []string{"p"}, - Usage: "Port for the frontend gRPC service", + Usage: "Port for the frontend gRPC service.", Value: sconfig.DefaultFrontendPort, }, &cli.IntFlag{ Name: common.FlagMetricsPort, - Usage: "Port for /metrics", + Usage: "Port for /metrics.", Value: sconfig.DefaultMetricsPort, DefaultText: "disabled", }, &cli.IntFlag{ Name: common.FlagUIPort, - Usage: "Port for the Web UI", + Usage: "Port for the Web UI.", DefaultText: fmt.Sprintf("--port + 1000, eg. %d", sconfig.DefaultFrontendPort+1000), }, &cli.BoolFlag{ Name: common.FlagHeadless, - Usage: "Disable the Web UI", + Usage: "Disable the Web UI.", }, &cli.StringFlag{ Name: common.FlagIP, - Usage: `IPv4 address to bind the frontend service to`, + Usage: `IPv4 address to bind the frontend service to.`, EnvVars: nil, Value: "127.0.0.1", }, &cli.StringFlag{ Name: common.FlagUIIP, - Usage: `IPv4 address to bind the Web UI to`, + Usage: `IPv4 address to bind the Web UI to.`, DefaultText: "same as --ip", }, &cli.StringFlag{ Name: common.FlagUIAssetPath, - Usage: `UI Custom Assets path`, + Usage: `UI Custom Assets path.`, EnvVars: nil, }, &cli.StringFlag{ Name: common.FlagUICodecEndpoint, - Usage: `UI Remote data converter HTTP endpoint`, + Usage: `UI Remote data converter HTTP endpoint.`, EnvVars: nil, }, &cli.StringFlag{ @@ -129,13 +129,13 @@ func NewServerCommands(defaultCfg *sconfig.Config) []*cli.Command { &cli.StringFlag{ Name: common.FlagConfig, Aliases: []string{"c"}, - Usage: `Path to config directory`, + Usage: `Path to config directory.`, EnvVars: []string{config.EnvKeyConfigDir}, Value: "", }, &cli.StringSliceFlag{ Name: common.FlagDynamicConfigValue, - Usage: `Dynamic config value, as KEY=JSON_VALUE (string values need quotes)`, + Usage: `Dynamic config value, as KEY=JSON_VALUE (string values need quotes).`, }, }, Before: func(c *cli.Context) error { diff --git a/taskqueue/task_queue.go b/taskqueue/task_queue.go index e5d53917..e90fe138 100644 --- a/taskqueue/task_queue.go +++ b/taskqueue/task_queue.go @@ -18,7 +18,7 @@ RatePerSecond is the maximum Activities per second the Worker will execute.`, &cli.StringFlag{ Name: common.FlagTaskQueue, Aliases: common.FlagTaskQueueAlias, - Usage: "Task Queue name", + Usage: "Task Queue name.", Required: true, Category: common.CategoryMain, }, @@ -40,7 +40,7 @@ RatePerSecond is the maximum Activities per second the Worker will execute.`, &cli.StringFlag{ Name: common.FlagTaskQueue, Aliases: common.FlagTaskQueueAlias, - Usage: "Task Queue name", + Usage: "Task Queue name.", Required: true, Category: common.CategoryMain, }, diff --git a/workflow/workflow.go b/workflow/workflow.go index ade42c94..6e1f1f3c 100644 --- a/workflow/workflow.go +++ b/workflow/workflow.go @@ -12,7 +12,7 @@ func NewWorkflowCommands() []*cli.Command { return []*cli.Command{ { Name: "start", - Usage: "Start a new Workflow Execution", + Usage: "Start a new Workflow Execution.", Flags: append(common.FlagsForStartWorkflow, common.FlagsForPaginationAndRendering...), Action: func(c *cli.Context) error { return StartWorkflow(c, false) @@ -20,7 +20,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "execute", - Usage: "Start a new Workflow Execution and print progress", + Usage: "Start a new Workflow Execution and prints its progress.", Flags: append(common.FlagsForStartWorkflow, common.FlagsForPaginationAndRendering...), Action: func(c *cli.Context) error { return StartWorkflow(c, true) @@ -28,16 +28,16 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "describe", - Usage: "Show information about a Workflow Execution", + Usage: "Show information about a Workflow Execution.", Flags: append(common.FlagsForExecution, []cli.Flag{ &cli.BoolFlag{ Name: common.FlagResetPointsOnly, - Usage: "Only show auto-reset points", + Usage: "Only show auto-reset points.", Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagPrintRaw, - Usage: "Print properties as they are stored", + Usage: "Print properties as they are stored.", Category: common.CategoryMain, }, }...), @@ -47,7 +47,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "list", - Usage: "List Workflow Executions based on a Query", + Usage: "List Workflow Executions based on a Query.", Flags: append(common.FlagsForWorkflowFiltering, common.FlagsForPaginationAndRendering...), Action: func(c *cli.Context) error { return ListWorkflow(c) @@ -55,7 +55,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "show", - Usage: "Show Event History for a Workflow Execution", + Usage: "Show Event History for a Workflow Execution.", Flags: append(append(common.FlagsForExecution, common.FlagsForShowWorkflow...), common.FlagsForPaginationAndRendering...), Action: func(c *cli.Context) error { return ShowHistory(c) @@ -63,11 +63,11 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "query", - Usage: "Query a Workflow Execution", + Usage: "Query a Workflow Execution.", Flags: append(common.FlagsForStackTraceQuery, &cli.StringFlag{ Name: common.FlagType, - Usage: "The query type you want to run", + Usage: "The query type you want to run.", Required: true, Category: common.CategoryMain, }), @@ -78,7 +78,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "stack", - Usage: "Query a Workflow Execution with __stack_trace as the query type", + Usage: "Query a Workflow Execution with __stack_trace as the query type.", Flags: common.FlagsForStackTraceQuery, Action: func(c *cli.Context) error { return QueryWorkflowUsingStackTrace(c) @@ -86,12 +86,12 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "signal", - Usage: "Signal Workflow Execution by Id or List Filter", + Usage: "Signal Workflow Execution by Id or List Filter.", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, Aliases: common.FlagWorkflowIDAlias, - Usage: "Signal Workflow Execution by Id", + Usage: "Signal Workflow Execution by Id.", Category: common.CategoryMain, }, &cli.StringFlag{ @@ -103,7 +103,7 @@ func NewWorkflowCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagQuery, Aliases: common.FlagQueryAlias, - Usage: "Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/", + Usage: "Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/.", Category: common.CategoryMain, }, &cli.StringFlag{ @@ -115,23 +115,23 @@ func NewWorkflowCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagInput, Aliases: common.FlagInputAlias, - Usage: "Input for the signal (JSON)", + Usage: "Input for the signal (JSON).", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagInputFile, - Usage: "Input for the signal from file (JSON)", + Usage: "Input for the signal from file (JSON).", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason for signaling with List Filter", + Usage: "Reason for signaling with List Filter.", Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagYes, Aliases: common.FlagYesAlias, - Usage: "Confirm all prompts", + Usage: "Confirm all prompts.", Category: common.CategoryMain, }, }, @@ -141,7 +141,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "count", - Usage: "Count Workflow Executions (requires ElasticSearch to be enabled)", + Usage: "Count Workflow Executions (requires ElasticSearch to be enabled).", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagQuery, @@ -156,12 +156,12 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "cancel", - Usage: "Cancel a Workflow Execution", + Usage: "Cancel a Workflow Execution.", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, Aliases: common.FlagWorkflowIDAlias, - Usage: "Cancel Workflow Execution by Id", + Usage: "Cancel Workflow Execution by Id.", Category: common.CategoryMain, }, &cli.StringFlag{ @@ -173,18 +173,18 @@ func NewWorkflowCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagQuery, Aliases: common.FlagQueryAlias, - Usage: "Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/", + Usage: "Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/.", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason for canceling with List Filter", + Usage: "Reason for canceling with List Filter.", Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagYes, Aliases: common.FlagYesAlias, - Usage: "Confirm all prompts", + Usage: "Confirm all prompts.", Category: common.CategoryMain, }, }, @@ -194,12 +194,12 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "terminate", - Usage: "Terminate Workflow Execution by Id or List Filter", + Usage: "Terminate Workflow Execution by Id or List Filter.", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, Aliases: common.FlagWorkflowIDAlias, - Usage: "Terminate Workflow Execution by Id", + Usage: "Terminate Workflow Execution by Id.", Category: common.CategoryMain, }, &cli.StringFlag{ @@ -211,18 +211,18 @@ func NewWorkflowCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagQuery, Aliases: common.FlagQueryAlias, - Usage: "Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/", + Usage: "Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/.", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason for termination", + Usage: "Reason for termination.", Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagYes, Aliases: common.FlagYesAlias, - Usage: "Confirm all prompts", + Usage: "Confirm all prompts.", Category: common.CategoryMain, }, }, @@ -232,7 +232,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "delete", - Usage: "Delete a Workflow Execution", + Usage: "Delete a Workflow Execution.", Flags: common.FlagsForExecution, Action: func(c *cli.Context) error { return DeleteWorkflow(c) @@ -240,16 +240,16 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "reset", - Usage: "Reset a Workflow Execution by event Id or reset type", + Usage: "Reset a Workflow Execution by Event Id or reset type.", Flags: append(common.FlagsForExecution, []cli.Flag{ &cli.StringFlag{ Name: common.FlagEventID, - Usage: "The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others", + Usage: "The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others.", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason to reset", + Usage: "Reason to reset.", Required: true, Category: common.CategoryMain, }, @@ -276,40 +276,40 @@ func NewWorkflowCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagQuery, Aliases: common.FlagQueryAlias, - Usage: "Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query", + Usage: "Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query.", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagInputFile, - Usage: "Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id", + Usage: "Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id.", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagExcludeFile, Value: "", - Usage: "Input file that specifies Workflow Executions to exclude from resetting", + Usage: "Input file that specifies Workflow Executions to exclude from resetting.", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagInputSeparator, Value: "\t", - Usage: "Separator for the input file. The default is a tab (\t)", + Usage: "Separator for the input file. The default is a tab (\t).", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason for resetting the Workflow Executions", + Usage: "Reason for resetting the Workflow Executions.", Required: true, Category: common.CategoryMain, }, &cli.IntFlag{ Name: common.FlagParallelism, Value: 1, - Usage: "Number of goroutines to run in parallel. Each goroutine processes one line for every second", + Usage: "Number of goroutines to run in parallel. Each goroutine processes one line for every second.", Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagSkipCurrentOpen, - Usage: "Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run", + Usage: "Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run.", Category: common.CategoryMain, }, &cli.BoolFlag{ @@ -317,12 +317,12 @@ func NewWorkflowCommands() []*cli.Command { // TODO https://github.com/uber/cadence/issues/2930 // The right way to prevent needs server side implementation . // This client side is only best effort - Usage: "Skip a Workflow Execution if the base Run is not the current Run", + Usage: "Skip a Workflow Execution if the base Run is not the current Run.", Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagNonDeterministic, - Usage: "Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error", + Usage: "Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error.", Category: common.CategoryMain, }, &cli.StringFlag{ @@ -333,7 +333,7 @@ func NewWorkflowCommands() []*cli.Command { }, &cli.BoolFlag{ Name: common.FlagDryRun, - Usage: "Simulate reset without resetting any Workflow Executions", + Usage: "Simulate reset without resetting any Workflow Executions.", Category: common.CategoryMain, }, }, @@ -343,12 +343,12 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "trace", - Usage: "Trace progress of a Workflow Execution and its children", + Usage: "Trace progress of a Workflow Execution and its children.", Flags: append(common.FlagsForExecution, &cli.IntFlag{ Name: common.FlagDepth, Value: -1, - Usage: "Number of child workflows to expand, -1 to expand all child workflows", + Usage: "Number of Child Workflows to expand, -1 to expand all Child Workflows.", Category: common.CategoryMain, }, &cli.IntFlag{ @@ -359,13 +359,13 @@ func NewWorkflowCommands() []*cli.Command { }, &cli.StringFlag{ Name: common.FlagFold, - Usage: fmt.Sprintf("Statuses for which child workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --%s supplied", common.FlagNoFold), + Usage: fmt.Sprintf("Statuses for which Child Workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --%s supplied.", common.FlagNoFold), Value: "completed,canceled,terminated", Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagNoFold, - Usage: "Disable folding. All child workflows within the set depth will be fetched and displayed", + Usage: "Disable folding. All Child Workflows within the set depth will be fetched and displayed.", Category: common.CategoryMain, }), Action: TraceWorkflow, From 8aba5f5b4f4bd14a33ec43fba84108ca75ba6ea8 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 17 Jan 2023 15:17:22 -0600 Subject: [PATCH 25/68] grammar --- app/app.go | 40 +++++++++++++++++++++---------- cmd/doc/main.go | 10 ++++---- docs/activity/index.md | 2 +- docs/batch/index.md | 2 +- docs/completion/index.md | 2 +- docs/env/index.md | 2 +- docs/operator/cluster.md | 2 +- docs/operator/index.md | 2 +- docs/operator/namespace.md | 2 +- docs/operator/search-attribute.md | 2 +- docs/schedule/index.md | 2 +- docs/server/index.md | 1 - docs/task-queue/index.md | 2 +- docs/workflow/index.md | 2 +- docs/workflow/reset-batch.md | 2 +- docs/workflow/reset.md | 2 +- 16 files changed, 46 insertions(+), 31 deletions(-) diff --git a/app/app.go b/app/app.go index 406ddf5a..ca3b960b 100644 --- a/app/app.go +++ b/app/app.go @@ -88,7 +88,9 @@ func serverCommands(defaultCfg *sconfig.Config) []*cli.Command { return []*cli.Command{ { Name: "server", - Usage: "Commands for managing Temporal server", + Usage: "", + UsageText: "", + Description: "Commands for managing the Temporal Server.", Subcommands: server.NewServerCommands(defaultCfg), }, } @@ -97,54 +99,68 @@ func serverCommands(defaultCfg *sconfig.Config) []*cli.Command { var clientCommands = []*cli.Command{ { Name: "workflow", - Usage: "Operations on Workflows", + Usage: "", + UsageText: "", + Description: "Operations that can be performed on Workflows.", Subcommands: workflow.NewWorkflowCommands(), }, { Name: "activity", - Usage: "Operations on Activities of Workflows", + Usage: "", + UsageText: "", + Description: "Operations that can be performed on Workflow Activities.", Subcommands: activity.NewActivityCommands(), }, { Name: "task-queue", - Usage: "Operations on Task Queues", + Usage: "", + UsageText: "", + Description: "Operations performed on Task Queues.", Subcommands: taskqueue.NewTaskQueueCommands(), }, { Name: "schedule", - Usage: "Operations on Schedules", + Usage: "", + UsageText: "", + Description: "Operations performed on Schedules.", Subcommands: schedule.NewScheduleCommands(), }, { Name: "batch", - Usage: "Operations on Batch jobs. Use Workflow commands with --query flag to start batch jobs", + Usage: "", + UsageText: "", + Description: "Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs.", Subcommands: batch.NewBatchCommands(), }, { Name: "operator", - Usage: "Operation on Temporal server", + Usage: "", + UsageText: "", + Description: "Operations on Temporal Server.", Subcommands: []*cli.Command{ { Name: "namespace", - Usage: "Operations on namespaces", + Usage: "Operations applying to Namespaces.", Subcommands: namespace.NewNamespaceCommands(), }, { Name: "search-attribute", - Usage: "Operations on search attributes", + Usage: "Operations applying to Search Attributes.", Subcommands: searchattribute.NewSearchAttributeCommands(), }, { Name: "cluster", - Usage: "Operations on a Temporal Cluster", + Usage: "Operations for running a Temporal Cluster.", Subcommands: cluster.NewClusterCommands(), }, }, }, { Name: "env", - Usage: "Manage client environment configurations", + Usage: "", + UsageText: "", + Description: "Manage environment configurations on Temporal Client.", Subcommands: env.NewEnvCommands(), }, } @@ -152,7 +168,7 @@ var clientCommands = []*cli.Command{ var completionCommands = []*cli.Command{ { Name: "completion", - Usage: "Output shell completion code for the specified shell (zsh, bash)", + Usage: "Output shell completion code for the specified shell (zsh, bash).", Subcommands: completion.NewCompletionCommands(), }, } diff --git a/cmd/doc/main.go b/cmd/doc/main.go index b81d631c..1a32a70e 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -40,6 +40,8 @@ func main() { var currentHeaderFile *os.File createdFiles := make(map[string]*os.File) + // TODO: identify different option categories and print flags accordingly + // TODO: rework what is written to the string for scanner.Scan() { line := scanner.Text() if strings.HasPrefix(line, "## ") { @@ -93,11 +95,9 @@ func main() { writeLine(currentHeaderFile, strings.TrimSpace(definition)) log.Info(found) - } else if !strings.HasPrefix(line, "# ") { - writeLine(currentHeaderFile, line) } else { - continue - } + writeLine(currentHeaderFile, line) + } } // close file descriptor after for loop has completed readFile.Close() @@ -117,4 +117,4 @@ func makeAlias(file *os.File, line string) { termArray := strings.Split(line, ",") writeLine(file, termArray[0] + "**") writeLine(file, "Alias: **" + strings.TrimSpace(termArray[1])) -} +} \ No newline at end of file diff --git a/docs/activity/index.md b/docs/activity/index.md index 02514c96..4674d0d3 100644 --- a/docs/activity/index.md +++ b/docs/activity/index.md @@ -1,4 +1,4 @@ ## activity -Operations on Activities of Workflows +Operations that can be performed on Workflow Activities. diff --git a/docs/batch/index.md b/docs/batch/index.md index f9564643..416f12fd 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -1,4 +1,4 @@ ## batch -Operations on Batch jobs. Use Workflow commands with --query flag to start batch jobs +Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs. diff --git a/docs/completion/index.md b/docs/completion/index.md index 830921f1..f9cfc9fe 100644 --- a/docs/completion/index.md +++ b/docs/completion/index.md @@ -1,4 +1,4 @@ ## completion -Output shell completion code for the specified shell (zsh, bash) +Output shell completion code for the specified shell (zsh, bash). diff --git a/docs/env/index.md b/docs/env/index.md index ada0329f..99d6dc72 100644 --- a/docs/env/index.md +++ b/docs/env/index.md @@ -1,4 +1,4 @@ ## env -Manage client environment configurations +Manage environment configurations on Temporal Client. diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index 0e7be121..da073134 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -1,6 +1,6 @@ ### cluster -Operations on a Temporal Cluster +Operations for running a Temporal Cluster. #### health diff --git a/docs/operator/index.md b/docs/operator/index.md index c9523cf7..bf085e01 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -1,4 +1,4 @@ ## operator -Operation on Temporal server +Operations on Temporal Server. diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index d160576e..77250ad7 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -1,6 +1,6 @@ ### namespace -Operations on namespaces +Operations applying to Namespaces. #### describe diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index 5a8d1ae0..f78cad23 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -1,6 +1,6 @@ ### search-attribute -Operations on search attributes +Operations applying to Search Attributes. #### create diff --git a/docs/schedule/index.md b/docs/schedule/index.md index b8d4efff..a99f2428 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -1,4 +1,4 @@ ## schedule -Operations on Schedules +Operations performed on Schedules. diff --git a/docs/server/index.md b/docs/server/index.md index eebf9911..597203f8 100644 --- a/docs/server/index.md +++ b/docs/server/index.md @@ -1,4 +1,3 @@ ## server -Commands for managing Temporal server diff --git a/docs/task-queue/index.md b/docs/task-queue/index.md index 7f0bc243..abc8a52a 100644 --- a/docs/task-queue/index.md +++ b/docs/task-queue/index.md @@ -1,4 +1,4 @@ ## task-queue -Operations on Task Queues +Operations performed on Task Queues. diff --git a/docs/workflow/index.md b/docs/workflow/index.md index b44c5ffc..55396fee 100644 --- a/docs/workflow/index.md +++ b/docs/workflow/index.md @@ -1,4 +1,4 @@ ## workflow -Operations on Workflows +Operations that can be performed on Workflows. diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 05a89ac8..6ca0950d 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -1,6 +1,6 @@ ### reset-batch -Reset a batch of Workflow Executions by reset type: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask +Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew **--address** host:port for Temporal frontend service diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 5de07caa..004295ca 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -56,7 +56,7 @@ Path to private key Override for target server name **--type** -Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew **--workflow-id** Alias: **-w** From 8f274de2fdd26a5d85bc3273d2dcb6dd195c2045 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 18 Jan 2023 12:10:58 -0600 Subject: [PATCH 26/68] UsageText added --- activity/activity.go | 3 ++- app/app.go | 35 +++++++++-------------------- batch/batch.go | 3 +++ cluster/cluster.go | 4 ++-- cmd/doc/main.go | 3 ++- docs/activity/complete.md | 4 +++- docs/batch/describe.md | 2 ++ docs/batch/index.md | 2 ++ docs/batch/list.md | 2 ++ docs/batch/terminate.md | 2 ++ docs/env/delete.md | 2 +- docs/env/get.md | 2 +- docs/env/index.md | 2 +- docs/env/set.md | 2 +- docs/operator/cluster.md | 4 ++-- docs/operator/index.md | 2 ++ docs/operator/namespace.md | 8 +++---- docs/operator/search-attribute.md | 6 ++--- docs/schedule/index.md | 2 ++ docs/server/index.md | 1 + docs/task-queue/describe.md | 6 ++++- docs/task-queue/list-partition.md | 2 +- docs/workflow/cancel.md | 2 ++ docs/workflow/delete.md | 2 +- docs/workflow/describe.md | 2 ++ docs/workflow/execute.md | 2 ++ docs/workflow/list.md | 2 ++ docs/workflow/query.md | 2 ++ docs/workflow/reset-batch.md | 4 +++- docs/workflow/reset.md | 8 ++++--- docs/workflow/start.md | 2 ++ docs/workflow/terminate.md | 2 ++ env/env.go | 6 ++--- namespace/namespace.go | 8 +++---- searchattribute/search_attribute.go | 6 ++--- taskqueue/task_queue.go | 6 ++--- workflow/workflow.go | 14 ++++++++++-- 37 files changed, 103 insertions(+), 64 deletions(-) diff --git a/activity/activity.go b/activity/activity.go index 7d0dbc2a..f3ccdeb4 100644 --- a/activity/activity.go +++ b/activity/activity.go @@ -9,7 +9,8 @@ func NewActivityCommands() []*cli.Command { return []*cli.Command{ { Name: "complete", - Usage: "Complete an Activity.", + Usage: "Completes an Activity.", + UsageText: "When used, the Activity is scheduled to be completed.", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, diff --git a/app/app.go b/app/app.go index ca3b960b..2d56ea0d 100644 --- a/app/app.go +++ b/app/app.go @@ -88,9 +88,7 @@ func serverCommands(defaultCfg *sconfig.Config) []*cli.Command { return []*cli.Command{ { Name: "server", - Usage: "", - UsageText: "", - Description: "Commands for managing the Temporal Server.", + Usage: "Commands for managing the Temporal Server.", Subcommands: server.NewServerCommands(defaultCfg), }, } @@ -99,45 +97,36 @@ func serverCommands(defaultCfg *sconfig.Config) []*cli.Command { var clientCommands = []*cli.Command{ { Name: "workflow", - Usage: "", - UsageText: "", - Description: "Operations that can be performed on Workflows.", + Usage: "Operations that can be performed on Workflows.", Subcommands: workflow.NewWorkflowCommands(), }, { Name: "activity", - Usage: "", - UsageText: "", - Description: "Operations that can be performed on Workflow Activities.", + Usage: "Operations that can be performed on Workflow Activities.", Subcommands: activity.NewActivityCommands(), }, { Name: "task-queue", - Usage: "", - UsageText: "", - Description: "Operations performed on Task Queues.", + Usage: "Operations performed on Task Queues.", Subcommands: taskqueue.NewTaskQueueCommands(), }, { Name: "schedule", - Usage: "", - UsageText: "", - Description: "Operations performed on Schedules.", + Usage: "Operations performed on Schedules.", + UsageText: "These commands allow Schedules to be created, used, and updated.", Subcommands: schedule.NewScheduleCommands(), }, { Name: "batch", - Usage: "", - UsageText: "", - Description: "Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs.", + Usage: "Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs.", + UsageText: "Batch jobs run in the background and affect Workflow Executions one at a time. In `cli`, the batch commands are used to view the status of Batch jobs, and to terminate them. A successfully started Batch job returns a Job Id, which is needed to execute batch commands. Terminating a batch job does not roll back the operations already performed by the job itself.", Subcommands: batch.NewBatchCommands(), }, { Name: "operator", - Usage: "", - UsageText: "", - Description: "Operations on Temporal Server.", + Usage: "Operations on Temporal Server.", + UsageText: "These commands enable operations on Namespaces, Search Attributes, and Temporal Clusters.", Subcommands: []*cli.Command{ { Name: "namespace", @@ -158,9 +147,7 @@ var clientCommands = []*cli.Command{ }, { Name: "env", - Usage: "", - UsageText: "", - Description: "Manage environment configurations on Temporal Client.", + Usage: "Manage environmental configurations on Temporal Client.", Subcommands: env.NewEnvCommands(), }, } diff --git a/batch/batch.go b/batch/batch.go index 22750abd..54f70243 100644 --- a/batch/batch.go +++ b/batch/batch.go @@ -10,6 +10,7 @@ func NewBatchCommands() []*cli.Command { { Name: "describe", Usage: "Describe a Batch operation job.", + UsageText: "This command shows the progress of an ongoing Batch job.", Flags: append([]cli.Flag{ &cli.StringFlag{ Name: common.FlagJobID, @@ -25,6 +26,7 @@ func NewBatchCommands() []*cli.Command { { Name: "list", Usage: "List Batch operation jobs.", + UsageText: "When used, all Batch operation jobs within the system are listed.", Flags: common.FlagsForPaginationAndRendering, ArgsUsage: " ", Action: func(c *cli.Context) error { @@ -34,6 +36,7 @@ func NewBatchCommands() []*cli.Command { { Name: "terminate", Usage: "Stop a Batch operation job.", + UsageText: "When used, the Batch job with the provided Batch Id is terminated.", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagJobID, diff --git a/cluster/cluster.go b/cluster/cluster.go index 3eb879c4..37c25ac4 100644 --- a/cluster/cluster.go +++ b/cluster/cluster.go @@ -10,7 +10,7 @@ func NewClusterCommands() []*cli.Command { return []*cli.Command{ { Name: "health", - Usage: "Check health of frontend service.", + Usage: "Checks the health of the Frontend Service.", Action: func(c *cli.Context) error { return HealthCheck(c) }, @@ -39,7 +39,7 @@ func NewClusterCommands() []*cli.Command { }, { Name: "system", - Usage: "Show information about the system and its capabilities.", + Usage: "Shows information about the system and its capabilities.", ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 1a32a70e..62bcc347 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -117,4 +117,5 @@ func makeAlias(file *os.File, line string) { termArray := strings.Split(line, ",") writeLine(file, termArray[0] + "**") writeLine(file, "Alias: **" + strings.TrimSpace(termArray[1])) -} \ No newline at end of file +} + diff --git a/docs/activity/complete.md b/docs/activity/complete.md index 3fa6514d..351c4bcc 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -1,6 +1,8 @@ ### complete -Complete an Activity. +Completes an Activity. + +>When used, the Activity is scheduled to be completed. **--activity-id** Identifies the Activity to be completed. diff --git a/docs/batch/describe.md b/docs/batch/describe.md index edfdbde6..b6c83577 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -2,6 +2,8 @@ Describe a Batch operation job. +>This command shows the progress of an ongoing Batch job. + **--address** host:port for Temporal frontend service diff --git a/docs/batch/index.md b/docs/batch/index.md index 416f12fd..3f1ab543 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -2,3 +2,5 @@ Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs. +>Batch jobs run in the background and affect Workflow Executions one at a time. In `cli`, the batch commands are used to view the status of Batch jobs, and to terminate them. A successfully started Batch job returns a Job Id, which is needed to execute batch commands. Terminating a batch job does not roll back the operations already performed by the job itself. + diff --git a/docs/batch/list.md b/docs/batch/list.md index 62f1119b..d269fb29 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -2,6 +2,8 @@ List Batch operation jobs. +>When used, all Batch operation jobs within the system are listed. + **--address** host:port for Temporal frontend service diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index 46c2342b..636a6385 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -2,6 +2,8 @@ Stop a Batch operation job. +>When used, the Batch job with the provided Batch Id is terminated. + **--address** host:port for Temporal frontend service diff --git a/docs/env/delete.md b/docs/env/delete.md index 2952cff1..dc726998 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -1,6 +1,6 @@ ### delete -Delete environment or environment property +Delete environment or environmental property. **--address** host:port for Temporal frontend service diff --git a/docs/env/get.md b/docs/env/get.md index c0661133..39e45f3a 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -1,6 +1,6 @@ ### get -Print environment properties +Prints environmental properties. **--address** host:port for Temporal frontend service diff --git a/docs/env/index.md b/docs/env/index.md index 99d6dc72..0014d96a 100644 --- a/docs/env/index.md +++ b/docs/env/index.md @@ -1,4 +1,4 @@ ## env -Manage environment configurations on Temporal Client. +Manage environmental configurations on Temporal Client. diff --git a/docs/env/set.md b/docs/env/set.md index de6ae897..a2377abe 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -1,6 +1,6 @@ ### set -Set environment property +Set environmental properties. **--address** host:port for Temporal frontend service diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index da073134..e9423b0d 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -4,7 +4,7 @@ Operations for running a Temporal Cluster. #### health -Check health of frontend service. +Checks the health of the Frontend Service. **--address** host:port for Temporal frontend service @@ -99,7 +99,7 @@ Override for target server name #### system -Show information about the system and its capabilities. +Shows information about the system and its capabilities. **--address** host:port for Temporal frontend service diff --git a/docs/operator/index.md b/docs/operator/index.md index bf085e01..e4ec09fa 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -2,3 +2,5 @@ Operations on Temporal Server. +>These commands enable operations on Namespaces, Search Attributes, and Temporal Clusters. + diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index 77250ad7..e7fa7420 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -4,7 +4,7 @@ Operations applying to Namespaces. #### describe -Describe a Namespace by name or Id. +Describe a Namespace by its name or Id. **--address** host:port for Temporal frontend service @@ -95,7 +95,7 @@ Override for target server name #### register -Register a new Namespace. +Registers a new Namespace. **--active-cluster** Active cluster name @@ -172,7 +172,7 @@ Optionally specify visibility archival URI (cannot be changed after first time a #### update -Update a Namespace. +Updates a Namespace. **--active-cluster** Active cluster name @@ -252,7 +252,7 @@ Optionally specify visibility archival URI (cannot be changed after first time a #### delete -Delete existing Namespace. +Deletes an existing Namespace. **--address** host:port for Temporal frontend service diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index f78cad23..6683923c 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -4,7 +4,7 @@ Operations applying to Search Attributes. #### create -Add custom search attributes. +Adds one or more custom Search Attributes. **--address** host:port for Temporal frontend service @@ -58,7 +58,7 @@ Confirm all prompts. #### list -List search attributes that can be used in list Workflow Query. +Lists all Search Attributes that can be used in list Workflow Queries. **--address** host:port for Temporal frontend service @@ -106,7 +106,7 @@ Override for target server name #### remove -Remove custom search attributes metadata only (Elasticsearch index schema is not modified). +Removes custom search attribute metadata only (Elasticsearch index schema is not modified). **--address** host:port for Temporal frontend service diff --git a/docs/schedule/index.md b/docs/schedule/index.md index a99f2428..ab8e71cd 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -2,3 +2,5 @@ Operations performed on Schedules. +>These commands allow Schedules to be created, used, and updated. + diff --git a/docs/server/index.md b/docs/server/index.md index 597203f8..8acff91a 100644 --- a/docs/server/index.md +++ b/docs/server/index.md @@ -1,3 +1,4 @@ ## server +Commands for managing the Temporal Server. diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index a6c915c8..c2387c37 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -1,6 +1,10 @@ ### describe -Describe the Workers that have recently polled on this Task Queue +Describes the Workers that have recently polled on this Task Queue + + The Server records the last time of each poll request. Poll requests can last up to a minute, so a LastAccessTime under a minute is normal. If it's over a minute, then likely either the Worker is at capacity (all Workflow and Activity slots are full) or it has shut down. Once it has been 5 minutes since the last poll request, the Worker is removed from the list. + + RatePerSecond is the maximum Activities per second the Worker will execute. **--address** host:port for Temporal frontend service diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index 3c470285..96296035 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -1,6 +1,6 @@ ### list-partition -List the Task Queue's partitions and which matching node they are assigned to +Lists the Task Queue's partitions and which matching node they are assigned to. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index 96425707..60f7e59f 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -2,6 +2,8 @@ Cancel a Workflow Execution. +>Canceling a running Workflow Execution records a `WorkflowExecutionCancelRequested` event in the Event History. A new command task will be scheduled. After cancellation, the Workflow Execution can perform cleanup work. + **--address** host:port for Temporal frontend service diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index bf7b3963..6d8d4dd7 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -1,6 +1,6 @@ ### delete -Delete a Workflow Execution. +Deletes a Workflow Execution. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index d1e8f586..7bbe541d 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -2,6 +2,8 @@ Show information about a Workflow Execution. +>This information can be used to locate a Workflow Execution that failed. + **--address** host:port for Temporal frontend service diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index 1c67a87f..973e7abb 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -2,6 +2,8 @@ Start a new Workflow Execution and prints its progress. +>Single quotes('') are used to wrap input as JSON. + **--address** host:port for Temporal frontend service diff --git a/docs/workflow/list.md b/docs/workflow/list.md index 58951ab1..4c2f141b 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -2,6 +2,8 @@ List Workflow Executions based on a Query. +>By default, this command lists up to 10 closed Workflow Executions. + **--address** host:port for Temporal frontend service diff --git a/docs/workflow/query.md b/docs/workflow/query.md index 99c3804d..eda13908 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -2,6 +2,8 @@ Query a Workflow Execution. +>Queries can retrieve all or part of the Workflow state within given parameters. Queries can also be used on completed Workflows. + **--address** host:port for Temporal frontend service diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 6ca0950d..60480ca2 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -2,6 +2,8 @@ Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +>Resetting a Workflow allows the process to resume from a certain point without losing your parameters or Event History. + **--address** host:port for Temporal frontend service @@ -74,5 +76,5 @@ Path to private key Override for target server name **--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 004295ca..a079ad00 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -1,6 +1,8 @@ ### reset -Reset a Workflow Execution by Event Id or reset type. +Resets a Workflow Execution by Event Id or reset type. + +>A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History. **--address** host:port for Temporal frontend service @@ -31,7 +33,7 @@ Alias: **-n** Temporal workflow namespace (default: default) **--reapply-type** -Event types to reapply after the reset point: , Signal, None. (default: All) +Event types to reapply after the reset point: Signal, None, . (default: All) **--reason** Reason to reset. @@ -56,7 +58,7 @@ Path to private key Override for target server name **--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask **--workflow-id** Alias: **-w** diff --git a/docs/workflow/start.md b/docs/workflow/start.md index 0888e9a5..a5b7078a 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -2,6 +2,8 @@ Start a new Workflow Execution. +>When invoked successfully, the Workflow and Run Ids of the recently started Workflow are returned. + **--address** host:port for Temporal frontend service diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index 0c836cf0..a2da2fa7 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -2,6 +2,8 @@ Terminate Workflow Execution by Id or List Filter. +>Terminating a running Workflow records a `WorkflowExecutionTerminated` event as the closing event. Command tasks cannot be scheduled after this. + **--address** host:port for Temporal frontend service diff --git a/env/env.go b/env/env.go index 220f0942..449ca524 100644 --- a/env/env.go +++ b/env/env.go @@ -20,7 +20,7 @@ func NewEnvCommands() []*cli.Command { return []*cli.Command{ { Name: "get", - Usage: "Print environment properties", + Usage: "Prints environmental properties.", Flags: []cli.Flag{}, ArgsUsage: "env_name or env_name.property_name", Action: func(c *cli.Context) error { @@ -29,7 +29,7 @@ func NewEnvCommands() []*cli.Command { }, { Name: "set", - Usage: "Set environment property", + Usage: "Set environmental properties.", Flags: []cli.Flag{}, ArgsUsage: "env_name.property_name value", Action: func(c *cli.Context) error { @@ -38,7 +38,7 @@ func NewEnvCommands() []*cli.Command { }, { Name: "delete", - Usage: "Delete environment or environment property", + Usage: "Delete environment or environmental property.", Flags: []cli.Flag{}, ArgsUsage: "env_name or env_name.property_name", Action: func(c *cli.Context) error { diff --git a/namespace/namespace.go b/namespace/namespace.go index 5b87d355..d92e6a73 100644 --- a/namespace/namespace.go +++ b/namespace/namespace.go @@ -17,7 +17,7 @@ func NewNamespaceCommands() []*cli.Command { return []*cli.Command{ { Name: "describe", - Usage: "Describe a Namespace by name or Id.", + Usage: "Describe a Namespace by its name or Id.", Flags: describeNamespaceFlags, ArgsUsage: "namespace_name", Action: func(c *cli.Context) error { @@ -34,7 +34,7 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "register", - Usage: "Register a new Namespace.", + Usage: "Registers a new Namespace.", Flags: registerNamespaceFlags, ArgsUsage: "namespace_name [cluster_name...]", Action: func(c *cli.Context) error { @@ -43,7 +43,7 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "update", - Usage: "Update a Namespace.", + Usage: "Updates a Namespace.", Flags: updateNamespaceFlags, ArgsUsage: "namespace_name [cluster_name...]", Action: func(c *cli.Context) error { @@ -52,7 +52,7 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "delete", - Usage: "Delete existing Namespace.", + Usage: "Deletes an existing Namespace.", Flags: []cli.Flag{ &cli.BoolFlag{ Name: common.FlagYes, diff --git a/searchattribute/search_attribute.go b/searchattribute/search_attribute.go index 0972d234..d4b6bce5 100644 --- a/searchattribute/search_attribute.go +++ b/searchattribute/search_attribute.go @@ -13,7 +13,7 @@ func NewSearchAttributeCommands() []*cli.Command { return []*cli.Command{ { Name: "create", - Usage: "Add custom search attributes.", + Usage: "Adds one or more custom Search Attributes.", Flags: []cli.Flag{ &cli.StringSliceFlag{ Name: common.FlagName, @@ -40,7 +40,7 @@ func NewSearchAttributeCommands() []*cli.Command { }, { Name: "list", - Usage: "List search attributes that can be used in list Workflow Query.", + Usage: "Lists all Search Attributes that can be used in list Workflow Queries.", Flags: []cli.Flag{ &cli.StringFlag{ Name: output.FlagOutput, @@ -56,7 +56,7 @@ func NewSearchAttributeCommands() []*cli.Command { }, { Name: "remove", - Usage: "Remove custom search attributes metadata only (Elasticsearch index schema is not modified).", + Usage: "Removes custom search attribute metadata only (Elasticsearch index schema is not modified).", Flags: []cli.Flag{ &cli.StringSliceFlag{ Name: common.FlagName, diff --git a/taskqueue/task_queue.go b/taskqueue/task_queue.go index e90fe138..78a547c7 100644 --- a/taskqueue/task_queue.go +++ b/taskqueue/task_queue.go @@ -10,8 +10,8 @@ func NewTaskQueueCommands() []*cli.Command { return []*cli.Command{ { Name: "describe", - Usage: "Describe the Workers that have recently polled on this Task Queue", - Description: `The Server records the last time of each poll request. Poll requests can last up to a minute, so a LastAccessTime under a minute is normal. If it's over a minute, then likely either the Worker is at capacity (all Workflow and Activity slots are full) or it has shut down. Once it has been 5 minutes since the last poll request, the Worker is removed from the list. + Usage: "Describes the Workers that have recently polled on this Task Queue", + UsageText: `The Server records the last time of each poll request. Poll requests can last up to a minute, so a LastAccessTime under a minute is normal. If it's over a minute, then likely either the Worker is at capacity (all Workflow and Activity slots are full) or it has shut down. Once it has been 5 minutes since the last poll request, the Worker is removed from the list. RatePerSecond is the maximum Activities per second the Worker will execute.`, Flags: append([]cli.Flag{ @@ -35,7 +35,7 @@ RatePerSecond is the maximum Activities per second the Worker will execute.`, }, { Name: "list-partition", - Usage: "List the Task Queue's partitions and which matching node they are assigned to", + Usage: "Lists the Task Queue's partitions and which matching node they are assigned to.", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagTaskQueue, diff --git a/workflow/workflow.go b/workflow/workflow.go index 6e1f1f3c..a744be34 100644 --- a/workflow/workflow.go +++ b/workflow/workflow.go @@ -13,6 +13,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "start", Usage: "Start a new Workflow Execution.", + UsageText: "When invoked successfully, the Workflow and Run Ids of the recently started Workflow are returned.", Flags: append(common.FlagsForStartWorkflow, common.FlagsForPaginationAndRendering...), Action: func(c *cli.Context) error { return StartWorkflow(c, false) @@ -21,6 +22,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "execute", Usage: "Start a new Workflow Execution and prints its progress.", + UsageText: "Single quotes('') are used to wrap input as JSON.", Flags: append(common.FlagsForStartWorkflow, common.FlagsForPaginationAndRendering...), Action: func(c *cli.Context) error { return StartWorkflow(c, true) @@ -29,6 +31,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "describe", Usage: "Show information about a Workflow Execution.", + UsageText: "This information can be used to locate a Workflow Execution that failed.", Flags: append(common.FlagsForExecution, []cli.Flag{ &cli.BoolFlag{ Name: common.FlagResetPointsOnly, @@ -48,6 +51,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "list", Usage: "List Workflow Executions based on a Query.", + UsageText: "By default, this command lists up to 10 closed Workflow Executions.", Flags: append(common.FlagsForWorkflowFiltering, common.FlagsForPaginationAndRendering...), Action: func(c *cli.Context) error { return ListWorkflow(c) @@ -64,6 +68,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "query", Usage: "Query a Workflow Execution.", + UsageText: "Queries can retrieve all or part of the Workflow state within given parameters. Queries can also be used on completed Workflows.", Flags: append(common.FlagsForStackTraceQuery, &cli.StringFlag{ Name: common.FlagType, @@ -87,6 +92,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "signal", Usage: "Signal Workflow Execution by Id or List Filter.", + UsageText: "", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, @@ -157,6 +163,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "cancel", Usage: "Cancel a Workflow Execution.", + UsageText: "Canceling a running Workflow Execution records a `WorkflowExecutionCancelRequested` event in the Event History. A new command task will be scheduled. After cancellation, the Workflow Execution can perform cleanup work.", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, @@ -195,6 +202,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "terminate", Usage: "Terminate Workflow Execution by Id or List Filter.", + UsageText: "Terminating a running Workflow records a `WorkflowExecutionTerminated` event as the closing event. Command tasks cannot be scheduled after this. ", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, @@ -232,7 +240,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "delete", - Usage: "Delete a Workflow Execution.", + Usage: "Deletes a Workflow Execution.", Flags: common.FlagsForExecution, Action: func(c *cli.Context) error { return DeleteWorkflow(c) @@ -240,7 +248,8 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "reset", - Usage: "Reset a Workflow Execution by Event Id or reset type.", + Usage: "Resets a Workflow Execution by Event Id or reset type.", + UsageText: "A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History.", Flags: append(common.FlagsForExecution, []cli.Flag{ &cli.StringFlag{ Name: common.FlagEventID, @@ -272,6 +281,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "reset-batch", Usage: "Reset a batch of Workflow Executions by reset type: " + strings.Join(mapKeysToArray(resetTypesMap), ", "), + UsageText: "Resetting a Workflow allows the process to resume from a certain point without losing your parameters or Event History.", Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagQuery, From 65024c56f1bed032258f10b26a14bfff40544f2e Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 18 Jan 2023 14:26:15 -0600 Subject: [PATCH 27/68] UsageText formatting --- activity/activity.go | 5 +- app/app.go | 27 ++++--- batch/batch.go | 12 ++-- cluster/cluster.go | 12 ++-- cmd/doc/main.go | 4 +- common/defs-cmds.go | 107 ++++++++++++++++++++++++++++ common/defs.go | 1 + docs/activity/complete.md | 2 - docs/activity/fail.md | 2 +- docs/batch/describe.md | 2 +- docs/batch/index.md | 7 +- docs/batch/list.md | 2 +- docs/batch/terminate.md | 2 +- docs/operator/index.md | 2 +- docs/schedule/index.md | 2 +- docs/task-queue/describe.md | 6 +- docs/workflow/cancel.md | 4 +- docs/workflow/describe.md | 2 +- docs/workflow/execute.md | 2 +- docs/workflow/list.md | 2 +- docs/workflow/query.md | 3 +- docs/workflow/reset-batch.md | 2 +- docs/workflow/reset.md | 4 +- docs/workflow/start.md | 4 +- docs/workflow/terminate.md | 4 +- env/env.go | 6 +- namespace/namespace.go | 10 +-- searchattribute/search_attribute.go | 6 +- taskqueue/task_queue.go | 8 +-- workflow/workflow.go | 46 ++++++------ 30 files changed, 207 insertions(+), 91 deletions(-) create mode 100644 common/defs-cmds.go diff --git a/activity/activity.go b/activity/activity.go index f3ccdeb4..86693472 100644 --- a/activity/activity.go +++ b/activity/activity.go @@ -9,8 +9,7 @@ func NewActivityCommands() []*cli.Command { return []*cli.Command{ { Name: "complete", - Usage: "Completes an Activity.", - UsageText: "When used, the Activity is scheduled to be completed.", + Usage: common.CompleteActivityDefinition, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, @@ -51,7 +50,7 @@ func NewActivityCommands() []*cli.Command { }, { Name: "fail", - Usage: "Fail an Activity.", + Usage: common.FailActivityDefinition, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, diff --git a/app/app.go b/app/app.go index 2d56ea0d..6b425440 100644 --- a/app/app.go +++ b/app/app.go @@ -97,57 +97,56 @@ func serverCommands(defaultCfg *sconfig.Config) []*cli.Command { var clientCommands = []*cli.Command{ { Name: "workflow", - Usage: "Operations that can be performed on Workflows.", + Usage: common.WorkflowDefinition, Subcommands: workflow.NewWorkflowCommands(), }, { Name: "activity", - Usage: "Operations that can be performed on Workflow Activities.", + Usage: common.ActivityDefinition, Subcommands: activity.NewActivityCommands(), }, { Name: "task-queue", - Usage: "Operations performed on Task Queues.", + Usage: common.TaskQueueDefinition, Subcommands: taskqueue.NewTaskQueueCommands(), }, { Name: "schedule", - Usage: "Operations performed on Schedules.", - UsageText: "These commands allow Schedules to be created, used, and updated.", + Usage: common.ScheduleDefinition, + UsageText: common.ScheduleUsageText, Subcommands: schedule.NewScheduleCommands(), }, - { Name: "batch", - Usage: "Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs.", - UsageText: "Batch jobs run in the background and affect Workflow Executions one at a time. In `cli`, the batch commands are used to view the status of Batch jobs, and to terminate them. A successfully started Batch job returns a Job Id, which is needed to execute batch commands. Terminating a batch job does not roll back the operations already performed by the job itself.", + Usage: common.BatchDefinition, + UsageText: common.BatchUsageText, Subcommands: batch.NewBatchCommands(), }, { Name: "operator", - Usage: "Operations on Temporal Server.", - UsageText: "These commands enable operations on Namespaces, Search Attributes, and Temporal Clusters.", + Usage: common.OperatorDefinition, + UsageText: common.OperatorUsageText, Subcommands: []*cli.Command{ { Name: "namespace", - Usage: "Operations applying to Namespaces.", + Usage: common.NamespaceDefinition, Subcommands: namespace.NewNamespaceCommands(), }, { Name: "search-attribute", - Usage: "Operations applying to Search Attributes.", + Usage: common.SearchAttributeDefinition, Subcommands: searchattribute.NewSearchAttributeCommands(), }, { Name: "cluster", - Usage: "Operations for running a Temporal Cluster.", + Usage: common.ClusterDefinition, Subcommands: cluster.NewClusterCommands(), }, }, }, { Name: "env", - Usage: "Manage environmental configurations on Temporal Client.", + Usage: common.EnvDefinition, Subcommands: env.NewEnvCommands(), }, } diff --git a/batch/batch.go b/batch/batch.go index 54f70243..8fa2398f 100644 --- a/batch/batch.go +++ b/batch/batch.go @@ -9,8 +9,8 @@ func NewBatchCommands() []*cli.Command { return []*cli.Command{ { Name: "describe", - Usage: "Describe a Batch operation job.", - UsageText: "This command shows the progress of an ongoing Batch job.", + Usage: common.DescribeBatchJobDefinition, + UsageText: common.DescribeBatchUsageText, Flags: append([]cli.Flag{ &cli.StringFlag{ Name: common.FlagJobID, @@ -25,8 +25,8 @@ func NewBatchCommands() []*cli.Command { }, { Name: "list", - Usage: "List Batch operation jobs.", - UsageText: "When used, all Batch operation jobs within the system are listed.", + Usage: common.ListBatchJobsDefinition, + UsageText: common.ListBatchUsageText, Flags: common.FlagsForPaginationAndRendering, ArgsUsage: " ", Action: func(c *cli.Context) error { @@ -35,8 +35,8 @@ func NewBatchCommands() []*cli.Command { }, { Name: "terminate", - Usage: "Stop a Batch operation job.", - UsageText: "When used, the Batch job with the provided Batch Id is terminated.", + Usage: common.TerminateBatchJobDefinition, + UsageText: common.TerminateBatchUsageText, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagJobID, diff --git a/cluster/cluster.go b/cluster/cluster.go index 37c25ac4..a77a01b2 100644 --- a/cluster/cluster.go +++ b/cluster/cluster.go @@ -10,14 +10,14 @@ func NewClusterCommands() []*cli.Command { return []*cli.Command{ { Name: "health", - Usage: "Checks the health of the Frontend Service.", + Usage: common.HealthDefinition, Action: func(c *cli.Context) error { return HealthCheck(c) }, }, { Name: "describe", - Usage: "Show information about the Cluster.", + Usage: common.DescribeDefinition, ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ @@ -39,7 +39,7 @@ func NewClusterCommands() []*cli.Command { }, { Name: "system", - Usage: "Shows information about the system and its capabilities.", + Usage: common.SystemDefinition, ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ @@ -61,7 +61,7 @@ func NewClusterCommands() []*cli.Command { }, { Name: "upsert", - Usage: "Add or update a remote Cluster.", + Usage: common.UpsertDefinition, ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ @@ -81,7 +81,7 @@ func NewClusterCommands() []*cli.Command { }, { Name: "list", - Usage: "List all remote Clusters.", + Usage: common.ListDefinition, ArgsUsage: " ", Flags: common.FlagsForPaginationAndRendering, Action: func(c *cli.Context) error { @@ -90,7 +90,7 @@ func NewClusterCommands() []*cli.Command { }, { Name: "remove", - Usage: "Remove a remote Cluster.", + Usage: common.RemoveDefinition, ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 62bcc347..eb48691e 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -41,7 +41,6 @@ func main() { createdFiles := make(map[string]*os.File) // TODO: identify different option categories and print flags accordingly - // TODO: rework what is written to the string for scanner.Scan() { line := scanner.Text() if strings.HasPrefix(line, "## ") { @@ -86,7 +85,6 @@ func main() { // write to file term = strings.TrimSuffix(term, "=\"\"") - // TODO: separate terms and aliases if strings.Contains(term, ",") { makeAlias(currentHeaderFile, term) } else { @@ -95,6 +93,8 @@ func main() { writeLine(currentHeaderFile, strings.TrimSpace(definition)) log.Info(found) + } else if strings.HasPrefix(line, ">") { + writeLine(currentHeaderFile, strings.TrimPrefix(line, ">")) } else { writeLine(currentHeaderFile, line) } diff --git a/common/defs-cmds.go b/common/defs-cmds.go new file mode 100644 index 00000000..70989e63 --- /dev/null +++ b/common/defs-cmds.go @@ -0,0 +1,107 @@ +package common + +const ( + // Main command definitions + WorkflowDefinition = "Operations that can be performed on Workflows." + ActivityDefinition = "Operations that can be performed on Workflow Activities." + TaskQueueDefinition = "Operations performed on Task Queues." + ScheduleDefinition = "Operations performed on Schedules." + BatchDefinition = "Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs." + OperatorDefinition = "Operations on Temporal Server." + EnvDefinition = "Manage environmental configurations on Temporal Client." + + // Workflow subcommand definitions + StartWorkflowDefinition = "Starts a new Workflow Execution." + StartWorkflowUsageText = "When invoked successfully, the Workflow and Run Ids of the recently started Workflow are returned." + + ExecuteWorkflowDefinition = "Start a new Workflow Execution and prints its progress." + ExecuteWorkflowUsageText = "Single quotes('') are used to wrap input as JSON." + + DescribeWorkflowDefinition = "Show information about a Workflow Execution." + DescribeWorkflowUsageText = "This information can be used to locate a Workflow Execution that failed." + + ListWorkflowDefinition = "List Workflow Executions based on a Query." + ListWorkflowUsageText = "By default, this command lists up to 10 closed Workflow Executions." + + ShowWorkflowDefinition = "Show Event History for a Workflow Execution." + + QueryWorkflowDefinition = "Query a Workflow Execution." + QueryWorkflowUsageText = "Queries can retrieve all or part of the Workflow state within given parameters.\nQueries can also be used on completed Workflows." + + StackWorkflowDefinition = "Query a Workflow Execution with __stack_trace as the query type." + SignalWorkflowDefinition = "Signal Workflow Execution by Id or List Filter." + CountWorkflowDefinition = "Count Workflow Executions (requires ElasticSearch to be enabled)." + + CancelWorkflowDefinition = "Cancel a Workflow Execution." + CancelWorkflowUsageText = "Canceling a running Workflow Execution records a `WorkflowExecutionCancelRequested` event in the Event History.\n\nAfter cancellation, the Workflow Execution can perform cleanup work,and a new command task will be scheduled." + + TerminateWorkflowDefinition = "Terminate Workflow Execution by Id or List Filter." + TerminateWorkflowUsageText = "Terminating a running Workflow records a `WorkflowExecutionTerminated` event as the closing event.\n\nAny further command tasks cannot be scheduled after running `terminate`." + + DeleteWorkflowDefinition = "Deletes a Workflow Execution." + + ResetWorkflowDefinition = "Resets a Workflow Execution by Event Id or reset type." + ResetWorkflowUsageText = "A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History." + + ResetBatchUsageText = "Resetting a Workflow allows the process to resume from a certain point without losing your parameters or Event History." + + TraceWorkflowDefinition = "Trace progress of a Workflow Execution and its children." + + // Activity subcommand definitions + CompleteActivityDefinition = "Completes an Activity." + FailActivityDefinition = "Fails an Activity." + + // Task Queue subcommand definitions + DescribeTaskQueueDefinition = "Describes the Workers that have recently polled on this Task Queue" + DescribeTaskQueueUsageText = "The Server records the last time of each poll request.\n\nPoll requests can last up to a minute, so a LastAccessTime under a minute is normal.\nIf it's over a minute, then likely either the Worker is at capacity (all Workflow and Activity slots are full) or it has shut down.\nOnce it has been 5 minutes since the last poll request, the Worker is removed from the list.\n\nRatePerSecond is the maximum Activities per second the Worker will execute." + + ListPartitionTaskQueueDefinition = "Lists the Task Queue's partitions and which matching node they are assigned to." + + // Schedule subcommand definitions + ScheduleUsageText = "These commands allow Schedules to be created, used, and updated." + + // Batch subcommand definitions + BatchUsageText = "Batch jobs run in the background and affect Workflow Executions one at a time.\n\nIn `cli`, the batch commands are used to view the status of Batch jobs, and to terminate them.\nA successfully started Batch job returns a Job Id, which is needed to execute batch commands.\n\nTerminating a batch job does not roll back the operations already performed by the job itself." + + DescribeBatchJobDefinition = "Describe a Batch operation job." + DescribeBatchUsageText = "This command shows the progress of an ongoing Batch job." + + ListBatchJobsDefinition = "List Batch operation jobs." + ListBatchUsageText = "When used, all Batch operation jobs within the system are listed." + + TerminateBatchJobDefinition = "Stop a Batch operation job." + TerminateBatchUsageText = "When used, the Batch job with the provided Batch Id is terminated." + + + // Operator subcommands and additional text + OperatorUsageText = "These commands enable operations on Namespaces, Search Attributes, and Temporal Clusters." + + NamespaceDefinition = "Operations applying to Namespaces." + SearchAttributeDefinition = "Operations applying to Search Attributes." + ClusterDefinition = "Operations for running a Temporal Cluster." + + // Namespace subcommand definitions + DescribeNamespaceDefinition = "Describe a Namespace by its name or Id." + ListNamespacesDefinition = "List all Namespaces." + RegisterNamespaceDefinition = "Registers a new Namespace." + UpdateNamespaceDefinition = "Updates a Namespace." + DeleteNamespaceDefinition = "Deletes an existing Namespace." + + // Search Attribute subcommand defintions + CreateSearchAttributeDefinition = "Adds one or more custom Search Attributes." + ListSearchAttributesDefinition = "Lists all Search Attributes that can be used in list Workflow Queries." + RemoveSearchAttributesDefinition = "Removes custom search attribute metadata only (Elasticsearch index schema is not modified)." + + // Cluster subcommand defintions + HealthDefinition = "Checks the health of the Frontend Service." + DescribeDefinition = "Show information about the Cluster." + SystemDefinition = "Shows information about the system and its capabilities." + UpsertDefinition = "Add or update a remote Cluster." + ListDefinition = "List all remote Clusters." + RemoveDefinition = "Remove a remote Cluster." + + // Env subcommand definitions + GetDefinition = "Prints environmental properties." + SetDefinition = "Set environmental properties." + DeleteDefinition = "Delete environment or environmental property." +) \ No newline at end of file diff --git a/common/defs.go b/common/defs.go index b3d03639..e9552b92 100644 --- a/common/defs.go +++ b/common/defs.go @@ -43,3 +43,4 @@ var envKeysForUserName = []string{ "LOGNAME", "HOME", } + diff --git a/docs/activity/complete.md b/docs/activity/complete.md index 351c4bcc..c3155103 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -2,8 +2,6 @@ Completes an Activity. ->When used, the Activity is scheduled to be completed. - **--activity-id** Identifies the Activity to be completed. diff --git a/docs/activity/fail.md b/docs/activity/fail.md index 74175488..1a0849e4 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -1,6 +1,6 @@ ### fail -Fail an Activity. +Fails an Activity. **--activity-id** Identifies the Activity to fail. diff --git a/docs/batch/describe.md b/docs/batch/describe.md index b6c83577..811b97c2 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -2,7 +2,7 @@ Describe a Batch operation job. ->This command shows the progress of an ongoing Batch job. +This command shows the progress of an ongoing Batch job. **--address** host:port for Temporal frontend service diff --git a/docs/batch/index.md b/docs/batch/index.md index 3f1ab543..73ea2f1e 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -2,5 +2,10 @@ Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs. ->Batch jobs run in the background and affect Workflow Executions one at a time. In `cli`, the batch commands are used to view the status of Batch jobs, and to terminate them. A successfully started Batch job returns a Job Id, which is needed to execute batch commands. Terminating a batch job does not roll back the operations already performed by the job itself. + Batch jobs run in the background and affect Workflow Executions one at a time. + + In `cli`, the batch commands are used to view the status of Batch jobs, and to terminate them. + A successfully started Batch job returns a Job Id, which is needed to execute batch commands. + + Terminating a batch job does not roll back the operations already performed by the job itself. diff --git a/docs/batch/list.md b/docs/batch/list.md index d269fb29..624fc08b 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -2,7 +2,7 @@ List Batch operation jobs. ->When used, all Batch operation jobs within the system are listed. +When used, all Batch operation jobs within the system are listed. **--address** host:port for Temporal frontend service diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index 636a6385..eab73965 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -2,7 +2,7 @@ Stop a Batch operation job. ->When used, the Batch job with the provided Batch Id is terminated. +When used, the Batch job with the provided Batch Id is terminated. **--address** host:port for Temporal frontend service diff --git a/docs/operator/index.md b/docs/operator/index.md index e4ec09fa..e07e2790 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -2,5 +2,5 @@ Operations on Temporal Server. ->These commands enable operations on Namespaces, Search Attributes, and Temporal Clusters. +These commands enable operations on Namespaces, Search Attributes, and Temporal Clusters. diff --git a/docs/schedule/index.md b/docs/schedule/index.md index ab8e71cd..e4baefc4 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -2,5 +2,5 @@ Operations performed on Schedules. ->These commands allow Schedules to be created, used, and updated. +These commands allow Schedules to be created, used, and updated. diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index c2387c37..fb927436 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -2,7 +2,11 @@ Describes the Workers that have recently polled on this Task Queue - The Server records the last time of each poll request. Poll requests can last up to a minute, so a LastAccessTime under a minute is normal. If it's over a minute, then likely either the Worker is at capacity (all Workflow and Activity slots are full) or it has shut down. Once it has been 5 minutes since the last poll request, the Worker is removed from the list. + The Server records the last time of each poll request. + + Poll requests can last up to a minute, so a LastAccessTime under a minute is normal. + If it's over a minute, then likely either the Worker is at capacity (all Workflow and Activity slots are full) or it has shut down. + Once it has been 5 minutes since the last poll request, the Worker is removed from the list. RatePerSecond is the maximum Activities per second the Worker will execute. diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index 60f7e59f..fed5b0f1 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -2,7 +2,9 @@ Cancel a Workflow Execution. ->Canceling a running Workflow Execution records a `WorkflowExecutionCancelRequested` event in the Event History. A new command task will be scheduled. After cancellation, the Workflow Execution can perform cleanup work. + Canceling a running Workflow Execution records a `WorkflowExecutionCancelRequested` event in the Event History. + + After cancellation, the Workflow Execution can perform cleanup work,and a new command task will be scheduled. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index 7bbe541d..4157cf22 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -2,7 +2,7 @@ Show information about a Workflow Execution. ->This information can be used to locate a Workflow Execution that failed. +This information can be used to locate a Workflow Execution that failed. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index 973e7abb..23229a7e 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -2,7 +2,7 @@ Start a new Workflow Execution and prints its progress. ->Single quotes('') are used to wrap input as JSON. +Single quotes('') are used to wrap input as JSON. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/list.md b/docs/workflow/list.md index 4c2f141b..5d48c4a2 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -2,7 +2,7 @@ List Workflow Executions based on a Query. ->By default, this command lists up to 10 closed Workflow Executions. +By default, this command lists up to 10 closed Workflow Executions. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/query.md b/docs/workflow/query.md index eda13908..d285d7e8 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -2,7 +2,8 @@ Query a Workflow Execution. ->Queries can retrieve all or part of the Workflow state within given parameters. Queries can also be used on completed Workflows. + Queries can retrieve all or part of the Workflow state within given parameters. + Queries can also be used on completed Workflows. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 60480ca2..392c6588 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -2,7 +2,7 @@ Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew ->Resetting a Workflow allows the process to resume from a certain point without losing your parameters or Event History. +Resetting a Workflow allows the process to resume from a certain point without losing your parameters or Event History. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index a079ad00..ad39d0b4 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -2,7 +2,7 @@ Resets a Workflow Execution by Event Id or reset type. ->A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History. +A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History. **--address** host:port for Temporal frontend service @@ -33,7 +33,7 @@ Alias: **-n** Temporal workflow namespace (default: default) **--reapply-type** -Event types to reapply after the reset point: Signal, None, . (default: All) +Event types to reapply after the reset point: , Signal, None. (default: All) **--reason** Reason to reset. diff --git a/docs/workflow/start.md b/docs/workflow/start.md index a5b7078a..f51d786b 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -1,8 +1,8 @@ ### start -Start a new Workflow Execution. +Starts a new Workflow Execution. ->When invoked successfully, the Workflow and Run Ids of the recently started Workflow are returned. +When invoked successfully, the Workflow and Run Ids of the recently started Workflow are returned. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index a2da2fa7..c0dd7cdd 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -2,7 +2,9 @@ Terminate Workflow Execution by Id or List Filter. ->Terminating a running Workflow records a `WorkflowExecutionTerminated` event as the closing event. Command tasks cannot be scheduled after this. + Terminating a running Workflow records a `WorkflowExecutionTerminated` event as the closing event. + + Any further command tasks cannot be scheduled after running `terminate`. **--address** host:port for Temporal frontend service diff --git a/env/env.go b/env/env.go index 449ca524..d6417dc1 100644 --- a/env/env.go +++ b/env/env.go @@ -20,7 +20,7 @@ func NewEnvCommands() []*cli.Command { return []*cli.Command{ { Name: "get", - Usage: "Prints environmental properties.", + Usage: common.GetDefinition, Flags: []cli.Flag{}, ArgsUsage: "env_name or env_name.property_name", Action: func(c *cli.Context) error { @@ -29,7 +29,7 @@ func NewEnvCommands() []*cli.Command { }, { Name: "set", - Usage: "Set environmental properties.", + Usage: common.SetDefinition, Flags: []cli.Flag{}, ArgsUsage: "env_name.property_name value", Action: func(c *cli.Context) error { @@ -38,7 +38,7 @@ func NewEnvCommands() []*cli.Command { }, { Name: "delete", - Usage: "Delete environment or environmental property.", + Usage: common.DeleteDefinition, Flags: []cli.Flag{}, ArgsUsage: "env_name or env_name.property_name", Action: func(c *cli.Context) error { diff --git a/namespace/namespace.go b/namespace/namespace.go index d92e6a73..3fff13e7 100644 --- a/namespace/namespace.go +++ b/namespace/namespace.go @@ -17,7 +17,7 @@ func NewNamespaceCommands() []*cli.Command { return []*cli.Command{ { Name: "describe", - Usage: "Describe a Namespace by its name or Id.", + Usage: common.DescribeNamespaceDefinition, Flags: describeNamespaceFlags, ArgsUsage: "namespace_name", Action: func(c *cli.Context) error { @@ -26,7 +26,7 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "list", - Usage: "List all Namespaces.", + Usage: common.ListNamespacesDefinition, ArgsUsage: " ", Action: func(c *cli.Context) error { return ListNamespaces(c) @@ -34,7 +34,7 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "register", - Usage: "Registers a new Namespace.", + Usage: common.RegisterNamespaceDefinition, Flags: registerNamespaceFlags, ArgsUsage: "namespace_name [cluster_name...]", Action: func(c *cli.Context) error { @@ -43,7 +43,7 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "update", - Usage: "Updates a Namespace.", + Usage: common.UpdateNamespaceDefinition, Flags: updateNamespaceFlags, ArgsUsage: "namespace_name [cluster_name...]", Action: func(c *cli.Context) error { @@ -52,7 +52,7 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "delete", - Usage: "Deletes an existing Namespace.", + Usage: common.DeleteNamespaceDefinition, Flags: []cli.Flag{ &cli.BoolFlag{ Name: common.FlagYes, diff --git a/searchattribute/search_attribute.go b/searchattribute/search_attribute.go index d4b6bce5..b8703028 100644 --- a/searchattribute/search_attribute.go +++ b/searchattribute/search_attribute.go @@ -13,7 +13,7 @@ func NewSearchAttributeCommands() []*cli.Command { return []*cli.Command{ { Name: "create", - Usage: "Adds one or more custom Search Attributes.", + Usage: common.CreateSearchAttributeDefinition, Flags: []cli.Flag{ &cli.StringSliceFlag{ Name: common.FlagName, @@ -40,7 +40,7 @@ func NewSearchAttributeCommands() []*cli.Command { }, { Name: "list", - Usage: "Lists all Search Attributes that can be used in list Workflow Queries.", + Usage: common.ListSearchAttributesDefinition, Flags: []cli.Flag{ &cli.StringFlag{ Name: output.FlagOutput, @@ -56,7 +56,7 @@ func NewSearchAttributeCommands() []*cli.Command { }, { Name: "remove", - Usage: "Removes custom search attribute metadata only (Elasticsearch index schema is not modified).", + Usage: common.RemoveSearchAttributesDefinition, Flags: []cli.Flag{ &cli.StringSliceFlag{ Name: common.FlagName, diff --git a/taskqueue/task_queue.go b/taskqueue/task_queue.go index 78a547c7..9dba286e 100644 --- a/taskqueue/task_queue.go +++ b/taskqueue/task_queue.go @@ -10,10 +10,8 @@ func NewTaskQueueCommands() []*cli.Command { return []*cli.Command{ { Name: "describe", - Usage: "Describes the Workers that have recently polled on this Task Queue", - UsageText: `The Server records the last time of each poll request. Poll requests can last up to a minute, so a LastAccessTime under a minute is normal. If it's over a minute, then likely either the Worker is at capacity (all Workflow and Activity slots are full) or it has shut down. Once it has been 5 minutes since the last poll request, the Worker is removed from the list. - -RatePerSecond is the maximum Activities per second the Worker will execute.`, + Usage: common.DescribeTaskQueueDefinition, + UsageText:common.DescribeTaskQueueUsageText, Flags: append([]cli.Flag{ &cli.StringFlag{ Name: common.FlagTaskQueue, @@ -35,7 +33,7 @@ RatePerSecond is the maximum Activities per second the Worker will execute.`, }, { Name: "list-partition", - Usage: "Lists the Task Queue's partitions and which matching node they are assigned to.", + Usage: common.ListPartitionTaskQueueDefinition, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagTaskQueue, diff --git a/workflow/workflow.go b/workflow/workflow.go index a744be34..1c67de64 100644 --- a/workflow/workflow.go +++ b/workflow/workflow.go @@ -12,8 +12,8 @@ func NewWorkflowCommands() []*cli.Command { return []*cli.Command{ { Name: "start", - Usage: "Start a new Workflow Execution.", - UsageText: "When invoked successfully, the Workflow and Run Ids of the recently started Workflow are returned.", + Usage: common.StartWorkflowDefinition, + UsageText: common.StartWorkflowUsageText, Flags: append(common.FlagsForStartWorkflow, common.FlagsForPaginationAndRendering...), Action: func(c *cli.Context) error { return StartWorkflow(c, false) @@ -21,8 +21,8 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "execute", - Usage: "Start a new Workflow Execution and prints its progress.", - UsageText: "Single quotes('') are used to wrap input as JSON.", + Usage: common.ExecuteWorkflowDefinition, + UsageText: common.ExecuteWorkflowUsageText, Flags: append(common.FlagsForStartWorkflow, common.FlagsForPaginationAndRendering...), Action: func(c *cli.Context) error { return StartWorkflow(c, true) @@ -30,8 +30,8 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "describe", - Usage: "Show information about a Workflow Execution.", - UsageText: "This information can be used to locate a Workflow Execution that failed.", + Usage: common.DescribeWorkflowDefinition, + UsageText: common.DescribeWorkflowUsageText, Flags: append(common.FlagsForExecution, []cli.Flag{ &cli.BoolFlag{ Name: common.FlagResetPointsOnly, @@ -50,8 +50,8 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "list", - Usage: "List Workflow Executions based on a Query.", - UsageText: "By default, this command lists up to 10 closed Workflow Executions.", + Usage: common.ListWorkflowDefinition, + UsageText: common.ListWorkflowUsageText, Flags: append(common.FlagsForWorkflowFiltering, common.FlagsForPaginationAndRendering...), Action: func(c *cli.Context) error { return ListWorkflow(c) @@ -59,7 +59,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "show", - Usage: "Show Event History for a Workflow Execution.", + Usage: common.ShowWorkflowDefinition, Flags: append(append(common.FlagsForExecution, common.FlagsForShowWorkflow...), common.FlagsForPaginationAndRendering...), Action: func(c *cli.Context) error { return ShowHistory(c) @@ -67,8 +67,8 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "query", - Usage: "Query a Workflow Execution.", - UsageText: "Queries can retrieve all or part of the Workflow state within given parameters. Queries can also be used on completed Workflows.", + Usage: common.QueryWorkflowDefinition, + UsageText: common.QueryWorkflowUsageText, Flags: append(common.FlagsForStackTraceQuery, &cli.StringFlag{ Name: common.FlagType, @@ -83,7 +83,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "stack", - Usage: "Query a Workflow Execution with __stack_trace as the query type.", + Usage: common.StackWorkflowDefinition, Flags: common.FlagsForStackTraceQuery, Action: func(c *cli.Context) error { return QueryWorkflowUsingStackTrace(c) @@ -91,7 +91,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "signal", - Usage: "Signal Workflow Execution by Id or List Filter.", + Usage: common.SignalWorkflowDefinition, UsageText: "", Flags: []cli.Flag{ &cli.StringFlag{ @@ -147,7 +147,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "count", - Usage: "Count Workflow Executions (requires ElasticSearch to be enabled).", + Usage: common.CountWorkflowDefinition, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagQuery, @@ -162,8 +162,8 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "cancel", - Usage: "Cancel a Workflow Execution.", - UsageText: "Canceling a running Workflow Execution records a `WorkflowExecutionCancelRequested` event in the Event History. A new command task will be scheduled. After cancellation, the Workflow Execution can perform cleanup work.", + Usage: common.CancelWorkflowDefinition, + UsageText: common.CancelWorkflowUsageText, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, @@ -201,8 +201,8 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "terminate", - Usage: "Terminate Workflow Execution by Id or List Filter.", - UsageText: "Terminating a running Workflow records a `WorkflowExecutionTerminated` event as the closing event. Command tasks cannot be scheduled after this. ", + Usage: common.TerminateWorkflowDefinition, + UsageText: common.TerminateWorkflowUsageText, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, @@ -240,7 +240,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "delete", - Usage: "Deletes a Workflow Execution.", + Usage: common.DeleteWorkflowDefinition, Flags: common.FlagsForExecution, Action: func(c *cli.Context) error { return DeleteWorkflow(c) @@ -248,8 +248,8 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "reset", - Usage: "Resets a Workflow Execution by Event Id or reset type.", - UsageText: "A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History.", + Usage: common.ResetWorkflowDefinition, + UsageText: common.ResetWorkflowUsageText, Flags: append(common.FlagsForExecution, []cli.Flag{ &cli.StringFlag{ Name: common.FlagEventID, @@ -281,7 +281,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "reset-batch", Usage: "Reset a batch of Workflow Executions by reset type: " + strings.Join(mapKeysToArray(resetTypesMap), ", "), - UsageText: "Resetting a Workflow allows the process to resume from a certain point without losing your parameters or Event History.", + UsageText: common.ResetBatchUsageText, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagQuery, @@ -353,7 +353,7 @@ func NewWorkflowCommands() []*cli.Command { }, { Name: "trace", - Usage: "Trace progress of a Workflow Execution and its children.", + Usage: common.TraceWorkflowDefinition, Flags: append(common.FlagsForExecution, &cli.IntFlag{ Name: common.FlagDepth, From 132767469a709f5a78ed1270b8f4c0619ae81fb9 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 18 Jan 2023 15:50:46 -0600 Subject: [PATCH 28/68] frontmatter template created --- cmd/doc/main.go | 18 +++++++++++++++++- docs/activity/complete.md | 9 +++++++++ docs/activity/fail.md | 9 +++++++++ docs/activity/index.md | 9 +++++++++ docs/batch/describe.md | 11 ++++++++++- docs/batch/index.md | 9 +++++++++ docs/batch/list.md | 11 ++++++++++- docs/batch/terminate.md | 11 ++++++++++- docs/completion/bash.md | 9 +++++++++ docs/completion/index.md | 9 +++++++++ docs/completion/zsh.md | 9 +++++++++ docs/env/delete.md | 9 +++++++++ docs/env/get.md | 9 +++++++++ docs/env/index.md | 9 +++++++++ docs/env/set.md | 9 +++++++++ docs/operator/cluster.md | 9 +++++++++ docs/operator/index.md | 11 ++++++++++- docs/operator/namespace.md | 9 +++++++++ docs/operator/search-attribute.md | 9 +++++++++ docs/schedule/backfill.md | 9 +++++++++ docs/schedule/create.md | 9 +++++++++ docs/schedule/delete.md | 9 +++++++++ docs/schedule/describe.md | 9 +++++++++ docs/schedule/index.md | 11 ++++++++++- docs/schedule/list.md | 9 +++++++++ docs/schedule/toggle.md | 9 +++++++++ docs/schedule/trigger.md | 9 +++++++++ docs/schedule/update.md | 9 +++++++++ docs/server/index.md | 9 +++++++++ docs/server/start-dev.md | 9 +++++++++ docs/task-queue/describe.md | 9 +++++++++ docs/task-queue/index.md | 9 +++++++++ docs/task-queue/list-partition.md | 9 +++++++++ docs/workflow/cancel.md | 9 +++++++++ docs/workflow/count.md | 9 +++++++++ docs/workflow/delete.md | 9 +++++++++ docs/workflow/describe.md | 11 ++++++++++- docs/workflow/execute.md | 11 ++++++++++- docs/workflow/index.md | 9 +++++++++ docs/workflow/list.md | 11 ++++++++++- docs/workflow/query.md | 9 +++++++++ docs/workflow/reset-batch.md | 13 +++++++++++-- docs/workflow/reset.md | 13 +++++++++++-- docs/workflow/show.md | 9 +++++++++ docs/workflow/signal.md | 9 +++++++++ docs/workflow/stack.md | 9 +++++++++ docs/workflow/start.md | 11 ++++++++++- docs/workflow/terminate.md | 9 +++++++++ docs/workflow/trace.md | 9 +++++++++ 49 files changed, 462 insertions(+), 14 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index eb48691e..0ea4c838 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -60,6 +60,7 @@ func main() { continue } createdFiles[headerIndexFile] = currentHeaderFile + writeLine(currentHeaderFile,FrontMatterTemplate) writeLine(currentHeaderFile, line) } else if strings.HasPrefix(line, "### ") { @@ -77,6 +78,7 @@ func main() { } createdFiles[filePath] = currentHeaderFile } + writeLine(currentHeaderFile,FrontMatterTemplate) writeLine(currentHeaderFile, line) } else if strings.HasPrefix(line, "**--") { // split into term and definition @@ -94,7 +96,7 @@ func main() { log.Info(found) } else if strings.HasPrefix(line, ">") { - writeLine(currentHeaderFile, strings.TrimPrefix(line, ">")) + writeLine(currentHeaderFile, strings.TrimPrefix(line, " >")) } else { writeLine(currentHeaderFile, line) } @@ -119,3 +121,17 @@ func makeAlias(file *os.File, line string) { writeLine(file, "Alias: **" + strings.TrimSpace(termArray[1])) } +// create frontmatter for docs team :) +var FrontMatterTemplate = +`--- +id: +title: +sidebar_label: +description: +tags: +--- +` + + + + diff --git a/docs/activity/complete.md b/docs/activity/complete.md index c3155103..8d94408d 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### complete Completes an Activity. diff --git a/docs/activity/fail.md b/docs/activity/fail.md index 1a0849e4..6f1f0170 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### fail Fails an Activity. diff --git a/docs/activity/index.md b/docs/activity/index.md index 4674d0d3..2c439263 100644 --- a/docs/activity/index.md +++ b/docs/activity/index.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ## activity Operations that can be performed on Workflow Activities. diff --git a/docs/batch/describe.md b/docs/batch/describe.md index 811b97c2..8453c170 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -1,8 +1,17 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### describe Describe a Batch operation job. -This command shows the progress of an ongoing Batch job. +>This command shows the progress of an ongoing Batch job. **--address** host:port for Temporal frontend service diff --git a/docs/batch/index.md b/docs/batch/index.md index 73ea2f1e..7ab85aee 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ## batch Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs. diff --git a/docs/batch/list.md b/docs/batch/list.md index 624fc08b..ee71f448 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -1,8 +1,17 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### list List Batch operation jobs. -When used, all Batch operation jobs within the system are listed. +>When used, all Batch operation jobs within the system are listed. **--address** host:port for Temporal frontend service diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index eab73965..3d3b4508 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -1,8 +1,17 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### terminate Stop a Batch operation job. -When used, the Batch job with the provided Batch Id is terminated. +>When used, the Batch job with the provided Batch Id is terminated. **--address** host:port for Temporal frontend service diff --git a/docs/completion/bash.md b/docs/completion/bash.md index 0ea5d8d1..9490edff 100644 --- a/docs/completion/bash.md +++ b/docs/completion/bash.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### bash bash completion output diff --git a/docs/completion/index.md b/docs/completion/index.md index f9cfc9fe..466c47dc 100644 --- a/docs/completion/index.md +++ b/docs/completion/index.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ## completion Output shell completion code for the specified shell (zsh, bash). diff --git a/docs/completion/zsh.md b/docs/completion/zsh.md index 5285e9ff..587f2728 100644 --- a/docs/completion/zsh.md +++ b/docs/completion/zsh.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### zsh zsh completion output diff --git a/docs/env/delete.md b/docs/env/delete.md index dc726998..cda2b3ab 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### delete Delete environment or environmental property. diff --git a/docs/env/get.md b/docs/env/get.md index 39e45f3a..b821bb09 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### get Prints environmental properties. diff --git a/docs/env/index.md b/docs/env/index.md index 0014d96a..26c042f5 100644 --- a/docs/env/index.md +++ b/docs/env/index.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ## env Manage environmental configurations on Temporal Client. diff --git a/docs/env/set.md b/docs/env/set.md index a2377abe..adcfa020 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### set Set environmental properties. diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index e9423b0d..6d7f76e3 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### cluster Operations for running a Temporal Cluster. diff --git a/docs/operator/index.md b/docs/operator/index.md index e07e2790..835deff9 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -1,6 +1,15 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ## operator Operations on Temporal Server. -These commands enable operations on Namespaces, Search Attributes, and Temporal Clusters. +>These commands enable operations on Namespaces, Search Attributes, and Temporal Clusters. diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index e7fa7420..bea971bf 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### namespace Operations applying to Namespaces. diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index 6683923c..359e5efa 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### search-attribute Operations applying to Search Attributes. diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md index 3ca8b199..90c4cca9 100644 --- a/docs/schedule/backfill.md +++ b/docs/schedule/backfill.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### backfill Backfills a past time range of actions diff --git a/docs/schedule/create.md b/docs/schedule/create.md index 0a50e916..5400e0a6 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### create Create a new schedule diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md index 154ef46e..f1032e56 100644 --- a/docs/schedule/delete.md +++ b/docs/schedule/delete.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### delete Deletes a schedule diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 2a3890df..462f375f 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### describe Get schedule configuration and current state diff --git a/docs/schedule/index.md b/docs/schedule/index.md index e4baefc4..ad445859 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -1,6 +1,15 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ## schedule Operations performed on Schedules. -These commands allow Schedules to be created, used, and updated. +>These commands allow Schedules to be created, used, and updated. diff --git a/docs/schedule/list.md b/docs/schedule/list.md index 913df0e5..b57ade94 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### list Lists schedules diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md index 974552e2..4cfca712 100644 --- a/docs/schedule/toggle.md +++ b/docs/schedule/toggle.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### toggle Pauses or unpauses a schedule diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md index c830d3ed..926adaa5 100644 --- a/docs/schedule/trigger.md +++ b/docs/schedule/trigger.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### trigger Triggers an immediate action diff --git a/docs/schedule/update.md b/docs/schedule/update.md index b4c349ed..4327f69a 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### update Updates a schedule with a new definition (full replacement, not patch) diff --git a/docs/server/index.md b/docs/server/index.md index 8acff91a..a9edda49 100644 --- a/docs/server/index.md +++ b/docs/server/index.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ## server Commands for managing the Temporal Server. diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index de67ab70..d242643a 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### start-dev Start Temporal development server. diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index fb927436..cfbdc9d6 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### describe Describes the Workers that have recently polled on this Task Queue diff --git a/docs/task-queue/index.md b/docs/task-queue/index.md index abc8a52a..6e1cc4f3 100644 --- a/docs/task-queue/index.md +++ b/docs/task-queue/index.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ## task-queue Operations performed on Task Queues. diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index 96296035..c962b9c5 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### list-partition Lists the Task Queue's partitions and which matching node they are assigned to. diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index fed5b0f1..8f4ffd3b 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### cancel Cancel a Workflow Execution. diff --git a/docs/workflow/count.md b/docs/workflow/count.md index 79a0e02a..58be6ebb 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### count Count Workflow Executions (requires ElasticSearch to be enabled). diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index 6d8d4dd7..1e3b8fef 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### delete Deletes a Workflow Execution. diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index 4157cf22..484dfce2 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -1,8 +1,17 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### describe Show information about a Workflow Execution. -This information can be used to locate a Workflow Execution that failed. +>This information can be used to locate a Workflow Execution that failed. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index 23229a7e..1a1d0277 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -1,8 +1,17 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### execute Start a new Workflow Execution and prints its progress. -Single quotes('') are used to wrap input as JSON. +>Single quotes('') are used to wrap input as JSON. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/index.md b/docs/workflow/index.md index 55396fee..db0eeb70 100644 --- a/docs/workflow/index.md +++ b/docs/workflow/index.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ## workflow Operations that can be performed on Workflows. diff --git a/docs/workflow/list.md b/docs/workflow/list.md index 5d48c4a2..f7b3894c 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -1,8 +1,17 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### list List Workflow Executions based on a Query. -By default, this command lists up to 10 closed Workflow Executions. +>By default, this command lists up to 10 closed Workflow Executions. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/query.md b/docs/workflow/query.md index d285d7e8..b773db64 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### query Query a Workflow Execution. diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 392c6588..a210be7d 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -1,8 +1,17 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### reset-batch Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew -Resetting a Workflow allows the process to resume from a certain point without losing your parameters or Event History. +>Resetting a Workflow allows the process to resume from a certain point without losing your parameters or Event History. **--address** host:port for Temporal frontend service @@ -76,5 +85,5 @@ Path to private key Override for target server name **--type** -Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index ad39d0b4..1434d10b 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -1,8 +1,17 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### reset Resets a Workflow Execution by Event Id or reset type. -A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History. +>A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History. **--address** host:port for Temporal frontend service @@ -58,7 +67,7 @@ Path to private key Override for target server name **--type** -Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew **--workflow-id** Alias: **-w** diff --git a/docs/workflow/show.md b/docs/workflow/show.md index 3446e0a7..31c51cdb 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### show Show Event History for a Workflow Execution. diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index fc166a9c..944a5da2 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### signal Signal Workflow Execution by Id or List Filter. diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index 9a5116a5..29f94320 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### stack Query a Workflow Execution with __stack_trace as the query type. diff --git a/docs/workflow/start.md b/docs/workflow/start.md index f51d786b..7e100dc2 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -1,8 +1,17 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### start Starts a new Workflow Execution. -When invoked successfully, the Workflow and Run Ids of the recently started Workflow are returned. +>When invoked successfully, the Workflow and Run Ids of the recently started Workflow are returned. **--address** host:port for Temporal frontend service diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index c0dd7cdd..beebb2d6 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### terminate Terminate Workflow Execution by Id or List Filter. diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index 706e7cf0..62bb763f 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -1,3 +1,12 @@ +--- +id: +title: +sidebar_label: +description: +tags: +--- + + ### trace Trace progress of a Workflow Execution and its children. From e531a5461d56bc5f28e438b085a404be5f6732a4 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 18 Jan 2023 16:12:07 -0600 Subject: [PATCH 29/68] template edited. --- cmd/doc/main.go | 25 ++++++++++--------------- docs/activity/complete.md | 9 ++++----- docs/activity/fail.md | 9 ++++----- docs/activity/index.md | 9 --------- docs/batch/describe.md | 9 ++++----- docs/batch/index.md | 9 --------- docs/batch/list.md | 9 ++++----- docs/batch/terminate.md | 9 ++++----- docs/completion/bash.md | 9 ++++----- docs/completion/index.md | 9 --------- docs/completion/zsh.md | 9 ++++----- docs/env/delete.md | 9 ++++----- docs/env/get.md | 9 ++++----- docs/env/index.md | 9 --------- docs/env/set.md | 9 ++++----- docs/operator/cluster.md | 9 ++++----- docs/operator/index.md | 9 --------- docs/operator/namespace.md | 9 ++++----- docs/operator/search-attribute.md | 9 ++++----- docs/schedule/backfill.md | 9 ++++----- docs/schedule/create.md | 9 ++++----- docs/schedule/delete.md | 9 ++++----- docs/schedule/describe.md | 9 ++++----- docs/schedule/index.md | 9 --------- docs/schedule/list.md | 9 ++++----- docs/schedule/toggle.md | 9 ++++----- docs/schedule/trigger.md | 9 ++++----- docs/schedule/update.md | 9 ++++----- docs/server/index.md | 9 --------- docs/server/start-dev.md | 9 ++++----- docs/task-queue/describe.md | 9 ++++----- docs/task-queue/index.md | 9 --------- docs/task-queue/list-partition.md | 9 ++++----- docs/workflow/cancel.md | 9 ++++----- docs/workflow/count.md | 9 ++++----- docs/workflow/delete.md | 9 ++++----- docs/workflow/describe.md | 9 ++++----- docs/workflow/execute.md | 9 ++++----- docs/workflow/index.md | 9 --------- docs/workflow/list.md | 9 ++++----- docs/workflow/query.md | 9 ++++----- docs/workflow/reset-batch.md | 11 +++++------ docs/workflow/reset.md | 11 +++++------ docs/workflow/show.md | 9 ++++----- docs/workflow/signal.md | 9 ++++----- docs/workflow/stack.md | 9 ++++----- docs/workflow/start.md | 9 ++++----- docs/workflow/terminate.md | 9 ++++----- docs/workflow/trace.md | 9 ++++----- 49 files changed, 168 insertions(+), 293 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 0ea4c838..df8f7e36 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -17,6 +17,16 @@ const ( indexFile = "index.md" ) +var FrontMatterTemplate = +`--- +id: %s +title: %s +sidebar_label: %s +description: %s +tags: +--- +` + // `BuildApp` takes a string and returns a `*App` and an error func main() { doc, err := app.BuildApp("").ToMarkdown() @@ -60,7 +70,6 @@ func main() { continue } createdFiles[headerIndexFile] = currentHeaderFile - writeLine(currentHeaderFile,FrontMatterTemplate) writeLine(currentHeaderFile, line) } else if strings.HasPrefix(line, "### ") { @@ -121,17 +130,3 @@ func makeAlias(file *os.File, line string) { writeLine(file, "Alias: **" + strings.TrimSpace(termArray[1])) } -// create frontmatter for docs team :) -var FrontMatterTemplate = -`--- -id: -title: -sidebar_label: -description: -tags: ---- -` - - - - diff --git a/docs/activity/complete.md b/docs/activity/complete.md index 8d94408d..ee6f8077 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### complete Completes an Activity. diff --git a/docs/activity/fail.md b/docs/activity/fail.md index 6f1f0170..f38f69b6 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### fail Fails an Activity. diff --git a/docs/activity/index.md b/docs/activity/index.md index 2c439263..4674d0d3 100644 --- a/docs/activity/index.md +++ b/docs/activity/index.md @@ -1,12 +1,3 @@ ---- -id: -title: -sidebar_label: -description: -tags: ---- - - ## activity Operations that can be performed on Workflow Activities. diff --git a/docs/batch/describe.md b/docs/batch/describe.md index 8453c170..8bdd3b2b 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### describe Describe a Batch operation job. diff --git a/docs/batch/index.md b/docs/batch/index.md index 7ab85aee..73ea2f1e 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -1,12 +1,3 @@ ---- -id: -title: -sidebar_label: -description: -tags: ---- - - ## batch Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs. diff --git a/docs/batch/list.md b/docs/batch/list.md index ee71f448..5efa8ec7 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### list List Batch operation jobs. diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index 3d3b4508..fc71c96d 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### terminate Stop a Batch operation job. diff --git a/docs/completion/bash.md b/docs/completion/bash.md index 9490edff..3ecff5f9 100644 --- a/docs/completion/bash.md +++ b/docs/completion/bash.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### bash bash completion output diff --git a/docs/completion/index.md b/docs/completion/index.md index 466c47dc..f9cfc9fe 100644 --- a/docs/completion/index.md +++ b/docs/completion/index.md @@ -1,12 +1,3 @@ ---- -id: -title: -sidebar_label: -description: -tags: ---- - - ## completion Output shell completion code for the specified shell (zsh, bash). diff --git a/docs/completion/zsh.md b/docs/completion/zsh.md index 587f2728..a924d4c0 100644 --- a/docs/completion/zsh.md +++ b/docs/completion/zsh.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### zsh zsh completion output diff --git a/docs/env/delete.md b/docs/env/delete.md index cda2b3ab..8ade35cc 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### delete Delete environment or environmental property. diff --git a/docs/env/get.md b/docs/env/get.md index b821bb09..41fabcc2 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### get Prints environmental properties. diff --git a/docs/env/index.md b/docs/env/index.md index 26c042f5..0014d96a 100644 --- a/docs/env/index.md +++ b/docs/env/index.md @@ -1,12 +1,3 @@ ---- -id: -title: -sidebar_label: -description: -tags: ---- - - ## env Manage environmental configurations on Temporal Client. diff --git a/docs/env/set.md b/docs/env/set.md index adcfa020..ac3cfd28 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### set Set environmental properties. diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index 6d7f76e3..74f3a438 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### cluster Operations for running a Temporal Cluster. diff --git a/docs/operator/index.md b/docs/operator/index.md index 835deff9..e4ec09fa 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -1,12 +1,3 @@ ---- -id: -title: -sidebar_label: -description: -tags: ---- - - ## operator Operations on Temporal Server. diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index bea971bf..857e7d9a 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### namespace Operations applying to Namespaces. diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index 359e5efa..c70a71af 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### search-attribute Operations applying to Search Attributes. diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md index 90c4cca9..bda8c0f0 100644 --- a/docs/schedule/backfill.md +++ b/docs/schedule/backfill.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### backfill Backfills a past time range of actions diff --git a/docs/schedule/create.md b/docs/schedule/create.md index 5400e0a6..24663718 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### create Create a new schedule diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md index f1032e56..3fa86855 100644 --- a/docs/schedule/delete.md +++ b/docs/schedule/delete.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### delete Deletes a schedule diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 462f375f..72fa3554 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### describe Get schedule configuration and current state diff --git a/docs/schedule/index.md b/docs/schedule/index.md index ad445859..ab8e71cd 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -1,12 +1,3 @@ ---- -id: -title: -sidebar_label: -description: -tags: ---- - - ## schedule Operations performed on Schedules. diff --git a/docs/schedule/list.md b/docs/schedule/list.md index b57ade94..14f8012c 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### list Lists schedules diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md index 4cfca712..9d71a166 100644 --- a/docs/schedule/toggle.md +++ b/docs/schedule/toggle.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### toggle Pauses or unpauses a schedule diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md index 926adaa5..f2d4451e 100644 --- a/docs/schedule/trigger.md +++ b/docs/schedule/trigger.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### trigger Triggers an immediate action diff --git a/docs/schedule/update.md b/docs/schedule/update.md index 4327f69a..54c53d2d 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### update Updates a schedule with a new definition (full replacement, not patch) diff --git a/docs/server/index.md b/docs/server/index.md index a9edda49..8acff91a 100644 --- a/docs/server/index.md +++ b/docs/server/index.md @@ -1,12 +1,3 @@ ---- -id: -title: -sidebar_label: -description: -tags: ---- - - ## server Commands for managing the Temporal Server. diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index d242643a..2d7f7149 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### start-dev Start Temporal development server. diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index cfbdc9d6..996cd523 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### describe Describes the Workers that have recently polled on this Task Queue diff --git a/docs/task-queue/index.md b/docs/task-queue/index.md index 6e1cc4f3..abc8a52a 100644 --- a/docs/task-queue/index.md +++ b/docs/task-queue/index.md @@ -1,12 +1,3 @@ ---- -id: -title: -sidebar_label: -description: -tags: ---- - - ## task-queue Operations performed on Task Queues. diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index c962b9c5..65b1f7d5 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### list-partition Lists the Task Queue's partitions and which matching node they are assigned to. diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index 8f4ffd3b..5bd2801e 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### cancel Cancel a Workflow Execution. diff --git a/docs/workflow/count.md b/docs/workflow/count.md index 58be6ebb..fd3b416a 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### count Count Workflow Executions (requires ElasticSearch to be enabled). diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index 1e3b8fef..b1180af4 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### delete Deletes a Workflow Execution. diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index 484dfce2..a824c3c8 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### describe Show information about a Workflow Execution. diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index 1a1d0277..3f8a4acf 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### execute Start a new Workflow Execution and prints its progress. diff --git a/docs/workflow/index.md b/docs/workflow/index.md index db0eeb70..55396fee 100644 --- a/docs/workflow/index.md +++ b/docs/workflow/index.md @@ -1,12 +1,3 @@ ---- -id: -title: -sidebar_label: -description: -tags: ---- - - ## workflow Operations that can be performed on Workflows. diff --git a/docs/workflow/list.md b/docs/workflow/list.md index f7b3894c..f36ea875 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### list List Workflow Executions based on a Query. diff --git a/docs/workflow/query.md b/docs/workflow/query.md index b773db64..5004046e 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### query Query a Workflow Execution. diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index a210be7d..8d2d64c9 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### reset-batch Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew @@ -85,5 +84,5 @@ Path to private key Override for target server name **--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 1434d10b..9ffc4906 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### reset Resets a Workflow Execution by Event Id or reset type. @@ -67,7 +66,7 @@ Path to private key Override for target server name **--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask **--workflow-id** Alias: **-w** diff --git a/docs/workflow/show.md b/docs/workflow/show.md index 31c51cdb..1d7d4ceb 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### show Show Event History for a Workflow Execution. diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index 944a5da2..a2419885 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### signal Signal Workflow Execution by Id or List Filter. diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index 29f94320..0f4d941e 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### stack Query a Workflow Execution with __stack_trace as the query type. diff --git a/docs/workflow/start.md b/docs/workflow/start.md index 7e100dc2..5d92b9a0 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### start Starts a new Workflow Execution. diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index beebb2d6..92408d8f 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### terminate Terminate Workflow Execution by Id or List Filter. diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index 62bb763f..e187afa6 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -1,12 +1,11 @@ --- -id: -title: -sidebar_label: -description: +id: %s +title: %s +sidebar_label: %s +description: %s tags: --- - ### trace Trace progress of a Workflow Execution and its children. From 87135d47b6c322fd231ce63aa7eb3ea9990d1e20 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 19 Jan 2023 11:42:09 -0600 Subject: [PATCH 30/68] generated front matter --- cmd/doc/main.go | 42 ++++++++++++++++++++++++++----- docs/activity/complete.md | 9 ++++--- docs/activity/fail.md | 9 ++++--- docs/activity/index.md | 9 +++++++ docs/batch/describe.md | 9 ++++--- docs/batch/index.md | 9 +++++++ docs/batch/list.md | 9 ++++--- docs/batch/terminate.md | 9 ++++--- docs/completion/bash.md | 9 ++++--- docs/completion/index.md | 9 +++++++ docs/completion/zsh.md | 9 ++++--- docs/env/delete.md | 9 ++++--- docs/env/get.md | 9 ++++--- docs/env/index.md | 9 +++++++ docs/env/set.md | 9 ++++--- docs/operator/cluster.md | 9 ++++--- docs/operator/index.md | 9 +++++++ docs/operator/namespace.md | 9 ++++--- docs/operator/search-attribute.md | 9 ++++--- docs/schedule/backfill.md | 9 ++++--- docs/schedule/create.md | 9 ++++--- docs/schedule/delete.md | 9 ++++--- docs/schedule/describe.md | 9 ++++--- docs/schedule/index.md | 9 +++++++ docs/schedule/list.md | 9 ++++--- docs/schedule/toggle.md | 9 ++++--- docs/schedule/trigger.md | 9 ++++--- docs/schedule/update.md | 9 ++++--- docs/server/index.md | 9 +++++++ docs/server/start-dev.md | 9 ++++--- docs/task-queue/describe.md | 9 ++++--- docs/task-queue/index.md | 9 +++++++ docs/task-queue/list-partition.md | 9 ++++--- docs/workflow/cancel.md | 9 ++++--- docs/workflow/count.md | 9 ++++--- docs/workflow/delete.md | 9 ++++--- docs/workflow/describe.md | 9 ++++--- docs/workflow/execute.md | 9 ++++--- docs/workflow/index.md | 9 +++++++ docs/workflow/list.md | 9 ++++--- docs/workflow/query.md | 9 ++++--- docs/workflow/reset-batch.md | 11 ++++---- docs/workflow/reset.md | 11 ++++---- docs/workflow/show.md | 9 ++++--- docs/workflow/signal.md | 9 ++++--- docs/workflow/stack.md | 9 ++++--- docs/workflow/start.md | 9 ++++--- docs/workflow/terminate.md | 9 ++++--- docs/workflow/trace.md | 9 ++++--- 49 files changed, 314 insertions(+), 164 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index df8f7e36..15d05bc6 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -5,6 +5,7 @@ import ( "os" "path/filepath" "strings" + "text/template" log "github.com/sirupsen/logrus" "github.com/temporalio/cli/app" @@ -17,16 +18,24 @@ const ( indexFile = "index.md" ) -var FrontMatterTemplate = +const FrontMatterTemplate = `--- -id: %s -title: %s -sidebar_label: %s -description: %s +id: {{.ID}} +title: temporal {{.Title}}{{if not .IsIndex}} {{.ID}}{{end}} +sidebar_label:{{if .IsIndex}} {{.Title}}{{else}} {{.ID}}{{end}} +description: words words words tags: + - cli --- + ` +type FMStruct struct { + ID string + Title string + IsIndex bool +} + // `BuildApp` takes a string and returns a `*App` and an error func main() { doc, err := app.BuildApp("").ToMarkdown() @@ -70,6 +79,8 @@ func main() { continue } createdFiles[headerIndexFile] = currentHeaderFile + + writeFrontMatter(indexFile, currentHeader, true, currentHeaderFile) writeLine(currentHeaderFile, line) } else if strings.HasPrefix(line, "### ") { @@ -87,7 +98,7 @@ func main() { } createdFiles[filePath] = currentHeaderFile } - writeLine(currentHeaderFile,FrontMatterTemplate) + writeFrontMatter(fileName, currentHeader, false, currentHeaderFile) writeLine(currentHeaderFile, line) } else if strings.HasPrefix(line, "**--") { // split into term and definition @@ -130,3 +141,22 @@ func makeAlias(file *os.File, line string) { writeLine(file, "Alias: **" + strings.TrimSpace(termArray[1])) } +// write front matter +func writeFrontMatter (idName string, titleName string, isIndex bool, currentHeaderFile *os.File) { + // make struct + data := FMStruct{ + ID: idName, + Title: titleName, + IsIndex: isIndex, + } + + tmpl := template.Must(template.New("fm").Parse(FrontMatterTemplate)) + + err := tmpl.ExecuteTemplate(currentHeaderFile, "fm", data) + + if err != nil { + log.Println("Execute: ", err) + return + } +} + diff --git a/docs/activity/complete.md b/docs/activity/complete.md index ee6f8077..bf73e8f8 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: complete +title: temporal activity complete +sidebar_label: complete +description: words words words tags: + - cli --- ### complete diff --git a/docs/activity/fail.md b/docs/activity/fail.md index f38f69b6..901a9170 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: fail +title: temporal activity fail +sidebar_label: fail +description: words words words tags: + - cli --- ### fail diff --git a/docs/activity/index.md b/docs/activity/index.md index 4674d0d3..e309d6fa 100644 --- a/docs/activity/index.md +++ b/docs/activity/index.md @@ -1,3 +1,12 @@ +--- +id: index.md +title: temporal activity +sidebar_label: activity +description: words words words +tags: + - cli +--- + ## activity Operations that can be performed on Workflow Activities. diff --git a/docs/batch/describe.md b/docs/batch/describe.md index 8bdd3b2b..d81f1dcb 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: describe +title: temporal batch describe +sidebar_label: describe +description: words words words tags: + - cli --- ### describe diff --git a/docs/batch/index.md b/docs/batch/index.md index 73ea2f1e..500637d0 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -1,3 +1,12 @@ +--- +id: index.md +title: temporal batch +sidebar_label: batch +description: words words words +tags: + - cli +--- + ## batch Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs. diff --git a/docs/batch/list.md b/docs/batch/list.md index 5efa8ec7..5956074d 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: list +title: temporal batch list +sidebar_label: list +description: words words words tags: + - cli --- ### list diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index fc71c96d..d87ba7f7 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: terminate +title: temporal batch terminate +sidebar_label: terminate +description: words words words tags: + - cli --- ### terminate diff --git a/docs/completion/bash.md b/docs/completion/bash.md index 3ecff5f9..a9d8563a 100644 --- a/docs/completion/bash.md +++ b/docs/completion/bash.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: bash +title: temporal completion bash +sidebar_label: bash +description: words words words tags: + - cli --- ### bash diff --git a/docs/completion/index.md b/docs/completion/index.md index f9cfc9fe..ea8d6e1a 100644 --- a/docs/completion/index.md +++ b/docs/completion/index.md @@ -1,3 +1,12 @@ +--- +id: index.md +title: temporal completion +sidebar_label: completion +description: words words words +tags: + - cli +--- + ## completion Output shell completion code for the specified shell (zsh, bash). diff --git a/docs/completion/zsh.md b/docs/completion/zsh.md index a924d4c0..f95cca98 100644 --- a/docs/completion/zsh.md +++ b/docs/completion/zsh.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: zsh +title: temporal completion zsh +sidebar_label: zsh +description: words words words tags: + - cli --- ### zsh diff --git a/docs/env/delete.md b/docs/env/delete.md index 8ade35cc..ad2bb07b 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: delete +title: temporal env delete +sidebar_label: delete +description: words words words tags: + - cli --- ### delete diff --git a/docs/env/get.md b/docs/env/get.md index 41fabcc2..a1e0735a 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: get +title: temporal env get +sidebar_label: get +description: words words words tags: + - cli --- ### get diff --git a/docs/env/index.md b/docs/env/index.md index 0014d96a..5911776e 100644 --- a/docs/env/index.md +++ b/docs/env/index.md @@ -1,3 +1,12 @@ +--- +id: index.md +title: temporal env +sidebar_label: env +description: words words words +tags: + - cli +--- + ## env Manage environmental configurations on Temporal Client. diff --git a/docs/env/set.md b/docs/env/set.md index ac3cfd28..7cb3a9ff 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: set +title: temporal env set +sidebar_label: set +description: words words words tags: + - cli --- ### set diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index 74f3a438..e2321ca7 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: cluster +title: temporal operator cluster +sidebar_label: cluster +description: words words words tags: + - cli --- ### cluster diff --git a/docs/operator/index.md b/docs/operator/index.md index e4ec09fa..c0ce3441 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -1,3 +1,12 @@ +--- +id: index.md +title: temporal operator +sidebar_label: operator +description: words words words +tags: + - cli +--- + ## operator Operations on Temporal Server. diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index 857e7d9a..44bb80ef 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: namespace +title: temporal operator namespace +sidebar_label: namespace +description: words words words tags: + - cli --- ### namespace diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index c70a71af..3ca451a2 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: search-attribute +title: temporal operator search-attribute +sidebar_label: search-attribute +description: words words words tags: + - cli --- ### search-attribute diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md index bda8c0f0..803ab37c 100644 --- a/docs/schedule/backfill.md +++ b/docs/schedule/backfill.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: backfill +title: temporal schedule backfill +sidebar_label: backfill +description: words words words tags: + - cli --- ### backfill diff --git a/docs/schedule/create.md b/docs/schedule/create.md index 24663718..f20d9df2 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: create +title: temporal schedule create +sidebar_label: create +description: words words words tags: + - cli --- ### create diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md index 3fa86855..0579c109 100644 --- a/docs/schedule/delete.md +++ b/docs/schedule/delete.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: delete +title: temporal schedule delete +sidebar_label: delete +description: words words words tags: + - cli --- ### delete diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 72fa3554..37f901ea 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: describe +title: temporal schedule describe +sidebar_label: describe +description: words words words tags: + - cli --- ### describe diff --git a/docs/schedule/index.md b/docs/schedule/index.md index ab8e71cd..00855abc 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -1,3 +1,12 @@ +--- +id: index.md +title: temporal schedule +sidebar_label: schedule +description: words words words +tags: + - cli +--- + ## schedule Operations performed on Schedules. diff --git a/docs/schedule/list.md b/docs/schedule/list.md index 14f8012c..0a829f71 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: list +title: temporal schedule list +sidebar_label: list +description: words words words tags: + - cli --- ### list diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md index 9d71a166..6a39cc7b 100644 --- a/docs/schedule/toggle.md +++ b/docs/schedule/toggle.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: toggle +title: temporal schedule toggle +sidebar_label: toggle +description: words words words tags: + - cli --- ### toggle diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md index f2d4451e..18112a49 100644 --- a/docs/schedule/trigger.md +++ b/docs/schedule/trigger.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: trigger +title: temporal schedule trigger +sidebar_label: trigger +description: words words words tags: + - cli --- ### trigger diff --git a/docs/schedule/update.md b/docs/schedule/update.md index 54c53d2d..e0013e35 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: update +title: temporal schedule update +sidebar_label: update +description: words words words tags: + - cli --- ### update diff --git a/docs/server/index.md b/docs/server/index.md index 8acff91a..09300436 100644 --- a/docs/server/index.md +++ b/docs/server/index.md @@ -1,3 +1,12 @@ +--- +id: index.md +title: temporal server +sidebar_label: server +description: words words words +tags: + - cli +--- + ## server Commands for managing the Temporal Server. diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index 2d7f7149..7384373d 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: start-dev +title: temporal server start-dev +sidebar_label: start-dev +description: words words words tags: + - cli --- ### start-dev diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index 996cd523..904bde7f 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: describe +title: temporal task-queue describe +sidebar_label: describe +description: words words words tags: + - cli --- ### describe diff --git a/docs/task-queue/index.md b/docs/task-queue/index.md index abc8a52a..47d8453a 100644 --- a/docs/task-queue/index.md +++ b/docs/task-queue/index.md @@ -1,3 +1,12 @@ +--- +id: index.md +title: temporal task-queue +sidebar_label: task-queue +description: words words words +tags: + - cli +--- + ## task-queue Operations performed on Task Queues. diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index 65b1f7d5..60750cb8 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: list-partition +title: temporal task-queue list-partition +sidebar_label: list-partition +description: words words words tags: + - cli --- ### list-partition diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index 5bd2801e..800a3484 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: cancel +title: temporal workflow cancel +sidebar_label: cancel +description: words words words tags: + - cli --- ### cancel diff --git a/docs/workflow/count.md b/docs/workflow/count.md index fd3b416a..348799cc 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: count +title: temporal workflow count +sidebar_label: count +description: words words words tags: + - cli --- ### count diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index b1180af4..8734e71c 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: delete +title: temporal workflow delete +sidebar_label: delete +description: words words words tags: + - cli --- ### delete diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index a824c3c8..5b9e75fb 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: describe +title: temporal workflow describe +sidebar_label: describe +description: words words words tags: + - cli --- ### describe diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index 3f8a4acf..74b624c8 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: execute +title: temporal workflow execute +sidebar_label: execute +description: words words words tags: + - cli --- ### execute diff --git a/docs/workflow/index.md b/docs/workflow/index.md index 55396fee..3b0f27a2 100644 --- a/docs/workflow/index.md +++ b/docs/workflow/index.md @@ -1,3 +1,12 @@ +--- +id: index.md +title: temporal workflow +sidebar_label: workflow +description: words words words +tags: + - cli +--- + ## workflow Operations that can be performed on Workflows. diff --git a/docs/workflow/list.md b/docs/workflow/list.md index f36ea875..7562e055 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: list +title: temporal workflow list +sidebar_label: list +description: words words words tags: + - cli --- ### list diff --git a/docs/workflow/query.md b/docs/workflow/query.md index 5004046e..ab3cbaf2 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: query +title: temporal workflow query +sidebar_label: query +description: words words words tags: + - cli --- ### query diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 8d2d64c9..7530c9df 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: reset-batch +title: temporal workflow reset-batch +sidebar_label: reset-batch +description: words words words tags: + - cli --- ### reset-batch @@ -84,5 +85,5 @@ Path to private key Override for target server name **--type** -Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 9ffc4906..b575ad71 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: reset +title: temporal workflow reset +sidebar_label: reset +description: words words words tags: + - cli --- ### reset @@ -66,7 +67,7 @@ Path to private key Override for target server name **--type** -Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew **--workflow-id** Alias: **-w** diff --git a/docs/workflow/show.md b/docs/workflow/show.md index 1d7d4ceb..b89c2045 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: show +title: temporal workflow show +sidebar_label: show +description: words words words tags: + - cli --- ### show diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index a2419885..0cb4b854 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: signal +title: temporal workflow signal +sidebar_label: signal +description: words words words tags: + - cli --- ### signal diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index 0f4d941e..42e1effa 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: stack +title: temporal workflow stack +sidebar_label: stack +description: words words words tags: + - cli --- ### stack diff --git a/docs/workflow/start.md b/docs/workflow/start.md index 5d92b9a0..a5dbec95 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: start +title: temporal workflow start +sidebar_label: start +description: words words words tags: + - cli --- ### start diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index 92408d8f..cc6f69cd 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: terminate +title: temporal workflow terminate +sidebar_label: terminate +description: words words words tags: + - cli --- ### terminate diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index e187afa6..c627e69e 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -1,9 +1,10 @@ --- -id: %s -title: %s -sidebar_label: %s -description: %s +id: trace +title: temporal workflow trace +sidebar_label: trace +description: words words words tags: + - cli --- ### trace From 8ffb26e8a7236c304aa342f171dd16db924420e0 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 19 Jan 2023 12:46:22 -0600 Subject: [PATCH 31/68] regenerated + moving definitions --- common/defs-flags.go | 45 ++++++++++++++++++++++++++++++++ common/flags.go | 62 +++++++++++++++++++------------------------- 2 files changed, 72 insertions(+), 35 deletions(-) create mode 100644 common/defs-flags.go diff --git a/common/defs-flags.go b/common/defs-flags.go new file mode 100644 index 00000000..4815610b --- /dev/null +++ b/common/defs-flags.go @@ -0,0 +1,45 @@ +package common +const ( + // Shared flag definitions + FlagEnvDefinition = "Name of the environment to read environmental variables from." + FlagAddrDefinition = "The host and port (formatted as host:port) for the Temporal Frontend Service." + FlagNSAliasDefinition = "Identifies a Namespace in the Temporal Workflow." + FlagMetadataDefinition = "Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format." + FlagTLSCertPathDefinition = "Path to x509 certificate." + FlagTLSKeyPathDefinition = "Path to private certificate key." + FlagTLSCaPathDefinition = "Path to server CA certificate." + FlagTLSDisableHVDefinition = "Disables TLS host name verification if already enabled." + FlagTLSServerNameDefinition = "Provides an override for the target TLS server name." + FlagContextTimeoutDefinition = "An optional timeout for the context of an RPC call (in seconds)." + FlagCodecEndpointDefinition = "Endpoint for a remote Codec Server." + FlagCodecAuthDefinition = "Sets the authorization header on requests to the Codec Server." + + // Execution flags + FlagWorkflowIdDefinition = "Workflow Id" + FlagRunIdDefinition = "Run Id" + + // ShowWorkflow flags + FlagOutputFilenameDefinition = "Serializes Event History to a file." + FlagMaxFieldLengthDefinition = "Maximum length for each attribute field." + FlagResetPointsOnlyDefinition = "Only show Workflow Events that are eligible for reset." + FlagFollowAliasDefinition = "Follow the progress of a Workflow Execution." + + // StartWorkflow flags + FlagWFTypeDefinition = "Workflow type name." + FlagTaskQueueDefinition = "Task Queue" + FlagWorkflowRunTimeoutDefinition = "Timeout (in seconds) of a single Workflow run." + FlagWorkflowExecutionTimeoutDefinition = "Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks." + FlagWorkflowTaskTimeoutDefinition = "Start-to-close timeout for a Workflow Task (in seconds)." + FlagCronScheduleDefinition = "Optional Cron Schedule for the Workflow. Cron spec is formatted as: \n" + + "\t┌───────────── minute (0 - 59) \n" + + "\t│ ┌───────────── hour (0 - 23) \n" + + "\t│ │ ┌───────────── day of the month (1 - 31) \n" + + "\t│ │ │ ┌───────────── month (1 - 12) \n" + + "\t│ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) \n" + + "\t│ │ │ │ │ \n" + + "\t* * * * *" + FlagWorkflowIdReusePolicyDefinition = "Allows the same Workflow Id to be used in a new Workflow Execution. " + + "Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning." + FlagInputDefinition = "Optional JSON input to provide to the Workflow.\nPass Pass \"null\" for null values." + +) \ No newline at end of file diff --git a/common/flags.go b/common/flags.go index cb64e948..90bb0a64 100644 --- a/common/flags.go +++ b/common/flags.go @@ -137,13 +137,13 @@ var SharedFlags = []cli.Flag{ &cli.StringFlag{ Name: FlagEnv, Value: config.DefaultEnv, - Usage: "Env name to read the client environment variables from", + Usage: FlagEnvDefinition, Category: CategoryClient, }, &cli.StringFlag{ Name: FlagAddress, Value: "", - Usage: "host:port for Temporal frontend service", + Usage: FlagAddrDefinition, EnvVars: []string{"TEMPORAL_CLI_ADDRESS"}, Category: CategoryClient, }, @@ -151,67 +151,67 @@ var SharedFlags = []cli.Flag{ Name: FlagNamespace, Aliases: FlagNamespaceAlias, Value: "default", - Usage: "Temporal workflow namespace", + Usage: FlagNSAliasDefinition, EnvVars: []string{"TEMPORAL_CLI_NAMESPACE"}, Category: CategoryClient, }, &cli.StringSliceFlag{ Name: FlagMetadata, - Usage: "gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value", + Usage: FlagMetadataDefinition, Category: CategoryClient, }, &cli.StringFlag{ Name: FlagTLSCertPath, Value: "", - Usage: "Path to x509 certificate", + Usage: FlagTLSCertPathDefinition, EnvVars: []string{"TEMPORAL_CLI_TLS_CERT"}, Category: CategoryClient, }, &cli.StringFlag{ Name: FlagTLSKeyPath, Value: "", - Usage: "Path to private key", + Usage: FlagTLSKeyPathDefinition, EnvVars: []string{"TEMPORAL_CLI_TLS_KEY"}, Category: CategoryClient, }, &cli.StringFlag{ Name: FlagTLSCaPath, Value: "", - Usage: "Path to server CA certificate", + Usage: FlagTLSCaPathDefinition, EnvVars: []string{"TEMPORAL_CLI_TLS_CA"}, Category: CategoryClient, }, &cli.BoolFlag{ Name: FlagTLSDisableHostVerification, - Usage: "Disable tls host name verification (tls must be enabled)", + Usage: FlagTLSDisableHVDefinition, EnvVars: []string{"TEMPORAL_CLI_TLS_DISABLE_HOST_VERIFICATION"}, Category: CategoryClient, }, &cli.StringFlag{ Name: FlagTLSServerName, Value: "", - Usage: "Override for target server name", + Usage: FlagTLSServerNameDefinition, EnvVars: []string{"TEMPORAL_CLI_TLS_SERVER_NAME"}, Category: CategoryClient, }, &cli.IntFlag{ Name: FlagContextTimeout, Value: defaultContextTimeoutInSeconds, - Usage: "Optional timeout for context of RPC call in seconds", + Usage: FlagContextTimeoutDefinition, EnvVars: []string{"TEMPORAL_CONTEXT_TIMEOUT"}, Category: CategoryClient, }, &cli.StringFlag{ Name: FlagCodecEndpoint, Value: "", - Usage: "Remote Codec Server Endpoint", + Usage: FlagCodecEndpointDefinition, EnvVars: []string{"TEMPORAL_CLI_CODEC_ENDPOINT"}, Category: CategoryClient, }, &cli.StringFlag{ Name: FlagCodecAuth, Value: "", - Usage: "Authorization header to set for requests to Codec Server", + Usage: FlagCodecAuthDefinition, EnvVars: []string{"TEMPORAL_CLI_CODEC_AUTH"}, Category: CategoryClient, }, @@ -234,7 +234,7 @@ var FlagsForExecution = []cli.Flag{ &cli.StringFlag{ Name: FlagRunID, Aliases: FlagRunIDAlias, - Usage: "Run Id", + Usage: FlagRunIdDefinition, Category: CategoryMain, }, } @@ -242,24 +242,24 @@ var FlagsForExecution = []cli.Flag{ var FlagsForShowWorkflow = []cli.Flag{ &cli.StringFlag{ Name: FlagOutputFilename, - Usage: "Serialize history event to a file", + Usage: FlagOutputFilenameDefinition, Category: CategoryMain, }, &cli.IntFlag{ Name: FlagMaxFieldLength, - Usage: "Maximum length for each attribute field", + Usage: FlagMaxFieldLengthDefinition, Value: defaultMaxFieldLength, Category: CategoryMain, }, &cli.BoolFlag{ Name: FlagResetPointsOnly, - Usage: "Only show events that are eligible for reset", + Usage: FlagResetPointsOnlyDefinition, Category: CategoryMain, }, &cli.BoolFlag{ Name: output.FlagFollow, Aliases: FlagFollowAlias, - Usage: "Follow the progress of Workflow Execution", + Usage: FlagFollowAliasDefinition, Value: false, Category: CategoryMain, }, @@ -268,7 +268,7 @@ var FlagsForShowWorkflow = []cli.Flag{ var FlagsForStartWorkflow = append(FlagsForStartWorkflowT, &cli.StringFlag{ Name: FlagType, - Usage: "Workflow type name", + Usage: FlagWFTypeDefinition, Required: true, Category: CategoryMain, }) @@ -276,7 +276,7 @@ var FlagsForStartWorkflow = append(FlagsForStartWorkflowT, var FlagsForStartWorkflowLong = append(FlagsForStartWorkflowT, &cli.StringFlag{ Name: FlagWorkflowType, - Usage: "Workflow type name", + Usage: FlagWFTypeDefinition, Required: true, Category: CategoryMain, }) @@ -285,54 +285,46 @@ var FlagsForStartWorkflowT = []cli.Flag{ &cli.StringFlag{ Name: FlagWorkflowID, Aliases: FlagWorkflowIDAlias, - Usage: "Workflow Id", + Usage: FlagWorkflowIdDefinition, Category: CategoryMain, }, &cli.StringFlag{ Name: FlagTaskQueue, Aliases: FlagTaskQueueAlias, - Usage: "Task queue", + Usage: FlagTaskQueueDefinition, Required: true, Category: CategoryMain, }, &cli.IntFlag{ Name: FlagWorkflowRunTimeout, - Usage: "Single workflow run timeout (seconds)", + Usage: FlagWorkflowRunTimeoutDefinition, Category: CategoryMain, }, &cli.IntFlag{ Name: FlagWorkflowExecutionTimeout, - Usage: "Workflow Execution timeout, including retries and continue-as-new (seconds)", + Usage: FlagWorkflowExecutionTimeoutDefinition, Category: CategoryMain, }, &cli.IntFlag{ Name: FlagWorkflowTaskTimeout, Value: defaultWorkflowTaskTimeoutInSeconds, - Usage: "Workflow task start to close timeout (seconds)", + Usage: FlagWorkflowTaskTimeoutDefinition, Category: CategoryMain, }, &cli.StringFlag{ Name: FlagCronSchedule, - Usage: "Optional cron schedule for the Workflow. Cron spec is as following: \n" + - "\t┌───────────── minute (0 - 59) \n" + - "\t│ ┌───────────── hour (0 - 23) \n" + - "\t│ │ ┌───────────── day of the month (1 - 31) \n" + - "\t│ │ │ ┌───────────── month (1 - 12) \n" + - "\t│ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) \n" + - "\t│ │ │ │ │ \n" + - "\t* * * * *", + Usage: FlagCronScheduleDefinition, Category: CategoryMain, }, &cli.StringFlag{ Name: FlagWorkflowIDReusePolicy, - Usage: "Configure if the same Workflow Id is allowed for use in new Workflow Execution. " + - "Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning", + Usage: FlagWorkflowIdReusePolicyDefinition, Category: CategoryMain, }, &cli.StringSliceFlag{ Name: FlagInput, Aliases: FlagInputAlias, - Usage: "Optional input for the Workflow in JSON format. Pass \"null\" for null values", + Usage: FlagInputDefinition, Category: CategoryMain, }, &cli.StringFlag{ From 2ea049903f59dbe6976d2a4506198cd0016a4bd8 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 19 Jan 2023 12:46:29 -0600 Subject: [PATCH 32/68] defs and generation --- cmd/doc/main.go | 9 +- common/defs-cmds.go | 1 + docs/activity/complete.md | 26 +++--- docs/activity/fail.md | 26 +++--- docs/activity/index.md | 4 +- docs/batch/describe.md | 28 +++--- docs/batch/index.md | 4 +- docs/batch/list.md | 28 +++--- docs/batch/terminate.md | 28 +++--- docs/completion/bash.md | 2 +- docs/completion/index.md | 4 +- docs/completion/zsh.md | 2 +- docs/env/delete.md | 26 +++--- docs/env/get.md | 26 +++--- docs/env/index.md | 4 +- docs/env/set.md | 26 +++--- docs/operator/cluster.md | 146 +++++++++++++++--------------- docs/operator/index.md | 6 +- docs/operator/namespace.md | 122 ++++++++++++------------- docs/operator/search-attribute.md | 74 +++++++-------- docs/schedule/backfill.md | 26 +++--- docs/schedule/create.md | 32 +++---- docs/schedule/delete.md | 26 +++--- docs/schedule/describe.md | 26 +++--- docs/schedule/index.md | 6 +- docs/schedule/list.md | 26 +++--- docs/schedule/toggle.md | 26 +++--- docs/schedule/trigger.md | 26 +++--- docs/schedule/update.md | 32 +++---- docs/server/index.md | 4 +- docs/server/start-dev.md | 2 +- docs/task-queue/describe.md | 26 +++--- docs/task-queue/index.md | 4 +- docs/task-queue/list-partition.md | 26 +++--- docs/workflow/cancel.md | 26 +++--- docs/workflow/count.md | 26 +++--- docs/workflow/delete.md | 26 +++--- docs/workflow/describe.md | 28 +++--- docs/workflow/execute.md | 34 +++---- docs/workflow/index.md | 4 +- docs/workflow/list.md | 28 +++--- docs/workflow/query.md | 26 +++--- docs/workflow/reset-batch.md | 28 +++--- docs/workflow/reset.md | 30 +++--- docs/workflow/show.md | 34 +++---- docs/workflow/signal.md | 26 +++--- docs/workflow/stack.md | 26 +++--- docs/workflow/start.md | 34 +++---- docs/workflow/terminate.md | 26 +++--- docs/workflow/trace.md | 26 +++--- 50 files changed, 654 insertions(+), 654 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 15d05bc6..9acafd64 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -23,7 +23,7 @@ const FrontMatterTemplate = id: {{.ID}} title: temporal {{.Title}}{{if not .IsIndex}} {{.ID}}{{end}} sidebar_label:{{if .IsIndex}} {{.Title}}{{else}} {{.ID}}{{end}} -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -80,7 +80,7 @@ func main() { } createdFiles[headerIndexFile] = currentHeaderFile - writeFrontMatter(indexFile, currentHeader, true, currentHeaderFile) + writeFrontMatter(strings.Trim(indexFile, ".md"), currentHeader, true, currentHeaderFile) writeLine(currentHeaderFile, line) } else if strings.HasPrefix(line, "### ") { @@ -116,7 +116,7 @@ func main() { log.Info(found) } else if strings.HasPrefix(line, ">") { - writeLine(currentHeaderFile, strings.TrimPrefix(line, " >")) + writeLine(currentHeaderFile, strings.Trim(line, ">")) } else { writeLine(currentHeaderFile, line) } @@ -143,7 +143,7 @@ func makeAlias(file *os.File, line string) { // write front matter func writeFrontMatter (idName string, titleName string, isIndex bool, currentHeaderFile *os.File) { - // make struct + // make struct to pass into the template data := FMStruct{ ID: idName, Title: titleName, @@ -153,7 +153,6 @@ func writeFrontMatter (idName string, titleName string, isIndex bool, currentHea tmpl := template.Must(template.New("fm").Parse(FrontMatterTemplate)) err := tmpl.ExecuteTemplate(currentHeaderFile, "fm", data) - if err != nil { log.Println("Execute: ", err) return diff --git a/common/defs-cmds.go b/common/defs-cmds.go index 70989e63..c7615218 100644 --- a/common/defs-cmds.go +++ b/common/defs-cmds.go @@ -1,5 +1,6 @@ package common +// TODO: add links to Temporal concepts after confirming the format won't screw with the command line const ( // Main command definitions WorkflowDefinition = "Operations that can be performed on Workflows." diff --git a/docs/activity/complete.md b/docs/activity/complete.md index bf73e8f8..655cf7e4 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -2,7 +2,7 @@ id: complete title: temporal activity complete sidebar_label: complete -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -15,32 +15,32 @@ Completes an Activity. Identifies the Activity to be completed. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--identity** Specify operator's identity. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--result** Set the result value of Activity completion. @@ -50,19 +50,19 @@ Alias: **-r** Identifies the current Workflow Run. **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--workflow-id** Alias: **-w** diff --git a/docs/activity/fail.md b/docs/activity/fail.md index 901a9170..a5589afb 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -2,7 +2,7 @@ id: fail title: temporal activity fail sidebar_label: fail -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -15,35 +15,35 @@ Fails an Activity. Identifies the Activity to fail. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--detail** Detail to fail the Activity. **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--identity** Specify the operator's identity. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--reason** Reason to fail the Activity. @@ -53,19 +53,19 @@ Alias: **-r** Identifies the current Workflow Run. **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--workflow-id** Alias: **-w** diff --git a/docs/activity/index.md b/docs/activity/index.md index e309d6fa..ff0a8834 100644 --- a/docs/activity/index.md +++ b/docs/activity/index.md @@ -1,8 +1,8 @@ --- -id: index.md +id: index title: temporal activity sidebar_label: activity -description: words words words +description: Temporal CLI operation for .... tags: - cli --- diff --git a/docs/batch/describe.md b/docs/batch/describe.md index d81f1dcb..024f2934 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -2,7 +2,7 @@ id: describe title: temporal batch describe sidebar_label: describe -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -11,38 +11,38 @@ tags: Describe a Batch operation job. ->This command shows the progress of an ongoing Batch job. +This command shows the progress of an ongoing Batch job. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--fields** customize fields to print. Set to 'long' to automatically print more of main fields **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--job-id** Batch Job Id **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--output** Alias: **-o** @@ -52,17 +52,17 @@ format output as: table, json, card. (default: table) format time as: relative, iso, raw. (default: relative) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/batch/index.md b/docs/batch/index.md index 500637d0..cb7f0177 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -1,8 +1,8 @@ --- -id: index.md +id: index title: temporal batch sidebar_label: batch -description: words words words +description: Temporal CLI operation for .... tags: - cli --- diff --git a/docs/batch/list.md b/docs/batch/list.md index 5956074d..3e6735e9 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -2,7 +2,7 @@ id: list title: temporal batch list sidebar_label: list -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -11,38 +11,38 @@ tags: List Batch operation jobs. ->When used, all Batch operation jobs within the system are listed. +When used, all Batch operation jobs within the system are listed. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--fields** customize fields to print. Set to 'long' to automatically print more of main fields **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--limit** number of items to print (default: 0) **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** @@ -59,17 +59,17 @@ pager to use: less, more, favoritePager.. format time as: relative, iso, raw. (default: relative) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index d87ba7f7..24982e6b 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -2,7 +2,7 @@ id: terminate title: temporal batch terminate sidebar_label: terminate -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -11,51 +11,51 @@ tags: Stop a Batch operation job. ->When used, the Batch job with the provided Batch Id is terminated. +When used, the Batch job with the provided Batch Id is terminated. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--job-id** Batch Job Id **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--reason** Reason to stop the Batch job. **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/completion/bash.md b/docs/completion/bash.md index a9d8563a..0e7e14b6 100644 --- a/docs/completion/bash.md +++ b/docs/completion/bash.md @@ -2,7 +2,7 @@ id: bash title: temporal completion bash sidebar_label: bash -description: words words words +description: Temporal CLI operation for .... tags: - cli --- diff --git a/docs/completion/index.md b/docs/completion/index.md index ea8d6e1a..f1d349c8 100644 --- a/docs/completion/index.md +++ b/docs/completion/index.md @@ -1,8 +1,8 @@ --- -id: index.md +id: index title: temporal completion sidebar_label: completion -description: words words words +description: Temporal CLI operation for .... tags: - cli --- diff --git a/docs/completion/zsh.md b/docs/completion/zsh.md index f95cca98..d35d6313 100644 --- a/docs/completion/zsh.md +++ b/docs/completion/zsh.md @@ -2,7 +2,7 @@ id: zsh title: temporal completion zsh sidebar_label: zsh -description: words words words +description: Temporal CLI operation for .... tags: - cli --- diff --git a/docs/env/delete.md b/docs/env/delete.md index ad2bb07b..869cba73 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -2,7 +2,7 @@ id: delete title: temporal env delete sidebar_label: delete -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,42 +12,42 @@ tags: Delete environment or environmental property. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/env/get.md b/docs/env/get.md index a1e0735a..16a07d89 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -2,7 +2,7 @@ id: get title: temporal env get sidebar_label: get -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,42 +12,42 @@ tags: Prints environmental properties. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/env/index.md b/docs/env/index.md index 5911776e..54a8408a 100644 --- a/docs/env/index.md +++ b/docs/env/index.md @@ -1,8 +1,8 @@ --- -id: index.md +id: index title: temporal env sidebar_label: env -description: words words words +description: Temporal CLI operation for .... tags: - cli --- diff --git a/docs/env/set.md b/docs/env/set.md index 7cb3a9ff..46d35c03 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -2,7 +2,7 @@ id: set title: temporal env set sidebar_label: set -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,42 +12,42 @@ tags: Set environmental properties. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index e2321ca7..714d9323 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -2,7 +2,7 @@ id: cluster title: temporal operator cluster sidebar_label: cluster -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -16,231 +16,231 @@ Operations for running a Temporal Cluster. Checks the health of the Frontend Service. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. #### describe Show information about the Cluster. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--fields** Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--output** Alias: **-o** format output as: table, json, card. (default: table) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. #### system Shows information about the system and its capabilities. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--fields** Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--output** Alias: **-o** format output as: table, json, card. (default: table) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. #### upsert Add or update a remote Cluster. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--enable-connection** Enable cross-cluster connection. **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--frontend-address** Frontend address of the remote Cluster. **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. #### list List all remote Clusters. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--fields** customize fields to print. Set to 'long' to automatically print more of main fields **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--limit** number of items to print (default: 0) **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** @@ -257,64 +257,64 @@ pager to use: less, more, favoritePager.. format time as: relative, iso, raw. (default: relative) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. #### remove Remove a remote Cluster. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--name** Frontend address of the remote Cluster. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/operator/index.md b/docs/operator/index.md index c0ce3441..4f48eb5f 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -1,8 +1,8 @@ --- -id: index.md +id: index title: temporal operator sidebar_label: operator -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -11,5 +11,5 @@ tags: Operations on Temporal Server. ->These commands enable operations on Namespaces, Search Attributes, and Temporal Clusters. +These commands enable operations on Namespaces, Search Attributes, and Temporal Clusters. diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index 44bb80ef..7ba0564a 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -2,7 +2,7 @@ id: namespace title: temporal operator namespace sidebar_label: namespace -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -16,91 +16,91 @@ Operations applying to Namespaces. Describe a Namespace by its name or Id. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--namespace-id** Namespace Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. #### list List all Namespaces. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. #### register @@ -110,22 +110,22 @@ Registers a new Namespace. Active cluster name **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--cluster** Cluster name **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--data** Namespace data in a format key=value @@ -137,13 +137,13 @@ Namespace description Owner email **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--global** Flag to indicate whether namespace is a global namespace **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--history-archival-state** Flag to set history archival state, valid values are "disabled" and "enabled" @@ -153,25 +153,25 @@ Optionally specify history archival URI (cannot be changed after first time arch **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--retention** Workflow Execution retention **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--visibility-archival-state** Flag to set visibility archival state, valid values are "disabled" and "enabled" @@ -187,22 +187,22 @@ Updates a Namespace. Active cluster name **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--cluster** Cluster name **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--data** Namespace data in a format key=value @@ -214,10 +214,10 @@ Namespace description Owner email **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--history-archival-state** Flag to set history archival state, valid values are "disabled" and "enabled" @@ -227,7 +227,7 @@ Optionally specify history archival URI (cannot be changed after first time arch **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--promote-global** Promote local namespace to global namespace @@ -239,19 +239,19 @@ Reason for the operation Workflow Execution retention **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--visibility-archival-state** Flag to set visibility archival state, valid values are "disabled" and "enabled" @@ -264,44 +264,44 @@ Optionally specify visibility archival URI (cannot be changed after first time a Deletes an existing Namespace. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--yes** Alias: **-y** diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index 3ca451a2..bf8077db 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -2,7 +2,7 @@ id: search-attribute title: temporal operator search-attribute sidebar_label: search-attribute -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -16,47 +16,47 @@ Operations applying to Search Attributes. Adds one or more custom Search Attributes. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--name** Search attribute name. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--type** Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] @@ -70,95 +70,95 @@ Confirm all prompts. Lists all Search Attributes that can be used in list Workflow Queries. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--output** Alias: **-o** format output as: table, json, card. (default: table) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. #### remove Removes custom search attribute metadata only (Elasticsearch index schema is not modified). **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--name** Search attribute name. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--yes** Alias: **-y** diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md index 803ab37c..f3591e44 100644 --- a/docs/schedule/backfill.md +++ b/docs/schedule/backfill.md @@ -2,7 +2,7 @@ id: backfill title: temporal schedule backfill sidebar_label: backfill -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,32 +12,32 @@ tags: Backfills a past time range of actions **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--end-time** Backfill end time **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--overlap-policy** Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll @@ -50,17 +50,17 @@ Schedule Id Backfill start time **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/schedule/create.md b/docs/schedule/create.md index f20d9df2..03b96c6d 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -2,7 +2,7 @@ id: create title: temporal schedule create sidebar_label: create -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,7 +12,7 @@ tags: Create a new schedule **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--calendar** Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} @@ -21,16 +21,16 @@ Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5" Maximum allowed catch-up time if server is down **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--cron** Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" @@ -39,13 +39,13 @@ Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" Overall schedule end time. **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--execution-timeout** Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--input** Alias: **-i** @@ -71,7 +71,7 @@ Set a memo from a file. Each line should follow the format key=value. Use valid **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--notes** Initial value of notes field @@ -89,7 +89,7 @@ Pause schedule after any workflow failure Total number of actions allowed (default: 0) **--run-timeout** -Single workflow run timeout (seconds) (default: 0) +Timeout (in seconds) of a single Workflow run. (default: 0) **--schedule-id** Alias: **-s** @@ -103,7 +103,7 @@ Overall schedule start time. **--task-queue** Alias: **-t** -Task queue +Task Queue **--task-timeout** Workflow task start to close timeout (seconds) (default: 10) @@ -112,24 +112,24 @@ Workflow task start to close timeout (seconds) (default: 10) Time zone (IANA name). **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--workflow-id** Alias: **-w** Workflow Id **--workflow-type** -Workflow type name +Workflow type name. diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md index 0579c109..131d04d1 100644 --- a/docs/schedule/delete.md +++ b/docs/schedule/delete.md @@ -2,7 +2,7 @@ id: delete title: temporal schedule delete sidebar_label: delete -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,46 +12,46 @@ tags: Deletes a schedule **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--schedule-id** Alias: **-s** Schedule Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 37f901ea..440cb370 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -2,7 +2,7 @@ id: describe title: temporal schedule describe sidebar_label: describe -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,32 +12,32 @@ tags: Get schedule configuration and current state **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--fields** customize fields to print. Set to 'long' to automatically print more of main fields **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--output** Alias: **-o** @@ -54,17 +54,17 @@ Schedule Id format time as: relative, iso, raw. (default: relative) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/schedule/index.md b/docs/schedule/index.md index 00855abc..4532e98b 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -1,8 +1,8 @@ --- -id: index.md +id: index title: temporal schedule sidebar_label: schedule -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -11,5 +11,5 @@ tags: Operations performed on Schedules. ->These commands allow Schedules to be created, used, and updated. +These commands allow Schedules to be created, used, and updated. diff --git a/docs/schedule/list.md b/docs/schedule/list.md index 0a829f71..771a2eb3 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -2,7 +2,7 @@ id: list title: temporal schedule list sidebar_label: list -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,35 +12,35 @@ tags: Lists schedules **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--fields** customize fields to print. Set to 'long' to automatically print more of main fields **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--limit** number of items to print (default: 0) **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** @@ -57,17 +57,17 @@ pager to use: less, more, favoritePager.. format time as: relative, iso, raw. (default: relative) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md index 6a39cc7b..fb6fa17f 100644 --- a/docs/schedule/toggle.md +++ b/docs/schedule/toggle.md @@ -2,7 +2,7 @@ id: toggle title: temporal schedule toggle sidebar_label: toggle -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,29 +12,29 @@ tags: Pauses or unpauses a schedule **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--pause** Pauses the schedule @@ -47,19 +47,19 @@ Alias: **-s** Schedule Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--unpause** Unpauses the schedule diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md index 18112a49..93ea0f83 100644 --- a/docs/schedule/trigger.md +++ b/docs/schedule/trigger.md @@ -2,7 +2,7 @@ id: trigger title: temporal schedule trigger sidebar_label: trigger -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,29 +12,29 @@ tags: Triggers an immediate action **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--overlap-policy** Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll @@ -44,17 +44,17 @@ Alias: **-s** Schedule Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/schedule/update.md b/docs/schedule/update.md index e0013e35..8c3a040d 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -2,7 +2,7 @@ id: update title: temporal schedule update sidebar_label: update -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,7 +12,7 @@ tags: Updates a schedule with a new definition (full replacement, not patch) **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--calendar** Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} @@ -21,16 +21,16 @@ Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5" Maximum allowed catch-up time if server is down **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--cron** Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" @@ -39,13 +39,13 @@ Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" Overall schedule end time. **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--execution-timeout** Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--input** Alias: **-i** @@ -71,7 +71,7 @@ Set a memo from a file. Each line should follow the format key=value. Use valid **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--notes** Initial value of notes field @@ -89,7 +89,7 @@ Pause schedule after any workflow failure Total number of actions allowed (default: 0) **--run-timeout** -Single workflow run timeout (seconds) (default: 0) +Timeout (in seconds) of a single Workflow run. (default: 0) **--schedule-id** Alias: **-s** @@ -103,7 +103,7 @@ Overall schedule start time. **--task-queue** Alias: **-t** -Task queue +Task Queue **--task-timeout** Workflow task start to close timeout (seconds) (default: 10) @@ -112,24 +112,24 @@ Workflow task start to close timeout (seconds) (default: 10) Time zone (IANA name). **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--workflow-id** Alias: **-w** Workflow Id **--workflow-type** -Workflow type name +Workflow type name. diff --git a/docs/server/index.md b/docs/server/index.md index 09300436..56980b3a 100644 --- a/docs/server/index.md +++ b/docs/server/index.md @@ -1,8 +1,8 @@ --- -id: index.md +id: index title: temporal server sidebar_label: server -description: words words words +description: Temporal CLI operation for .... tags: - cli --- diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index 7384373d..793403e3 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -2,7 +2,7 @@ id: start-dev title: temporal server start-dev sidebar_label: start-dev -description: words words words +description: Temporal CLI operation for .... tags: - cli --- diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index 904bde7f..35b50a5b 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -2,7 +2,7 @@ id: describe title: temporal task-queue describe sidebar_label: describe -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -20,32 +20,32 @@ Describes the Workers that have recently polled on this Task Queue RatePerSecond is the maximum Activities per second the Worker will execute. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--fields** customize fields to print. Set to 'long' to automatically print more of main fields **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--output** Alias: **-o** @@ -62,17 +62,17 @@ Task Queue type [workflow|activity] (default: workflow) format time as: relative, iso, raw. (default: relative) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/task-queue/index.md b/docs/task-queue/index.md index 47d8453a..bebb00d0 100644 --- a/docs/task-queue/index.md +++ b/docs/task-queue/index.md @@ -1,8 +1,8 @@ --- -id: index.md +id: index title: temporal task-queue sidebar_label: task-queue -description: words words words +description: Temporal CLI operation for .... tags: - cli --- diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index 60750cb8..73f22bc3 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -2,7 +2,7 @@ id: list-partition title: temporal task-queue list-partition sidebar_label: list-partition -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,29 +12,29 @@ tags: Lists the Task Queue's partitions and which matching node they are assigned to. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--output** Alias: **-o** @@ -45,17 +45,17 @@ Alias: **-t** Task Queue name. **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index 800a3484..04314ae8 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -2,7 +2,7 @@ id: cancel title: temporal workflow cancel sidebar_label: cancel -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -16,29 +16,29 @@ Cancel a Workflow Execution. After cancellation, the Workflow Execution can perform cleanup work,and a new command task will be scheduled. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--query** Alias: **-q** @@ -52,19 +52,19 @@ Alias: **-r** Run Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--workflow-id** Alias: **-w** diff --git a/docs/workflow/count.md b/docs/workflow/count.md index 348799cc..e9745ec3 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -2,7 +2,7 @@ id: count title: temporal workflow count sidebar_label: count -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,46 +12,46 @@ tags: Count Workflow Executions (requires ElasticSearch to be enabled). **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--query** Alias: **-q** Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index 8734e71c..00d8a8dc 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -2,7 +2,7 @@ id: delete title: temporal workflow delete sidebar_label: delete -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,48 +12,48 @@ tags: Deletes a Workflow Execution. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--run-id** Alias: **-r** Run Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--workflow-id** Alias: **-w** diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index 5b9e75fb..94f36fb0 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -2,7 +2,7 @@ id: describe title: temporal workflow describe sidebar_label: describe -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -11,32 +11,32 @@ tags: Show information about a Workflow Execution. ->This information can be used to locate a Workflow Execution that failed. +This information can be used to locate a Workflow Execution that failed. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--raw** Print properties as they are stored. @@ -49,19 +49,19 @@ Alias: **-r** Run Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--workflow-id** Alias: **-w** diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index 74b624c8..6a2aec73 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -2,7 +2,7 @@ id: execute title: temporal workflow execute sidebar_label: execute -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -11,22 +11,22 @@ tags: Start a new Workflow Execution and prints its progress. ->Single quotes('') are used to wrap input as JSON. +Single quotes('') are used to wrap input as JSON. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--cron** Optional cron schedule for the Workflow. Cron spec is as following: @@ -39,7 +39,7 @@ Optional cron schedule for the Workflow. Cron spec is as following: * * * * * **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--execution-timeout** Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) @@ -48,7 +48,7 @@ Workflow Execution timeout, including retries and continue-as-new (seconds) (def customize fields to print. Set to 'long' to automatically print more of main fields **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--id-reuse-policy** Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning @@ -74,7 +74,7 @@ Pass a memo from a file, where each line follows the format key=value. Use valid **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** @@ -88,14 +88,14 @@ format output as: table, json, card. (default: table) pager to use: less, more, favoritePager.. **--run-timeout** -Single workflow run timeout (seconds) (default: 0) +Timeout (in seconds) of a single Workflow run. (default: 0) **--search-attribute** Pass Search Attribute in a format key=value. Use valid JSON formats for value **--task-queue** Alias: **-t** -Task queue +Task Queue **--task-timeout** Workflow task start to close timeout (seconds) (default: 10) @@ -104,22 +104,22 @@ Workflow task start to close timeout (seconds) (default: 10) format time as: relative, iso, raw. (default: relative) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--type** -Workflow type name +Workflow type name. **--workflow-id** Alias: **-w** diff --git a/docs/workflow/index.md b/docs/workflow/index.md index 3b0f27a2..914acd32 100644 --- a/docs/workflow/index.md +++ b/docs/workflow/index.md @@ -1,8 +1,8 @@ --- -id: index.md +id: index title: temporal workflow sidebar_label: workflow -description: words words words +description: Temporal CLI operation for .... tags: - cli --- diff --git a/docs/workflow/list.md b/docs/workflow/list.md index 7562e055..c795dd78 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -2,7 +2,7 @@ id: list title: temporal workflow list sidebar_label: list -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -11,41 +11,41 @@ tags: List Workflow Executions based on a Query. ->By default, this command lists up to 10 closed Workflow Executions. +By default, this command lists up to 10 closed Workflow Executions. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--archived** List archived Workflow Executions (EXPERIMENTAL) **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--fields** customize fields to print. Set to 'long' to automatically print more of main fields **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--limit** number of items to print (default: 0) **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** @@ -66,17 +66,17 @@ Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/work format time as: relative, iso, raw. (default: relative) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. diff --git a/docs/workflow/query.md b/docs/workflow/query.md index ab3cbaf2..b958c206 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -2,7 +2,7 @@ id: query title: temporal workflow query sidebar_label: query -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -15,25 +15,25 @@ Query a Workflow Execution. Queries can also be used on completed Workflows. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--input** Alias: **-i** @@ -44,7 +44,7 @@ Optional input for the query from JSON file. If there are multiple JSON, concate **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--reject-condition** Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" @@ -54,19 +54,19 @@ Alias: **-r** Run Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--type** The query type you want to run. diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 7530c9df..1689a9cf 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -2,7 +2,7 @@ id: reset-batch title: temporal workflow reset-batch sidebar_label: reset-batch -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -11,34 +11,34 @@ tags: Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew ->Resetting a Workflow allows the process to resume from a certain point without losing your parameters or Event History. +Resetting a Workflow allows the process to resume from a certain point without losing your parameters or Event History. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--dry-run** Simulate reset without resetting any Workflow Executions. **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--exclude-file** Input file that specifies Workflow Executions to exclude from resetting. **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--input-file** Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id. @@ -51,7 +51,7 @@ Separator for the input file. The default is a tab ( ). (default: ) **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--non-deterministic** Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error. @@ -70,19 +70,19 @@ Skip a Workflow Execution if the base Run is not the current Run. Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run. **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--type** Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index b575ad71..1b8441d6 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -2,7 +2,7 @@ id: reset title: temporal workflow reset sidebar_label: reset -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -11,38 +11,38 @@ tags: Resets a Workflow Execution by Event Id or reset type. ->A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History. +A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--event-id** The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others. **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--reapply-type** -Event types to reapply after the reset point: , Signal, None. (default: All) +Event types to reapply after the reset point: Signal, None, . (default: All) **--reason** Reason to reset. @@ -52,19 +52,19 @@ Alias: **-r** Run Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--type** Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew diff --git a/docs/workflow/show.md b/docs/workflow/show.md index b89c2045..06532cf4 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -2,7 +2,7 @@ id: show title: temporal workflow show sidebar_label: show -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,42 +12,42 @@ tags: Show Event History for a Workflow Execution. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--fields** customize fields to print. Set to 'long' to automatically print more of main fields **--follow** Alias: **-f** -Follow the progress of Workflow Execution +Follow the progress of a Workflow Execution. **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--limit** number of items to print (default: 0) **--max-field-length** -Maximum length for each attribute field (default: 500) +Maximum length for each attribute field. (default: 500) **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** @@ -58,13 +58,13 @@ Alias: **-o** format output as: table, json, card. (default: table) **--output-filename** -Serialize history event to a file +Serializes Event History to a file. **--pager** pager to use: less, more, favoritePager.. **--reset-points** -Only show events that are eligible for reset +Only show Workflow Events that are eligible for reset. **--run-id** Alias: **-r** @@ -74,19 +74,19 @@ Run Id format time as: relative, iso, raw. (default: relative) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--workflow-id** Alias: **-w** diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index 0cb4b854..ab871dfe 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -2,7 +2,7 @@ id: signal title: temporal workflow signal sidebar_label: signal -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,25 +12,25 @@ tags: Signal Workflow Execution by Id or List Filter. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--input** Alias: **-i** @@ -44,7 +44,7 @@ Signal Name **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--query** Alias: **-q** @@ -58,19 +58,19 @@ Alias: **-r** Run Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--workflow-id** Alias: **-w** diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index 42e1effa..07ec2f7f 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -2,7 +2,7 @@ id: stack title: temporal workflow stack sidebar_label: stack -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,25 +12,25 @@ tags: Query a Workflow Execution with __stack_trace as the query type. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--input** Alias: **-i** @@ -41,7 +41,7 @@ Optional input for the query from JSON file. If there are multiple JSON, concate **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--reject-condition** Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" @@ -51,19 +51,19 @@ Alias: **-r** Run Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--workflow-id** Alias: **-w** diff --git a/docs/workflow/start.md b/docs/workflow/start.md index a5dbec95..822bf942 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -2,7 +2,7 @@ id: start title: temporal workflow start sidebar_label: start -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -11,22 +11,22 @@ tags: Starts a new Workflow Execution. ->When invoked successfully, the Workflow and Run Ids of the recently started Workflow are returned. +When invoked successfully, the Workflow and Run Ids of the recently started Workflow are returned. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--cron** Optional cron schedule for the Workflow. Cron spec is as following: @@ -39,7 +39,7 @@ Optional cron schedule for the Workflow. Cron spec is as following: * * * * * **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--execution-timeout** Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) @@ -48,7 +48,7 @@ Workflow Execution timeout, including retries and continue-as-new (seconds) (def customize fields to print. Set to 'long' to automatically print more of main fields **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--id-reuse-policy** Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning @@ -74,7 +74,7 @@ Pass a memo from a file, where each line follows the format key=value. Use valid **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** @@ -88,14 +88,14 @@ format output as: table, json, card. (default: table) pager to use: less, more, favoritePager.. **--run-timeout** -Single workflow run timeout (seconds) (default: 0) +Timeout (in seconds) of a single Workflow run. (default: 0) **--search-attribute** Pass Search Attribute in a format key=value. Use valid JSON formats for value **--task-queue** Alias: **-t** -Task queue +Task Queue **--task-timeout** Workflow task start to close timeout (seconds) (default: 10) @@ -104,22 +104,22 @@ Workflow task start to close timeout (seconds) (default: 10) format time as: relative, iso, raw. (default: relative) **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--type** -Workflow type name +Workflow type name. **--workflow-id** Alias: **-w** diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index cc6f69cd..50bf2cb4 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -2,7 +2,7 @@ id: terminate title: temporal workflow terminate sidebar_label: terminate -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -16,29 +16,29 @@ Terminate Workflow Execution by Id or List Filter. Any further command tasks cannot be scheduled after running `terminate`. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--query** Alias: **-q** @@ -52,19 +52,19 @@ Alias: **-r** Run Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--workflow-id** Alias: **-w** diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index c627e69e..faa1184c 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -2,7 +2,7 @@ id: trace title: temporal workflow trace sidebar_label: trace -description: words words words +description: Temporal CLI operation for .... tags: - cli --- @@ -12,13 +12,13 @@ tags: Trace progress of a Workflow Execution and its children. **--address** -host:port for Temporal frontend service +The host and port (formatted as host:port) for the Temporal Frontend Service. **--codec-auth** -Authorization header to set for requests to Codec Server +Sets the authorization header on requests to the Codec Server. **--codec-endpoint** -Remote Codec Server Endpoint +Endpoint for a remote Codec Server. **--color** when to use color: auto, always, never. (default: auto) @@ -27,23 +27,23 @@ when to use color: auto, always, never. (default: auto) Request concurrency (default: 10) **--context-timeout** -Optional timeout for context of RPC call in seconds (default: 5) +An optional timeout for the context of an RPC call (in seconds). (default: 5) **--depth** Number of Child Workflows to expand, -1 to expand all Child Workflows. (default: -1) **--env** -Env name to read the client environment variables from (default: default) +Name of the environment to read environmental variables from. (default: default) **--fold** Statuses for which Child Workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied. (default: completed,canceled,terminated) **--grpc-meta** -gRPC metadata to send with requests. Format: key=value. Use valid JSON formats for value +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--namespace** Alias: **-n** -Temporal workflow namespace (default: default) +Identifies a Namespace in the Temporal Workflow. (default: default) **--no-fold** Disable folding. All Child Workflows within the set depth will be fetched and displayed. @@ -53,19 +53,19 @@ Alias: **-r** Run Id **--tls-ca-path** -Path to server CA certificate +Path to server CA certificate. **--tls-cert-path** -Path to x509 certificate +Path to x509 certificate. **--tls-disable-host-verification** -Disable tls host name verification (tls must be enabled) +Disables TLS host name verification if already enabled. **--tls-key-path** -Path to private key +Path to private certificate key. **--tls-server-name** -Override for target server name +Provides an override for the target TLS server name. **--workflow-id** Alias: **-w** From 7e28a8365baa97fdcdc9bcafc94ec2cd05daeef3 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 19 Jan 2023 14:24:49 -0600 Subject: [PATCH 33/68] pre-demo commit --- common/flags.go | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/common/flags.go b/common/flags.go index 90bb0a64..ad05897e 100644 --- a/common/flags.go +++ b/common/flags.go @@ -89,7 +89,7 @@ var ( FlagQuery = "query" FlagQueryAlias = []string{"q"} FlagQueryRejectCondition = "reject-condition" - FlagQueryUsage = "Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details" + FlagQueryUsage = "Filter results using an SQL-like query. See [Queries](https://docs.temporal.io/docs/tctl/workflow/list#--query) for more information." FlagReason = "reason" FlagRemainingActions = "remaining-actions" FlagResetPointsOnly = "reset-points" @@ -329,29 +329,27 @@ var FlagsForStartWorkflowT = []cli.Flag{ }, &cli.StringFlag{ Name: FlagInputFile, - Usage: "Pass an optional input for the Workflow from a JSON file." + - " If there are multiple JSON files, concatenate them and separate by space or newline." + - " Input from the command line overwrites input from the file", + Usage: FlagInputFileDefinition, Category: CategoryMain, }, &cli.IntFlag{ Name: FlagMaxFieldLength, - Usage: "Maximum length for each attribute field", + Usage: FlagMaxFieldLengthDefinition, Category: CategoryMain, }, &cli.StringSliceFlag{ Name: FlagSearchAttribute, - Usage: "Pass Search Attribute in a format key=value. Use valid JSON formats for value", + Usage: FlagSearchAttributeDefinition, Category: CategoryMain, }, &cli.StringSliceFlag{ Name: FlagMemo, - Usage: "Pass a memo in a format key=value. Use valid JSON formats for value", + Usage: FlagMemoDefinition, Category: CategoryMain, }, &cli.StringFlag{ Name: FlagMemoFile, - Usage: "Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value", + Usage: FlagMemoFileDefinition, Category: CategoryMain, }, } @@ -365,7 +363,7 @@ var FlagsForWorkflowFiltering = []cli.Flag{ }, &cli.BoolFlag{ Name: FlagArchive, - Usage: "List archived Workflow Executions (EXPERIMENTAL)", + Usage: "List archived Workflow Executions.\nCurrently an experimental feature.", Category: CategoryMain, }, } @@ -374,18 +372,17 @@ var FlagsForStackTraceQuery = append(FlagsForExecution, []cli.Flag{ &cli.StringFlag{ Name: FlagInput, Aliases: FlagInputAlias, - Usage: "Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space", + Usage: FlagInputSTQDefinition, Category: CategoryMain, }, &cli.StringFlag{ Name: FlagInputFile, - Usage: "Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. " + - "Input from file will be overwrite by input from command line", + Usage: FlagInputFileSTQDefinition, Category: CategoryMain, }, &cli.StringFlag{ Name: FlagQueryRejectCondition, - Usage: "Optional flag to reject queries based on Workflow state. Valid values are \"not_open\" and \"not_completed_cleanly\"", + Usage: FlagQueryRejectConditionDefinition, Category: CategoryMain, }, }...) @@ -393,19 +390,19 @@ var FlagsForStackTraceQuery = append(FlagsForExecution, []cli.Flag{ var FlagsForPagination = []cli.Flag{ &cli.IntFlag{ Name: output.FlagLimit, - Usage: "number of items to print", + Usage: FlagLimitDefinition, Category: CategoryDisplay, }, &cli.StringFlag{ Name: pager.FlagPager, - Usage: "pager to use: less, more, favoritePager..", + Usage: FlagPagerDefinition, EnvVars: []string{"PAGER"}, Category: CategoryDisplay, }, &cli.BoolFlag{ Name: pager.FlagNoPager, Aliases: []string{"P"}, - Usage: "disable interactive pager", + Usage: FlagNoPagerDefinition, Category: CategoryDisplay, }, } @@ -420,13 +417,13 @@ var FlagsForFormatting = []cli.Flag{ }, &cli.StringFlag{ Name: format.FlagTimeFormat, - Usage: fmt.Sprintf("format time as: %v, %v, %v.", format.Relative, format.ISO, format.Raw), + Usage: fmt.Sprintf("Format time as: %v, %v, %v.", format.Relative, format.ISO, format.Raw), Value: string(format.Relative), Category: CategoryDisplay, }, &cli.StringFlag{ Name: output.FlagFields, - Usage: "customize fields to print. Set to 'long' to automatically print more of main fields", + Usage: "Customize fields to print. Set to 'long' to automatically print more of main fields.", Category: CategoryDisplay, }, } From fa30ed66d6f093f4966cc61737b89937202083a6 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 19 Jan 2023 14:24:56 -0600 Subject: [PATCH 34/68] links added --- common/defs-cmds.go | 75 +++++++++++++++---------------- common/defs-flags.go | 17 ++++++- docs/activity/complete.md | 2 +- docs/activity/fail.md | 2 +- docs/activity/index.md | 2 +- docs/batch/describe.md | 4 +- docs/batch/index.md | 10 ++--- docs/batch/list.md | 11 ++--- docs/env/index.md | 2 +- docs/operator/cluster.md | 13 +++--- docs/operator/index.md | 4 +- docs/operator/namespace.md | 2 +- docs/operator/search-attribute.md | 2 +- docs/schedule/create.md | 13 +++--- docs/schedule/describe.md | 4 +- docs/schedule/index.md | 4 +- docs/schedule/list.md | 11 ++--- docs/schedule/update.md | 13 +++--- docs/task-queue/describe.md | 10 ++--- docs/task-queue/index.md | 2 +- docs/task-queue/list-partition.md | 2 +- docs/workflow/cancel.md | 6 +-- docs/workflow/count.md | 2 +- docs/workflow/delete.md | 2 +- docs/workflow/describe.md | 2 +- docs/workflow/execute.md | 36 ++++++++------- docs/workflow/index.md | 2 +- docs/workflow/list.md | 18 ++++---- docs/workflow/query.md | 12 ++--- docs/workflow/reset-batch.md | 2 +- docs/workflow/reset.md | 6 +-- docs/workflow/show.md | 13 +++--- docs/workflow/signal.md | 2 +- docs/workflow/stack.md | 10 +++-- docs/workflow/start.md | 38 +++++++++------- docs/workflow/terminate.md | 6 +-- docs/workflow/trace.md | 2 +- 37 files changed, 201 insertions(+), 163 deletions(-) diff --git a/common/defs-cmds.go b/common/defs-cmds.go index c7615218..ede0f11a 100644 --- a/common/defs-cmds.go +++ b/common/defs-cmds.go @@ -1,68 +1,67 @@ package common -// TODO: add links to Temporal concepts after confirming the format won't screw with the command line const ( // Main command definitions - WorkflowDefinition = "Operations that can be performed on Workflows." - ActivityDefinition = "Operations that can be performed on Workflow Activities." - TaskQueueDefinition = "Operations performed on Task Queues." - ScheduleDefinition = "Operations performed on Schedules." - BatchDefinition = "Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs." - OperatorDefinition = "Operations on Temporal Server." - EnvDefinition = "Manage environmental configurations on Temporal Client." + WorkflowDefinition = "Operations that can be performed on [Workflows](https://docs.temporal.io/workflows)." + ActivityDefinition = "Operations that can be performed on Workflow [Activities](https://docs.temporal.io/activities)." + TaskQueueDefinition = "Operations performed on [Task Queues](https://docs.temporal.io/tasks/#task-queue)." + ScheduleDefinition = "Operations performed on [Schedules](https://docs.temporal.io/workflows/#schedule)." + BatchDefinition = "Operations performed on Batch jobs. Use [Workflows](https://docs.temporal.io/workflows) commands with --query flag to start batch jobs." + OperatorDefinition = "Operations performed on the [Temporal Server](https://docs.temporal.io/clusters/#temporal-server)." + EnvDefinition = "Manage environmental configurations on [Temporal Client](https://docs.temporal.io/temporal/#temporal-client)." // Workflow subcommand definitions - StartWorkflowDefinition = "Starts a new Workflow Execution." - StartWorkflowUsageText = "When invoked successfully, the Workflow and Run Ids of the recently started Workflow are returned." + StartWorkflowDefinition = "Starts a new [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution)." + StartWorkflowUsageText = "When invoked successfully, the Workflow and Run Ids of the recently started [Workflow](https://docs.temporal.io/workflows) are returned." - ExecuteWorkflowDefinition = "Start a new Workflow Execution and prints its progress." + ExecuteWorkflowDefinition = "Start a new [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) and prints its progress." ExecuteWorkflowUsageText = "Single quotes('') are used to wrap input as JSON." - DescribeWorkflowDefinition = "Show information about a Workflow Execution." + DescribeWorkflowDefinition = "Show information about a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution)." DescribeWorkflowUsageText = "This information can be used to locate a Workflow Execution that failed." - ListWorkflowDefinition = "List Workflow Executions based on a Query." + ListWorkflowDefinition = "List [Workflow Executions](https://docs.temporal.io/workflows/#workflow-execution) based on a [Query](https://docs.temporal.io/workflows/#query)." ListWorkflowUsageText = "By default, this command lists up to 10 closed Workflow Executions." - ShowWorkflowDefinition = "Show Event History for a Workflow Execution." + ShowWorkflowDefinition = "Show [Event History](https://docs.temporal.io/workflows/#event-history) for a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution)." - QueryWorkflowDefinition = "Query a Workflow Execution." - QueryWorkflowUsageText = "Queries can retrieve all or part of the Workflow state within given parameters.\nQueries can also be used on completed Workflows." + QueryWorkflowDefinition = "[Query](https://docs.temporal.io/workflows/#query) a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution)." + QueryWorkflowUsageText = "Queries can retrieve all or part of the Workflow state within given parameters.\nQueries can also be used on completed [Workflows](https://docs.temporal.io/workflows/)." - StackWorkflowDefinition = "Query a Workflow Execution with __stack_trace as the query type." - SignalWorkflowDefinition = "Signal Workflow Execution by Id or List Filter." + StackWorkflowDefinition = "Query a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) with [__stack_trace](https://docs.temporal.io/workflows/#stack-trace-query) as the query type." + SignalWorkflowDefinition = "Signal [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) by Id or [List Filter](https://docs.temporal.io/visibility/#list-filter)." CountWorkflowDefinition = "Count Workflow Executions (requires ElasticSearch to be enabled)." - CancelWorkflowDefinition = "Cancel a Workflow Execution." - CancelWorkflowUsageText = "Canceling a running Workflow Execution records a `WorkflowExecutionCancelRequested` event in the Event History.\n\nAfter cancellation, the Workflow Execution can perform cleanup work,and a new command task will be scheduled." + CancelWorkflowDefinition = "Cancel a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution)." + CancelWorkflowUsageText = "Canceling a running Workflow Execution records a [`WorkflowExecutionCancelRequested` event](https://docs.temporal.io/references/events/#workflowexecutioncanceled) in the [Event History](https://docs.temporal.io/workflows/#event-history).\n\nAfter cancellation, the Workflow Execution can perform cleanup work,and a new [Command](https://docs.temporal.io/workflows/#command) task will be scheduled." - TerminateWorkflowDefinition = "Terminate Workflow Execution by Id or List Filter." - TerminateWorkflowUsageText = "Terminating a running Workflow records a `WorkflowExecutionTerminated` event as the closing event.\n\nAny further command tasks cannot be scheduled after running `terminate`." + TerminateWorkflowDefinition = "Terminate [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) by Id or [List Filter](https://docs.temporal.io/visibility/#list-filter)." + TerminateWorkflowUsageText = "Terminating a running Workflow records a [`WorkflowExecutionTerminated` event](https://docs.temporal.io/references/events/#workflowexecutionterminated) as the closing event.\n\nAny further [Command](https://docs.temporal.io/workflows/#command) tasks cannot be scheduled after running `terminate`." - DeleteWorkflowDefinition = "Deletes a Workflow Execution." + DeleteWorkflowDefinition = "Deletes a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution)." - ResetWorkflowDefinition = "Resets a Workflow Execution by Event Id or reset type." - ResetWorkflowUsageText = "A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History." + ResetWorkflowDefinition = "Resets a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) by Event Id or reset type." + ResetWorkflowUsageText = "A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history)." - ResetBatchUsageText = "Resetting a Workflow allows the process to resume from a certain point without losing your parameters or Event History." + ResetBatchUsageText = "Resetting a Workflow allows the process to resume from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history)." - TraceWorkflowDefinition = "Trace progress of a Workflow Execution and its children." + TraceWorkflowDefinition = "Trace progress of a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) and its [children](https://docs.temporal.io/workflows/#child-workflow)." // Activity subcommand definitions - CompleteActivityDefinition = "Completes an Activity." - FailActivityDefinition = "Fails an Activity." + CompleteActivityDefinition = "Completes an [Activity](https://docs.temporal.io/activities)." + FailActivityDefinition = "Fails an [Activity](https://docs.temporal.io/activities)." // Task Queue subcommand definitions - DescribeTaskQueueDefinition = "Describes the Workers that have recently polled on this Task Queue" - DescribeTaskQueueUsageText = "The Server records the last time of each poll request.\n\nPoll requests can last up to a minute, so a LastAccessTime under a minute is normal.\nIf it's over a minute, then likely either the Worker is at capacity (all Workflow and Activity slots are full) or it has shut down.\nOnce it has been 5 minutes since the last poll request, the Worker is removed from the list.\n\nRatePerSecond is the maximum Activities per second the Worker will execute." + DescribeTaskQueueDefinition = "Describes the [Workers](https://docs.temporal.io/workers) that have recently polled on this [Task Queue](https://docs.temporal.io/tasks/#task-queue)" + DescribeTaskQueueUsageText = "The [Server](https://docs.temporal.io/clusters/#temporal-server) records the last time of each poll request.\n\nPoll requests can last up to a minute, so a LastAccessTime under a minute is normal.\nIf it's over a minute, then likely either the Worker is at capacity (all [Workflow](https://docs.temporal.io/workflows/) and [Activity](https://docs.temporal.io/activities) slots are full) or it has shut down.\nOnce it has been 5 minutes since the last poll request, the Worker is removed from the list.\n\nRatePerSecond is the maximum Activities per second the Worker will execute." - ListPartitionTaskQueueDefinition = "Lists the Task Queue's partitions and which matching node they are assigned to." + ListPartitionTaskQueueDefinition = "Lists the [Task Queue's](https://docs.temporal.io/tasks/#task-queue) partitions and which matching node they are assigned to." // Schedule subcommand definitions - ScheduleUsageText = "These commands allow Schedules to be created, used, and updated." + ScheduleUsageText = "These commands allow [Schedules](https://docs.temporal.io/workflows/#schedule) to be created, used, and updated." // Batch subcommand definitions - BatchUsageText = "Batch jobs run in the background and affect Workflow Executions one at a time.\n\nIn `cli`, the batch commands are used to view the status of Batch jobs, and to terminate them.\nA successfully started Batch job returns a Job Id, which is needed to execute batch commands.\n\nTerminating a batch job does not roll back the operations already performed by the job itself." + BatchUsageText = "Batch Jobs run in the background and affect [Workflow Executions](https://docs.temporal.io/workflows/#workflow-execution) one at a time.\n\nIn `cli`, the Batch Commands are used to view the status of Batch jobs, and to terminate them.\nA successfully started Batch job returns a Job Id, which is needed to execute Batch Commands.\n\nTerminating a Batch Job does not roll back the operations already performed by the job itself." DescribeBatchJobDefinition = "Describe a Batch operation job." DescribeBatchUsageText = "This command shows the progress of an ongoing Batch job." @@ -75,11 +74,11 @@ const ( // Operator subcommands and additional text - OperatorUsageText = "These commands enable operations on Namespaces, Search Attributes, and Temporal Clusters." + OperatorUsageText = "These commands enable operations on [Namespaces](https://docs.temporal.io/namespaces), [Search Attributes](https://docs.temporal.io/visibility#search-attribute), and [Temporal Clusters](https://docs.temporal.io/clusters)." - NamespaceDefinition = "Operations applying to Namespaces." - SearchAttributeDefinition = "Operations applying to Search Attributes." - ClusterDefinition = "Operations for running a Temporal Cluster." + NamespaceDefinition = "Operations applying to [Namespaces](https://docs.temporal.io/namespaces)." + SearchAttributeDefinition = "Operations applying to [Search Attributes](https://docs.temporal.io/visibility#search-attribute)." + ClusterDefinition = "Operations for running a [Temporal Cluster](https://docs.temporal.io/clusters)." // Namespace subcommand definitions DescribeNamespaceDefinition = "Describe a Namespace by its name or Id." diff --git a/common/defs-flags.go b/common/defs-flags.go index 4815610b..1f86102a 100644 --- a/common/defs-flags.go +++ b/common/defs-flags.go @@ -40,6 +40,21 @@ const ( "\t* * * * *" FlagWorkflowIdReusePolicyDefinition = "Allows the same Workflow Id to be used in a new Workflow Execution. " + "Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning." - FlagInputDefinition = "Optional JSON input to provide to the Workflow.\nPass Pass \"null\" for null values." + FlagInputDefinition = "Optional JSON input to provide to the Workflow.\nPass \"null\" for null values." + FlagInputFileDefinition = "Passes optional input for the Workflow from a JSON file.\n" + + "If there are multiple JSON files, concatenate them and separate by space or newline.\n" + + "Input from the command line will overwrite file input." + FlagSearchAttributeDefinition = "Passes Search Attribute in key=value format. Use valid JSON formats for value." + FlagMemoDefinition = "Passes a memo in key=value format. Use valid JSON formats for value." + FlagMemoFileDefinition = "Passes a memo as file input, with each line following key=value format. Use valid JSON formats for value." + // Stack trace query flag definitions + FlagInputSTQDefinition = "Optional query input, in JSON format. For multiple parameters, concatenate them and separate by space." + FlagInputFileSTQDefinition = "Passes optional Query input from a JSON file.\nIf there are multiple JSON, concatenate them and separate by space or newline.\n" + "Input from the command line will overwrite file input." + FlagQueryRejectConditionDefinition = "Optional flag for rejecting Queries based on Workflow state. Valid values are \"not_open\" and \"not_completed_cleanly\"." + + // Pagination flag definitions + FlagLimitDefinition = "Number of items to print." + FlagPagerDefinition = "Sets the pager for Temporal CLI to use.\nOptions: less, more, favoritePager." + FlagNoPagerDefinition = "Disables the interactive pager." ) \ No newline at end of file diff --git a/docs/activity/complete.md b/docs/activity/complete.md index 655cf7e4..92794786 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -9,7 +9,7 @@ tags: ### complete -Completes an Activity. +Completes an [Activity](https://docs.temporal.io/activities). **--activity-id** Identifies the Activity to be completed. diff --git a/docs/activity/fail.md b/docs/activity/fail.md index a5589afb..cd84f455 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -9,7 +9,7 @@ tags: ### fail -Fails an Activity. +Fails an [Activity](https://docs.temporal.io/activities). **--activity-id** Identifies the Activity to fail. diff --git a/docs/activity/index.md b/docs/activity/index.md index ff0a8834..bd7b84af 100644 --- a/docs/activity/index.md +++ b/docs/activity/index.md @@ -9,5 +9,5 @@ tags: ## activity -Operations that can be performed on Workflow Activities. +Operations that can be performed on Workflow [Activities](https://docs.temporal.io/activities). diff --git a/docs/batch/describe.md b/docs/batch/describe.md index 024f2934..ebb0fb37 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -32,7 +32,7 @@ An optional timeout for the context of an RPC call (in seconds). (default: 5) Name of the environment to read environmental variables from. (default: default) **--fields** -customize fields to print. Set to 'long' to automatically print more of main fields +Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. @@ -49,7 +49,7 @@ Alias: **-o** format output as: table, json, card. (default: table) **--time-format** -format time as: relative, iso, raw. (default: relative) +Format time as: relative, iso, raw. (default: relative) **--tls-ca-path** Path to server CA certificate. diff --git a/docs/batch/index.md b/docs/batch/index.md index cb7f0177..058b5f14 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -9,12 +9,12 @@ tags: ## batch -Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs. +Operations performed on Batch jobs. Use [Workflows](https://docs.temporal.io/workflows) commands with --query flag to start batch jobs. - Batch jobs run in the background and affect Workflow Executions one at a time. + Batch Jobs run in the background and affect [Workflow Executions](https://docs.temporal.io/workflows/#workflow-execution) one at a time. - In `cli`, the batch commands are used to view the status of Batch jobs, and to terminate them. - A successfully started Batch job returns a Job Id, which is needed to execute batch commands. + In `cli`, the Batch Commands are used to view the status of Batch jobs, and to terminate them. + A successfully started Batch job returns a Job Id, which is needed to execute Batch Commands. - Terminating a batch job does not roll back the operations already performed by the job itself. + Terminating a Batch Job does not roll back the operations already performed by the job itself. diff --git a/docs/batch/list.md b/docs/batch/list.md index 3e6735e9..b8ff884a 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -32,13 +32,13 @@ An optional timeout for the context of an RPC call (in seconds). (default: 5) Name of the environment to read environmental variables from. (default: default) **--fields** -customize fields to print. Set to 'long' to automatically print more of main fields +Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--limit** -number of items to print (default: 0) +Number of items to print. (default: 0) **--namespace** Alias: **-n** @@ -46,17 +46,18 @@ Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** -disable interactive pager +Disables the interactive pager. **--output** Alias: **-o** format output as: table, json, card. (default: table) **--pager** -pager to use: less, more, favoritePager.. +Sets the pager for Temporal CLI to use. +Options: less, more, favoritePager. **--time-format** -format time as: relative, iso, raw. (default: relative) +Format time as: relative, iso, raw. (default: relative) **--tls-ca-path** Path to server CA certificate. diff --git a/docs/env/index.md b/docs/env/index.md index 54a8408a..c4ddc50b 100644 --- a/docs/env/index.md +++ b/docs/env/index.md @@ -9,5 +9,5 @@ tags: ## env -Manage environmental configurations on Temporal Client. +Manage environmental configurations on [Temporal Client](https://docs.temporal.io/temporal/#temporal-client). diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index 714d9323..9187631d 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -9,7 +9,7 @@ tags: ### cluster -Operations for running a Temporal Cluster. +Operations for running a [Temporal Cluster](https://docs.temporal.io/clusters). #### health @@ -230,13 +230,13 @@ An optional timeout for the context of an RPC call (in seconds). (default: 5) Name of the environment to read environmental variables from. (default: default) **--fields** -customize fields to print. Set to 'long' to automatically print more of main fields +Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--limit** -number of items to print (default: 0) +Number of items to print. (default: 0) **--namespace** Alias: **-n** @@ -244,17 +244,18 @@ Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** -disable interactive pager +Disables the interactive pager. **--output** Alias: **-o** format output as: table, json, card. (default: table) **--pager** -pager to use: less, more, favoritePager.. +Sets the pager for Temporal CLI to use. +Options: less, more, favoritePager. **--time-format** -format time as: relative, iso, raw. (default: relative) +Format time as: relative, iso, raw. (default: relative) **--tls-ca-path** Path to server CA certificate. diff --git a/docs/operator/index.md b/docs/operator/index.md index 4f48eb5f..60ef1548 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -9,7 +9,7 @@ tags: ## operator -Operations on Temporal Server. +Operations performed on the [Temporal Server](https://docs.temporal.io/clusters/#temporal-server). -These commands enable operations on Namespaces, Search Attributes, and Temporal Clusters. +These commands enable operations on [Namespaces](https://docs.temporal.io/namespaces), [Search Attributes](https://docs.temporal.io/visibility#search-attribute), and [Temporal Clusters](https://docs.temporal.io/clusters). diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index 7ba0564a..fc29184d 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -9,7 +9,7 @@ tags: ### namespace -Operations applying to Namespaces. +Operations applying to [Namespaces](https://docs.temporal.io/namespaces). #### describe diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index bf8077db..e7e8c526 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -9,7 +9,7 @@ tags: ### search-attribute -Operations applying to Search Attributes. +Operations applying to [Search Attributes](https://docs.temporal.io/visibility#search-attribute). #### create diff --git a/docs/schedule/create.md b/docs/schedule/create.md index 03b96c6d..5c748286 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -42,17 +42,20 @@ Overall schedule end time. Name of the environment to read environmental variables from. (default: default) **--execution-timeout** -Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) +Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) **--grpc-meta** Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--input** Alias: **-i** -Optional input for the Workflow in JSON format. Pass "null" for null values +Optional JSON input to provide to the Workflow. +Pass "null" for null values. **--input-file** -Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file +Passes optional input for the Workflow from a JSON file. +If there are multiple JSON files, concatenate them and separate by space or newline. +Input from the command line will overwrite file input. **--interval** Interval duration, e.g. 90m, or 90m/13m to include phase offset. @@ -61,7 +64,7 @@ Interval duration, e.g. 90m, or 90m/13m to include phase offset. Jitter duration. **--max-field-length** -Maximum length for each attribute field (default: 0) +Maximum length for each attribute field. (default: 0) **--memo** Set a memo on a schedule. Format: key=value. Use valid JSON formats for value @@ -106,7 +109,7 @@ Alias: **-t** Task Queue **--task-timeout** -Workflow task start to close timeout (seconds) (default: 10) +Start-to-close timeout for a Workflow Task (in seconds). (default: 10) **--time-zone** Time zone (IANA name). diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 440cb370..699430f0 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -30,7 +30,7 @@ An optional timeout for the context of an RPC call (in seconds). (default: 5) Name of the environment to read environmental variables from. (default: default) **--fields** -customize fields to print. Set to 'long' to automatically print more of main fields +Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. @@ -51,7 +51,7 @@ Alias: **-s** Schedule Id **--time-format** -format time as: relative, iso, raw. (default: relative) +Format time as: relative, iso, raw. (default: relative) **--tls-ca-path** Path to server CA certificate. diff --git a/docs/schedule/index.md b/docs/schedule/index.md index 4532e98b..1439908b 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -9,7 +9,7 @@ tags: ## schedule -Operations performed on Schedules. +Operations performed on [Schedules](https://docs.temporal.io/workflows/#schedule). -These commands allow Schedules to be created, used, and updated. +These commands allow [Schedules](https://docs.temporal.io/workflows/#schedule) to be created, used, and updated. diff --git a/docs/schedule/list.md b/docs/schedule/list.md index 771a2eb3..e7d72796 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -30,13 +30,13 @@ An optional timeout for the context of an RPC call (in seconds). (default: 5) Name of the environment to read environmental variables from. (default: default) **--fields** -customize fields to print. Set to 'long' to automatically print more of main fields +Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--limit** -number of items to print (default: 0) +Number of items to print. (default: 0) **--namespace** Alias: **-n** @@ -44,17 +44,18 @@ Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** -disable interactive pager +Disables the interactive pager. **--output** Alias: **-o** format output as: table, json, card. (default: table) **--pager** -pager to use: less, more, favoritePager.. +Sets the pager for Temporal CLI to use. +Options: less, more, favoritePager. **--time-format** -format time as: relative, iso, raw. (default: relative) +Format time as: relative, iso, raw. (default: relative) **--tls-ca-path** Path to server CA certificate. diff --git a/docs/schedule/update.md b/docs/schedule/update.md index 8c3a040d..6009067b 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -42,17 +42,20 @@ Overall schedule end time. Name of the environment to read environmental variables from. (default: default) **--execution-timeout** -Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) +Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) **--grpc-meta** Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--input** Alias: **-i** -Optional input for the Workflow in JSON format. Pass "null" for null values +Optional JSON input to provide to the Workflow. +Pass "null" for null values. **--input-file** -Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file +Passes optional input for the Workflow from a JSON file. +If there are multiple JSON files, concatenate them and separate by space or newline. +Input from the command line will overwrite file input. **--interval** Interval duration, e.g. 90m, or 90m/13m to include phase offset. @@ -61,7 +64,7 @@ Interval duration, e.g. 90m, or 90m/13m to include phase offset. Jitter duration. **--max-field-length** -Maximum length for each attribute field (default: 0) +Maximum length for each attribute field. (default: 0) **--memo** Set a memo on a schedule. Format: key=value. Use valid JSON formats for value @@ -106,7 +109,7 @@ Alias: **-t** Task Queue **--task-timeout** -Workflow task start to close timeout (seconds) (default: 10) +Start-to-close timeout for a Workflow Task (in seconds). (default: 10) **--time-zone** Time zone (IANA name). diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index 35b50a5b..0bc60c81 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -9,12 +9,12 @@ tags: ### describe -Describes the Workers that have recently polled on this Task Queue +Describes the [Workers](https://docs.temporal.io/workers) that have recently polled on this [Task Queue](https://docs.temporal.io/tasks/#task-queue) - The Server records the last time of each poll request. + The [Server](https://docs.temporal.io/clusters/#temporal-server) records the last time of each poll request. Poll requests can last up to a minute, so a LastAccessTime under a minute is normal. - If it's over a minute, then likely either the Worker is at capacity (all Workflow and Activity slots are full) or it has shut down. + If it's over a minute, then likely either the Worker is at capacity (all [Workflow](https://docs.temporal.io/workflows/) and [Activity](https://docs.temporal.io/activities) slots are full) or it has shut down. Once it has been 5 minutes since the last poll request, the Worker is removed from the list. RatePerSecond is the maximum Activities per second the Worker will execute. @@ -38,7 +38,7 @@ An optional timeout for the context of an RPC call (in seconds). (default: 5) Name of the environment to read environmental variables from. (default: default) **--fields** -customize fields to print. Set to 'long' to automatically print more of main fields +Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. @@ -59,7 +59,7 @@ Task Queue name. Task Queue type [workflow|activity] (default: workflow) **--time-format** -format time as: relative, iso, raw. (default: relative) +Format time as: relative, iso, raw. (default: relative) **--tls-ca-path** Path to server CA certificate. diff --git a/docs/task-queue/index.md b/docs/task-queue/index.md index bebb00d0..b2d9c402 100644 --- a/docs/task-queue/index.md +++ b/docs/task-queue/index.md @@ -9,5 +9,5 @@ tags: ## task-queue -Operations performed on Task Queues. +Operations performed on [Task Queues](https://docs.temporal.io/tasks/#task-queue). diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index 73f22bc3..d84a11cc 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -9,7 +9,7 @@ tags: ### list-partition -Lists the Task Queue's partitions and which matching node they are assigned to. +Lists the [Task Queue's](https://docs.temporal.io/tasks/#task-queue) partitions and which matching node they are assigned to. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index 04314ae8..347eecf7 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -9,11 +9,11 @@ tags: ### cancel -Cancel a Workflow Execution. +Cancel a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution). - Canceling a running Workflow Execution records a `WorkflowExecutionCancelRequested` event in the Event History. + Canceling a running Workflow Execution records a [`WorkflowExecutionCancelRequested` event](https://docs.temporal.io/references/events/#workflowexecutioncanceled) in the [Event History](https://docs.temporal.io/workflows/#event-history). - After cancellation, the Workflow Execution can perform cleanup work,and a new command task will be scheduled. + After cancellation, the Workflow Execution can perform cleanup work,and a new [Command](https://docs.temporal.io/workflows/#command) task will be scheduled. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/count.md b/docs/workflow/count.md index e9745ec3..43b32f49 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -38,7 +38,7 @@ Identifies a Namespace in the Temporal Workflow. (default: default) **--query** Alias: **-q** -Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details +Filter results using an SQL-like query. See [Queries](https://docs.temporal.io/docs/tctl/workflow/list#--query) for more information. **--tls-ca-path** Path to server CA certificate. diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index 00d8a8dc..dc0e2b75 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -9,7 +9,7 @@ tags: ### delete -Deletes a Workflow Execution. +Deletes a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution). **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index 94f36fb0..1f5ebcd5 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -9,7 +9,7 @@ tags: ### describe -Show information about a Workflow Execution. +Show information about a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution). This information can be used to locate a Workflow Execution that failed. diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index 6a2aec73..118c0219 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -9,7 +9,7 @@ tags: ### execute -Start a new Workflow Execution and prints its progress. +Start a new [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) and prints its progress. Single quotes('') are used to wrap input as JSON. @@ -29,7 +29,7 @@ when to use color: auto, always, never. (default: auto) An optional timeout for the context of an RPC call (in seconds). (default: 5) **--cron** -Optional cron schedule for the Workflow. Cron spec is as following: +Optional Cron Schedule for the Workflow. Cron spec is formatted as: ┌───────────── minute (0 - 59) │ ┌───────────── hour (0 - 23) │ │ ┌───────────── day of the month (1 - 31) @@ -42,35 +42,38 @@ Optional cron schedule for the Workflow. Cron spec is as following: Name of the environment to read environmental variables from. (default: default) **--execution-timeout** -Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) +Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) **--fields** -customize fields to print. Set to 'long' to automatically print more of main fields +Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--id-reuse-policy** -Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning +Allows the same Workflow Id to be used in a new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. **--input** Alias: **-i** -Optional input for the Workflow in JSON format. Pass "null" for null values +Optional JSON input to provide to the Workflow. +Pass "null" for null values. **--input-file** -Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file +Passes optional input for the Workflow from a JSON file. +If there are multiple JSON files, concatenate them and separate by space or newline. +Input from the command line will overwrite file input. **--limit** -number of items to print (default: 0) +Number of items to print. (default: 0) **--max-field-length** -Maximum length for each attribute field (default: 0) +Maximum length for each attribute field. (default: 0) **--memo** -Pass a memo in a format key=value. Use valid JSON formats for value +Passes a memo in key=value format. Use valid JSON formats for value. **--memo-file** -Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value +Passes a memo as file input, with each line following key=value format. Use valid JSON formats for value. **--namespace** Alias: **-n** @@ -78,30 +81,31 @@ Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** -disable interactive pager +Disables the interactive pager. **--output** Alias: **-o** format output as: table, json, card. (default: table) **--pager** -pager to use: less, more, favoritePager.. +Sets the pager for Temporal CLI to use. +Options: less, more, favoritePager. **--run-timeout** Timeout (in seconds) of a single Workflow run. (default: 0) **--search-attribute** -Pass Search Attribute in a format key=value. Use valid JSON formats for value +Passes Search Attribute in key=value format. Use valid JSON formats for value. **--task-queue** Alias: **-t** Task Queue **--task-timeout** -Workflow task start to close timeout (seconds) (default: 10) +Start-to-close timeout for a Workflow Task (in seconds). (default: 10) **--time-format** -format time as: relative, iso, raw. (default: relative) +Format time as: relative, iso, raw. (default: relative) **--tls-ca-path** Path to server CA certificate. diff --git a/docs/workflow/index.md b/docs/workflow/index.md index 914acd32..b593822f 100644 --- a/docs/workflow/index.md +++ b/docs/workflow/index.md @@ -9,5 +9,5 @@ tags: ## workflow -Operations that can be performed on Workflows. +Operations that can be performed on [Workflows](https://docs.temporal.io/workflows). diff --git a/docs/workflow/list.md b/docs/workflow/list.md index c795dd78..45a5cafc 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -9,7 +9,7 @@ tags: ### list -List Workflow Executions based on a Query. +List [Workflow Executions](https://docs.temporal.io/workflows/#workflow-execution) based on a [Query](https://docs.temporal.io/workflows/#query). By default, this command lists up to 10 closed Workflow Executions. @@ -17,7 +17,8 @@ By default, this command lists up to 10 closed Workflow Executions. The host and port (formatted as host:port) for the Temporal Frontend Service. **--archived** -List archived Workflow Executions (EXPERIMENTAL) +List archived Workflow Executions. +Currently an experimental feature. **--codec-auth** Sets the authorization header on requests to the Codec Server. @@ -35,13 +36,13 @@ An optional timeout for the context of an RPC call (in seconds). (default: 5) Name of the environment to read environmental variables from. (default: default) **--fields** -customize fields to print. Set to 'long' to automatically print more of main fields +Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--limit** -number of items to print (default: 0) +Number of items to print. (default: 0) **--namespace** Alias: **-n** @@ -49,21 +50,22 @@ Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** -disable interactive pager +Disables the interactive pager. **--output** Alias: **-o** format output as: table, json, card. (default: table) **--pager** -pager to use: less, more, favoritePager.. +Sets the pager for Temporal CLI to use. +Options: less, more, favoritePager. **--query** Alias: **-q** -Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details +Filter results using an SQL-like query. See [Queries](https://docs.temporal.io/docs/tctl/workflow/list#--query) for more information. **--time-format** -format time as: relative, iso, raw. (default: relative) +Format time as: relative, iso, raw. (default: relative) **--tls-ca-path** Path to server CA certificate. diff --git a/docs/workflow/query.md b/docs/workflow/query.md index b958c206..2e166cd2 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -9,10 +9,10 @@ tags: ### query -Query a Workflow Execution. +[Query](https://docs.temporal.io/workflows/#query) a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution). Queries can retrieve all or part of the Workflow state within given parameters. - Queries can also be used on completed Workflows. + Queries can also be used on completed [Workflows](https://docs.temporal.io/workflows/). **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -37,17 +37,19 @@ Contains gRPC metadata to send with requests (Format: key=value). Values must be **--input** Alias: **-i** -Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space +Optional query input, in JSON format. For multiple parameters, concatenate them and separate by space. **--input-file** -Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line +Passes optional Query input from a JSON file. +If there are multiple JSON, concatenate them and separate by space or newline. +Input from the command line will overwrite file input. **--namespace** Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--reject-condition** -Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" +Optional flag for rejecting Queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly". **--run-id** Alias: **-r** diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 1689a9cf..a81fe6a8 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -11,7 +11,7 @@ tags: Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew -Resetting a Workflow allows the process to resume from a certain point without losing your parameters or Event History. +Resetting a Workflow allows the process to resume from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history). **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 1b8441d6..1ec4d2e3 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -9,9 +9,9 @@ tags: ### reset -Resets a Workflow Execution by Event Id or reset type. +Resets a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) by Event Id or reset type. -A reset allows the Workflow to be resumed from a certain point without losing your parameters or Event History. +A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history). **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -42,7 +42,7 @@ Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--reapply-type** -Event types to reapply after the reset point: Signal, None, . (default: All) +Event types to reapply after the reset point: , Signal, None. (default: All) **--reason** Reason to reset. diff --git a/docs/workflow/show.md b/docs/workflow/show.md index 06532cf4..1e598eef 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -9,7 +9,7 @@ tags: ### show -Show Event History for a Workflow Execution. +Show [Event History](https://docs.temporal.io/workflows/#event-history) for a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution). **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -30,7 +30,7 @@ An optional timeout for the context of an RPC call (in seconds). (default: 5) Name of the environment to read environmental variables from. (default: default) **--fields** -customize fields to print. Set to 'long' to automatically print more of main fields +Customize fields to print. Set to 'long' to automatically print more of main fields. **--follow** Alias: **-f** @@ -40,7 +40,7 @@ Follow the progress of a Workflow Execution. Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--limit** -number of items to print (default: 0) +Number of items to print. (default: 0) **--max-field-length** Maximum length for each attribute field. (default: 500) @@ -51,7 +51,7 @@ Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** -disable interactive pager +Disables the interactive pager. **--output** Alias: **-o** @@ -61,7 +61,8 @@ format output as: table, json, card. (default: table) Serializes Event History to a file. **--pager** -pager to use: less, more, favoritePager.. +Sets the pager for Temporal CLI to use. +Options: less, more, favoritePager. **--reset-points** Only show Workflow Events that are eligible for reset. @@ -71,7 +72,7 @@ Alias: **-r** Run Id **--time-format** -format time as: relative, iso, raw. (default: relative) +Format time as: relative, iso, raw. (default: relative) **--tls-ca-path** Path to server CA certificate. diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index ab871dfe..26c92323 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -9,7 +9,7 @@ tags: ### signal -Signal Workflow Execution by Id or List Filter. +Signal [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) by Id or [List Filter](https://docs.temporal.io/visibility/#list-filter). **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index 07ec2f7f..0dc40d68 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -9,7 +9,7 @@ tags: ### stack -Query a Workflow Execution with __stack_trace as the query type. +Query a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) with [__stack_trace](https://docs.temporal.io/workflows/#stack-trace-query) as the query type. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -34,17 +34,19 @@ Contains gRPC metadata to send with requests (Format: key=value). Values must be **--input** Alias: **-i** -Optional input for the query, in JSON format. If there are multiple parameters, concatenate them and separate by space +Optional query input, in JSON format. For multiple parameters, concatenate them and separate by space. **--input-file** -Optional input for the query from JSON file. If there are multiple JSON, concatenate them and separate by space or newline. Input from file will be overwrite by input from command line +Passes optional Query input from a JSON file. +If there are multiple JSON, concatenate them and separate by space or newline. +Input from the command line will overwrite file input. **--namespace** Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--reject-condition** -Optional flag to reject queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly" +Optional flag for rejecting Queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly". **--run-id** Alias: **-r** diff --git a/docs/workflow/start.md b/docs/workflow/start.md index 822bf942..c7d59c58 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -9,9 +9,9 @@ tags: ### start -Starts a new Workflow Execution. +Starts a new [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution). -When invoked successfully, the Workflow and Run Ids of the recently started Workflow are returned. +When invoked successfully, the Workflow and Run Ids of the recently started [Workflow](https://docs.temporal.io/workflows) are returned. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -29,7 +29,7 @@ when to use color: auto, always, never. (default: auto) An optional timeout for the context of an RPC call (in seconds). (default: 5) **--cron** -Optional cron schedule for the Workflow. Cron spec is as following: +Optional Cron Schedule for the Workflow. Cron spec is formatted as: ┌───────────── minute (0 - 59) │ ┌───────────── hour (0 - 23) │ │ ┌───────────── day of the month (1 - 31) @@ -42,35 +42,38 @@ Optional cron schedule for the Workflow. Cron spec is as following: Name of the environment to read environmental variables from. (default: default) **--execution-timeout** -Workflow Execution timeout, including retries and continue-as-new (seconds) (default: 0) +Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) **--fields** -customize fields to print. Set to 'long' to automatically print more of main fields +Customize fields to print. Set to 'long' to automatically print more of main fields. **--grpc-meta** Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. **--id-reuse-policy** -Configure if the same Workflow Id is allowed for use in new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning +Allows the same Workflow Id to be used in a new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. **--input** Alias: **-i** -Optional input for the Workflow in JSON format. Pass "null" for null values +Optional JSON input to provide to the Workflow. +Pass "null" for null values. **--input-file** -Pass an optional input for the Workflow from a JSON file. If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line overwrites input from the file +Passes optional input for the Workflow from a JSON file. +If there are multiple JSON files, concatenate them and separate by space or newline. +Input from the command line will overwrite file input. **--limit** -number of items to print (default: 0) +Number of items to print. (default: 0) **--max-field-length** -Maximum length for each attribute field (default: 0) +Maximum length for each attribute field. (default: 0) **--memo** -Pass a memo in a format key=value. Use valid JSON formats for value +Passes a memo in key=value format. Use valid JSON formats for value. **--memo-file** -Pass a memo from a file, where each line follows the format key=value. Use valid JSON formats for value +Passes a memo as file input, with each line following key=value format. Use valid JSON formats for value. **--namespace** Alias: **-n** @@ -78,30 +81,31 @@ Identifies a Namespace in the Temporal Workflow. (default: default) **--no-pager** Alias: **-P** -disable interactive pager +Disables the interactive pager. **--output** Alias: **-o** format output as: table, json, card. (default: table) **--pager** -pager to use: less, more, favoritePager.. +Sets the pager for Temporal CLI to use. +Options: less, more, favoritePager. **--run-timeout** Timeout (in seconds) of a single Workflow run. (default: 0) **--search-attribute** -Pass Search Attribute in a format key=value. Use valid JSON formats for value +Passes Search Attribute in key=value format. Use valid JSON formats for value. **--task-queue** Alias: **-t** Task Queue **--task-timeout** -Workflow task start to close timeout (seconds) (default: 10) +Start-to-close timeout for a Workflow Task (in seconds). (default: 10) **--time-format** -format time as: relative, iso, raw. (default: relative) +Format time as: relative, iso, raw. (default: relative) **--tls-ca-path** Path to server CA certificate. diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index 50bf2cb4..2380b874 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -9,11 +9,11 @@ tags: ### terminate -Terminate Workflow Execution by Id or List Filter. +Terminate [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) by Id or [List Filter](https://docs.temporal.io/visibility/#list-filter). - Terminating a running Workflow records a `WorkflowExecutionTerminated` event as the closing event. + Terminating a running Workflow records a [`WorkflowExecutionTerminated` event](https://docs.temporal.io/references/events/#workflowexecutionterminated) as the closing event. - Any further command tasks cannot be scheduled after running `terminate`. + Any further [Command](https://docs.temporal.io/workflows/#command) tasks cannot be scheduled after running `terminate`. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index faa1184c..9f67368b 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -9,7 +9,7 @@ tags: ### trace -Trace progress of a Workflow Execution and its children. +Trace progress of a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) and its [children](https://docs.temporal.io/workflows/#child-workflow). **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. From d56b1ae89a4037d9d8f2d05c07234101562e4014 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 19 Jan 2023 15:52:08 -0600 Subject: [PATCH 35/68] retooling descriptions --- cmd/doc/main.go | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 9acafd64..96959ddc 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -23,7 +23,7 @@ const FrontMatterTemplate = id: {{.ID}} title: temporal {{.Title}}{{if not .IsIndex}} {{.ID}}{{end}} sidebar_label:{{if .IsIndex}} {{.Title}}{{else}} {{.ID}}{{end}} -description: Temporal CLI operation for .... +description: {{.Description}} tags: - cli --- @@ -33,6 +33,7 @@ tags: type FMStruct struct { ID string Title string + Description string IsIndex bool } @@ -52,8 +53,14 @@ func main() { if err != nil { log.Fatalf("Error when trying to open %s file: %v", cliFile, err) } + var pos int64 scanner := bufio.NewScanner(readFile) - scanner.Split(bufio.ScanLines) + scanLines := func(data []byte, atEOF bool) (advance int, token []byte, err error) { + advance, token, err = bufio.ScanLines(data, atEOF) + pos += int64(advance) + return + } + scanner.Split(scanLines) var currentHeader string var currentHeaderFile *os.File @@ -79,9 +86,9 @@ func main() { continue } createdFiles[headerIndexFile] = currentHeaderFile - - writeFrontMatter(strings.Trim(indexFile, ".md"), currentHeader, true, currentHeaderFile) - writeLine(currentHeaderFile, line) + // get next line for description text + + writeFrontMatter(strings.Trim(indexFile, ".md"), currentHeader, "nextLine", true, currentHeaderFile) } else if strings.HasPrefix(line, "### ") { path := filepath.Join(docsPath, currentHeader) @@ -98,7 +105,7 @@ func main() { } createdFiles[filePath] = currentHeaderFile } - writeFrontMatter(fileName, currentHeader, false, currentHeaderFile) + writeFrontMatter(fileName, currentHeader, scanner.Text(), false,currentHeaderFile) writeLine(currentHeaderFile, line) } else if strings.HasPrefix(line, "**--") { // split into term and definition @@ -107,6 +114,8 @@ func main() { // write to file term = strings.TrimSuffix(term, "=\"\"") + // TODO: make files and separate directory and reference THAT + if strings.Contains(term, ",") { makeAlias(currentHeaderFile, term) } else { @@ -115,7 +124,7 @@ func main() { writeLine(currentHeaderFile, strings.TrimSpace(definition)) log.Info(found) - } else if strings.HasPrefix(line, ">") { + } else if strings.Contains(line, ">") { writeLine(currentHeaderFile, strings.Trim(line, ">")) } else { writeLine(currentHeaderFile, line) @@ -142,11 +151,12 @@ func makeAlias(file *os.File, line string) { } // write front matter -func writeFrontMatter (idName string, titleName string, isIndex bool, currentHeaderFile *os.File) { +func writeFrontMatter (idName string, titleName string, descriptionTxt string, isIndex bool, currentHeaderFile *os.File) { // make struct to pass into the template data := FMStruct{ ID: idName, Title: titleName, + Description: descriptionTxt, IsIndex: isIndex, } From 15698f6146cc44e9d86b65a2833aaf41db2bccc4 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 19 Jan 2023 15:52:11 -0600 Subject: [PATCH 36/68] links --- common/defs-cmds.go | 70 ++++++++++++++++++------------- common/flags.go | 2 +- docs/activity/complete.md | 4 +- docs/activity/fail.md | 4 +- docs/activity/index.md | 5 +-- docs/batch/describe.md | 2 +- docs/batch/index.md | 5 +-- docs/batch/list.md | 2 +- docs/batch/terminate.md | 2 +- docs/completion/bash.md | 2 +- docs/completion/index.md | 3 +- docs/completion/zsh.md | 2 +- docs/env/delete.md | 4 +- docs/env/get.md | 2 +- docs/env/index.md | 5 +-- docs/env/set.md | 2 +- docs/operator/cluster.md | 4 +- docs/operator/index.md | 5 +-- docs/operator/namespace.md | 4 +- docs/operator/search-attribute.md | 4 +- docs/schedule/backfill.md | 2 +- docs/schedule/create.md | 2 +- docs/schedule/delete.md | 2 +- docs/schedule/describe.md | 2 +- docs/schedule/index.md | 5 +-- docs/schedule/list.md | 2 +- docs/schedule/toggle.md | 2 +- docs/schedule/trigger.md | 2 +- docs/schedule/update.md | 2 +- docs/server/index.md | 3 +- docs/server/start-dev.md | 2 +- docs/task-queue/describe.md | 4 +- docs/task-queue/index.md | 5 +-- docs/task-queue/list-partition.md | 2 +- docs/workflow/cancel.md | 4 +- docs/workflow/count.md | 4 +- docs/workflow/delete.md | 4 +- docs/workflow/describe.md | 4 +- docs/workflow/execute.md | 4 +- docs/workflow/index.md | 5 +-- docs/workflow/list.md | 6 +-- docs/workflow/query.md | 4 +- docs/workflow/reset-batch.md | 4 +- docs/workflow/reset.md | 4 +- docs/workflow/show.md | 4 +- docs/workflow/signal.md | 4 +- docs/workflow/stack.md | 4 +- docs/workflow/start.md | 4 +- docs/workflow/terminate.md | 4 +- docs/workflow/trace.md | 4 +- 50 files changed, 121 insertions(+), 116 deletions(-) diff --git a/common/defs-cmds.go b/common/defs-cmds.go index ede0f11a..0bed105c 100644 --- a/common/defs-cmds.go +++ b/common/defs-cmds.go @@ -2,83 +2,97 @@ package common const ( // Main command definitions - WorkflowDefinition = "Operations that can be performed on [Workflows](https://docs.temporal.io/workflows)." - ActivityDefinition = "Operations that can be performed on Workflow [Activities](https://docs.temporal.io/activities)." - TaskQueueDefinition = "Operations performed on [Task Queues](https://docs.temporal.io/tasks/#task-queue)." - ScheduleDefinition = "Operations performed on [Schedules](https://docs.temporal.io/workflows/#schedule)." - BatchDefinition = "Operations performed on Batch jobs. Use [Workflows](https://docs.temporal.io/workflows) commands with --query flag to start batch jobs." - OperatorDefinition = "Operations performed on the [Temporal Server](https://docs.temporal.io/clusters/#temporal-server)." - EnvDefinition = "Manage environmental configurations on [Temporal Client](https://docs.temporal.io/temporal/#temporal-client)." + WorkflowDefinition = "Operations that can be performed on Workflows." + ActivityDefinition = "Operations that can be performed on Workflow Activities." + TaskQueueDefinition = "Operations performed on Task Queues." + ScheduleDefinition = "Operations performed on Schedules." + BatchDefinition = "Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs." + OperatorDefinition = "Operations performed on the Temporal Server." + EnvDefinition = "Manage environmental configurations on Temporal Client." // Workflow subcommand definitions - StartWorkflowDefinition = "Starts a new [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution)." + StartWorkflowDefinition = "Starts a new Workflow Execution." + // TODO: make string literal usage text StartWorkflowUsageText = "When invoked successfully, the Workflow and Run Ids of the recently started [Workflow](https://docs.temporal.io/workflows) are returned." - ExecuteWorkflowDefinition = "Start a new [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) and prints its progress." + ExecuteWorkflowDefinition = "Start a new Workflow Execution and prints its progress." + // TODO: make string literal usage text ExecuteWorkflowUsageText = "Single quotes('') are used to wrap input as JSON." - DescribeWorkflowDefinition = "Show information about a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution)." + DescribeWorkflowDefinition = "Show information about a Workflow Execution." + // TODO: make string literal usage text DescribeWorkflowUsageText = "This information can be used to locate a Workflow Execution that failed." - ListWorkflowDefinition = "List [Workflow Executions](https://docs.temporal.io/workflows/#workflow-execution) based on a [Query](https://docs.temporal.io/workflows/#query)." + ListWorkflowDefinition = "List Workflow Executions based on a Query." + // TODO: make string literal usage text ListWorkflowUsageText = "By default, this command lists up to 10 closed Workflow Executions." - ShowWorkflowDefinition = "Show [Event History](https://docs.temporal.io/workflows/#event-history) for a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution)." + ShowWorkflowDefinition = "Show Event History for a Workflow Execution." - QueryWorkflowDefinition = "[Query](https://docs.temporal.io/workflows/#query) a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution)." + QueryWorkflowDefinition = "Query a Workflow Execution." + // TODO: make string literal usage text QueryWorkflowUsageText = "Queries can retrieve all or part of the Workflow state within given parameters.\nQueries can also be used on completed [Workflows](https://docs.temporal.io/workflows/)." - StackWorkflowDefinition = "Query a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) with [__stack_trace](https://docs.temporal.io/workflows/#stack-trace-query) as the query type." - SignalWorkflowDefinition = "Signal [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) by Id or [List Filter](https://docs.temporal.io/visibility/#list-filter)." + StackWorkflowDefinition = "Query a Workflow Execution with __stack_trace as the query type." + SignalWorkflowDefinition = "Signal Workflow Execution by Id or List Filter." CountWorkflowDefinition = "Count Workflow Executions (requires ElasticSearch to be enabled)." - CancelWorkflowDefinition = "Cancel a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution)." + CancelWorkflowDefinition = "Cancel a Workflow Execution." + // TODO: make string literal usage text CancelWorkflowUsageText = "Canceling a running Workflow Execution records a [`WorkflowExecutionCancelRequested` event](https://docs.temporal.io/references/events/#workflowexecutioncanceled) in the [Event History](https://docs.temporal.io/workflows/#event-history).\n\nAfter cancellation, the Workflow Execution can perform cleanup work,and a new [Command](https://docs.temporal.io/workflows/#command) task will be scheduled." - TerminateWorkflowDefinition = "Terminate [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) by Id or [List Filter](https://docs.temporal.io/visibility/#list-filter)." + TerminateWorkflowDefinition = "Terminate Workflow Execution by Id or List Filter." + // TODO: make string literal usage text TerminateWorkflowUsageText = "Terminating a running Workflow records a [`WorkflowExecutionTerminated` event](https://docs.temporal.io/references/events/#workflowexecutionterminated) as the closing event.\n\nAny further [Command](https://docs.temporal.io/workflows/#command) tasks cannot be scheduled after running `terminate`." - DeleteWorkflowDefinition = "Deletes a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution)." + DeleteWorkflowDefinition = "Deletes a Workflow Execution." - ResetWorkflowDefinition = "Resets a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) by Event Id or reset type." + ResetWorkflowDefinition = "Resets a Workflow Execution by Event Id or reset type." + // TODO: make string literal usage text ResetWorkflowUsageText = "A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history)." - + // TODO: make string literal usage text ResetBatchUsageText = "Resetting a Workflow allows the process to resume from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history)." - TraceWorkflowDefinition = "Trace progress of a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) and its [children](https://docs.temporal.io/workflows/#child-workflow)." + TraceWorkflowDefinition = "Trace progress of a Workflow Execution and its children." // Activity subcommand definitions - CompleteActivityDefinition = "Completes an [Activity](https://docs.temporal.io/activities)." - FailActivityDefinition = "Fails an [Activity](https://docs.temporal.io/activities)." + CompleteActivityDefinition = "Completes an Activity." + FailActivityDefinition = "Fails an Activity." // Task Queue subcommand definitions - DescribeTaskQueueDefinition = "Describes the [Workers](https://docs.temporal.io/workers) that have recently polled on this [Task Queue](https://docs.temporal.io/tasks/#task-queue)" + DescribeTaskQueueDefinition = "Describes the Workers that have recently polled on this Task Queue." + // TODO: make string literal usage text DescribeTaskQueueUsageText = "The [Server](https://docs.temporal.io/clusters/#temporal-server) records the last time of each poll request.\n\nPoll requests can last up to a minute, so a LastAccessTime under a minute is normal.\nIf it's over a minute, then likely either the Worker is at capacity (all [Workflow](https://docs.temporal.io/workflows/) and [Activity](https://docs.temporal.io/activities) slots are full) or it has shut down.\nOnce it has been 5 minutes since the last poll request, the Worker is removed from the list.\n\nRatePerSecond is the maximum Activities per second the Worker will execute." ListPartitionTaskQueueDefinition = "Lists the [Task Queue's](https://docs.temporal.io/tasks/#task-queue) partitions and which matching node they are assigned to." // Schedule subcommand definitions + // TODO: make string literal usage text ScheduleUsageText = "These commands allow [Schedules](https://docs.temporal.io/workflows/#schedule) to be created, used, and updated." // Batch subcommand definitions + // TODO: make string literal usage text BatchUsageText = "Batch Jobs run in the background and affect [Workflow Executions](https://docs.temporal.io/workflows/#workflow-execution) one at a time.\n\nIn `cli`, the Batch Commands are used to view the status of Batch jobs, and to terminate them.\nA successfully started Batch job returns a Job Id, which is needed to execute Batch Commands.\n\nTerminating a Batch Job does not roll back the operations already performed by the job itself." DescribeBatchJobDefinition = "Describe a Batch operation job." + // TODO: make string literal usage text DescribeBatchUsageText = "This command shows the progress of an ongoing Batch job." ListBatchJobsDefinition = "List Batch operation jobs." + // TODO: make string literal usage text ListBatchUsageText = "When used, all Batch operation jobs within the system are listed." TerminateBatchJobDefinition = "Stop a Batch operation job." + // TODO: make string literal usage text TerminateBatchUsageText = "When used, the Batch job with the provided Batch Id is terminated." // Operator subcommands and additional text OperatorUsageText = "These commands enable operations on [Namespaces](https://docs.temporal.io/namespaces), [Search Attributes](https://docs.temporal.io/visibility#search-attribute), and [Temporal Clusters](https://docs.temporal.io/clusters)." - NamespaceDefinition = "Operations applying to [Namespaces](https://docs.temporal.io/namespaces)." - SearchAttributeDefinition = "Operations applying to [Search Attributes](https://docs.temporal.io/visibility#search-attribute)." - ClusterDefinition = "Operations for running a [Temporal Cluster](https://docs.temporal.io/clusters)." + NamespaceDefinition = "Operations applying to Namespaces." + SearchAttributeDefinition = "Operations applying to Search Attributes." + ClusterDefinition = "Operations for running a Temporal Cluster." // Namespace subcommand definitions DescribeNamespaceDefinition = "Describe a Namespace by its name or Id." @@ -103,5 +117,5 @@ const ( // Env subcommand definitions GetDefinition = "Prints environmental properties." SetDefinition = "Set environmental properties." - DeleteDefinition = "Delete environment or environmental property." + DeleteDefinition = "Delete an environment or environmental property." ) \ No newline at end of file diff --git a/common/flags.go b/common/flags.go index ad05897e..71e6b45e 100644 --- a/common/flags.go +++ b/common/flags.go @@ -89,7 +89,7 @@ var ( FlagQuery = "query" FlagQueryAlias = []string{"q"} FlagQueryRejectCondition = "reject-condition" - FlagQueryUsage = "Filter results using an SQL-like query. See [Queries](https://docs.temporal.io/docs/tctl/workflow/list#--query) for more information." + FlagQueryUsage = "Filter results using an SQL-like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for more information." FlagReason = "reason" FlagRemainingActions = "remaining-actions" FlagResetPointsOnly = "reset-points" diff --git a/docs/activity/complete.md b/docs/activity/complete.md index 92794786..b5fd8109 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -2,14 +2,14 @@ id: complete title: temporal activity complete sidebar_label: complete -description: Temporal CLI operation for .... +description: ### complete tags: - cli --- ### complete -Completes an [Activity](https://docs.temporal.io/activities). +Completes an Activity. **--activity-id** Identifies the Activity to be completed. diff --git a/docs/activity/fail.md b/docs/activity/fail.md index cd84f455..cfbb7a83 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -2,14 +2,14 @@ id: fail title: temporal activity fail sidebar_label: fail -description: Temporal CLI operation for .... +description: ### fail tags: - cli --- ### fail -Fails an [Activity](https://docs.temporal.io/activities). +Fails an Activity. **--activity-id** Identifies the Activity to fail. diff --git a/docs/activity/index.md b/docs/activity/index.md index bd7b84af..7d2431b2 100644 --- a/docs/activity/index.md +++ b/docs/activity/index.md @@ -2,12 +2,11 @@ id: index title: temporal activity sidebar_label: activity -description: Temporal CLI operation for .... +description: nextLine tags: - cli --- -## activity -Operations that can be performed on Workflow [Activities](https://docs.temporal.io/activities). +Operations that can be performed on Workflow Activities. diff --git a/docs/batch/describe.md b/docs/batch/describe.md index ebb0fb37..4a88e6a0 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -2,7 +2,7 @@ id: describe title: temporal batch describe sidebar_label: describe -description: Temporal CLI operation for .... +description: ### describe tags: - cli --- diff --git a/docs/batch/index.md b/docs/batch/index.md index 058b5f14..201ca6b7 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -2,14 +2,13 @@ id: index title: temporal batch sidebar_label: batch -description: Temporal CLI operation for .... +description: nextLine tags: - cli --- -## batch -Operations performed on Batch jobs. Use [Workflows](https://docs.temporal.io/workflows) commands with --query flag to start batch jobs. +Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs. Batch Jobs run in the background and affect [Workflow Executions](https://docs.temporal.io/workflows/#workflow-execution) one at a time. diff --git a/docs/batch/list.md b/docs/batch/list.md index b8ff884a..2b683f05 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -2,7 +2,7 @@ id: list title: temporal batch list sidebar_label: list -description: Temporal CLI operation for .... +description: ### list tags: - cli --- diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index 24982e6b..8393337c 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -2,7 +2,7 @@ id: terminate title: temporal batch terminate sidebar_label: terminate -description: Temporal CLI operation for .... +description: ### terminate tags: - cli --- diff --git a/docs/completion/bash.md b/docs/completion/bash.md index 0e7e14b6..353cce2b 100644 --- a/docs/completion/bash.md +++ b/docs/completion/bash.md @@ -2,7 +2,7 @@ id: bash title: temporal completion bash sidebar_label: bash -description: Temporal CLI operation for .... +description: ### bash tags: - cli --- diff --git a/docs/completion/index.md b/docs/completion/index.md index f1d349c8..707caeff 100644 --- a/docs/completion/index.md +++ b/docs/completion/index.md @@ -2,12 +2,11 @@ id: index title: temporal completion sidebar_label: completion -description: Temporal CLI operation for .... +description: nextLine tags: - cli --- -## completion Output shell completion code for the specified shell (zsh, bash). diff --git a/docs/completion/zsh.md b/docs/completion/zsh.md index d35d6313..ef6e4adc 100644 --- a/docs/completion/zsh.md +++ b/docs/completion/zsh.md @@ -2,7 +2,7 @@ id: zsh title: temporal completion zsh sidebar_label: zsh -description: Temporal CLI operation for .... +description: ### zsh tags: - cli --- diff --git a/docs/env/delete.md b/docs/env/delete.md index 869cba73..b5a28ff6 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -2,14 +2,14 @@ id: delete title: temporal env delete sidebar_label: delete -description: Temporal CLI operation for .... +description: ### delete tags: - cli --- ### delete -Delete environment or environmental property. +Delete an environment or environmental property. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/env/get.md b/docs/env/get.md index 16a07d89..b45c96c0 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -2,7 +2,7 @@ id: get title: temporal env get sidebar_label: get -description: Temporal CLI operation for .... +description: ### get tags: - cli --- diff --git a/docs/env/index.md b/docs/env/index.md index c4ddc50b..7300870a 100644 --- a/docs/env/index.md +++ b/docs/env/index.md @@ -2,12 +2,11 @@ id: index title: temporal env sidebar_label: env -description: Temporal CLI operation for .... +description: nextLine tags: - cli --- -## env -Manage environmental configurations on [Temporal Client](https://docs.temporal.io/temporal/#temporal-client). +Manage environmental configurations on Temporal Client. diff --git a/docs/env/set.md b/docs/env/set.md index 46d35c03..9f9ac564 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -2,7 +2,7 @@ id: set title: temporal env set sidebar_label: set -description: Temporal CLI operation for .... +description: ### set tags: - cli --- diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md index 9187631d..f72f6841 100644 --- a/docs/operator/cluster.md +++ b/docs/operator/cluster.md @@ -2,14 +2,14 @@ id: cluster title: temporal operator cluster sidebar_label: cluster -description: Temporal CLI operation for .... +description: ### cluster tags: - cli --- ### cluster -Operations for running a [Temporal Cluster](https://docs.temporal.io/clusters). +Operations for running a Temporal Cluster. #### health diff --git a/docs/operator/index.md b/docs/operator/index.md index 60ef1548..5d016964 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -2,14 +2,13 @@ id: index title: temporal operator sidebar_label: operator -description: Temporal CLI operation for .... +description: nextLine tags: - cli --- -## operator -Operations performed on the [Temporal Server](https://docs.temporal.io/clusters/#temporal-server). +Operations performed on the Temporal Server. These commands enable operations on [Namespaces](https://docs.temporal.io/namespaces), [Search Attributes](https://docs.temporal.io/visibility#search-attribute), and [Temporal Clusters](https://docs.temporal.io/clusters). diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md index fc29184d..51e025eb 100644 --- a/docs/operator/namespace.md +++ b/docs/operator/namespace.md @@ -2,14 +2,14 @@ id: namespace title: temporal operator namespace sidebar_label: namespace -description: Temporal CLI operation for .... +description: ### namespace tags: - cli --- ### namespace -Operations applying to [Namespaces](https://docs.temporal.io/namespaces). +Operations applying to Namespaces. #### describe diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md index e7e8c526..9bd96fb9 100644 --- a/docs/operator/search-attribute.md +++ b/docs/operator/search-attribute.md @@ -2,14 +2,14 @@ id: search-attribute title: temporal operator search-attribute sidebar_label: search-attribute -description: Temporal CLI operation for .... +description: ### search-attribute tags: - cli --- ### search-attribute -Operations applying to [Search Attributes](https://docs.temporal.io/visibility#search-attribute). +Operations applying to Search Attributes. #### create diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md index f3591e44..86d97076 100644 --- a/docs/schedule/backfill.md +++ b/docs/schedule/backfill.md @@ -2,7 +2,7 @@ id: backfill title: temporal schedule backfill sidebar_label: backfill -description: Temporal CLI operation for .... +description: ### backfill tags: - cli --- diff --git a/docs/schedule/create.md b/docs/schedule/create.md index 5c748286..2d797cdd 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -2,7 +2,7 @@ id: create title: temporal schedule create sidebar_label: create -description: Temporal CLI operation for .... +description: ### create tags: - cli --- diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md index 131d04d1..c56afe99 100644 --- a/docs/schedule/delete.md +++ b/docs/schedule/delete.md @@ -2,7 +2,7 @@ id: delete title: temporal schedule delete sidebar_label: delete -description: Temporal CLI operation for .... +description: ### delete tags: - cli --- diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 699430f0..442a063d 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -2,7 +2,7 @@ id: describe title: temporal schedule describe sidebar_label: describe -description: Temporal CLI operation for .... +description: ### describe tags: - cli --- diff --git a/docs/schedule/index.md b/docs/schedule/index.md index 1439908b..009543d7 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -2,14 +2,13 @@ id: index title: temporal schedule sidebar_label: schedule -description: Temporal CLI operation for .... +description: nextLine tags: - cli --- -## schedule -Operations performed on [Schedules](https://docs.temporal.io/workflows/#schedule). +Operations performed on Schedules. These commands allow [Schedules](https://docs.temporal.io/workflows/#schedule) to be created, used, and updated. diff --git a/docs/schedule/list.md b/docs/schedule/list.md index e7d72796..51a04a6c 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -2,7 +2,7 @@ id: list title: temporal schedule list sidebar_label: list -description: Temporal CLI operation for .... +description: ### list tags: - cli --- diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md index fb6fa17f..eb806528 100644 --- a/docs/schedule/toggle.md +++ b/docs/schedule/toggle.md @@ -2,7 +2,7 @@ id: toggle title: temporal schedule toggle sidebar_label: toggle -description: Temporal CLI operation for .... +description: ### toggle tags: - cli --- diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md index 93ea0f83..955a76ca 100644 --- a/docs/schedule/trigger.md +++ b/docs/schedule/trigger.md @@ -2,7 +2,7 @@ id: trigger title: temporal schedule trigger sidebar_label: trigger -description: Temporal CLI operation for .... +description: ### trigger tags: - cli --- diff --git a/docs/schedule/update.md b/docs/schedule/update.md index 6009067b..17a839db 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -2,7 +2,7 @@ id: update title: temporal schedule update sidebar_label: update -description: Temporal CLI operation for .... +description: ### update tags: - cli --- diff --git a/docs/server/index.md b/docs/server/index.md index 56980b3a..1057f81f 100644 --- a/docs/server/index.md +++ b/docs/server/index.md @@ -2,12 +2,11 @@ id: index title: temporal server sidebar_label: server -description: Temporal CLI operation for .... +description: nextLine tags: - cli --- -## server Commands for managing the Temporal Server. diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index 793403e3..f2a08ef5 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -2,7 +2,7 @@ id: start-dev title: temporal server start-dev sidebar_label: start-dev -description: Temporal CLI operation for .... +description: ### start-dev tags: - cli --- diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index 0bc60c81..9492eac9 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -2,14 +2,14 @@ id: describe title: temporal task-queue describe sidebar_label: describe -description: Temporal CLI operation for .... +description: ### describe tags: - cli --- ### describe -Describes the [Workers](https://docs.temporal.io/workers) that have recently polled on this [Task Queue](https://docs.temporal.io/tasks/#task-queue) +Describes the Workers that have recently polled on this Task Queue. The [Server](https://docs.temporal.io/clusters/#temporal-server) records the last time of each poll request. diff --git a/docs/task-queue/index.md b/docs/task-queue/index.md index b2d9c402..e58f6b14 100644 --- a/docs/task-queue/index.md +++ b/docs/task-queue/index.md @@ -2,12 +2,11 @@ id: index title: temporal task-queue sidebar_label: task-queue -description: Temporal CLI operation for .... +description: nextLine tags: - cli --- -## task-queue -Operations performed on [Task Queues](https://docs.temporal.io/tasks/#task-queue). +Operations performed on Task Queues. diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index d84a11cc..2e1e5d47 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -2,7 +2,7 @@ id: list-partition title: temporal task-queue list-partition sidebar_label: list-partition -description: Temporal CLI operation for .... +description: ### list-partition tags: - cli --- diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index 347eecf7..23356d85 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -2,14 +2,14 @@ id: cancel title: temporal workflow cancel sidebar_label: cancel -description: Temporal CLI operation for .... +description: ### cancel tags: - cli --- ### cancel -Cancel a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution). +Cancel a Workflow Execution. Canceling a running Workflow Execution records a [`WorkflowExecutionCancelRequested` event](https://docs.temporal.io/references/events/#workflowexecutioncanceled) in the [Event History](https://docs.temporal.io/workflows/#event-history). diff --git a/docs/workflow/count.md b/docs/workflow/count.md index 43b32f49..7750bfd5 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -2,7 +2,7 @@ id: count title: temporal workflow count sidebar_label: count -description: Temporal CLI operation for .... +description: ### count tags: - cli --- @@ -38,7 +38,7 @@ Identifies a Namespace in the Temporal Workflow. (default: default) **--query** Alias: **-q** -Filter results using an SQL-like query. See [Queries](https://docs.temporal.io/docs/tctl/workflow/list#--query) for more information. +Filter results using an SQL-like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for more information. **--tls-ca-path** Path to server CA certificate. diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index dc0e2b75..544f1125 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -2,14 +2,14 @@ id: delete title: temporal workflow delete sidebar_label: delete -description: Temporal CLI operation for .... +description: ### delete tags: - cli --- ### delete -Deletes a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution). +Deletes a Workflow Execution. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index 1f5ebcd5..c2df162c 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -2,14 +2,14 @@ id: describe title: temporal workflow describe sidebar_label: describe -description: Temporal CLI operation for .... +description: ### describe tags: - cli --- ### describe -Show information about a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution). +Show information about a Workflow Execution. This information can be used to locate a Workflow Execution that failed. diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index 118c0219..5911aafb 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -2,14 +2,14 @@ id: execute title: temporal workflow execute sidebar_label: execute -description: Temporal CLI operation for .... +description: ### execute tags: - cli --- ### execute -Start a new [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) and prints its progress. +Start a new Workflow Execution and prints its progress. Single quotes('') are used to wrap input as JSON. diff --git a/docs/workflow/index.md b/docs/workflow/index.md index b593822f..38870490 100644 --- a/docs/workflow/index.md +++ b/docs/workflow/index.md @@ -2,12 +2,11 @@ id: index title: temporal workflow sidebar_label: workflow -description: Temporal CLI operation for .... +description: nextLine tags: - cli --- -## workflow -Operations that can be performed on [Workflows](https://docs.temporal.io/workflows). +Operations that can be performed on Workflows. diff --git a/docs/workflow/list.md b/docs/workflow/list.md index 45a5cafc..f006d7ab 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -2,14 +2,14 @@ id: list title: temporal workflow list sidebar_label: list -description: Temporal CLI operation for .... +description: ### list tags: - cli --- ### list -List [Workflow Executions](https://docs.temporal.io/workflows/#workflow-execution) based on a [Query](https://docs.temporal.io/workflows/#query). +List Workflow Executions based on a Query. By default, this command lists up to 10 closed Workflow Executions. @@ -62,7 +62,7 @@ Options: less, more, favoritePager. **--query** Alias: **-q** -Filter results using an SQL-like query. See [Queries](https://docs.temporal.io/docs/tctl/workflow/list#--query) for more information. +Filter results using an SQL-like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for more information. **--time-format** Format time as: relative, iso, raw. (default: relative) diff --git a/docs/workflow/query.md b/docs/workflow/query.md index 2e166cd2..29846fb3 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -2,14 +2,14 @@ id: query title: temporal workflow query sidebar_label: query -description: Temporal CLI operation for .... +description: ### query tags: - cli --- ### query -[Query](https://docs.temporal.io/workflows/#query) a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution). +Query a Workflow Execution. Queries can retrieve all or part of the Workflow state within given parameters. Queries can also be used on completed [Workflows](https://docs.temporal.io/workflows/). diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index a81fe6a8..615e95fb 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -2,7 +2,7 @@ id: reset-batch title: temporal workflow reset-batch sidebar_label: reset-batch -description: Temporal CLI operation for .... +description: ### reset-batch tags: - cli --- @@ -85,5 +85,5 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 1ec4d2e3..166473ba 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -2,14 +2,14 @@ id: reset title: temporal workflow reset sidebar_label: reset -description: Temporal CLI operation for .... +description: ### reset tags: - cli --- ### reset -Resets a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) by Event Id or reset type. +Resets a Workflow Execution by Event Id or reset type. A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history). diff --git a/docs/workflow/show.md b/docs/workflow/show.md index 1e598eef..7ad7d528 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -2,14 +2,14 @@ id: show title: temporal workflow show sidebar_label: show -description: Temporal CLI operation for .... +description: ### show tags: - cli --- ### show -Show [Event History](https://docs.temporal.io/workflows/#event-history) for a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution). +Show Event History for a Workflow Execution. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index 26c92323..0025f93c 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -2,14 +2,14 @@ id: signal title: temporal workflow signal sidebar_label: signal -description: Temporal CLI operation for .... +description: ### signal tags: - cli --- ### signal -Signal [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) by Id or [List Filter](https://docs.temporal.io/visibility/#list-filter). +Signal Workflow Execution by Id or List Filter. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index 0dc40d68..bca8476b 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -2,14 +2,14 @@ id: stack title: temporal workflow stack sidebar_label: stack -description: Temporal CLI operation for .... +description: ### stack tags: - cli --- ### stack -Query a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) with [__stack_trace](https://docs.temporal.io/workflows/#stack-trace-query) as the query type. +Query a Workflow Execution with __stack_trace as the query type. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/start.md b/docs/workflow/start.md index c7d59c58..82c24bd9 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -2,14 +2,14 @@ id: start title: temporal workflow start sidebar_label: start -description: Temporal CLI operation for .... +description: ### start tags: - cli --- ### start -Starts a new [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution). +Starts a new Workflow Execution. When invoked successfully, the Workflow and Run Ids of the recently started [Workflow](https://docs.temporal.io/workflows) are returned. diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index 2380b874..82a000c1 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -2,14 +2,14 @@ id: terminate title: temporal workflow terminate sidebar_label: terminate -description: Temporal CLI operation for .... +description: ### terminate tags: - cli --- ### terminate -Terminate [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) by Id or [List Filter](https://docs.temporal.io/visibility/#list-filter). +Terminate Workflow Execution by Id or List Filter. Terminating a running Workflow records a [`WorkflowExecutionTerminated` event](https://docs.temporal.io/references/events/#workflowexecutionterminated) as the closing event. diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index 9f67368b..95dd8425 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -2,14 +2,14 @@ id: trace title: temporal workflow trace sidebar_label: trace -description: Temporal CLI operation for .... +description: ### trace tags: - cli --- ### trace -Trace progress of a [Workflow Execution](https://docs.temporal.io/workflows/#workflow-execution) and its [children](https://docs.temporal.io/workflows/#child-workflow). +Trace progress of a Workflow Execution and its children. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. From 0585b0303dbdadfc244b502291e30446b505375f Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 19 Jan 2023 18:57:18 -0600 Subject: [PATCH 37/68] partially refactored --- cmd/doc/main.go | 109 +++++--- docs/activity/complete.md | 5 +- docs/activity/fail.md | 5 +- docs/activity/index.md | 4 +- docs/batch/describe.md | 5 +- docs/batch/index.md | 4 +- docs/batch/list.md | 5 +- docs/batch/terminate.md | 5 +- docs/completion/bash.md | 5 +- docs/completion/index.md | 4 +- docs/completion/zsh.md | 5 +- docs/env/delete.md | 5 +- docs/env/get.md | 5 +- docs/env/index.md | 4 +- docs/env/set.md | 5 +- docs/operator/cluster.md | 321 ----------------------- docs/operator/cluster/describe.md | 57 ++++ docs/operator/cluster/health.md | 50 ++++ docs/operator/cluster/index.md | 10 + docs/operator/cluster/list.md | 71 +++++ docs/operator/cluster/remove.md | 53 ++++ docs/operator/cluster/system.md | 57 ++++ docs/operator/cluster/upsert.md | 56 ++++ docs/operator/index.md | 4 +- docs/operator/namespace.md | 309 ---------------------- docs/operator/namespace/delete.md | 54 ++++ docs/operator/namespace/describe.md | 53 ++++ docs/operator/namespace/index.md | 10 + docs/operator/namespace/list.md | 50 ++++ docs/operator/namespace/register.md | 83 ++++++ docs/operator/namespace/update.md | 86 ++++++ docs/operator/search-attribute.md | 166 ------------ docs/operator/search-attribute/create.md | 60 +++++ docs/operator/search-attribute/index.md | 10 + docs/operator/search-attribute/list.md | 54 ++++ docs/operator/search-attribute/remove.md | 57 ++++ docs/schedule/backfill.md | 5 +- docs/schedule/create.md | 5 +- docs/schedule/delete.md | 5 +- docs/schedule/describe.md | 5 +- docs/schedule/index.md | 4 +- docs/schedule/list.md | 5 +- docs/schedule/toggle.md | 5 +- docs/schedule/trigger.md | 5 +- docs/schedule/update.md | 5 +- docs/server/index.md | 4 +- docs/server/start-dev.md | 5 +- docs/task-queue/describe.md | 5 +- docs/task-queue/index.md | 4 +- docs/task-queue/list-partition.md | 5 +- docs/workflow/cancel.md | 5 +- docs/workflow/count.md | 5 +- docs/workflow/delete.md | 5 +- docs/workflow/describe.md | 5 +- docs/workflow/execute.md | 5 +- docs/workflow/index.md | 4 +- docs/workflow/list.md | 5 +- docs/workflow/query.md | 5 +- docs/workflow/reset-batch.md | 7 +- docs/workflow/reset.md | 5 +- docs/workflow/show.md | 5 +- docs/workflow/signal.md | 5 +- docs/workflow/stack.md | 5 +- docs/workflow/start.md | 5 +- docs/workflow/terminate.md | 5 +- docs/workflow/trace.md | 5 +- 66 files changed, 990 insertions(+), 1004 deletions(-) delete mode 100644 docs/operator/cluster.md create mode 100644 docs/operator/cluster/describe.md create mode 100644 docs/operator/cluster/health.md create mode 100644 docs/operator/cluster/index.md create mode 100644 docs/operator/cluster/list.md create mode 100644 docs/operator/cluster/remove.md create mode 100644 docs/operator/cluster/system.md create mode 100644 docs/operator/cluster/upsert.md delete mode 100644 docs/operator/namespace.md create mode 100644 docs/operator/namespace/delete.md create mode 100644 docs/operator/namespace/describe.md create mode 100644 docs/operator/namespace/index.md create mode 100644 docs/operator/namespace/list.md create mode 100644 docs/operator/namespace/register.md create mode 100644 docs/operator/namespace/update.md delete mode 100644 docs/operator/search-attribute.md create mode 100644 docs/operator/search-attribute/create.md create mode 100644 docs/operator/search-attribute/index.md create mode 100644 docs/operator/search-attribute/list.md create mode 100644 docs/operator/search-attribute/remove.md diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 96959ddc..dd8826c2 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -15,7 +15,7 @@ const ( docsPath = "docs" cliFile = "cli.md" filePerm = 0644 - indexFile = "index.md" + indexFile = "index.md" ) const FrontMatterTemplate = @@ -37,6 +37,12 @@ type FMStruct struct { IsIndex bool } +var currentHeader string +var fileName string +var path string +var currentHeaderFile *os.File +var headerIndexFile string + // `BuildApp` takes a string and returns a `*App` and an error func main() { doc, err := app.BuildApp("").ToMarkdown() @@ -53,17 +59,9 @@ func main() { if err != nil { log.Fatalf("Error when trying to open %s file: %v", cliFile, err) } - var pos int64 + scanner := bufio.NewScanner(readFile) - scanLines := func(data []byte, atEOF bool) (advance int, token []byte, err error) { - advance, token, err = bufio.ScanLines(data, atEOF) - pos += int64(advance) - return - } - scanner.Split(scanLines) - - var currentHeader string - var currentHeaderFile *os.File + scanner.Split(bufio.ScanLines) createdFiles := make(map[string]*os.File) // TODO: identify different option categories and print flags accordingly @@ -71,30 +69,46 @@ func main() { line := scanner.Text() if strings.HasPrefix(line, "## ") { currentHeader = strings.TrimSpace(line[2:]) - path := filepath.Join(docsPath, currentHeader) - - err := os.MkdirAll(path, os.ModePerm) - if err != nil { - log.Printf("Error when trying to create directory %s: %v", path, err) - continue - } - - headerIndexFile := filepath.Join(path, indexFile) - currentHeaderFile, err = os.Create(headerIndexFile) - if err != nil { - log.Printf("Error when trying to create file %s: %v", headerIndexFile, err) - continue - } - createdFiles[headerIndexFile] = currentHeaderFile - // get next line for description text - - writeFrontMatter(strings.Trim(indexFile, ".md"), currentHeader, "nextLine", true, currentHeaderFile) + path = filepath.Join(docsPath, currentHeader) + makeFile(path, true, scanner, createdFiles) } else if strings.HasPrefix(line, "### ") { - path := filepath.Join(docsPath, currentHeader) - fileName := strings.TrimSpace(line[3:]) + fileName = strings.TrimSpace(line[3:]) + path = filepath.Join(docsPath, currentHeader) + // special condition for operator command file gen. + if strings.Contains(currentHeader, "operator") { + opPath := filepath.Join(path, fileName) + err := os.MkdirAll(opPath, os.ModePerm) + if err != nil { + log.Printf("Error when trying to create directory %s: %v", path, err) + continue + } + headerIndexFile := filepath.Join(opPath, indexFile) + currentHeaderFile, err = os.Create(headerIndexFile) + if err != nil { + log.Printf("Error when trying to create file %s: %v", headerIndexFile, err) + continue + } + createdFiles[headerIndexFile] = currentHeaderFile - filePath := filepath.Join(path, fileName+".md") + writeFrontMatter(strings.Trim(indexFile, ".md"), currentHeader, scanner, true, currentHeaderFile) + } else { + filePath := filepath.Join(path, fileName+".md") + // check if already created file + currentHeaderFile = createdFiles[filePath] + if currentHeaderFile == nil { + currentHeaderFile, err = os.Create(filePath) + if err != nil { + log.Printf("Error when trying to create file %s: %v", filePath, err) + continue + } + createdFiles[filePath] = currentHeaderFile + } + writeFrontMatter(fileName, currentHeader, scanner, false, currentHeaderFile) + } + } else if strings.HasPrefix(line, "#### ") { + operatorFileName := strings.TrimSpace(line[4:]) + filePath := filepath.Join(path, fileName, operatorFileName+".md") // check if already created file currentHeaderFile = createdFiles[filePath] if currentHeaderFile == nil { @@ -105,8 +119,8 @@ func main() { } createdFiles[filePath] = currentHeaderFile } - writeFrontMatter(fileName, currentHeader, scanner.Text(), false,currentHeaderFile) - writeLine(currentHeaderFile, line) + writeFrontMatter(fileName, currentHeader, scanner, false, currentHeaderFile) + } else if strings.HasPrefix(line, "**--") { // split into term and definition term, definition, found := strings.Cut(line, ":") @@ -135,6 +149,25 @@ func main() { defer os.Remove(cliFile) } +func makeFile(path string, isIndex bool, scanner *bufio.Scanner, createdFiles map[string]*os.File) { + err := os.MkdirAll(path, os.ModePerm) + if err != nil { + log.Printf("Error when trying to create directory %s: %v", path, err) + } + if (isIndex) { + headerIndexFile = filepath.Join(path, indexFile) + currentHeaderFile, err = os.Create(headerIndexFile) + if err != nil { + log.Printf("Error when trying to create file %s: %v", headerIndexFile, err) + } + if err != nil { + log.Printf("Error when trying to create file %s: %v", headerIndexFile, err) + } + createdFiles[headerIndexFile] = currentHeaderFile + writeFrontMatter(strings.Trim(indexFile, ".md"), currentHeader, scanner, true, currentHeaderFile) +} +} + // It takes a file and a string, and writes the string to the file func writeLine(file *os.File, line string) { _, err := file.WriteString(line + "\n") @@ -145,14 +178,18 @@ func writeLine(file *os.File, line string) { // separates aliases from terms func makeAlias(file *os.File, line string) { + termArray := strings.Split(line, ",") writeLine(file, termArray[0] + "**") writeLine(file, "Alias: **" + strings.TrimSpace(termArray[1])) } // write front matter -func writeFrontMatter (idName string, titleName string, descriptionTxt string, isIndex bool, currentHeaderFile *os.File) { - // make struct to pass into the template +func writeFrontMatter (idName string, titleName string, scanner *bufio.Scanner, isIndex bool, currentHeaderFile *os.File) { + for i := 0; i < 2; i++ { + scanner.Scan() + } + descriptionTxt := scanner.Text() data := FMStruct{ ID: idName, Title: titleName, diff --git a/docs/activity/complete.md b/docs/activity/complete.md index b5fd8109..77d18148 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -2,14 +2,11 @@ id: complete title: temporal activity complete sidebar_label: complete -description: ### complete +description: Completes an Activity. tags: - cli --- -### complete - -Completes an Activity. **--activity-id** Identifies the Activity to be completed. diff --git a/docs/activity/fail.md b/docs/activity/fail.md index cfbb7a83..1fd3b6f5 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -2,14 +2,11 @@ id: fail title: temporal activity fail sidebar_label: fail -description: ### fail +description: Fails an Activity. tags: - cli --- -### fail - -Fails an Activity. **--activity-id** Identifies the Activity to fail. diff --git a/docs/activity/index.md b/docs/activity/index.md index 7d2431b2..71eda627 100644 --- a/docs/activity/index.md +++ b/docs/activity/index.md @@ -2,11 +2,9 @@ id: index title: temporal activity sidebar_label: activity -description: nextLine +description: Operations that can be performed on Workflow Activities. tags: - cli --- -Operations that can be performed on Workflow Activities. - diff --git a/docs/batch/describe.md b/docs/batch/describe.md index 4a88e6a0..709fc559 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -2,14 +2,11 @@ id: describe title: temporal batch describe sidebar_label: describe -description: ### describe +description: Describe a Batch operation job. tags: - cli --- -### describe - -Describe a Batch operation job. This command shows the progress of an ongoing Batch job. diff --git a/docs/batch/index.md b/docs/batch/index.md index 201ca6b7..077f7844 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -2,14 +2,12 @@ id: index title: temporal batch sidebar_label: batch -description: nextLine +description: Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs. tags: - cli --- -Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs. - Batch Jobs run in the background and affect [Workflow Executions](https://docs.temporal.io/workflows/#workflow-execution) one at a time. In `cli`, the Batch Commands are used to view the status of Batch jobs, and to terminate them. diff --git a/docs/batch/list.md b/docs/batch/list.md index 2b683f05..eec48077 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -2,14 +2,11 @@ id: list title: temporal batch list sidebar_label: list -description: ### list +description: List Batch operation jobs. tags: - cli --- -### list - -List Batch operation jobs. When used, all Batch operation jobs within the system are listed. diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index 8393337c..6fe12f5c 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -2,14 +2,11 @@ id: terminate title: temporal batch terminate sidebar_label: terminate -description: ### terminate +description: Stop a Batch operation job. tags: - cli --- -### terminate - -Stop a Batch operation job. When used, the Batch job with the provided Batch Id is terminated. diff --git a/docs/completion/bash.md b/docs/completion/bash.md index 353cce2b..4649c40d 100644 --- a/docs/completion/bash.md +++ b/docs/completion/bash.md @@ -2,12 +2,9 @@ id: bash title: temporal completion bash sidebar_label: bash -description: ### bash +description: bash completion output tags: - cli --- -### bash - -bash completion output diff --git a/docs/completion/index.md b/docs/completion/index.md index 707caeff..3bc2668a 100644 --- a/docs/completion/index.md +++ b/docs/completion/index.md @@ -2,11 +2,9 @@ id: index title: temporal completion sidebar_label: completion -description: nextLine +description: Output shell completion code for the specified shell (zsh, bash). tags: - cli --- -Output shell completion code for the specified shell (zsh, bash). - diff --git a/docs/completion/zsh.md b/docs/completion/zsh.md index ef6e4adc..9348eb6d 100644 --- a/docs/completion/zsh.md +++ b/docs/completion/zsh.md @@ -2,11 +2,8 @@ id: zsh title: temporal completion zsh sidebar_label: zsh -description: ### zsh +description: zsh completion output tags: - cli --- -### zsh - -zsh completion output diff --git a/docs/env/delete.md b/docs/env/delete.md index b5a28ff6..9528f7da 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -2,14 +2,11 @@ id: delete title: temporal env delete sidebar_label: delete -description: ### delete +description: Delete an environment or environmental property. tags: - cli --- -### delete - -Delete an environment or environmental property. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/env/get.md b/docs/env/get.md index b45c96c0..e5e23ab7 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -2,14 +2,11 @@ id: get title: temporal env get sidebar_label: get -description: ### get +description: Prints environmental properties. tags: - cli --- -### get - -Prints environmental properties. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/env/index.md b/docs/env/index.md index 7300870a..55b3cb66 100644 --- a/docs/env/index.md +++ b/docs/env/index.md @@ -2,11 +2,9 @@ id: index title: temporal env sidebar_label: env -description: nextLine +description: Manage environmental configurations on Temporal Client. tags: - cli --- -Manage environmental configurations on Temporal Client. - diff --git a/docs/env/set.md b/docs/env/set.md index 9f9ac564..640b9704 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -2,14 +2,11 @@ id: set title: temporal env set sidebar_label: set -description: ### set +description: Set environmental properties. tags: - cli --- -### set - -Set environmental properties. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/cluster.md b/docs/operator/cluster.md deleted file mode 100644 index f72f6841..00000000 --- a/docs/operator/cluster.md +++ /dev/null @@ -1,321 +0,0 @@ ---- -id: cluster -title: temporal operator cluster -sidebar_label: cluster -description: ### cluster -tags: - - cli ---- - -### cluster - -Operations for running a Temporal Cluster. - -#### health - -Checks the health of the Frontend Service. - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -#### describe - -Show information about the Cluster. - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -#### system - -Shows information about the system and its capabilities. - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -#### upsert - -Add or update a remote Cluster. - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--enable-connection** -Enable cross-cluster connection. - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--frontend-address** -Frontend address of the remote Cluster. - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -#### list - -List all remote Clusters. - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--limit** -Number of items to print. (default: 0) - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--no-pager** -Alias: **-P** -Disables the interactive pager. - -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) - -**--pager** -Sets the pager for Temporal CLI to use. -Options: less, more, favoritePager. - -**--time-format** -Format time as: relative, iso, raw. (default: relative) - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -#### remove - -Remove a remote Cluster. - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--name** -Frontend address of the remote Cluster. - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - diff --git a/docs/operator/cluster/describe.md b/docs/operator/cluster/describe.md new file mode 100644 index 00000000..6bc92231 --- /dev/null +++ b/docs/operator/cluster/describe.md @@ -0,0 +1,57 @@ +--- +id: cluster +title: temporal operator cluster +sidebar_label: cluster +description: Show information about the Cluster. +tags: + - cli +--- + + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--fields** +Customize fields to print. Set to 'long' to automatically print more of main fields. + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--output** +Alias: **-o** +format output as: table, json, card. (default: table) + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + diff --git a/docs/operator/cluster/health.md b/docs/operator/cluster/health.md new file mode 100644 index 00000000..7a82fafe --- /dev/null +++ b/docs/operator/cluster/health.md @@ -0,0 +1,50 @@ +--- +id: cluster +title: temporal operator cluster +sidebar_label: cluster +description: Checks the health of the Frontend Service. +tags: + - cli +--- + + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + diff --git a/docs/operator/cluster/index.md b/docs/operator/cluster/index.md new file mode 100644 index 00000000..6780481e --- /dev/null +++ b/docs/operator/cluster/index.md @@ -0,0 +1,10 @@ +--- +id: index +title: temporal operator +sidebar_label: operator +description: Operations for running a Temporal Cluster. +tags: + - cli +--- + + diff --git a/docs/operator/cluster/list.md b/docs/operator/cluster/list.md new file mode 100644 index 00000000..d5f0e6ba --- /dev/null +++ b/docs/operator/cluster/list.md @@ -0,0 +1,71 @@ +--- +id: cluster +title: temporal operator cluster +sidebar_label: cluster +description: List all remote Clusters. +tags: + - cli +--- + + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--fields** +Customize fields to print. Set to 'long' to automatically print more of main fields. + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--limit** +Number of items to print. (default: 0) + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--no-pager** +Alias: **-P** +Disables the interactive pager. + +**--output** +Alias: **-o** +format output as: table, json, card. (default: table) + +**--pager** +Sets the pager for Temporal CLI to use. +Options: less, more, favoritePager. + +**--time-format** +Format time as: relative, iso, raw. (default: relative) + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + diff --git a/docs/operator/cluster/remove.md b/docs/operator/cluster/remove.md new file mode 100644 index 00000000..6157f070 --- /dev/null +++ b/docs/operator/cluster/remove.md @@ -0,0 +1,53 @@ +--- +id: cluster +title: temporal operator cluster +sidebar_label: cluster +description: Remove a remote Cluster. +tags: + - cli +--- + + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--name** +Frontend address of the remote Cluster. + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + diff --git a/docs/operator/cluster/system.md b/docs/operator/cluster/system.md new file mode 100644 index 00000000..0bbed072 --- /dev/null +++ b/docs/operator/cluster/system.md @@ -0,0 +1,57 @@ +--- +id: cluster +title: temporal operator cluster +sidebar_label: cluster +description: Shows information about the system and its capabilities. +tags: + - cli +--- + + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--fields** +Customize fields to print. Set to 'long' to automatically print more of main fields. + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--output** +Alias: **-o** +format output as: table, json, card. (default: table) + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + diff --git a/docs/operator/cluster/upsert.md b/docs/operator/cluster/upsert.md new file mode 100644 index 00000000..e07aa726 --- /dev/null +++ b/docs/operator/cluster/upsert.md @@ -0,0 +1,56 @@ +--- +id: cluster +title: temporal operator cluster +sidebar_label: cluster +description: Add or update a remote Cluster. +tags: + - cli +--- + + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--enable-connection** +Enable cross-cluster connection. + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--frontend-address** +Frontend address of the remote Cluster. + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + diff --git a/docs/operator/index.md b/docs/operator/index.md index 5d016964..ea56ca9b 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -2,13 +2,11 @@ id: index title: temporal operator sidebar_label: operator -description: nextLine +description: Operations performed on the Temporal Server. tags: - cli --- -Operations performed on the Temporal Server. - These commands enable operations on [Namespaces](https://docs.temporal.io/namespaces), [Search Attributes](https://docs.temporal.io/visibility#search-attribute), and [Temporal Clusters](https://docs.temporal.io/clusters). diff --git a/docs/operator/namespace.md b/docs/operator/namespace.md deleted file mode 100644 index 51e025eb..00000000 --- a/docs/operator/namespace.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -id: namespace -title: temporal operator namespace -sidebar_label: namespace -description: ### namespace -tags: - - cli ---- - -### namespace - -Operations applying to Namespaces. - -#### describe - -Describe a Namespace by its name or Id. - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--namespace-id** -Namespace Id - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -#### list - -List all Namespaces. - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -#### register - -Registers a new Namespace. - -**--active-cluster** -Active cluster name - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--cluster** -Cluster name - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--data** -Namespace data in a format key=value - -**--description** -Namespace description - -**--email** -Owner email - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--global** -Flag to indicate whether namespace is a global namespace - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--history-archival-state** -Flag to set history archival state, valid values are "disabled" and "enabled" - -**--history-uri** -Optionally specify history archival URI (cannot be changed after first time archival is enabled) - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--retention** -Workflow Execution retention - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -**--visibility-archival-state** -Flag to set visibility archival state, valid values are "disabled" and "enabled" - -**--visibility-uri** -Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) - -#### update - -Updates a Namespace. - -**--active-cluster** -Active cluster name - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--cluster** -Cluster name - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--data** -Namespace data in a format key=value - -**--description** -Namespace description - -**--email** -Owner email - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--history-archival-state** -Flag to set history archival state, valid values are "disabled" and "enabled" - -**--history-uri** -Optionally specify history archival URI (cannot be changed after first time archival is enabled) - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--promote-global** -Promote local namespace to global namespace - -**--reason** -Reason for the operation - -**--retention** -Workflow Execution retention - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -**--visibility-archival-state** -Flag to set visibility archival state, valid values are "disabled" and "enabled" - -**--visibility-uri** -Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) - -#### delete - -Deletes an existing Namespace. - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -**--yes** -Alias: **-y** -Confirm all prompts. - diff --git a/docs/operator/namespace/delete.md b/docs/operator/namespace/delete.md new file mode 100644 index 00000000..7bc7d4bc --- /dev/null +++ b/docs/operator/namespace/delete.md @@ -0,0 +1,54 @@ +--- +id: namespace +title: temporal operator namespace +sidebar_label: namespace +description: Deletes an existing Namespace. +tags: + - cli +--- + + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + +**--yes** +Alias: **-y** +Confirm all prompts. + diff --git a/docs/operator/namespace/describe.md b/docs/operator/namespace/describe.md new file mode 100644 index 00000000..adb29d1b --- /dev/null +++ b/docs/operator/namespace/describe.md @@ -0,0 +1,53 @@ +--- +id: namespace +title: temporal operator namespace +sidebar_label: namespace +description: Describe a Namespace by its name or Id. +tags: + - cli +--- + + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--namespace-id** +Namespace Id + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + diff --git a/docs/operator/namespace/index.md b/docs/operator/namespace/index.md new file mode 100644 index 00000000..208da637 --- /dev/null +++ b/docs/operator/namespace/index.md @@ -0,0 +1,10 @@ +--- +id: index +title: temporal operator +sidebar_label: operator +description: Operations applying to Namespaces. +tags: + - cli +--- + + diff --git a/docs/operator/namespace/list.md b/docs/operator/namespace/list.md new file mode 100644 index 00000000..f699fb02 --- /dev/null +++ b/docs/operator/namespace/list.md @@ -0,0 +1,50 @@ +--- +id: namespace +title: temporal operator namespace +sidebar_label: namespace +description: List all Namespaces. +tags: + - cli +--- + + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + diff --git a/docs/operator/namespace/register.md b/docs/operator/namespace/register.md new file mode 100644 index 00000000..7b350a4f --- /dev/null +++ b/docs/operator/namespace/register.md @@ -0,0 +1,83 @@ +--- +id: namespace +title: temporal operator namespace +sidebar_label: namespace +description: Registers a new Namespace. +tags: + - cli +--- + + +**--active-cluster** +Active cluster name + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--cluster** +Cluster name + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--data** +Namespace data in a format key=value + +**--description** +Namespace description + +**--email** +Owner email + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--global** +Flag to indicate whether namespace is a global namespace + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--history-archival-state** +Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri** +Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--retention** +Workflow Execution retention + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + +**--visibility-archival-state** +Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri** +Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + diff --git a/docs/operator/namespace/update.md b/docs/operator/namespace/update.md new file mode 100644 index 00000000..efd2f4f4 --- /dev/null +++ b/docs/operator/namespace/update.md @@ -0,0 +1,86 @@ +--- +id: namespace +title: temporal operator namespace +sidebar_label: namespace +description: Updates a Namespace. +tags: + - cli +--- + + +**--active-cluster** +Active cluster name + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--cluster** +Cluster name + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--data** +Namespace data in a format key=value + +**--description** +Namespace description + +**--email** +Owner email + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--history-archival-state** +Flag to set history archival state, valid values are "disabled" and "enabled" + +**--history-uri** +Optionally specify history archival URI (cannot be changed after first time archival is enabled) + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--promote-global** +Promote local namespace to global namespace + +**--reason** +Reason for the operation + +**--retention** +Workflow Execution retention + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + +**--visibility-archival-state** +Flag to set visibility archival state, valid values are "disabled" and "enabled" + +**--visibility-uri** +Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) + diff --git a/docs/operator/search-attribute.md b/docs/operator/search-attribute.md deleted file mode 100644 index 9bd96fb9..00000000 --- a/docs/operator/search-attribute.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -id: search-attribute -title: temporal operator search-attribute -sidebar_label: search-attribute -description: ### search-attribute -tags: - - cli ---- - -### search-attribute - -Operations applying to Search Attributes. - -#### create - -Adds one or more custom Search Attributes. - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--name** -Search attribute name. - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -**--type** -Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] - -**--yes** -Alias: **-y** -Confirm all prompts. - -#### list - -Lists all Search Attributes that can be used in list Workflow Queries. - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -#### remove - -Removes custom search attribute metadata only (Elasticsearch index schema is not modified). - -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. - -**--codec-auth** -Sets the authorization header on requests to the Codec Server. - -**--codec-endpoint** -Endpoint for a remote Codec Server. - -**--color** -when to use color: auto, always, never. (default: auto) - -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) - -**--env** -Name of the environment to read environmental variables from. (default: default) - -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. - -**--name** -Search attribute name. - -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) - -**--tls-ca-path** -Path to server CA certificate. - -**--tls-cert-path** -Path to x509 certificate. - -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. - -**--tls-key-path** -Path to private certificate key. - -**--tls-server-name** -Provides an override for the target TLS server name. - -**--yes** -Alias: **-y** -Confirm all prompts. - diff --git a/docs/operator/search-attribute/create.md b/docs/operator/search-attribute/create.md new file mode 100644 index 00000000..1236956a --- /dev/null +++ b/docs/operator/search-attribute/create.md @@ -0,0 +1,60 @@ +--- +id: search-attribute +title: temporal operator search-attribute +sidebar_label: search-attribute +description: Adds one or more custom Search Attributes. +tags: + - cli +--- + + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--name** +Search attribute name. + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + +**--type** +Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] + +**--yes** +Alias: **-y** +Confirm all prompts. + diff --git a/docs/operator/search-attribute/index.md b/docs/operator/search-attribute/index.md new file mode 100644 index 00000000..9c4b8ecd --- /dev/null +++ b/docs/operator/search-attribute/index.md @@ -0,0 +1,10 @@ +--- +id: index +title: temporal operator +sidebar_label: operator +description: Operations applying to Search Attributes. +tags: + - cli +--- + + diff --git a/docs/operator/search-attribute/list.md b/docs/operator/search-attribute/list.md new file mode 100644 index 00000000..3a3ed0f4 --- /dev/null +++ b/docs/operator/search-attribute/list.md @@ -0,0 +1,54 @@ +--- +id: search-attribute +title: temporal operator search-attribute +sidebar_label: search-attribute +description: Lists all Search Attributes that can be used in list Workflow Queries. +tags: + - cli +--- + + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--output** +Alias: **-o** +format output as: table, json, card. (default: table) + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + diff --git a/docs/operator/search-attribute/remove.md b/docs/operator/search-attribute/remove.md new file mode 100644 index 00000000..3352ca6c --- /dev/null +++ b/docs/operator/search-attribute/remove.md @@ -0,0 +1,57 @@ +--- +id: search-attribute +title: temporal operator search-attribute +sidebar_label: search-attribute +description: Removes custom search attribute metadata only (Elasticsearch index schema is not modified). +tags: + - cli +--- + + +**--address** +The host and port (formatted as host:port) for the Temporal Frontend Service. + +**--codec-auth** +Sets the authorization header on requests to the Codec Server. + +**--codec-endpoint** +Endpoint for a remote Codec Server. + +**--color** +when to use color: auto, always, never. (default: auto) + +**--context-timeout** +An optional timeout for the context of an RPC call (in seconds). (default: 5) + +**--env** +Name of the environment to read environmental variables from. (default: default) + +**--grpc-meta** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. + +**--name** +Search attribute name. + +**--namespace** +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) + +**--tls-ca-path** +Path to server CA certificate. + +**--tls-cert-path** +Path to x509 certificate. + +**--tls-disable-host-verification** +Disables TLS host name verification if already enabled. + +**--tls-key-path** +Path to private certificate key. + +**--tls-server-name** +Provides an override for the target TLS server name. + +**--yes** +Alias: **-y** +Confirm all prompts. + diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md index 86d97076..1d2ccb93 100644 --- a/docs/schedule/backfill.md +++ b/docs/schedule/backfill.md @@ -2,14 +2,11 @@ id: backfill title: temporal schedule backfill sidebar_label: backfill -description: ### backfill +description: Backfills a past time range of actions tags: - cli --- -### backfill - -Backfills a past time range of actions **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/schedule/create.md b/docs/schedule/create.md index 2d797cdd..97b5637f 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -2,14 +2,11 @@ id: create title: temporal schedule create sidebar_label: create -description: ### create +description: Create a new schedule tags: - cli --- -### create - -Create a new schedule **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md index c56afe99..b417d36d 100644 --- a/docs/schedule/delete.md +++ b/docs/schedule/delete.md @@ -2,14 +2,11 @@ id: delete title: temporal schedule delete sidebar_label: delete -description: ### delete +description: Deletes a schedule tags: - cli --- -### delete - -Deletes a schedule **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 442a063d..2875191f 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -2,14 +2,11 @@ id: describe title: temporal schedule describe sidebar_label: describe -description: ### describe +description: Get schedule configuration and current state tags: - cli --- -### describe - -Get schedule configuration and current state **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/schedule/index.md b/docs/schedule/index.md index 009543d7..154abfdd 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -2,13 +2,11 @@ id: index title: temporal schedule sidebar_label: schedule -description: nextLine +description: Operations performed on Schedules. tags: - cli --- -Operations performed on Schedules. - These commands allow [Schedules](https://docs.temporal.io/workflows/#schedule) to be created, used, and updated. diff --git a/docs/schedule/list.md b/docs/schedule/list.md index 51a04a6c..e7144aad 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -2,14 +2,11 @@ id: list title: temporal schedule list sidebar_label: list -description: ### list +description: Lists schedules tags: - cli --- -### list - -Lists schedules **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md index eb806528..c4334fbc 100644 --- a/docs/schedule/toggle.md +++ b/docs/schedule/toggle.md @@ -2,14 +2,11 @@ id: toggle title: temporal schedule toggle sidebar_label: toggle -description: ### toggle +description: Pauses or unpauses a schedule tags: - cli --- -### toggle - -Pauses or unpauses a schedule **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md index 955a76ca..25968cb7 100644 --- a/docs/schedule/trigger.md +++ b/docs/schedule/trigger.md @@ -2,14 +2,11 @@ id: trigger title: temporal schedule trigger sidebar_label: trigger -description: ### trigger +description: Triggers an immediate action tags: - cli --- -### trigger - -Triggers an immediate action **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/schedule/update.md b/docs/schedule/update.md index 17a839db..15ac619b 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -2,14 +2,11 @@ id: update title: temporal schedule update sidebar_label: update -description: ### update +description: Updates a schedule with a new definition (full replacement, not patch) tags: - cli --- -### update - -Updates a schedule with a new definition (full replacement, not patch) **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/server/index.md b/docs/server/index.md index 1057f81f..576e4b45 100644 --- a/docs/server/index.md +++ b/docs/server/index.md @@ -2,11 +2,9 @@ id: index title: temporal server sidebar_label: server -description: nextLine +description: Commands for managing the Temporal Server. tags: - cli --- -Commands for managing the Temporal Server. - diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index f2a08ef5..3b7dd549 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -2,14 +2,11 @@ id: start-dev title: temporal server start-dev sidebar_label: start-dev -description: ### start-dev +description: Start Temporal development server. tags: - cli --- -### start-dev - -Start Temporal development server. **--config** Alias: **-c** diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index 9492eac9..cd1a5be3 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -2,14 +2,11 @@ id: describe title: temporal task-queue describe sidebar_label: describe -description: ### describe +description: Describes the Workers that have recently polled on this Task Queue. tags: - cli --- -### describe - -Describes the Workers that have recently polled on this Task Queue. The [Server](https://docs.temporal.io/clusters/#temporal-server) records the last time of each poll request. diff --git a/docs/task-queue/index.md b/docs/task-queue/index.md index e58f6b14..51b0f073 100644 --- a/docs/task-queue/index.md +++ b/docs/task-queue/index.md @@ -2,11 +2,9 @@ id: index title: temporal task-queue sidebar_label: task-queue -description: nextLine +description: Operations performed on Task Queues. tags: - cli --- -Operations performed on Task Queues. - diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index 2e1e5d47..db4ae523 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -2,14 +2,11 @@ id: list-partition title: temporal task-queue list-partition sidebar_label: list-partition -description: ### list-partition +description: Lists the [Task Queue's](https://docs.temporal.io/tasks/#task-queue) partitions and which matching node they are assigned to. tags: - cli --- -### list-partition - -Lists the [Task Queue's](https://docs.temporal.io/tasks/#task-queue) partitions and which matching node they are assigned to. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index 23356d85..13e812d6 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -2,14 +2,11 @@ id: cancel title: temporal workflow cancel sidebar_label: cancel -description: ### cancel +description: Cancel a Workflow Execution. tags: - cli --- -### cancel - -Cancel a Workflow Execution. Canceling a running Workflow Execution records a [`WorkflowExecutionCancelRequested` event](https://docs.temporal.io/references/events/#workflowexecutioncanceled) in the [Event History](https://docs.temporal.io/workflows/#event-history). diff --git a/docs/workflow/count.md b/docs/workflow/count.md index 7750bfd5..2847f9ee 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -2,14 +2,11 @@ id: count title: temporal workflow count sidebar_label: count -description: ### count +description: Count Workflow Executions (requires ElasticSearch to be enabled). tags: - cli --- -### count - -Count Workflow Executions (requires ElasticSearch to be enabled). **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index 544f1125..6d2998d8 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -2,14 +2,11 @@ id: delete title: temporal workflow delete sidebar_label: delete -description: ### delete +description: Deletes a Workflow Execution. tags: - cli --- -### delete - -Deletes a Workflow Execution. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index c2df162c..9906d2ed 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -2,14 +2,11 @@ id: describe title: temporal workflow describe sidebar_label: describe -description: ### describe +description: Show information about a Workflow Execution. tags: - cli --- -### describe - -Show information about a Workflow Execution. This information can be used to locate a Workflow Execution that failed. diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index 5911aafb..e0136829 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -2,14 +2,11 @@ id: execute title: temporal workflow execute sidebar_label: execute -description: ### execute +description: Start a new Workflow Execution and prints its progress. tags: - cli --- -### execute - -Start a new Workflow Execution and prints its progress. Single quotes('') are used to wrap input as JSON. diff --git a/docs/workflow/index.md b/docs/workflow/index.md index 38870490..4bf80a24 100644 --- a/docs/workflow/index.md +++ b/docs/workflow/index.md @@ -2,11 +2,9 @@ id: index title: temporal workflow sidebar_label: workflow -description: nextLine +description: Operations that can be performed on Workflows. tags: - cli --- -Operations that can be performed on Workflows. - diff --git a/docs/workflow/list.md b/docs/workflow/list.md index f006d7ab..75438ba8 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -2,14 +2,11 @@ id: list title: temporal workflow list sidebar_label: list -description: ### list +description: List Workflow Executions based on a Query. tags: - cli --- -### list - -List Workflow Executions based on a Query. By default, this command lists up to 10 closed Workflow Executions. diff --git a/docs/workflow/query.md b/docs/workflow/query.md index 29846fb3..eb0af3c3 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -2,14 +2,11 @@ id: query title: temporal workflow query sidebar_label: query -description: ### query +description: Query a Workflow Execution. tags: - cli --- -### query - -Query a Workflow Execution. Queries can retrieve all or part of the Workflow state within given parameters. Queries can also be used on completed [Workflows](https://docs.temporal.io/workflows/). diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 615e95fb..7e64ab26 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -2,14 +2,11 @@ id: reset-batch title: temporal workflow reset-batch sidebar_label: reset-batch -description: ### reset-batch +description: Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew tags: - cli --- -### reset-batch - -Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew Resetting a Workflow allows the process to resume from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history). @@ -85,5 +82,5 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 166473ba..d775842c 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -2,14 +2,11 @@ id: reset title: temporal workflow reset sidebar_label: reset -description: ### reset +description: Resets a Workflow Execution by Event Id or reset type. tags: - cli --- -### reset - -Resets a Workflow Execution by Event Id or reset type. A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history). diff --git a/docs/workflow/show.md b/docs/workflow/show.md index 7ad7d528..d0a25803 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -2,14 +2,11 @@ id: show title: temporal workflow show sidebar_label: show -description: ### show +description: Show Event History for a Workflow Execution. tags: - cli --- -### show - -Show Event History for a Workflow Execution. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index 0025f93c..7bf54f55 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -2,14 +2,11 @@ id: signal title: temporal workflow signal sidebar_label: signal -description: ### signal +description: Signal Workflow Execution by Id or List Filter. tags: - cli --- -### signal - -Signal Workflow Execution by Id or List Filter. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index bca8476b..3fa9c553 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -2,14 +2,11 @@ id: stack title: temporal workflow stack sidebar_label: stack -description: ### stack +description: Query a Workflow Execution with __stack_trace as the query type. tags: - cli --- -### stack - -Query a Workflow Execution with __stack_trace as the query type. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/start.md b/docs/workflow/start.md index 82c24bd9..f734709f 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -2,14 +2,11 @@ id: start title: temporal workflow start sidebar_label: start -description: ### start +description: Starts a new Workflow Execution. tags: - cli --- -### start - -Starts a new Workflow Execution. When invoked successfully, the Workflow and Run Ids of the recently started [Workflow](https://docs.temporal.io/workflows) are returned. diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index 82a000c1..49a2e367 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -2,14 +2,11 @@ id: terminate title: temporal workflow terminate sidebar_label: terminate -description: ### terminate +description: Terminate Workflow Execution by Id or List Filter. tags: - cli --- -### terminate - -Terminate Workflow Execution by Id or List Filter. Terminating a running Workflow records a [`WorkflowExecutionTerminated` event](https://docs.temporal.io/references/events/#workflowexecutionterminated) as the closing event. diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index 95dd8425..72ebd9a1 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -2,14 +2,11 @@ id: trace title: temporal workflow trace sidebar_label: trace -description: ### trace +description: Trace progress of a Workflow Execution and its children. tags: - cli --- -### trace - -Trace progress of a Workflow Execution and its children. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. From e9df95903f3dfaaa0a50970225a4d8d24774ff1e Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Fri, 20 Jan 2023 09:47:10 -0600 Subject: [PATCH 38/68] refactoring in progress --- cmd/doc/main.go | 39 ++++++++++++++++----------------------- docs/workflow/reset.md | 2 +- 2 files changed, 17 insertions(+), 24 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index dd8826c2..b7cd9958 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -37,11 +37,8 @@ type FMStruct struct { IsIndex bool } -var currentHeader string -var fileName string -var path string +var currentHeader, fileName, path, headerIndexFile string var currentHeaderFile *os.File -var headerIndexFile string // `BuildApp` takes a string and returns a `*App` and an error func main() { @@ -71,27 +68,12 @@ func main() { currentHeader = strings.TrimSpace(line[2:]) path = filepath.Join(docsPath, currentHeader) makeFile(path, true, scanner, createdFiles) - } else if strings.HasPrefix(line, "### ") { fileName = strings.TrimSpace(line[3:]) path = filepath.Join(docsPath, currentHeader) - // special condition for operator command file gen. if strings.Contains(currentHeader, "operator") { opPath := filepath.Join(path, fileName) - err := os.MkdirAll(opPath, os.ModePerm) - if err != nil { - log.Printf("Error when trying to create directory %s: %v", path, err) - continue - } - headerIndexFile := filepath.Join(opPath, indexFile) - currentHeaderFile, err = os.Create(headerIndexFile) - if err != nil { - log.Printf("Error when trying to create file %s: %v", headerIndexFile, err) - continue - } - createdFiles[headerIndexFile] = currentHeaderFile - - writeFrontMatter(strings.Trim(indexFile, ".md"), currentHeader, scanner, true, currentHeaderFile) + makeFile(opPath, true, scanner, createdFiles) } else { filePath := filepath.Join(path, fileName+".md") // check if already created file @@ -158,14 +140,25 @@ func makeFile(path string, isIndex bool, scanner *bufio.Scanner, createdFiles ma headerIndexFile = filepath.Join(path, indexFile) currentHeaderFile, err = os.Create(headerIndexFile) if err != nil { - log.Printf("Error when trying to create file %s: %v", headerIndexFile, err) + log.Printf("Error when trying to create index file %s: %v", headerIndexFile, err) } if err != nil { - log.Printf("Error when trying to create file %s: %v", headerIndexFile, err) + log.Printf("Error when trying to create index file %s: %v", headerIndexFile, err) } createdFiles[headerIndexFile] = currentHeaderFile writeFrontMatter(strings.Trim(indexFile, ".md"), currentHeader, scanner, true, currentHeaderFile) -} + } else { + // check if we already created the file + currentHeaderFile = createdFiles[path] + if currentHeaderFile == nil { + currentHeaderFile, err = os.Create(path) + if err != nil { + log.Printf("Error when trying to create non-index file %s: %v", path, err) + } + createdFiles[path] = currentHeaderFile + } + writeFrontMatter(fileName, currentHeader, scanner, false, currentHeaderFile) + } } // It takes a file and a string, and writes the string to the file diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index d775842c..721fd7b2 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -39,7 +39,7 @@ Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--reapply-type** -Event types to reapply after the reset point: , Signal, None. (default: All) +Event types to reapply after the reset point: Signal, None, . (default: All) **--reason** Reason to reset. From dd39439a1ec4a9d052518186faa7356240cc1a2a Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Fri, 20 Jan 2023 10:44:36 -0600 Subject: [PATCH 39/68] point before I go mess with things --- cmd/doc/main.go | 15 +++++++++++---- docs/workflow/reset.md | 2 +- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index b7cd9958..2fcc1217 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -37,8 +37,11 @@ type FMStruct struct { IsIndex bool } -var currentHeader, fileName, path, headerIndexFile string +var currentHeader string +var fileName string +var path string var currentHeaderFile *os.File +var headerIndexFile string // `BuildApp` takes a string and returns a `*App` and an error func main() { @@ -68,9 +71,11 @@ func main() { currentHeader = strings.TrimSpace(line[2:]) path = filepath.Join(docsPath, currentHeader) makeFile(path, true, scanner, createdFiles) + } else if strings.HasPrefix(line, "### ") { fileName = strings.TrimSpace(line[3:]) path = filepath.Join(docsPath, currentHeader) + // special condition for operator command file gen. if strings.Contains(currentHeader, "operator") { opPath := filepath.Join(path, fileName) makeFile(opPath, true, scanner, createdFiles) @@ -140,10 +145,10 @@ func makeFile(path string, isIndex bool, scanner *bufio.Scanner, createdFiles ma headerIndexFile = filepath.Join(path, indexFile) currentHeaderFile, err = os.Create(headerIndexFile) if err != nil { - log.Printf("Error when trying to create index file %s: %v", headerIndexFile, err) + log.Printf("Error when trying to create file %s: %v", headerIndexFile, err) } if err != nil { - log.Printf("Error when trying to create index file %s: %v", headerIndexFile, err) + log.Printf("Error when trying to create file %s: %v", headerIndexFile, err) } createdFiles[headerIndexFile] = currentHeaderFile writeFrontMatter(strings.Trim(indexFile, ".md"), currentHeader, scanner, true, currentHeaderFile) @@ -153,7 +158,7 @@ func makeFile(path string, isIndex bool, scanner *bufio.Scanner, createdFiles ma if currentHeaderFile == nil { currentHeaderFile, err = os.Create(path) if err != nil { - log.Printf("Error when trying to create non-index file %s: %v", path, err) + log.Printf("Error when trying to create file %s: %v", path, err) } createdFiles[path] = currentHeaderFile } @@ -161,6 +166,8 @@ func makeFile(path string, isIndex bool, scanner *bufio.Scanner, createdFiles ma } } +func MakeDirectory () {} + // It takes a file and a string, and writes the string to the file func writeLine(file *os.File, line string) { _, err := file.WriteString(line + "\n") diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 721fd7b2..049f4706 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -39,7 +39,7 @@ Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--reapply-type** -Event types to reapply after the reset point: Signal, None, . (default: All) +Event types to reapply after the reset point: None, , Signal. (default: All) **--reason** Reason to reset. From dfad2963319a77941f33271518a68d138132bf0c Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Fri, 20 Jan 2023 11:03:49 -0600 Subject: [PATCH 40/68] directory function --- cmd/doc/main.go | 22 +++++++++++++++++----- docs/workflow/reset-batch.md | 2 +- docs/workflow/reset.md | 4 ++-- 3 files changed, 20 insertions(+), 8 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 2fcc1217..4e01a3bf 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -16,6 +16,7 @@ const ( cliFile = "cli.md" filePerm = 0644 indexFile = "index.md" + optionsPath = "cmd-options" ) const FrontMatterTemplate = @@ -64,6 +65,8 @@ func main() { scanner.Split(bufio.ScanLines) createdFiles := make(map[string]*os.File) + + // TODO: identify different option categories and print flags accordingly for scanner.Scan() { line := scanner.Text() @@ -137,11 +140,10 @@ func main() { } func makeFile(path string, isIndex bool, scanner *bufio.Scanner, createdFiles map[string]*os.File) { - err := os.MkdirAll(path, os.ModePerm) - if err != nil { - log.Printf("Error when trying to create directory %s: %v", path, err) - } + var err error + MakeDirectory(true) if (isIndex) { + MakeDirectory(false) headerIndexFile = filepath.Join(path, indexFile) currentHeaderFile, err = os.Create(headerIndexFile) if err != nil { @@ -166,7 +168,17 @@ func makeFile(path string, isIndex bool, scanner *bufio.Scanner, createdFiles ma } } -func MakeDirectory () {} +func MakeDirectory (isOptions bool) { + var err error + if isOptions { + err = os.MkdirAll(filepath.Join(docsPath, optionsPath), os.ModePerm) + } else { + err = os.MkdirAll(path, os.ModePerm) + } + if err != nil { + log.Printf("Error when trying to create a directory %s: %v", path, err) + } +} // It takes a file and a string, and writes the string to the file func writeLine(file *os.File, line string) { diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 7e64ab26..e190d137 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -82,5 +82,5 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 049f4706..ac3df95a 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -39,7 +39,7 @@ Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--reapply-type** -Event types to reapply after the reset point: None, , Signal. (default: All) +Event types to reapply after the reset point: , Signal, None. (default: All) **--reason** Reason to reset. @@ -64,7 +64,7 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask **--workflow-id** Alias: **-w** From 10c9e0852d42a3a0318c959c09311f372fdd17d8 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Fri, 20 Jan 2023 11:53:00 -0600 Subject: [PATCH 41/68] added isOptions bool --- cmd/doc/main.go | 52 +++++++++++++++--------------------- docs/workflow/reset-batch.md | 2 +- docs/workflow/reset.md | 2 +- 3 files changed, 24 insertions(+), 32 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 4e01a3bf..17b8ecac 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -15,8 +15,8 @@ const ( docsPath = "docs" cliFile = "cli.md" filePerm = 0644 - indexFile = "index.md" - optionsPath = "cmd-options" + indexFile = "index.md" + optionsPath = "cmd-options" ) const FrontMatterTemplate = @@ -38,11 +38,8 @@ type FMStruct struct { IsIndex bool } -var currentHeader string -var fileName string -var path string +var currentHeader, fileName, path, headerIndexFile string var currentHeaderFile *os.File -var headerIndexFile string // `BuildApp` takes a string and returns a `*App` and an error func main() { @@ -65,23 +62,19 @@ func main() { scanner.Split(bufio.ScanLines) createdFiles := make(map[string]*os.File) - - // TODO: identify different option categories and print flags accordingly for scanner.Scan() { line := scanner.Text() if strings.HasPrefix(line, "## ") { currentHeader = strings.TrimSpace(line[2:]) path = filepath.Join(docsPath, currentHeader) - makeFile(path, true, scanner, createdFiles) - + makeFile(path, true, false, scanner, createdFiles) } else if strings.HasPrefix(line, "### ") { fileName = strings.TrimSpace(line[3:]) path = filepath.Join(docsPath, currentHeader) - // special condition for operator command file gen. if strings.Contains(currentHeader, "operator") { opPath := filepath.Join(path, fileName) - makeFile(opPath, true, scanner, createdFiles) + makeFile(opPath, true, false, scanner, createdFiles) } else { filePath := filepath.Join(path, fileName+".md") // check if already created file @@ -139,18 +132,29 @@ func main() { defer os.Remove(cliFile) } -func makeFile(path string, isIndex bool, scanner *bufio.Scanner, createdFiles map[string]*os.File) { +func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, createdFiles map[string]*os.File) { var err error - MakeDirectory(true) + + if (isOptions) { + err = os.MkdirAll(filepath.Join(docsPath, optionsPath), os.ModePerm) + if err != nil { + log.Printf("Error when trying to create a directory %s: %v", path, err) + } + } else { + err = os.MkdirAll(path, os.ModePerm) + if err != nil { + log.Printf("Error when trying to create a directory %s: %v", path, err) + } + } + if (isIndex) { - MakeDirectory(false) headerIndexFile = filepath.Join(path, indexFile) currentHeaderFile, err = os.Create(headerIndexFile) if err != nil { - log.Printf("Error when trying to create file %s: %v", headerIndexFile, err) + log.Printf("Error when trying to create index file %s: %v", headerIndexFile, err) } if err != nil { - log.Printf("Error when trying to create file %s: %v", headerIndexFile, err) + log.Printf("Error when trying to create index file %s: %v", headerIndexFile, err) } createdFiles[headerIndexFile] = currentHeaderFile writeFrontMatter(strings.Trim(indexFile, ".md"), currentHeader, scanner, true, currentHeaderFile) @@ -160,7 +164,7 @@ func makeFile(path string, isIndex bool, scanner *bufio.Scanner, createdFiles ma if currentHeaderFile == nil { currentHeaderFile, err = os.Create(path) if err != nil { - log.Printf("Error when trying to create file %s: %v", path, err) + log.Printf("Error when trying to create non-index file %s: %v", path, err) } createdFiles[path] = currentHeaderFile } @@ -168,18 +172,6 @@ func makeFile(path string, isIndex bool, scanner *bufio.Scanner, createdFiles ma } } -func MakeDirectory (isOptions bool) { - var err error - if isOptions { - err = os.MkdirAll(filepath.Join(docsPath, optionsPath), os.ModePerm) - } else { - err = os.MkdirAll(path, os.ModePerm) - } - if err != nil { - log.Printf("Error when trying to create a directory %s: %v", path, err) - } -} - // It takes a file and a string, and writes the string to the file func writeLine(file *os.File, line string) { _, err := file.WriteString(line + "\n") diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index e190d137..7e64ab26 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -82,5 +82,5 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index ac3df95a..d775842c 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -64,7 +64,7 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew **--workflow-id** Alias: **-w** From 382df9ac78890da31012485bd0312db0ea441857 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Fri, 20 Jan 2023 12:21:26 -0600 Subject: [PATCH 42/68] makeFile func, deleteExisting --- cmd/doc/main.go | 45 ++++++++++++++++++--------------------------- 1 file changed, 18 insertions(+), 27 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 17b8ecac..e0fdecfc 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -43,6 +43,8 @@ var currentHeaderFile *os.File // `BuildApp` takes a string and returns a `*App` and an error func main() { + deleteExistingFolder() + doc, err := app.BuildApp("").ToMarkdown() if err != nil { log.Fatalf("Error when trying to build app: %v", err) @@ -77,32 +79,12 @@ func main() { makeFile(opPath, true, false, scanner, createdFiles) } else { filePath := filepath.Join(path, fileName+".md") - // check if already created file - currentHeaderFile = createdFiles[filePath] - if currentHeaderFile == nil { - currentHeaderFile, err = os.Create(filePath) - if err != nil { - log.Printf("Error when trying to create file %s: %v", filePath, err) - continue - } - createdFiles[filePath] = currentHeaderFile - } - writeFrontMatter(fileName, currentHeader, scanner, false, currentHeaderFile) - } + makeFile(filePath, false, false, scanner, createdFiles) + } } else if strings.HasPrefix(line, "#### ") { operatorFileName := strings.TrimSpace(line[4:]) filePath := filepath.Join(path, fileName, operatorFileName+".md") - // check if already created file - currentHeaderFile = createdFiles[filePath] - if currentHeaderFile == nil { - currentHeaderFile, err = os.Create(filePath) - if err != nil { - log.Printf("Error when trying to create file %s: %v", filePath, err) - continue - } - createdFiles[filePath] = currentHeaderFile - } - writeFrontMatter(fileName, currentHeader, scanner, false, currentHeaderFile) + makeFile(filePath, false, false, scanner, createdFiles) } else if strings.HasPrefix(line, "**--") { // split into term and definition @@ -134,18 +116,18 @@ func main() { func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, createdFiles map[string]*os.File) { var err error - + if (isOptions) { err = os.MkdirAll(filepath.Join(docsPath, optionsPath), os.ModePerm) if err != nil { log.Printf("Error when trying to create a directory %s: %v", path, err) } - } else { + } else if (isIndex) { err = os.MkdirAll(path, os.ModePerm) if err != nil { log.Printf("Error when trying to create a directory %s: %v", path, err) } - } + } if (isIndex) { headerIndexFile = filepath.Join(path, indexFile) @@ -189,7 +171,7 @@ func makeAlias(file *os.File, line string) { } // write front matter -func writeFrontMatter (idName string, titleName string, scanner *bufio.Scanner, isIndex bool, currentHeaderFile *os.File) { +func writeFrontMatter(idName string, titleName string, scanner *bufio.Scanner, isIndex bool, currentHeaderFile *os.File) { for i := 0; i < 2; i++ { scanner.Scan() } @@ -210,3 +192,12 @@ func writeFrontMatter (idName string, titleName string, scanner *bufio.Scanner, } } +func deleteExistingFolder() { + // delete existing docs folder (if applicable) + folderinfo, err := os.Stat(filepath.Join(docsPath)) + if os.IsExist(err) { + os.RemoveAll(filepath.Join(docsPath)) + } + log.Println("deleted docs folder, %v", folderinfo) +} + From 968eecc3c6a2e5d9839ed90955c80d49fccb296d Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Fri, 20 Jan 2023 13:27:19 -0600 Subject: [PATCH 43/68] makeFile restructure --- cmd/doc/main.go | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index e0fdecfc..196019b9 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -92,9 +92,6 @@ func main() { // write to file term = strings.TrimSuffix(term, "=\"\"") - - // TODO: make files and separate directory and reference THAT - if strings.Contains(term, ",") { makeAlias(currentHeaderFile, term) } else { @@ -102,6 +99,7 @@ func main() { } writeLine(currentHeaderFile, strings.TrimSpace(definition)) log.Info(found) + } else if strings.Contains(line, ">") { writeLine(currentHeaderFile, strings.Trim(line, ">")) @@ -127,9 +125,6 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, if err != nil { log.Printf("Error when trying to create a directory %s: %v", path, err) } - } - - if (isIndex) { headerIndexFile = filepath.Join(path, indexFile) currentHeaderFile, err = os.Create(headerIndexFile) if err != nil { @@ -193,11 +188,12 @@ func writeFrontMatter(idName string, titleName string, scanner *bufio.Scanner, i } func deleteExistingFolder() { - // delete existing docs folder (if applicable) - folderinfo, err := os.Stat(filepath.Join(docsPath)) - if os.IsExist(err) { - os.RemoveAll(filepath.Join(docsPath)) + folderinfo, err := os.Stat(docsPath) + if os.IsNotExist(err) { + log.Info("Folder doesn't exist.") + return } - log.Println("deleted docs folder, %v", folderinfo) + os.RemoveAll(docsPath) + log.Println("deleted docs folder %v", folderinfo) } From 66f6ff16783eabf20cff9f49b78102a9817bce9d Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Fri, 20 Jan 2023 13:27:28 -0600 Subject: [PATCH 44/68] precautionary commit --- docs/workflow/reset-batch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 7e64ab26..e190d137 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -82,5 +82,5 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask From 727235d53b6f61e65f0443a895e393428f8eedb2 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Fri, 20 Jan 2023 15:13:31 -0600 Subject: [PATCH 45/68] cmd-options folder generating --- cmd/doc/main.go | 27 +++++++++++++++++++-------- docs/workflow/reset-batch.md | 2 +- 2 files changed, 20 insertions(+), 9 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 196019b9..94b90149 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -38,8 +38,8 @@ type FMStruct struct { IsIndex bool } -var currentHeader, fileName, path, headerIndexFile string -var currentHeaderFile *os.File +var currentHeader, fileName, optionFileName, path, optionFilePath, headerIndexFile string +var currentHeaderFile, currentOptionFile *os.File // `BuildApp` takes a string and returns a `*App` and an error func main() { @@ -89,8 +89,6 @@ func main() { } else if strings.HasPrefix(line, "**--") { // split into term and definition term, definition, found := strings.Cut(line, ":") - - // write to file term = strings.TrimSuffix(term, "=\"\"") if strings.Contains(term, ",") { makeAlias(currentHeaderFile, term) @@ -99,7 +97,15 @@ func main() { } writeLine(currentHeaderFile, strings.TrimSpace(definition)) log.Info(found) - + + optionFileName = strings.Trim(term, "*-,") + //filePath := filepath.Join(docsPath, optionsPath, optionFileName+".md") + err = os.MkdirAll(filepath.Join(docsPath, optionsPath), os.ModePerm) + if err != nil { + log.Printf("Error when trying to create options directory %s: %v", path, err) + } + //makeFile(filePath, false, true, scanner, createdFiles) + } else if strings.Contains(line, ">") { writeLine(currentHeaderFile, strings.Trim(line, ">")) @@ -116,10 +122,15 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, var err error if (isOptions) { - err = os.MkdirAll(filepath.Join(docsPath, optionsPath), os.ModePerm) - if err != nil { - log.Printf("Error when trying to create a directory %s: %v", path, err) + currentOptionFile = createdFiles[path] + if currentOptionFile == nil { + currentOptionFile, err = os.Create(path) + if err != nil { + log.Printf("Error when trying to create options file %s: %v", path, err) + } + createdFiles[path] = currentOptionFile } + writeFrontMatter(optionFileName, "", scanner, false, currentOptionFile) } else if (isIndex) { err = os.MkdirAll(path, os.ModePerm) if err != nil { diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index e190d137..e73587aa 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -82,5 +82,5 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask From 316264a3feba14bda038f2adeb18a38996f3f3f0 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Fri, 20 Jan 2023 15:55:58 -0600 Subject: [PATCH 46/68] now --- cmd/doc/main.go | 26 ++++++++++++++++---------- docs/workflow/reset-batch.md | 2 +- docs/workflow/reset.md | 2 +- 3 files changed, 18 insertions(+), 12 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 94b90149..c5cc8ed4 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -94,17 +94,18 @@ func main() { makeAlias(currentHeaderFile, term) } else { writeLine(currentHeaderFile, term) + optionFileName = term } writeLine(currentHeaderFile, strings.TrimSpace(definition)) - log.Info(found) + log.Info("string split successfully into term and definition (%v)",found) + + optionFileName = strings.TrimPrefix(optionFileName, "**--") + optionFileName = strings.TrimSuffix(optionFileName, "**") + + filePath := filepath.Join(docsPath, optionsPath, optionFileName+".md") - optionFileName = strings.Trim(term, "*-,") - //filePath := filepath.Join(docsPath, optionsPath, optionFileName+".md") - err = os.MkdirAll(filepath.Join(docsPath, optionsPath), os.ModePerm) - if err != nil { - log.Printf("Error when trying to create options directory %s: %v", path, err) - } //makeFile(filePath, false, true, scanner, createdFiles) + log.Println(filePath) } else if strings.Contains(line, ">") { @@ -120,17 +121,21 @@ func main() { func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, createdFiles map[string]*os.File) { var err error - if (isOptions) { - currentOptionFile = createdFiles[path] + err = os.MkdirAll(filepath.Join(docsPath, optionsPath), os.ModePerm) + if err != nil { + log.Printf("Error when trying to create options directory %s: %v", path, err) + } + optionFileName = filepath.Join() if currentOptionFile == nil { currentOptionFile, err = os.Create(path) if err != nil { log.Printf("Error when trying to create options file %s: %v", path, err) } createdFiles[path] = currentOptionFile + writeFrontMatter(optionFileName, "", scanner, false, currentOptionFile) + } - writeFrontMatter(optionFileName, "", scanner, false, currentOptionFile) } else if (isIndex) { err = os.MkdirAll(path, os.ModePerm) if err != nil { @@ -174,6 +179,7 @@ func makeAlias(file *os.File, line string) { termArray := strings.Split(line, ",") writeLine(file, termArray[0] + "**") writeLine(file, "Alias: **" + strings.TrimSpace(termArray[1])) + optionFileName = termArray[0] } // write front matter diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index e73587aa..7e64ab26 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -82,5 +82,5 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index d775842c..ac3df95a 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -64,7 +64,7 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask **--workflow-id** Alias: **-w** From 67b7b7525c570aa7c3dfc254bd2685b8a2b3fee6 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Fri, 20 Jan 2023 16:15:35 -0600 Subject: [PATCH 47/68] cmd-options files initialized --- cmd/doc/main.go | 26 +++++++------------ docs/cmd-options/active-cluster.md | 0 docs/cmd-options/activity-id.md | 0 docs/cmd-options/address.md | 0 docs/cmd-options/archived.md | 0 docs/cmd-options/calendar.md | 0 docs/cmd-options/catchup-window.md | 0 docs/cmd-options/cluster.md | 0 docs/cmd-options/codec-auth.md | 0 docs/cmd-options/codec-endpoint.md | 0 docs/cmd-options/color.md | 0 docs/cmd-options/concurrency.md | 0 docs/cmd-options/config.md | 0 docs/cmd-options/context-timeout.md | 0 docs/cmd-options/cron.md | 0 docs/cmd-options/data.md | 0 docs/cmd-options/db-filename.md | 0 docs/cmd-options/depth.md | 0 docs/cmd-options/description.md | 0 docs/cmd-options/detail.md | 0 docs/cmd-options/dry-run.md | 0 docs/cmd-options/dynamic-config-value.md | 0 docs/cmd-options/email.md | 0 docs/cmd-options/enable-connection.md | 0 docs/cmd-options/end-time.md | 0 docs/cmd-options/env.md | 0 docs/cmd-options/event-id.md | 0 docs/cmd-options/exclude-file.md | 0 docs/cmd-options/execution-timeout.md | 0 docs/cmd-options/fields.md | 0 docs/cmd-options/fold.md | 0 docs/cmd-options/follow.md | 0 docs/cmd-options/frontend-address.md | 0 docs/cmd-options/global.md | 0 docs/cmd-options/grpc-meta.md | 0 docs/cmd-options/headless.md | 0 docs/cmd-options/history-archival-state.md | 0 docs/cmd-options/history-uri.md | 0 docs/cmd-options/id-reuse-policy.md | 0 docs/cmd-options/identity.md | 0 docs/cmd-options/input-file.md | 0 docs/cmd-options/input-parallelism.md | 0 docs/cmd-options/input-separator.md | 0 docs/cmd-options/input.md | 0 docs/cmd-options/interval.md | 0 docs/cmd-options/ip.md | 0 docs/cmd-options/jitter.md | 0 docs/cmd-options/job-id.md | 0 docs/cmd-options/limit.md | 0 docs/cmd-options/log-format.md | 0 docs/cmd-options/log-level.md | 0 docs/cmd-options/max-field-length.md | 0 docs/cmd-options/memo-file.md | 0 docs/cmd-options/memo.md | 0 docs/cmd-options/metrics-port.md | 0 docs/cmd-options/name.md | 0 docs/cmd-options/namespace-id.md | 0 docs/cmd-options/namespace.md | 0 docs/cmd-options/no-fold.md | 0 docs/cmd-options/no-pager.md | 0 docs/cmd-options/non-deterministic.md | 0 docs/cmd-options/notes.md | 0 docs/cmd-options/output-filename.md | 0 docs/cmd-options/output.md | 0 docs/cmd-options/overlap-policy.md | 0 docs/cmd-options/pager.md | 0 docs/cmd-options/pause-on-failure.md | 0 docs/cmd-options/pause.md | 0 docs/cmd-options/port.md | 0 docs/cmd-options/promote-global.md | 0 docs/cmd-options/query.md | 0 docs/cmd-options/raw.md | 0 docs/cmd-options/reapply-type.md | 0 docs/cmd-options/reason.md | 0 docs/cmd-options/reject-condition.md | 0 docs/cmd-options/remaining-actions.md | 0 docs/cmd-options/reset-points.md | 0 docs/cmd-options/result.md | 0 docs/cmd-options/retention.md | 0 docs/cmd-options/run-id.md | 0 docs/cmd-options/run-timeout.md | 0 docs/cmd-options/schedule-id.md | 0 docs/cmd-options/search-attribute.md | 0 docs/cmd-options/skip-base-is-not-current.md | 0 docs/cmd-options/skip-current-open.md | 0 docs/cmd-options/sqlite-pragma.md | 0 docs/cmd-options/start-time.md | 0 docs/cmd-options/task-queue-type.md | 0 docs/cmd-options/task-queue.md | 0 docs/cmd-options/task-timeout.md | 0 docs/cmd-options/time-format.md | 0 docs/cmd-options/time-zone.md | 0 docs/cmd-options/tls-ca-path.md | 0 docs/cmd-options/tls-cert-path.md | 0 .../tls-disable-host-verification.md | 0 docs/cmd-options/tls-key-path.md | 0 docs/cmd-options/tls-server-name.md | 0 docs/cmd-options/type.md | 0 docs/cmd-options/ui-asset-path.md | 0 docs/cmd-options/ui-codec-endpoint.md | 0 docs/cmd-options/ui-ip.md | 0 docs/cmd-options/ui-port.md | 0 docs/cmd-options/unpause.md | 0 docs/cmd-options/visibility-archival-state.md | 0 docs/cmd-options/visibility-uri.md | 0 docs/cmd-options/workflow-id.md | 0 docs/cmd-options/workflow-type.md | 0 docs/cmd-options/yes.md | 0 docs/workflow/reset.md | 2 +- 109 files changed, 10 insertions(+), 18 deletions(-) create mode 100644 docs/cmd-options/active-cluster.md create mode 100644 docs/cmd-options/activity-id.md create mode 100644 docs/cmd-options/address.md create mode 100644 docs/cmd-options/archived.md create mode 100644 docs/cmd-options/calendar.md create mode 100644 docs/cmd-options/catchup-window.md create mode 100644 docs/cmd-options/cluster.md create mode 100644 docs/cmd-options/codec-auth.md create mode 100644 docs/cmd-options/codec-endpoint.md create mode 100644 docs/cmd-options/color.md create mode 100644 docs/cmd-options/concurrency.md create mode 100644 docs/cmd-options/config.md create mode 100644 docs/cmd-options/context-timeout.md create mode 100644 docs/cmd-options/cron.md create mode 100644 docs/cmd-options/data.md create mode 100644 docs/cmd-options/db-filename.md create mode 100644 docs/cmd-options/depth.md create mode 100644 docs/cmd-options/description.md create mode 100644 docs/cmd-options/detail.md create mode 100644 docs/cmd-options/dry-run.md create mode 100644 docs/cmd-options/dynamic-config-value.md create mode 100644 docs/cmd-options/email.md create mode 100644 docs/cmd-options/enable-connection.md create mode 100644 docs/cmd-options/end-time.md create mode 100644 docs/cmd-options/env.md create mode 100644 docs/cmd-options/event-id.md create mode 100644 docs/cmd-options/exclude-file.md create mode 100644 docs/cmd-options/execution-timeout.md create mode 100644 docs/cmd-options/fields.md create mode 100644 docs/cmd-options/fold.md create mode 100644 docs/cmd-options/follow.md create mode 100644 docs/cmd-options/frontend-address.md create mode 100644 docs/cmd-options/global.md create mode 100644 docs/cmd-options/grpc-meta.md create mode 100644 docs/cmd-options/headless.md create mode 100644 docs/cmd-options/history-archival-state.md create mode 100644 docs/cmd-options/history-uri.md create mode 100644 docs/cmd-options/id-reuse-policy.md create mode 100644 docs/cmd-options/identity.md create mode 100644 docs/cmd-options/input-file.md create mode 100644 docs/cmd-options/input-parallelism.md create mode 100644 docs/cmd-options/input-separator.md create mode 100644 docs/cmd-options/input.md create mode 100644 docs/cmd-options/interval.md create mode 100644 docs/cmd-options/ip.md create mode 100644 docs/cmd-options/jitter.md create mode 100644 docs/cmd-options/job-id.md create mode 100644 docs/cmd-options/limit.md create mode 100644 docs/cmd-options/log-format.md create mode 100644 docs/cmd-options/log-level.md create mode 100644 docs/cmd-options/max-field-length.md create mode 100644 docs/cmd-options/memo-file.md create mode 100644 docs/cmd-options/memo.md create mode 100644 docs/cmd-options/metrics-port.md create mode 100644 docs/cmd-options/name.md create mode 100644 docs/cmd-options/namespace-id.md create mode 100644 docs/cmd-options/namespace.md create mode 100644 docs/cmd-options/no-fold.md create mode 100644 docs/cmd-options/no-pager.md create mode 100644 docs/cmd-options/non-deterministic.md create mode 100644 docs/cmd-options/notes.md create mode 100644 docs/cmd-options/output-filename.md create mode 100644 docs/cmd-options/output.md create mode 100644 docs/cmd-options/overlap-policy.md create mode 100644 docs/cmd-options/pager.md create mode 100644 docs/cmd-options/pause-on-failure.md create mode 100644 docs/cmd-options/pause.md create mode 100644 docs/cmd-options/port.md create mode 100644 docs/cmd-options/promote-global.md create mode 100644 docs/cmd-options/query.md create mode 100644 docs/cmd-options/raw.md create mode 100644 docs/cmd-options/reapply-type.md create mode 100644 docs/cmd-options/reason.md create mode 100644 docs/cmd-options/reject-condition.md create mode 100644 docs/cmd-options/remaining-actions.md create mode 100644 docs/cmd-options/reset-points.md create mode 100644 docs/cmd-options/result.md create mode 100644 docs/cmd-options/retention.md create mode 100644 docs/cmd-options/run-id.md create mode 100644 docs/cmd-options/run-timeout.md create mode 100644 docs/cmd-options/schedule-id.md create mode 100644 docs/cmd-options/search-attribute.md create mode 100644 docs/cmd-options/skip-base-is-not-current.md create mode 100644 docs/cmd-options/skip-current-open.md create mode 100644 docs/cmd-options/sqlite-pragma.md create mode 100644 docs/cmd-options/start-time.md create mode 100644 docs/cmd-options/task-queue-type.md create mode 100644 docs/cmd-options/task-queue.md create mode 100644 docs/cmd-options/task-timeout.md create mode 100644 docs/cmd-options/time-format.md create mode 100644 docs/cmd-options/time-zone.md create mode 100644 docs/cmd-options/tls-ca-path.md create mode 100644 docs/cmd-options/tls-cert-path.md create mode 100644 docs/cmd-options/tls-disable-host-verification.md create mode 100644 docs/cmd-options/tls-key-path.md create mode 100644 docs/cmd-options/tls-server-name.md create mode 100644 docs/cmd-options/type.md create mode 100644 docs/cmd-options/ui-asset-path.md create mode 100644 docs/cmd-options/ui-codec-endpoint.md create mode 100644 docs/cmd-options/ui-ip.md create mode 100644 docs/cmd-options/ui-port.md create mode 100644 docs/cmd-options/unpause.md create mode 100644 docs/cmd-options/visibility-archival-state.md create mode 100644 docs/cmd-options/visibility-uri.md create mode 100644 docs/cmd-options/workflow-id.md create mode 100644 docs/cmd-options/workflow-type.md create mode 100644 docs/cmd-options/yes.md diff --git a/cmd/doc/main.go b/cmd/doc/main.go index c5cc8ed4..65131740 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -102,11 +102,9 @@ func main() { optionFileName = strings.TrimPrefix(optionFileName, "**--") optionFileName = strings.TrimSuffix(optionFileName, "**") - filePath := filepath.Join(docsPath, optionsPath, optionFileName+".md") + optionFilePath = filepath.Join(docsPath, optionsPath, optionFileName+".md") - //makeFile(filePath, false, true, scanner, createdFiles) - log.Println(filePath) - + makeFile(optionFilePath, false, true, scanner, createdFiles) } else if strings.Contains(line, ">") { writeLine(currentHeaderFile, strings.Trim(line, ">")) @@ -126,17 +124,14 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, if err != nil { log.Printf("Error when trying to create options directory %s: %v", path, err) } - optionFileName = filepath.Join() - if currentOptionFile == nil { - currentOptionFile, err = os.Create(path) - if err != nil { - log.Printf("Error when trying to create options file %s: %v", path, err) - } - createdFiles[path] = currentOptionFile - writeFrontMatter(optionFileName, "", scanner, false, currentOptionFile) - + currentOptionFile, err = os.Create(optionFilePath) + if err != nil { + log.Printf("Error when trying to create option file %s: %v", optionFilePath, err) } - } else if (isIndex) { + createdFiles[optionFileName] = currentOptionFile + //writeFrontMatter(optionFileName, "", scanner, false, currentOptionFile) + + } else if (isIndex) { err = os.MkdirAll(path, os.ModePerm) if err != nil { log.Printf("Error when trying to create a directory %s: %v", path, err) @@ -146,9 +141,6 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, if err != nil { log.Printf("Error when trying to create index file %s: %v", headerIndexFile, err) } - if err != nil { - log.Printf("Error when trying to create index file %s: %v", headerIndexFile, err) - } createdFiles[headerIndexFile] = currentHeaderFile writeFrontMatter(strings.Trim(indexFile, ".md"), currentHeader, scanner, true, currentHeaderFile) } else { diff --git a/docs/cmd-options/active-cluster.md b/docs/cmd-options/active-cluster.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/activity-id.md b/docs/cmd-options/activity-id.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/address.md b/docs/cmd-options/address.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/archived.md b/docs/cmd-options/archived.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/calendar.md b/docs/cmd-options/calendar.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/catchup-window.md b/docs/cmd-options/catchup-window.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/cluster.md b/docs/cmd-options/cluster.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/codec-auth.md b/docs/cmd-options/codec-auth.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/codec-endpoint.md b/docs/cmd-options/codec-endpoint.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/color.md b/docs/cmd-options/color.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/concurrency.md b/docs/cmd-options/concurrency.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/config.md b/docs/cmd-options/config.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/context-timeout.md b/docs/cmd-options/context-timeout.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/cron.md b/docs/cmd-options/cron.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/data.md b/docs/cmd-options/data.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/db-filename.md b/docs/cmd-options/db-filename.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/depth.md b/docs/cmd-options/depth.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/description.md b/docs/cmd-options/description.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/detail.md b/docs/cmd-options/detail.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/dry-run.md b/docs/cmd-options/dry-run.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/dynamic-config-value.md b/docs/cmd-options/dynamic-config-value.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/email.md b/docs/cmd-options/email.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/enable-connection.md b/docs/cmd-options/enable-connection.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/end-time.md b/docs/cmd-options/end-time.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/env.md b/docs/cmd-options/env.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/event-id.md b/docs/cmd-options/event-id.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/exclude-file.md b/docs/cmd-options/exclude-file.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/execution-timeout.md b/docs/cmd-options/execution-timeout.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/fields.md b/docs/cmd-options/fields.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/fold.md b/docs/cmd-options/fold.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/follow.md b/docs/cmd-options/follow.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/frontend-address.md b/docs/cmd-options/frontend-address.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/global.md b/docs/cmd-options/global.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/grpc-meta.md b/docs/cmd-options/grpc-meta.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/headless.md b/docs/cmd-options/headless.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/history-archival-state.md b/docs/cmd-options/history-archival-state.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/history-uri.md b/docs/cmd-options/history-uri.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/id-reuse-policy.md b/docs/cmd-options/id-reuse-policy.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/identity.md b/docs/cmd-options/identity.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/input-file.md b/docs/cmd-options/input-file.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/input-parallelism.md b/docs/cmd-options/input-parallelism.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/input-separator.md b/docs/cmd-options/input-separator.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/input.md b/docs/cmd-options/input.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/interval.md b/docs/cmd-options/interval.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/ip.md b/docs/cmd-options/ip.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/jitter.md b/docs/cmd-options/jitter.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/job-id.md b/docs/cmd-options/job-id.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/limit.md b/docs/cmd-options/limit.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/log-format.md b/docs/cmd-options/log-format.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/log-level.md b/docs/cmd-options/log-level.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/max-field-length.md b/docs/cmd-options/max-field-length.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/memo-file.md b/docs/cmd-options/memo-file.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/memo.md b/docs/cmd-options/memo.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/metrics-port.md b/docs/cmd-options/metrics-port.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/name.md b/docs/cmd-options/name.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/namespace-id.md b/docs/cmd-options/namespace-id.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/namespace.md b/docs/cmd-options/namespace.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/no-fold.md b/docs/cmd-options/no-fold.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/no-pager.md b/docs/cmd-options/no-pager.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/non-deterministic.md b/docs/cmd-options/non-deterministic.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/notes.md b/docs/cmd-options/notes.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/output-filename.md b/docs/cmd-options/output-filename.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/output.md b/docs/cmd-options/output.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/overlap-policy.md b/docs/cmd-options/overlap-policy.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/pager.md b/docs/cmd-options/pager.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/pause-on-failure.md b/docs/cmd-options/pause-on-failure.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/pause.md b/docs/cmd-options/pause.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/port.md b/docs/cmd-options/port.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/promote-global.md b/docs/cmd-options/promote-global.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/query.md b/docs/cmd-options/query.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/raw.md b/docs/cmd-options/raw.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/reapply-type.md b/docs/cmd-options/reapply-type.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/reason.md b/docs/cmd-options/reason.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/reject-condition.md b/docs/cmd-options/reject-condition.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/remaining-actions.md b/docs/cmd-options/remaining-actions.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/reset-points.md b/docs/cmd-options/reset-points.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/result.md b/docs/cmd-options/result.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/retention.md b/docs/cmd-options/retention.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/run-id.md b/docs/cmd-options/run-id.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/run-timeout.md b/docs/cmd-options/run-timeout.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/schedule-id.md b/docs/cmd-options/schedule-id.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/search-attribute.md b/docs/cmd-options/search-attribute.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/skip-base-is-not-current.md b/docs/cmd-options/skip-base-is-not-current.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/skip-current-open.md b/docs/cmd-options/skip-current-open.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/sqlite-pragma.md b/docs/cmd-options/sqlite-pragma.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/start-time.md b/docs/cmd-options/start-time.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/task-queue-type.md b/docs/cmd-options/task-queue-type.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/task-queue.md b/docs/cmd-options/task-queue.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/task-timeout.md b/docs/cmd-options/task-timeout.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/time-format.md b/docs/cmd-options/time-format.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/time-zone.md b/docs/cmd-options/time-zone.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/tls-ca-path.md b/docs/cmd-options/tls-ca-path.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/tls-cert-path.md b/docs/cmd-options/tls-cert-path.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/tls-disable-host-verification.md b/docs/cmd-options/tls-disable-host-verification.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/tls-key-path.md b/docs/cmd-options/tls-key-path.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/tls-server-name.md b/docs/cmd-options/tls-server-name.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/type.md b/docs/cmd-options/type.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/ui-asset-path.md b/docs/cmd-options/ui-asset-path.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/ui-codec-endpoint.md b/docs/cmd-options/ui-codec-endpoint.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/ui-ip.md b/docs/cmd-options/ui-ip.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/ui-port.md b/docs/cmd-options/ui-port.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/unpause.md b/docs/cmd-options/unpause.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/visibility-archival-state.md b/docs/cmd-options/visibility-archival-state.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/visibility-uri.md b/docs/cmd-options/visibility-uri.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/workflow-id.md b/docs/cmd-options/workflow-id.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/workflow-type.md b/docs/cmd-options/workflow-type.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cmd-options/yes.md b/docs/cmd-options/yes.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index ac3df95a..d775842c 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -64,7 +64,7 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew **--workflow-id** Alias: **-w** From 1f9acdfe290a9b6ff8c947f497f75077f7aedb5f Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Fri, 20 Jan 2023 16:32:30 -0600 Subject: [PATCH 48/68] cmd-files have definitions --- cmd/doc/main.go | 15 +++++++++++---- docs/cmd-options/active-cluster.md | 10 ++++++++++ docs/cmd-options/activity-id.md | 10 ++++++++++ docs/cmd-options/address.md | 10 ++++++++++ docs/cmd-options/archived.md | 10 ++++++++++ docs/cmd-options/calendar.md | 10 ++++++++++ docs/cmd-options/catchup-window.md | 10 ++++++++++ docs/cmd-options/cluster.md | 10 ++++++++++ docs/cmd-options/codec-auth.md | 10 ++++++++++ docs/cmd-options/codec-endpoint.md | 10 ++++++++++ docs/cmd-options/color.md | 10 ++++++++++ docs/cmd-options/concurrency.md | 10 ++++++++++ docs/cmd-options/config.md | 10 ++++++++++ docs/cmd-options/context-timeout.md | 10 ++++++++++ docs/cmd-options/cron.md | 10 ++++++++++ docs/cmd-options/data.md | 10 ++++++++++ docs/cmd-options/db-filename.md | 10 ++++++++++ docs/cmd-options/depth.md | 10 ++++++++++ docs/cmd-options/description.md | 10 ++++++++++ docs/cmd-options/detail.md | 10 ++++++++++ docs/cmd-options/dry-run.md | 10 ++++++++++ docs/cmd-options/dynamic-config-value.md | 10 ++++++++++ docs/cmd-options/email.md | 10 ++++++++++ docs/cmd-options/enable-connection.md | 10 ++++++++++ docs/cmd-options/end-time.md | 10 ++++++++++ docs/cmd-options/env.md | 10 ++++++++++ docs/cmd-options/event-id.md | 10 ++++++++++ docs/cmd-options/exclude-file.md | 10 ++++++++++ docs/cmd-options/execution-timeout.md | 10 ++++++++++ docs/cmd-options/fields.md | 10 ++++++++++ docs/cmd-options/fold.md | 10 ++++++++++ docs/cmd-options/follow.md | 10 ++++++++++ docs/cmd-options/frontend-address.md | 10 ++++++++++ docs/cmd-options/global.md | 10 ++++++++++ docs/cmd-options/grpc-meta.md | 10 ++++++++++ docs/cmd-options/headless.md | 10 ++++++++++ docs/cmd-options/history-archival-state.md | 10 ++++++++++ docs/cmd-options/history-uri.md | 10 ++++++++++ docs/cmd-options/id-reuse-policy.md | 10 ++++++++++ docs/cmd-options/identity.md | 10 ++++++++++ docs/cmd-options/input-file.md | 10 ++++++++++ docs/cmd-options/input-parallelism.md | 10 ++++++++++ docs/cmd-options/input-separator.md | 10 ++++++++++ docs/cmd-options/input.md | 10 ++++++++++ docs/cmd-options/interval.md | 10 ++++++++++ docs/cmd-options/ip.md | 10 ++++++++++ docs/cmd-options/jitter.md | 10 ++++++++++ docs/cmd-options/job-id.md | 10 ++++++++++ docs/cmd-options/limit.md | 10 ++++++++++ docs/cmd-options/log-format.md | 10 ++++++++++ docs/cmd-options/log-level.md | 10 ++++++++++ docs/cmd-options/max-field-length.md | 10 ++++++++++ docs/cmd-options/memo-file.md | 10 ++++++++++ docs/cmd-options/memo.md | 10 ++++++++++ docs/cmd-options/metrics-port.md | 10 ++++++++++ docs/cmd-options/name.md | 10 ++++++++++ docs/cmd-options/namespace-id.md | 10 ++++++++++ docs/cmd-options/namespace.md | 10 ++++++++++ docs/cmd-options/no-fold.md | 10 ++++++++++ docs/cmd-options/no-pager.md | 10 ++++++++++ docs/cmd-options/non-deterministic.md | 10 ++++++++++ docs/cmd-options/notes.md | 10 ++++++++++ docs/cmd-options/output-filename.md | 10 ++++++++++ docs/cmd-options/output.md | 10 ++++++++++ docs/cmd-options/overlap-policy.md | 10 ++++++++++ docs/cmd-options/pager.md | 10 ++++++++++ docs/cmd-options/pause-on-failure.md | 10 ++++++++++ docs/cmd-options/pause.md | 10 ++++++++++ docs/cmd-options/port.md | 10 ++++++++++ docs/cmd-options/promote-global.md | 10 ++++++++++ docs/cmd-options/query.md | 10 ++++++++++ docs/cmd-options/raw.md | 10 ++++++++++ docs/cmd-options/reapply-type.md | 10 ++++++++++ docs/cmd-options/reason.md | 10 ++++++++++ docs/cmd-options/reject-condition.md | 10 ++++++++++ docs/cmd-options/remaining-actions.md | 10 ++++++++++ docs/cmd-options/reset-points.md | 10 ++++++++++ docs/cmd-options/result.md | 10 ++++++++++ docs/cmd-options/retention.md | 10 ++++++++++ docs/cmd-options/run-id.md | 10 ++++++++++ docs/cmd-options/run-timeout.md | 10 ++++++++++ docs/cmd-options/schedule-id.md | 10 ++++++++++ docs/cmd-options/search-attribute.md | 10 ++++++++++ docs/cmd-options/skip-base-is-not-current.md | 10 ++++++++++ docs/cmd-options/skip-current-open.md | 10 ++++++++++ docs/cmd-options/sqlite-pragma.md | 10 ++++++++++ docs/cmd-options/start-time.md | 10 ++++++++++ docs/cmd-options/task-queue-type.md | 10 ++++++++++ docs/cmd-options/task-queue.md | 10 ++++++++++ docs/cmd-options/task-timeout.md | 10 ++++++++++ docs/cmd-options/time-format.md | 10 ++++++++++ docs/cmd-options/time-zone.md | 10 ++++++++++ docs/cmd-options/tls-ca-path.md | 10 ++++++++++ docs/cmd-options/tls-cert-path.md | 10 ++++++++++ docs/cmd-options/tls-disable-host-verification.md | 10 ++++++++++ docs/cmd-options/tls-key-path.md | 10 ++++++++++ docs/cmd-options/tls-server-name.md | 10 ++++++++++ docs/cmd-options/type.md | 10 ++++++++++ docs/cmd-options/ui-asset-path.md | 10 ++++++++++ docs/cmd-options/ui-codec-endpoint.md | 10 ++++++++++ docs/cmd-options/ui-ip.md | 10 ++++++++++ docs/cmd-options/ui-port.md | 10 ++++++++++ docs/cmd-options/unpause.md | 10 ++++++++++ docs/cmd-options/visibility-archival-state.md | 10 ++++++++++ docs/cmd-options/visibility-uri.md | 10 ++++++++++ docs/cmd-options/workflow-id.md | 10 ++++++++++ docs/cmd-options/workflow-type.md | 10 ++++++++++ docs/cmd-options/yes.md | 10 ++++++++++ docs/workflow/reset-batch.md | 2 +- 109 files changed, 1082 insertions(+), 5 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 65131740..8bc8a902 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -105,6 +105,7 @@ func main() { optionFilePath = filepath.Join(docsPath, optionsPath, optionFileName+".md") makeFile(optionFilePath, false, true, scanner, createdFiles) + writeLine(currentOptionFile, definition) } else if strings.Contains(line, ">") { writeLine(currentHeaderFile, strings.Trim(line, ">")) @@ -129,7 +130,7 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, log.Printf("Error when trying to create option file %s: %v", optionFilePath, err) } createdFiles[optionFileName] = currentOptionFile - //writeFrontMatter(optionFileName, "", scanner, false, currentOptionFile) + writeFrontMatter(optionFileName, "", scanner, false, currentOptionFile) } else if (isIndex) { err = os.MkdirAll(path, os.ModePerm) @@ -176,10 +177,16 @@ func makeAlias(file *os.File, line string) { // write front matter func writeFrontMatter(idName string, titleName string, scanner *bufio.Scanner, isIndex bool, currentHeaderFile *os.File) { - for i := 0; i < 2; i++ { - scanner.Scan() + var descriptionTxt string + if (titleName != "") { + for i := 0; i < 2; i++ { + scanner.Scan() + } + descriptionTxt = scanner.Text() + } else { + descriptionTxt = "Definition for the " + idName + " command option." } - descriptionTxt := scanner.Text() + data := FMStruct{ ID: idName, Title: titleName, diff --git a/docs/cmd-options/active-cluster.md b/docs/cmd-options/active-cluster.md index e69de29b..251175bc 100644 --- a/docs/cmd-options/active-cluster.md +++ b/docs/cmd-options/active-cluster.md @@ -0,0 +1,10 @@ +--- +id: active-cluster +title: temporal active-cluster +sidebar_label: active-cluster +description: Definition for the active-cluster command option. +tags: + - cli +--- + + Active cluster name diff --git a/docs/cmd-options/activity-id.md b/docs/cmd-options/activity-id.md index e69de29b..0dbd3606 100644 --- a/docs/cmd-options/activity-id.md +++ b/docs/cmd-options/activity-id.md @@ -0,0 +1,10 @@ +--- +id: activity-id +title: temporal activity-id +sidebar_label: activity-id +description: Definition for the activity-id command option. +tags: + - cli +--- + + Identifies the Activity to fail. diff --git a/docs/cmd-options/address.md b/docs/cmd-options/address.md index e69de29b..71b4309b 100644 --- a/docs/cmd-options/address.md +++ b/docs/cmd-options/address.md @@ -0,0 +1,10 @@ +--- +id: address +title: temporal address +sidebar_label: address +description: Definition for the address command option. +tags: + - cli +--- + + The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/cmd-options/archived.md b/docs/cmd-options/archived.md index e69de29b..d21844a4 100644 --- a/docs/cmd-options/archived.md +++ b/docs/cmd-options/archived.md @@ -0,0 +1,10 @@ +--- +id: archived +title: temporal archived +sidebar_label: archived +description: Definition for the archived command option. +tags: + - cli +--- + + List archived Workflow Executions. diff --git a/docs/cmd-options/calendar.md b/docs/cmd-options/calendar.md index e69de29b..ff83e2e2 100644 --- a/docs/cmd-options/calendar.md +++ b/docs/cmd-options/calendar.md @@ -0,0 +1,10 @@ +--- +id: calendar +title: temporal calendar +sidebar_label: calendar +description: Definition for the calendar command option. +tags: + - cli +--- + + Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} diff --git a/docs/cmd-options/catchup-window.md b/docs/cmd-options/catchup-window.md index e69de29b..2c8e557c 100644 --- a/docs/cmd-options/catchup-window.md +++ b/docs/cmd-options/catchup-window.md @@ -0,0 +1,10 @@ +--- +id: catchup-window +title: temporal catchup-window +sidebar_label: catchup-window +description: Definition for the catchup-window command option. +tags: + - cli +--- + + Maximum allowed catch-up time if server is down diff --git a/docs/cmd-options/cluster.md b/docs/cmd-options/cluster.md index e69de29b..1a15fb4e 100644 --- a/docs/cmd-options/cluster.md +++ b/docs/cmd-options/cluster.md @@ -0,0 +1,10 @@ +--- +id: cluster +title: temporal cluster +sidebar_label: cluster +description: Definition for the cluster command option. +tags: + - cli +--- + + Cluster name diff --git a/docs/cmd-options/codec-auth.md b/docs/cmd-options/codec-auth.md index e69de29b..d4e4bea0 100644 --- a/docs/cmd-options/codec-auth.md +++ b/docs/cmd-options/codec-auth.md @@ -0,0 +1,10 @@ +--- +id: codec-auth +title: temporal codec-auth +sidebar_label: codec-auth +description: Definition for the codec-auth command option. +tags: + - cli +--- + + Sets the authorization header on requests to the Codec Server. diff --git a/docs/cmd-options/codec-endpoint.md b/docs/cmd-options/codec-endpoint.md index e69de29b..8619f9e2 100644 --- a/docs/cmd-options/codec-endpoint.md +++ b/docs/cmd-options/codec-endpoint.md @@ -0,0 +1,10 @@ +--- +id: codec-endpoint +title: temporal codec-endpoint +sidebar_label: codec-endpoint +description: Definition for the codec-endpoint command option. +tags: + - cli +--- + + Endpoint for a remote Codec Server. diff --git a/docs/cmd-options/color.md b/docs/cmd-options/color.md index e69de29b..73e19cdb 100644 --- a/docs/cmd-options/color.md +++ b/docs/cmd-options/color.md @@ -0,0 +1,10 @@ +--- +id: color +title: temporal color +sidebar_label: color +description: Definition for the color command option. +tags: + - cli +--- + + when to use color: auto, always, never. (default: auto) diff --git a/docs/cmd-options/concurrency.md b/docs/cmd-options/concurrency.md index e69de29b..58c8129b 100644 --- a/docs/cmd-options/concurrency.md +++ b/docs/cmd-options/concurrency.md @@ -0,0 +1,10 @@ +--- +id: concurrency +title: temporal concurrency +sidebar_label: concurrency +description: Definition for the concurrency command option. +tags: + - cli +--- + + Request concurrency (default: 10) diff --git a/docs/cmd-options/config.md b/docs/cmd-options/config.md index e69de29b..95e21d23 100644 --- a/docs/cmd-options/config.md +++ b/docs/cmd-options/config.md @@ -0,0 +1,10 @@ +--- +id: config +title: temporal config +sidebar_label: config +description: Definition for the config command option. +tags: + - cli +--- + + Path to config directory. diff --git a/docs/cmd-options/context-timeout.md b/docs/cmd-options/context-timeout.md index e69de29b..6130118e 100644 --- a/docs/cmd-options/context-timeout.md +++ b/docs/cmd-options/context-timeout.md @@ -0,0 +1,10 @@ +--- +id: context-timeout +title: temporal context-timeout +sidebar_label: context-timeout +description: Definition for the context-timeout command option. +tags: + - cli +--- + + An optional timeout for the context of an RPC call (in seconds). (default: 5) diff --git a/docs/cmd-options/cron.md b/docs/cmd-options/cron.md index e69de29b..28c37944 100644 --- a/docs/cmd-options/cron.md +++ b/docs/cmd-options/cron.md @@ -0,0 +1,10 @@ +--- +id: cron +title: temporal cron +sidebar_label: cron +description: Definition for the cron command option. +tags: + - cli +--- + + Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" diff --git a/docs/cmd-options/data.md b/docs/cmd-options/data.md index e69de29b..e0cfc7d9 100644 --- a/docs/cmd-options/data.md +++ b/docs/cmd-options/data.md @@ -0,0 +1,10 @@ +--- +id: data +title: temporal data +sidebar_label: data +description: Definition for the data command option. +tags: + - cli +--- + + Namespace data in a format key=value diff --git a/docs/cmd-options/db-filename.md b/docs/cmd-options/db-filename.md index e69de29b..8109efd2 100644 --- a/docs/cmd-options/db-filename.md +++ b/docs/cmd-options/db-filename.md @@ -0,0 +1,10 @@ +--- +id: db-filename +title: temporal db-filename +sidebar_label: db-filename +description: Definition for the db-filename command option. +tags: + - cli +--- + + File in which to persist Temporal state (by default, Workflows are lost when the process dies). diff --git a/docs/cmd-options/depth.md b/docs/cmd-options/depth.md index e69de29b..a54df4d0 100644 --- a/docs/cmd-options/depth.md +++ b/docs/cmd-options/depth.md @@ -0,0 +1,10 @@ +--- +id: depth +title: temporal depth +sidebar_label: depth +description: Definition for the depth command option. +tags: + - cli +--- + + Number of Child Workflows to expand, -1 to expand all Child Workflows. (default: -1) diff --git a/docs/cmd-options/description.md b/docs/cmd-options/description.md index e69de29b..13011745 100644 --- a/docs/cmd-options/description.md +++ b/docs/cmd-options/description.md @@ -0,0 +1,10 @@ +--- +id: description +title: temporal description +sidebar_label: description +description: Definition for the description command option. +tags: + - cli +--- + + Namespace description diff --git a/docs/cmd-options/detail.md b/docs/cmd-options/detail.md index e69de29b..f1acab4c 100644 --- a/docs/cmd-options/detail.md +++ b/docs/cmd-options/detail.md @@ -0,0 +1,10 @@ +--- +id: detail +title: temporal detail +sidebar_label: detail +description: Definition for the detail command option. +tags: + - cli +--- + + Detail to fail the Activity. diff --git a/docs/cmd-options/dry-run.md b/docs/cmd-options/dry-run.md index e69de29b..dcb360ca 100644 --- a/docs/cmd-options/dry-run.md +++ b/docs/cmd-options/dry-run.md @@ -0,0 +1,10 @@ +--- +id: dry-run +title: temporal dry-run +sidebar_label: dry-run +description: Definition for the dry-run command option. +tags: + - cli +--- + + Simulate reset without resetting any Workflow Executions. diff --git a/docs/cmd-options/dynamic-config-value.md b/docs/cmd-options/dynamic-config-value.md index e69de29b..94ba2f01 100644 --- a/docs/cmd-options/dynamic-config-value.md +++ b/docs/cmd-options/dynamic-config-value.md @@ -0,0 +1,10 @@ +--- +id: dynamic-config-value +title: temporal dynamic-config-value +sidebar_label: dynamic-config-value +description: Definition for the dynamic-config-value command option. +tags: + - cli +--- + + Dynamic config value, as KEY=JSON_VALUE (string values need quotes). diff --git a/docs/cmd-options/email.md b/docs/cmd-options/email.md index e69de29b..102e7014 100644 --- a/docs/cmd-options/email.md +++ b/docs/cmd-options/email.md @@ -0,0 +1,10 @@ +--- +id: email +title: temporal email +sidebar_label: email +description: Definition for the email command option. +tags: + - cli +--- + + Owner email diff --git a/docs/cmd-options/enable-connection.md b/docs/cmd-options/enable-connection.md index e69de29b..f5920ba9 100644 --- a/docs/cmd-options/enable-connection.md +++ b/docs/cmd-options/enable-connection.md @@ -0,0 +1,10 @@ +--- +id: enable-connection +title: temporal enable-connection +sidebar_label: enable-connection +description: Definition for the enable-connection command option. +tags: + - cli +--- + + Enable cross-cluster connection. diff --git a/docs/cmd-options/end-time.md b/docs/cmd-options/end-time.md index e69de29b..ec760e96 100644 --- a/docs/cmd-options/end-time.md +++ b/docs/cmd-options/end-time.md @@ -0,0 +1,10 @@ +--- +id: end-time +title: temporal end-time +sidebar_label: end-time +description: Definition for the end-time command option. +tags: + - cli +--- + + Backfill end time diff --git a/docs/cmd-options/env.md b/docs/cmd-options/env.md index e69de29b..544fec42 100644 --- a/docs/cmd-options/env.md +++ b/docs/cmd-options/env.md @@ -0,0 +1,10 @@ +--- +id: env +title: temporal env +sidebar_label: env +description: Definition for the env command option. +tags: + - cli +--- + + Name of the environment to read environmental variables from. (default: default) diff --git a/docs/cmd-options/event-id.md b/docs/cmd-options/event-id.md index e69de29b..86cca561 100644 --- a/docs/cmd-options/event-id.md +++ b/docs/cmd-options/event-id.md @@ -0,0 +1,10 @@ +--- +id: event-id +title: temporal event-id +sidebar_label: event-id +description: Definition for the event-id command option. +tags: + - cli +--- + + The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others. diff --git a/docs/cmd-options/exclude-file.md b/docs/cmd-options/exclude-file.md index e69de29b..188ebdd9 100644 --- a/docs/cmd-options/exclude-file.md +++ b/docs/cmd-options/exclude-file.md @@ -0,0 +1,10 @@ +--- +id: exclude-file +title: temporal exclude-file +sidebar_label: exclude-file +description: Definition for the exclude-file command option. +tags: + - cli +--- + + Input file that specifies Workflow Executions to exclude from resetting. diff --git a/docs/cmd-options/execution-timeout.md b/docs/cmd-options/execution-timeout.md index e69de29b..3b17bb63 100644 --- a/docs/cmd-options/execution-timeout.md +++ b/docs/cmd-options/execution-timeout.md @@ -0,0 +1,10 @@ +--- +id: execution-timeout +title: temporal execution-timeout +sidebar_label: execution-timeout +description: Definition for the execution-timeout command option. +tags: + - cli +--- + + Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) diff --git a/docs/cmd-options/fields.md b/docs/cmd-options/fields.md index e69de29b..ca5a50e3 100644 --- a/docs/cmd-options/fields.md +++ b/docs/cmd-options/fields.md @@ -0,0 +1,10 @@ +--- +id: fields +title: temporal fields +sidebar_label: fields +description: Definition for the fields command option. +tags: + - cli +--- + + Customize fields to print. Set to 'long' to automatically print more of main fields. diff --git a/docs/cmd-options/fold.md b/docs/cmd-options/fold.md index e69de29b..5125fabb 100644 --- a/docs/cmd-options/fold.md +++ b/docs/cmd-options/fold.md @@ -0,0 +1,10 @@ +--- +id: fold +title: temporal fold +sidebar_label: fold +description: Definition for the fold command option. +tags: + - cli +--- + + Statuses for which Child Workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied. (default: completed,canceled,terminated) diff --git a/docs/cmd-options/follow.md b/docs/cmd-options/follow.md index e69de29b..ef5cf500 100644 --- a/docs/cmd-options/follow.md +++ b/docs/cmd-options/follow.md @@ -0,0 +1,10 @@ +--- +id: follow +title: temporal follow +sidebar_label: follow +description: Definition for the follow command option. +tags: + - cli +--- + + Follow the progress of a Workflow Execution. diff --git a/docs/cmd-options/frontend-address.md b/docs/cmd-options/frontend-address.md index e69de29b..6a15973f 100644 --- a/docs/cmd-options/frontend-address.md +++ b/docs/cmd-options/frontend-address.md @@ -0,0 +1,10 @@ +--- +id: frontend-address +title: temporal frontend-address +sidebar_label: frontend-address +description: Definition for the frontend-address command option. +tags: + - cli +--- + + Frontend address of the remote Cluster. diff --git a/docs/cmd-options/global.md b/docs/cmd-options/global.md index e69de29b..f0a21c19 100644 --- a/docs/cmd-options/global.md +++ b/docs/cmd-options/global.md @@ -0,0 +1,10 @@ +--- +id: global +title: temporal global +sidebar_label: global +description: Definition for the global command option. +tags: + - cli +--- + + Flag to indicate whether namespace is a global namespace diff --git a/docs/cmd-options/grpc-meta.md b/docs/cmd-options/grpc-meta.md index e69de29b..0454d6c3 100644 --- a/docs/cmd-options/grpc-meta.md +++ b/docs/cmd-options/grpc-meta.md @@ -0,0 +1,10 @@ +--- +id: grpc-meta +title: temporal grpc-meta +sidebar_label: grpc-meta +description: Definition for the grpc-meta command option. +tags: + - cli +--- + + Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. diff --git a/docs/cmd-options/headless.md b/docs/cmd-options/headless.md index e69de29b..33e3aa48 100644 --- a/docs/cmd-options/headless.md +++ b/docs/cmd-options/headless.md @@ -0,0 +1,10 @@ +--- +id: headless +title: temporal headless +sidebar_label: headless +description: Definition for the headless command option. +tags: + - cli +--- + + Disable the Web UI. diff --git a/docs/cmd-options/history-archival-state.md b/docs/cmd-options/history-archival-state.md index e69de29b..7d27d9ff 100644 --- a/docs/cmd-options/history-archival-state.md +++ b/docs/cmd-options/history-archival-state.md @@ -0,0 +1,10 @@ +--- +id: history-archival-state +title: temporal history-archival-state +sidebar_label: history-archival-state +description: Definition for the history-archival-state command option. +tags: + - cli +--- + + Flag to set history archival state, valid values are "disabled" and "enabled" diff --git a/docs/cmd-options/history-uri.md b/docs/cmd-options/history-uri.md index e69de29b..1ba42565 100644 --- a/docs/cmd-options/history-uri.md +++ b/docs/cmd-options/history-uri.md @@ -0,0 +1,10 @@ +--- +id: history-uri +title: temporal history-uri +sidebar_label: history-uri +description: Definition for the history-uri command option. +tags: + - cli +--- + + Optionally specify history archival URI (cannot be changed after first time archival is enabled) diff --git a/docs/cmd-options/id-reuse-policy.md b/docs/cmd-options/id-reuse-policy.md index e69de29b..0fff91e8 100644 --- a/docs/cmd-options/id-reuse-policy.md +++ b/docs/cmd-options/id-reuse-policy.md @@ -0,0 +1,10 @@ +--- +id: id-reuse-policy +title: temporal id-reuse-policy +sidebar_label: id-reuse-policy +description: Definition for the id-reuse-policy command option. +tags: + - cli +--- + + Allows the same Workflow Id to be used in a new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. diff --git a/docs/cmd-options/identity.md b/docs/cmd-options/identity.md index e69de29b..62dfd63c 100644 --- a/docs/cmd-options/identity.md +++ b/docs/cmd-options/identity.md @@ -0,0 +1,10 @@ +--- +id: identity +title: temporal identity +sidebar_label: identity +description: Definition for the identity command option. +tags: + - cli +--- + + Specify the operator's identity. diff --git a/docs/cmd-options/input-file.md b/docs/cmd-options/input-file.md index e69de29b..85233de5 100644 --- a/docs/cmd-options/input-file.md +++ b/docs/cmd-options/input-file.md @@ -0,0 +1,10 @@ +--- +id: input-file +title: temporal input-file +sidebar_label: input-file +description: Definition for the input-file command option. +tags: + - cli +--- + + Passes optional input for the Workflow from a JSON file. diff --git a/docs/cmd-options/input-parallelism.md b/docs/cmd-options/input-parallelism.md index e69de29b..051116c3 100644 --- a/docs/cmd-options/input-parallelism.md +++ b/docs/cmd-options/input-parallelism.md @@ -0,0 +1,10 @@ +--- +id: input-parallelism +title: temporal input-parallelism +sidebar_label: input-parallelism +description: Definition for the input-parallelism command option. +tags: + - cli +--- + + Number of goroutines to run in parallel. Each goroutine processes one line for every second. (default: 1) diff --git a/docs/cmd-options/input-separator.md b/docs/cmd-options/input-separator.md index e69de29b..e64f85d5 100644 --- a/docs/cmd-options/input-separator.md +++ b/docs/cmd-options/input-separator.md @@ -0,0 +1,10 @@ +--- +id: input-separator +title: temporal input-separator +sidebar_label: input-separator +description: Definition for the input-separator command option. +tags: + - cli +--- + + Separator for the input file. The default is a tab ( ). (default: ) diff --git a/docs/cmd-options/input.md b/docs/cmd-options/input.md index e69de29b..761a6ba5 100644 --- a/docs/cmd-options/input.md +++ b/docs/cmd-options/input.md @@ -0,0 +1,10 @@ +--- +id: input +title: temporal input +sidebar_label: input +description: Definition for the input command option. +tags: + - cli +--- + + Optional JSON input to provide to the Workflow. diff --git a/docs/cmd-options/interval.md b/docs/cmd-options/interval.md index e69de29b..1e0e1f26 100644 --- a/docs/cmd-options/interval.md +++ b/docs/cmd-options/interval.md @@ -0,0 +1,10 @@ +--- +id: interval +title: temporal interval +sidebar_label: interval +description: Definition for the interval command option. +tags: + - cli +--- + + Interval duration, e.g. 90m, or 90m/13m to include phase offset. diff --git a/docs/cmd-options/ip.md b/docs/cmd-options/ip.md index e69de29b..a934e780 100644 --- a/docs/cmd-options/ip.md +++ b/docs/cmd-options/ip.md @@ -0,0 +1,10 @@ +--- +id: ip +title: temporal ip +sidebar_label: ip +description: Definition for the ip command option. +tags: + - cli +--- + + IPv4 address to bind the frontend service to. (default: 127.0.0.1) diff --git a/docs/cmd-options/jitter.md b/docs/cmd-options/jitter.md index e69de29b..71fd0feb 100644 --- a/docs/cmd-options/jitter.md +++ b/docs/cmd-options/jitter.md @@ -0,0 +1,10 @@ +--- +id: jitter +title: temporal jitter +sidebar_label: jitter +description: Definition for the jitter command option. +tags: + - cli +--- + + Jitter duration. diff --git a/docs/cmd-options/job-id.md b/docs/cmd-options/job-id.md index e69de29b..afa41889 100644 --- a/docs/cmd-options/job-id.md +++ b/docs/cmd-options/job-id.md @@ -0,0 +1,10 @@ +--- +id: job-id +title: temporal job-id +sidebar_label: job-id +description: Definition for the job-id command option. +tags: + - cli +--- + + Batch Job Id diff --git a/docs/cmd-options/limit.md b/docs/cmd-options/limit.md index e69de29b..c82b5737 100644 --- a/docs/cmd-options/limit.md +++ b/docs/cmd-options/limit.md @@ -0,0 +1,10 @@ +--- +id: limit +title: temporal limit +sidebar_label: limit +description: Definition for the limit command option. +tags: + - cli +--- + + Number of items to print. (default: 0) diff --git a/docs/cmd-options/log-format.md b/docs/cmd-options/log-format.md index e69de29b..fc01afb2 100644 --- a/docs/cmd-options/log-format.md +++ b/docs/cmd-options/log-format.md @@ -0,0 +1,10 @@ +--- +id: log-format +title: temporal log-format +sidebar_label: log-format +description: Definition for the log-format command option. +tags: + - cli +--- + + Set the log formatting. Options: ["json", "pretty"]. (default: json) diff --git a/docs/cmd-options/log-level.md b/docs/cmd-options/log-level.md index e69de29b..a82db6e1 100644 --- a/docs/cmd-options/log-level.md +++ b/docs/cmd-options/log-level.md @@ -0,0 +1,10 @@ +--- +id: log-level +title: temporal log-level +sidebar_label: log-level +description: Definition for the log-level command option. +tags: + - cli +--- + + Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) diff --git a/docs/cmd-options/max-field-length.md b/docs/cmd-options/max-field-length.md index e69de29b..403a21cd 100644 --- a/docs/cmd-options/max-field-length.md +++ b/docs/cmd-options/max-field-length.md @@ -0,0 +1,10 @@ +--- +id: max-field-length +title: temporal max-field-length +sidebar_label: max-field-length +description: Definition for the max-field-length command option. +tags: + - cli +--- + + Maximum length for each attribute field. (default: 0) diff --git a/docs/cmd-options/memo-file.md b/docs/cmd-options/memo-file.md index e69de29b..e1fdf611 100644 --- a/docs/cmd-options/memo-file.md +++ b/docs/cmd-options/memo-file.md @@ -0,0 +1,10 @@ +--- +id: memo-file +title: temporal memo-file +sidebar_label: memo-file +description: Definition for the memo-file command option. +tags: + - cli +--- + + Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value diff --git a/docs/cmd-options/memo.md b/docs/cmd-options/memo.md index e69de29b..f1236019 100644 --- a/docs/cmd-options/memo.md +++ b/docs/cmd-options/memo.md @@ -0,0 +1,10 @@ +--- +id: memo +title: temporal memo +sidebar_label: memo +description: Definition for the memo command option. +tags: + - cli +--- + + Set a memo on a schedule. Format: key=value. Use valid JSON formats for value diff --git a/docs/cmd-options/metrics-port.md b/docs/cmd-options/metrics-port.md index e69de29b..ebef1c1d 100644 --- a/docs/cmd-options/metrics-port.md +++ b/docs/cmd-options/metrics-port.md @@ -0,0 +1,10 @@ +--- +id: metrics-port +title: temporal metrics-port +sidebar_label: metrics-port +description: Definition for the metrics-port command option. +tags: + - cli +--- + + Port for /metrics. (default: 0) diff --git a/docs/cmd-options/name.md b/docs/cmd-options/name.md index e69de29b..b1b6d4f0 100644 --- a/docs/cmd-options/name.md +++ b/docs/cmd-options/name.md @@ -0,0 +1,10 @@ +--- +id: name +title: temporal name +sidebar_label: name +description: Definition for the name command option. +tags: + - cli +--- + + Frontend address of the remote Cluster. diff --git a/docs/cmd-options/namespace-id.md b/docs/cmd-options/namespace-id.md index e69de29b..0951644b 100644 --- a/docs/cmd-options/namespace-id.md +++ b/docs/cmd-options/namespace-id.md @@ -0,0 +1,10 @@ +--- +id: namespace-id +title: temporal namespace-id +sidebar_label: namespace-id +description: Definition for the namespace-id command option. +tags: + - cli +--- + + Namespace Id diff --git a/docs/cmd-options/namespace.md b/docs/cmd-options/namespace.md index e69de29b..fd8a255f 100644 --- a/docs/cmd-options/namespace.md +++ b/docs/cmd-options/namespace.md @@ -0,0 +1,10 @@ +--- +id: namespace +title: temporal namespace +sidebar_label: namespace +description: Definition for the namespace command option. +tags: + - cli +--- + + Identifies a Namespace in the Temporal Workflow. (default: default) diff --git a/docs/cmd-options/no-fold.md b/docs/cmd-options/no-fold.md index e69de29b..a3cdd790 100644 --- a/docs/cmd-options/no-fold.md +++ b/docs/cmd-options/no-fold.md @@ -0,0 +1,10 @@ +--- +id: no-fold +title: temporal no-fold +sidebar_label: no-fold +description: Definition for the no-fold command option. +tags: + - cli +--- + + Disable folding. All Child Workflows within the set depth will be fetched and displayed. diff --git a/docs/cmd-options/no-pager.md b/docs/cmd-options/no-pager.md index e69de29b..e88928d0 100644 --- a/docs/cmd-options/no-pager.md +++ b/docs/cmd-options/no-pager.md @@ -0,0 +1,10 @@ +--- +id: no-pager +title: temporal no-pager +sidebar_label: no-pager +description: Definition for the no-pager command option. +tags: + - cli +--- + + Disables the interactive pager. diff --git a/docs/cmd-options/non-deterministic.md b/docs/cmd-options/non-deterministic.md index e69de29b..8c189786 100644 --- a/docs/cmd-options/non-deterministic.md +++ b/docs/cmd-options/non-deterministic.md @@ -0,0 +1,10 @@ +--- +id: non-deterministic +title: temporal non-deterministic +sidebar_label: non-deterministic +description: Definition for the non-deterministic command option. +tags: + - cli +--- + + Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error. diff --git a/docs/cmd-options/notes.md b/docs/cmd-options/notes.md index e69de29b..029a696b 100644 --- a/docs/cmd-options/notes.md +++ b/docs/cmd-options/notes.md @@ -0,0 +1,10 @@ +--- +id: notes +title: temporal notes +sidebar_label: notes +description: Definition for the notes command option. +tags: + - cli +--- + + Initial value of notes field diff --git a/docs/cmd-options/output-filename.md b/docs/cmd-options/output-filename.md index e69de29b..24692f52 100644 --- a/docs/cmd-options/output-filename.md +++ b/docs/cmd-options/output-filename.md @@ -0,0 +1,10 @@ +--- +id: output-filename +title: temporal output-filename +sidebar_label: output-filename +description: Definition for the output-filename command option. +tags: + - cli +--- + + Serializes Event History to a file. diff --git a/docs/cmd-options/output.md b/docs/cmd-options/output.md index e69de29b..bf12c67e 100644 --- a/docs/cmd-options/output.md +++ b/docs/cmd-options/output.md @@ -0,0 +1,10 @@ +--- +id: output +title: temporal output +sidebar_label: output +description: Definition for the output command option. +tags: + - cli +--- + + format output as: table, json, card. (default: table) diff --git a/docs/cmd-options/overlap-policy.md b/docs/cmd-options/overlap-policy.md index e69de29b..9a62b306 100644 --- a/docs/cmd-options/overlap-policy.md +++ b/docs/cmd-options/overlap-policy.md @@ -0,0 +1,10 @@ +--- +id: overlap-policy +title: temporal overlap-policy +sidebar_label: overlap-policy +description: Definition for the overlap-policy command option. +tags: + - cli +--- + + Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll diff --git a/docs/cmd-options/pager.md b/docs/cmd-options/pager.md index e69de29b..c5599e17 100644 --- a/docs/cmd-options/pager.md +++ b/docs/cmd-options/pager.md @@ -0,0 +1,10 @@ +--- +id: pager +title: temporal pager +sidebar_label: pager +description: Definition for the pager command option. +tags: + - cli +--- + + Sets the pager for Temporal CLI to use. diff --git a/docs/cmd-options/pause-on-failure.md b/docs/cmd-options/pause-on-failure.md index e69de29b..48236cfc 100644 --- a/docs/cmd-options/pause-on-failure.md +++ b/docs/cmd-options/pause-on-failure.md @@ -0,0 +1,10 @@ +--- +id: pause-on-failure +title: temporal pause-on-failure +sidebar_label: pause-on-failure +description: Definition for the pause-on-failure command option. +tags: + - cli +--- + + Pause schedule after any workflow failure diff --git a/docs/cmd-options/pause.md b/docs/cmd-options/pause.md index e69de29b..df9231e4 100644 --- a/docs/cmd-options/pause.md +++ b/docs/cmd-options/pause.md @@ -0,0 +1,10 @@ +--- +id: pause +title: temporal pause +sidebar_label: pause +description: Definition for the pause command option. +tags: + - cli +--- + + Pauses the schedule diff --git a/docs/cmd-options/port.md b/docs/cmd-options/port.md index e69de29b..2a79fde7 100644 --- a/docs/cmd-options/port.md +++ b/docs/cmd-options/port.md @@ -0,0 +1,10 @@ +--- +id: port +title: temporal port +sidebar_label: port +description: Definition for the port command option. +tags: + - cli +--- + + Port for the frontend gRPC service. (default: 7233) diff --git a/docs/cmd-options/promote-global.md b/docs/cmd-options/promote-global.md index e69de29b..783406f5 100644 --- a/docs/cmd-options/promote-global.md +++ b/docs/cmd-options/promote-global.md @@ -0,0 +1,10 @@ +--- +id: promote-global +title: temporal promote-global +sidebar_label: promote-global +description: Definition for the promote-global command option. +tags: + - cli +--- + + Promote local namespace to global namespace diff --git a/docs/cmd-options/query.md b/docs/cmd-options/query.md index e69de29b..8f986a03 100644 --- a/docs/cmd-options/query.md +++ b/docs/cmd-options/query.md @@ -0,0 +1,10 @@ +--- +id: query +title: temporal query +sidebar_label: query +description: Definition for the query command option. +tags: + - cli +--- + + Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query. diff --git a/docs/cmd-options/raw.md b/docs/cmd-options/raw.md index e69de29b..9d4b5c0d 100644 --- a/docs/cmd-options/raw.md +++ b/docs/cmd-options/raw.md @@ -0,0 +1,10 @@ +--- +id: raw +title: temporal raw +sidebar_label: raw +description: Definition for the raw command option. +tags: + - cli +--- + + Print raw data as json (prefer this over -o json for scripting) diff --git a/docs/cmd-options/reapply-type.md b/docs/cmd-options/reapply-type.md index e69de29b..da69e12b 100644 --- a/docs/cmd-options/reapply-type.md +++ b/docs/cmd-options/reapply-type.md @@ -0,0 +1,10 @@ +--- +id: reapply-type +title: temporal reapply-type +sidebar_label: reapply-type +description: Definition for the reapply-type command option. +tags: + - cli +--- + + Event types to reapply after the reset point: , Signal, None. (default: All) diff --git a/docs/cmd-options/reason.md b/docs/cmd-options/reason.md index e69de29b..c5e30ccb 100644 --- a/docs/cmd-options/reason.md +++ b/docs/cmd-options/reason.md @@ -0,0 +1,10 @@ +--- +id: reason +title: temporal reason +sidebar_label: reason +description: Definition for the reason command option. +tags: + - cli +--- + + Reason for the operation diff --git a/docs/cmd-options/reject-condition.md b/docs/cmd-options/reject-condition.md index e69de29b..8e02c758 100644 --- a/docs/cmd-options/reject-condition.md +++ b/docs/cmd-options/reject-condition.md @@ -0,0 +1,10 @@ +--- +id: reject-condition +title: temporal reject-condition +sidebar_label: reject-condition +description: Definition for the reject-condition command option. +tags: + - cli +--- + + Optional flag for rejecting Queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly". diff --git a/docs/cmd-options/remaining-actions.md b/docs/cmd-options/remaining-actions.md index e69de29b..425a8d7c 100644 --- a/docs/cmd-options/remaining-actions.md +++ b/docs/cmd-options/remaining-actions.md @@ -0,0 +1,10 @@ +--- +id: remaining-actions +title: temporal remaining-actions +sidebar_label: remaining-actions +description: Definition for the remaining-actions command option. +tags: + - cli +--- + + Total number of actions allowed (default: 0) diff --git a/docs/cmd-options/reset-points.md b/docs/cmd-options/reset-points.md index e69de29b..0ae0c440 100644 --- a/docs/cmd-options/reset-points.md +++ b/docs/cmd-options/reset-points.md @@ -0,0 +1,10 @@ +--- +id: reset-points +title: temporal reset-points +sidebar_label: reset-points +description: Definition for the reset-points command option. +tags: + - cli +--- + + Only show Workflow Events that are eligible for reset. diff --git a/docs/cmd-options/result.md b/docs/cmd-options/result.md index e69de29b..c36cf649 100644 --- a/docs/cmd-options/result.md +++ b/docs/cmd-options/result.md @@ -0,0 +1,10 @@ +--- +id: result +title: temporal result +sidebar_label: result +description: Definition for the result command option. +tags: + - cli +--- + + Set the result value of Activity completion. diff --git a/docs/cmd-options/retention.md b/docs/cmd-options/retention.md index e69de29b..49ef9b13 100644 --- a/docs/cmd-options/retention.md +++ b/docs/cmd-options/retention.md @@ -0,0 +1,10 @@ +--- +id: retention +title: temporal retention +sidebar_label: retention +description: Definition for the retention command option. +tags: + - cli +--- + + Workflow Execution retention diff --git a/docs/cmd-options/run-id.md b/docs/cmd-options/run-id.md index e69de29b..2ad7ef98 100644 --- a/docs/cmd-options/run-id.md +++ b/docs/cmd-options/run-id.md @@ -0,0 +1,10 @@ +--- +id: run-id +title: temporal run-id +sidebar_label: run-id +description: Definition for the run-id command option. +tags: + - cli +--- + + Identifies the current Workflow Run. diff --git a/docs/cmd-options/run-timeout.md b/docs/cmd-options/run-timeout.md index e69de29b..55ec2975 100644 --- a/docs/cmd-options/run-timeout.md +++ b/docs/cmd-options/run-timeout.md @@ -0,0 +1,10 @@ +--- +id: run-timeout +title: temporal run-timeout +sidebar_label: run-timeout +description: Definition for the run-timeout command option. +tags: + - cli +--- + + Timeout (in seconds) of a single Workflow run. (default: 0) diff --git a/docs/cmd-options/schedule-id.md b/docs/cmd-options/schedule-id.md index e69de29b..d0125526 100644 --- a/docs/cmd-options/schedule-id.md +++ b/docs/cmd-options/schedule-id.md @@ -0,0 +1,10 @@ +--- +id: schedule-id +title: temporal schedule-id +sidebar_label: schedule-id +description: Definition for the schedule-id command option. +tags: + - cli +--- + + Schedule Id diff --git a/docs/cmd-options/search-attribute.md b/docs/cmd-options/search-attribute.md index e69de29b..fdedf58f 100644 --- a/docs/cmd-options/search-attribute.md +++ b/docs/cmd-options/search-attribute.md @@ -0,0 +1,10 @@ +--- +id: search-attribute +title: temporal search-attribute +sidebar_label: search-attribute +description: Definition for the search-attribute command option. +tags: + - cli +--- + + Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value diff --git a/docs/cmd-options/skip-base-is-not-current.md b/docs/cmd-options/skip-base-is-not-current.md index e69de29b..a816e379 100644 --- a/docs/cmd-options/skip-base-is-not-current.md +++ b/docs/cmd-options/skip-base-is-not-current.md @@ -0,0 +1,10 @@ +--- +id: skip-base-is-not-current +title: temporal skip-base-is-not-current +sidebar_label: skip-base-is-not-current +description: Definition for the skip-base-is-not-current command option. +tags: + - cli +--- + + Skip a Workflow Execution if the base Run is not the current Run. diff --git a/docs/cmd-options/skip-current-open.md b/docs/cmd-options/skip-current-open.md index e69de29b..5669ebea 100644 --- a/docs/cmd-options/skip-current-open.md +++ b/docs/cmd-options/skip-current-open.md @@ -0,0 +1,10 @@ +--- +id: skip-current-open +title: temporal skip-current-open +sidebar_label: skip-current-open +description: Definition for the skip-current-open command option. +tags: + - cli +--- + + Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run. diff --git a/docs/cmd-options/sqlite-pragma.md b/docs/cmd-options/sqlite-pragma.md index e69de29b..c737f17d 100644 --- a/docs/cmd-options/sqlite-pragma.md +++ b/docs/cmd-options/sqlite-pragma.md @@ -0,0 +1,10 @@ +--- +id: sqlite-pragma +title: temporal sqlite-pragma +sidebar_label: sqlite-pragma +description: Definition for the sqlite-pragma command option. +tags: + - cli +--- + + Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. diff --git a/docs/cmd-options/start-time.md b/docs/cmd-options/start-time.md index e69de29b..c94e1b3e 100644 --- a/docs/cmd-options/start-time.md +++ b/docs/cmd-options/start-time.md @@ -0,0 +1,10 @@ +--- +id: start-time +title: temporal start-time +sidebar_label: start-time +description: Definition for the start-time command option. +tags: + - cli +--- + + Backfill start time diff --git a/docs/cmd-options/task-queue-type.md b/docs/cmd-options/task-queue-type.md index e69de29b..0d96dc12 100644 --- a/docs/cmd-options/task-queue-type.md +++ b/docs/cmd-options/task-queue-type.md @@ -0,0 +1,10 @@ +--- +id: task-queue-type +title: temporal task-queue-type +sidebar_label: task-queue-type +description: Definition for the task-queue-type command option. +tags: + - cli +--- + + Task Queue type [workflow|activity] (default: workflow) diff --git a/docs/cmd-options/task-queue.md b/docs/cmd-options/task-queue.md index e69de29b..9c96dfdf 100644 --- a/docs/cmd-options/task-queue.md +++ b/docs/cmd-options/task-queue.md @@ -0,0 +1,10 @@ +--- +id: task-queue +title: temporal task-queue +sidebar_label: task-queue +description: Definition for the task-queue command option. +tags: + - cli +--- + + Task Queue diff --git a/docs/cmd-options/task-timeout.md b/docs/cmd-options/task-timeout.md index e69de29b..292f2a0a 100644 --- a/docs/cmd-options/task-timeout.md +++ b/docs/cmd-options/task-timeout.md @@ -0,0 +1,10 @@ +--- +id: task-timeout +title: temporal task-timeout +sidebar_label: task-timeout +description: Definition for the task-timeout command option. +tags: + - cli +--- + + Start-to-close timeout for a Workflow Task (in seconds). (default: 10) diff --git a/docs/cmd-options/time-format.md b/docs/cmd-options/time-format.md index e69de29b..c09ad107 100644 --- a/docs/cmd-options/time-format.md +++ b/docs/cmd-options/time-format.md @@ -0,0 +1,10 @@ +--- +id: time-format +title: temporal time-format +sidebar_label: time-format +description: Definition for the time-format command option. +tags: + - cli +--- + + Format time as: relative, iso, raw. (default: relative) diff --git a/docs/cmd-options/time-zone.md b/docs/cmd-options/time-zone.md index e69de29b..f384a595 100644 --- a/docs/cmd-options/time-zone.md +++ b/docs/cmd-options/time-zone.md @@ -0,0 +1,10 @@ +--- +id: time-zone +title: temporal time-zone +sidebar_label: time-zone +description: Definition for the time-zone command option. +tags: + - cli +--- + + Time zone (IANA name). diff --git a/docs/cmd-options/tls-ca-path.md b/docs/cmd-options/tls-ca-path.md index e69de29b..eeb24eb5 100644 --- a/docs/cmd-options/tls-ca-path.md +++ b/docs/cmd-options/tls-ca-path.md @@ -0,0 +1,10 @@ +--- +id: tls-ca-path +title: temporal tls-ca-path +sidebar_label: tls-ca-path +description: Definition for the tls-ca-path command option. +tags: + - cli +--- + + Path to server CA certificate. diff --git a/docs/cmd-options/tls-cert-path.md b/docs/cmd-options/tls-cert-path.md index e69de29b..6caa85a4 100644 --- a/docs/cmd-options/tls-cert-path.md +++ b/docs/cmd-options/tls-cert-path.md @@ -0,0 +1,10 @@ +--- +id: tls-cert-path +title: temporal tls-cert-path +sidebar_label: tls-cert-path +description: Definition for the tls-cert-path command option. +tags: + - cli +--- + + Path to x509 certificate. diff --git a/docs/cmd-options/tls-disable-host-verification.md b/docs/cmd-options/tls-disable-host-verification.md index e69de29b..05f5b8e7 100644 --- a/docs/cmd-options/tls-disable-host-verification.md +++ b/docs/cmd-options/tls-disable-host-verification.md @@ -0,0 +1,10 @@ +--- +id: tls-disable-host-verification +title: temporal tls-disable-host-verification +sidebar_label: tls-disable-host-verification +description: Definition for the tls-disable-host-verification command option. +tags: + - cli +--- + + Disables TLS host name verification if already enabled. diff --git a/docs/cmd-options/tls-key-path.md b/docs/cmd-options/tls-key-path.md index e69de29b..03c47caa 100644 --- a/docs/cmd-options/tls-key-path.md +++ b/docs/cmd-options/tls-key-path.md @@ -0,0 +1,10 @@ +--- +id: tls-key-path +title: temporal tls-key-path +sidebar_label: tls-key-path +description: Definition for the tls-key-path command option. +tags: + - cli +--- + + Path to private certificate key. diff --git a/docs/cmd-options/tls-server-name.md b/docs/cmd-options/tls-server-name.md index e69de29b..68d24000 100644 --- a/docs/cmd-options/tls-server-name.md +++ b/docs/cmd-options/tls-server-name.md @@ -0,0 +1,10 @@ +--- +id: tls-server-name +title: temporal tls-server-name +sidebar_label: tls-server-name +description: Definition for the tls-server-name command option. +tags: + - cli +--- + + Provides an override for the target TLS server name. diff --git a/docs/cmd-options/type.md b/docs/cmd-options/type.md index e69de29b..5d9495f7 100644 --- a/docs/cmd-options/type.md +++ b/docs/cmd-options/type.md @@ -0,0 +1,10 @@ +--- +id: type +title: temporal type +sidebar_label: type +description: Definition for the type command option. +tags: + - cli +--- + + Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] diff --git a/docs/cmd-options/ui-asset-path.md b/docs/cmd-options/ui-asset-path.md index e69de29b..e95368b8 100644 --- a/docs/cmd-options/ui-asset-path.md +++ b/docs/cmd-options/ui-asset-path.md @@ -0,0 +1,10 @@ +--- +id: ui-asset-path +title: temporal ui-asset-path +sidebar_label: ui-asset-path +description: Definition for the ui-asset-path command option. +tags: + - cli +--- + + UI Custom Assets path. diff --git a/docs/cmd-options/ui-codec-endpoint.md b/docs/cmd-options/ui-codec-endpoint.md index e69de29b..97028e1c 100644 --- a/docs/cmd-options/ui-codec-endpoint.md +++ b/docs/cmd-options/ui-codec-endpoint.md @@ -0,0 +1,10 @@ +--- +id: ui-codec-endpoint +title: temporal ui-codec-endpoint +sidebar_label: ui-codec-endpoint +description: Definition for the ui-codec-endpoint command option. +tags: + - cli +--- + + UI Remote data converter HTTP endpoint. diff --git a/docs/cmd-options/ui-ip.md b/docs/cmd-options/ui-ip.md index e69de29b..88e16258 100644 --- a/docs/cmd-options/ui-ip.md +++ b/docs/cmd-options/ui-ip.md @@ -0,0 +1,10 @@ +--- +id: ui-ip +title: temporal ui-ip +sidebar_label: ui-ip +description: Definition for the ui-ip command option. +tags: + - cli +--- + + IPv4 address to bind the Web UI to. diff --git a/docs/cmd-options/ui-port.md b/docs/cmd-options/ui-port.md index e69de29b..8f864ac1 100644 --- a/docs/cmd-options/ui-port.md +++ b/docs/cmd-options/ui-port.md @@ -0,0 +1,10 @@ +--- +id: ui-port +title: temporal ui-port +sidebar_label: ui-port +description: Definition for the ui-port command option. +tags: + - cli +--- + + Port for the Web UI. (default: 0) diff --git a/docs/cmd-options/unpause.md b/docs/cmd-options/unpause.md index e69de29b..26004ae0 100644 --- a/docs/cmd-options/unpause.md +++ b/docs/cmd-options/unpause.md @@ -0,0 +1,10 @@ +--- +id: unpause +title: temporal unpause +sidebar_label: unpause +description: Definition for the unpause command option. +tags: + - cli +--- + + Unpauses the schedule diff --git a/docs/cmd-options/visibility-archival-state.md b/docs/cmd-options/visibility-archival-state.md index e69de29b..c953c7d8 100644 --- a/docs/cmd-options/visibility-archival-state.md +++ b/docs/cmd-options/visibility-archival-state.md @@ -0,0 +1,10 @@ +--- +id: visibility-archival-state +title: temporal visibility-archival-state +sidebar_label: visibility-archival-state +description: Definition for the visibility-archival-state command option. +tags: + - cli +--- + + Flag to set visibility archival state, valid values are "disabled" and "enabled" diff --git a/docs/cmd-options/visibility-uri.md b/docs/cmd-options/visibility-uri.md index e69de29b..c5c72162 100644 --- a/docs/cmd-options/visibility-uri.md +++ b/docs/cmd-options/visibility-uri.md @@ -0,0 +1,10 @@ +--- +id: visibility-uri +title: temporal visibility-uri +sidebar_label: visibility-uri +description: Definition for the visibility-uri command option. +tags: + - cli +--- + + Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) diff --git a/docs/cmd-options/workflow-id.md b/docs/cmd-options/workflow-id.md index e69de29b..ecee629d 100644 --- a/docs/cmd-options/workflow-id.md +++ b/docs/cmd-options/workflow-id.md @@ -0,0 +1,10 @@ +--- +id: workflow-id +title: temporal workflow-id +sidebar_label: workflow-id +description: Definition for the workflow-id command option. +tags: + - cli +--- + + Workflow Id diff --git a/docs/cmd-options/workflow-type.md b/docs/cmd-options/workflow-type.md index e69de29b..5a4e2f81 100644 --- a/docs/cmd-options/workflow-type.md +++ b/docs/cmd-options/workflow-type.md @@ -0,0 +1,10 @@ +--- +id: workflow-type +title: temporal workflow-type +sidebar_label: workflow-type +description: Definition for the workflow-type command option. +tags: + - cli +--- + + Workflow type name. diff --git a/docs/cmd-options/yes.md b/docs/cmd-options/yes.md index e69de29b..af429a7e 100644 --- a/docs/cmd-options/yes.md +++ b/docs/cmd-options/yes.md @@ -0,0 +1,10 @@ +--- +id: yes +title: temporal yes +sidebar_label: yes +description: Definition for the yes command option. +tags: + - cli +--- + + Confirm all prompts. diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 7e64ab26..e73587aa 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -82,5 +82,5 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask From 9eeb72e4ec3b6243bdbf925b8216e970dfbde806 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 24 Jan 2023 13:42:37 -0600 Subject: [PATCH 49/68] regen --- docs/cmd-options/reapply-type.md | 2 +- docs/workflow/reset-batch.md | 2 +- docs/workflow/reset.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/cmd-options/reapply-type.md b/docs/cmd-options/reapply-type.md index da69e12b..dbd11212 100644 --- a/docs/cmd-options/reapply-type.md +++ b/docs/cmd-options/reapply-type.md @@ -7,4 +7,4 @@ tags: - cli --- - Event types to reapply after the reset point: , Signal, None. (default: All) + Event types to reapply after the reset point: Signal, None, . (default: All) diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index e73587aa..e190d137 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -82,5 +82,5 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask +Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index d775842c..721fd7b2 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -39,7 +39,7 @@ Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--reapply-type** -Event types to reapply after the reset point: , Signal, None. (default: All) +Event types to reapply after the reset point: Signal, None, . (default: All) **--reason** Reason to reset. From 3f758fa0e856e77f69c1f3fb506525c98eb82dbc Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Tue, 24 Jan 2023 17:58:57 -0600 Subject: [PATCH 50/68] moving usagetext to string templates --- cmd/doc/main.go | 2 +- common/defs-cmds.go | 153 +++++++++++++----- docs/batch/describe.md | 8 +- docs/batch/index.md | 15 +- docs/batch/list.md | 8 +- docs/batch/terminate.md | 8 +- docs/cmd-options/reapply-type.md | 2 +- .../{register.md => create, register.md} | 2 +- docs/task-queue/describe.md | 14 +- docs/workflow/cancel.md | 13 +- docs/workflow/describe.md | 9 +- docs/workflow/execute.md | 23 ++- docs/workflow/list.md | 9 +- docs/workflow/query.md | 12 +- docs/workflow/reset-batch.md | 4 +- docs/workflow/reset.md | 2 +- docs/workflow/start.md | 23 ++- docs/workflow/terminate.md | 13 +- 18 files changed, 237 insertions(+), 83 deletions(-) rename docs/operator/namespace/{register.md => create, register.md} (97%) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 8bc8a902..09684c2e 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -110,7 +110,7 @@ func main() { } else if strings.Contains(line, ">") { writeLine(currentHeaderFile, strings.Trim(line, ">")) } else { - writeLine(currentHeaderFile, line) + writeLine(currentHeaderFile, strings.TrimSpace(line)) } } // close file descriptor after for loop has completed diff --git a/common/defs-cmds.go b/common/defs-cmds.go index 0bed105c..dc5102ba 100644 --- a/common/defs-cmds.go +++ b/common/defs-cmds.go @@ -12,41 +12,17 @@ const ( // Workflow subcommand definitions StartWorkflowDefinition = "Starts a new Workflow Execution." - // TODO: make string literal usage text - StartWorkflowUsageText = "When invoked successfully, the Workflow and Run Ids of the recently started [Workflow](https://docs.temporal.io/workflows) are returned." - ExecuteWorkflowDefinition = "Start a new Workflow Execution and prints its progress." - // TODO: make string literal usage text - ExecuteWorkflowUsageText = "Single quotes('') are used to wrap input as JSON." - DescribeWorkflowDefinition = "Show information about a Workflow Execution." - // TODO: make string literal usage text - DescribeWorkflowUsageText = "This information can be used to locate a Workflow Execution that failed." - ListWorkflowDefinition = "List Workflow Executions based on a Query." - // TODO: make string literal usage text - ListWorkflowUsageText = "By default, this command lists up to 10 closed Workflow Executions." - ShowWorkflowDefinition = "Show Event History for a Workflow Execution." - QueryWorkflowDefinition = "Query a Workflow Execution." - // TODO: make string literal usage text - QueryWorkflowUsageText = "Queries can retrieve all or part of the Workflow state within given parameters.\nQueries can also be used on completed [Workflows](https://docs.temporal.io/workflows/)." - StackWorkflowDefinition = "Query a Workflow Execution with __stack_trace as the query type." SignalWorkflowDefinition = "Signal Workflow Execution by Id or List Filter." CountWorkflowDefinition = "Count Workflow Executions (requires ElasticSearch to be enabled)." - CancelWorkflowDefinition = "Cancel a Workflow Execution." - // TODO: make string literal usage text - CancelWorkflowUsageText = "Canceling a running Workflow Execution records a [`WorkflowExecutionCancelRequested` event](https://docs.temporal.io/references/events/#workflowexecutioncanceled) in the [Event History](https://docs.temporal.io/workflows/#event-history).\n\nAfter cancellation, the Workflow Execution can perform cleanup work,and a new [Command](https://docs.temporal.io/workflows/#command) task will be scheduled." - TerminateWorkflowDefinition = "Terminate Workflow Execution by Id or List Filter." - // TODO: make string literal usage text - TerminateWorkflowUsageText = "Terminating a running Workflow records a [`WorkflowExecutionTerminated` event](https://docs.temporal.io/references/events/#workflowexecutionterminated) as the closing event.\n\nAny further [Command](https://docs.temporal.io/workflows/#command) tasks cannot be scheduled after running `terminate`." - DeleteWorkflowDefinition = "Deletes a Workflow Execution." - ResetWorkflowDefinition = "Resets a Workflow Execution by Event Id or reset type." // TODO: make string literal usage text ResetWorkflowUsageText = "A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history)." @@ -72,20 +48,9 @@ const ( // Batch subcommand definitions // TODO: make string literal usage text - BatchUsageText = "Batch Jobs run in the background and affect [Workflow Executions](https://docs.temporal.io/workflows/#workflow-execution) one at a time.\n\nIn `cli`, the Batch Commands are used to view the status of Batch jobs, and to terminate them.\nA successfully started Batch job returns a Job Id, which is needed to execute Batch Commands.\n\nTerminating a Batch Job does not roll back the operations already performed by the job itself." - DescribeBatchJobDefinition = "Describe a Batch operation job." - // TODO: make string literal usage text - DescribeBatchUsageText = "This command shows the progress of an ongoing Batch job." - ListBatchJobsDefinition = "List Batch operation jobs." - // TODO: make string literal usage text - ListBatchUsageText = "When used, all Batch operation jobs within the system are listed." - TerminateBatchJobDefinition = "Stop a Batch operation job." - // TODO: make string literal usage text - TerminateBatchUsageText = "When used, the Batch job with the provided Batch Id is terminated." - // Operator subcommands and additional text OperatorUsageText = "These commands enable operations on [Namespaces](https://docs.temporal.io/namespaces), [Search Attributes](https://docs.temporal.io/visibility#search-attribute), and [Temporal Clusters](https://docs.temporal.io/clusters)." @@ -118,4 +83,120 @@ const ( GetDefinition = "Prints environmental properties." SetDefinition = "Set environmental properties." DeleteDefinition = "Delete an environment or environmental property." -) \ No newline at end of file +) + +const BatchUsageText = `Batch commands allow you to change multiple [Workflow Executions](/concepts/what-is-a-workflow-execution) without having to repeat yourself on the command line. +In order to do this, you provide the command with a [List Filter](/concepts/what-is-a-list-filter) and the type of Batch job to execute. + +The List Filter identifies the Workflow Executions that will be affected by the Batch job. +The Batch type determines the other parameters that need to be provided, along with what is being affected on the Workflow Executions. + +To start the Batch job, run `+"`"+`temporal workflow query`+"`"+`. +A successfully started Batch job will return a Job ID. +Use this Job ID to execute other actions on the Batch job. +` +//TODO: get above info in BatchUsageText checked. + +const DescribeBatchUsageText = `The `+"`"+`temporal batch describe`+"`"+` command shows the progress of an ongoing Batch job. + +Use the command options listed below to change the information returned by this command. +Make sure to write the command in this format: +`+"`"+`temporal batch describe [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const ListBatchUsageText = `When used, `+"`"+`temporal batch list`+"`"+` returns all Batch jobs. + +Use the command options listed below to change the information returned by this command. +Make sure to write the command in this format: +`+"`"+`temporal batch list [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const TerminateBatchUsageText = `The `+"`"+`temporal batch terminate`+"`"+` command terminates a Batch job with the provided Job ID. + +Use the command options listed below to change the behavior of this command. +Make sure to write the command as follows: +`+"`"+`temporal batch terminate [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const StartWorkflowUsageText = `The `+"`"+`temporal workflow start`+"`"+` command starts a new [Workflow Execution](/concepts/what-is-a-workflow-execution). +When invoked successfully, the Workflow and Run ID are returned immediately after starting the [Workflow](/concepts/what-is-a-workflow). + +Use the command options listed below to change how the Workflow Execution behaves upon starting. +Make sure to write the command in this format: +`+"`"+`temporal workflow start [command options] [arguments]`+"`"+` + +## OPTIONS +` +const ExecuteWorkflowUsageText = `The `+"`"+`temporal workflow execute`+"`"+` command starts a new [Workflow Execution](/concepts/what-is-a-workflow-execution) and prints its progress. +The command doesn't finish until the [Workflow](/concepts/what-is-a-workflow) completes. + +Single quotes('') are used to wrap input as JSON. + +Use the command options listed below to change how the Workflow Execution behaves during its run. +Make sure to write the command in this format: +`+"`"+`temporal workflow execute [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const DescribeWorkflowUsageText = `The `+"`"+`temporal workflow describe`+"`"+` command shows information about a given [Workflow Execution](/concepts/what-is-a-workflow-execution). +This information can be used to locate Workflow Executions that weren't able to run successfully. + +Use the command options listed below to change the information returned by this command. +Make sure to write the command in this format: +`+"`"+`temporal workflow describe [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const ListWorkflowUsageText = `The `+"`"+`temporal workflow list`+"`"+` command provides a list of [Workflow Executions](/concepts/what-is-a-workflow-execution) that meet the criteria of a given [Query](/concepts/what-is-a-query). +By default, this command returns a list of up to 10 closed Workflow Executions. + +Use the command options listed below to change the information returned by this command. +Make sure to write the command as follows: +`+"`"+`temporal workflow list [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const QueryWorkflowUsageText = `The `+"`"+`temporal workflow query`+"`"+` command sends a [Query](/concepts/what-is-a-query) to a [Workflow Execution](/concepts/what-is-a-workflow-execution). + +Queries can retrieve all or part of the Workflow state within given parameters. +Queries can also be used on completed [Workflows](/concepts/what-is-a-workflow). + +Use the command options listed below to change the information returned by this command. +Make sure to write the command as follows: +`+"`"+`temporal workflow query [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const CancelWorkflowUsageText = `The `+"`"+`temporal workflow cancel`+"`"+` command cancels a [Workflow Execution](/concepts/what-is-a-workflow-execution). + +Canceling a running Workflow Execution records a [`+"`"+`WorkflowExecutionCancelRequested`+"`"+` event]() in the [Event History](). +A new [Command]() Task will be scheduled, and the Workflow Execution performs cleanup work. + +Use the options listed below to change the behavior of this command. +Make sure to write the command as follows: +`+"`"+`temporal workflow cancel [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const TerminateWorkflowUsageText = `The `+"`"+`temporal workflow terminate`+"`"+` command terminates a [Workflow Execution](/concepts/what-is-a-workflow-execution) + +Terminating a running Workflow Execution records a [`+"`"+`WorkflowExecutionTerminated`+"`"+` event]() as the closing Event in the [Event History](). +Any further [Command]() Tasks cannot be scheduled after running this command. + +Use the options listed below to change termination behavior. +Make sure to write the command as follows: +`+"`"+`temporal workflow terminate [command options] [arguments]`+"`"+` + +## OPTIONS +` diff --git a/docs/batch/describe.md b/docs/batch/describe.md index 709fc559..3847b642 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -8,7 +8,13 @@ tags: --- -This command shows the progress of an ongoing Batch job. +The `temporal batch describe` command shows the progress of an ongoing Batch job. + +Use the command options listed below to change the information returned by this command. +Make sure to write the command in this format: +`temporal batch describe [command options] [arguments]` + +## OPTIONS **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/batch/index.md b/docs/batch/index.md index 077f7844..9868d736 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -8,10 +8,13 @@ tags: --- - Batch Jobs run in the background and affect [Workflow Executions](https://docs.temporal.io/workflows/#workflow-execution) one at a time. - - In `cli`, the Batch Commands are used to view the status of Batch jobs, and to terminate them. - A successfully started Batch job returns a Job Id, which is needed to execute Batch Commands. - - Terminating a Batch Job does not roll back the operations already performed by the job itself. +Batch commands allow you to change multiple [Workflow Executions](/concepts/what-is-a-workflow-execution) without having to repeat yourself on the command line. +In order to do this, you provide the command with a [List Filter](/concepts/what-is-a-list-filter) and the type of Batch job to execute. + +The List Filter identifies the Workflow Executions that will be affected by the Batch job. +The Batch type determines the other parameters that need to be provided, along with what is being affected on the Workflow Executions. + +To start the Batch job, run `temporal workflow query`. +A successfully started Batch job will return a Job ID. +Use this Job ID to execute other actions on the Batch job. diff --git a/docs/batch/list.md b/docs/batch/list.md index eec48077..1295293f 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -8,7 +8,13 @@ tags: --- -When used, all Batch operation jobs within the system are listed. +When used, `temporal batch list` returns all Batch jobs. + +Use the command options listed below to change the information returned by this command. +Make sure to write the command in this format: +`temporal batch list [command options] [arguments]` + +## OPTIONS **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index 6fe12f5c..838b2804 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -8,7 +8,13 @@ tags: --- -When used, the Batch job with the provided Batch Id is terminated. +The `temporal batch terminate` command terminates a Batch job with the provided Job ID. + +Use the command options listed below to change the behavior of this command. +Make sure to write the command as follows: +`temporal batch terminate [command options] [arguments]` + +## OPTIONS **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/cmd-options/reapply-type.md b/docs/cmd-options/reapply-type.md index dbd11212..da69e12b 100644 --- a/docs/cmd-options/reapply-type.md +++ b/docs/cmd-options/reapply-type.md @@ -7,4 +7,4 @@ tags: - cli --- - Event types to reapply after the reset point: Signal, None, . (default: All) + Event types to reapply after the reset point: , Signal, None. (default: All) diff --git a/docs/operator/namespace/register.md b/docs/operator/namespace/create, register.md similarity index 97% rename from docs/operator/namespace/register.md rename to docs/operator/namespace/create, register.md index 7b350a4f..24770b79 100644 --- a/docs/operator/namespace/register.md +++ b/docs/operator/namespace/create, register.md @@ -2,7 +2,7 @@ id: namespace title: temporal operator namespace sidebar_label: namespace -description: Registers a new Namespace. +description: Register a new Namespace tags: - cli --- diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index cd1a5be3..c49e432b 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -8,13 +8,13 @@ tags: --- - The [Server](https://docs.temporal.io/clusters/#temporal-server) records the last time of each poll request. - - Poll requests can last up to a minute, so a LastAccessTime under a minute is normal. - If it's over a minute, then likely either the Worker is at capacity (all [Workflow](https://docs.temporal.io/workflows/) and [Activity](https://docs.temporal.io/activities) slots are full) or it has shut down. - Once it has been 5 minutes since the last poll request, the Worker is removed from the list. - - RatePerSecond is the maximum Activities per second the Worker will execute. +The [Server](https://docs.temporal.io/clusters/#temporal-server) records the last time of each poll request. + +Poll requests can last up to a minute, so a LastAccessTime under a minute is normal. +If it's over a minute, then likely either the Worker is at capacity (all [Workflow](https://docs.temporal.io/workflows/) and [Activity](https://docs.temporal.io/activities) slots are full) or it has shut down. +Once it has been 5 minutes since the last poll request, the Worker is removed from the list. + +RatePerSecond is the maximum Activities per second the Worker will execute. **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index 13e812d6..33425870 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -8,9 +8,16 @@ tags: --- - Canceling a running Workflow Execution records a [`WorkflowExecutionCancelRequested` event](https://docs.temporal.io/references/events/#workflowexecutioncanceled) in the [Event History](https://docs.temporal.io/workflows/#event-history). - - After cancellation, the Workflow Execution can perform cleanup work,and a new [Command](https://docs.temporal.io/workflows/#command) task will be scheduled. +The `temporal workflow cancel` command cancels a [Workflow Execution](/concepts/what-is-a-workflow-execution). + +Canceling a running Workflow Execution records a [`WorkflowExecutionCancelRequested` event]() in the [Event History](). +A new [Command]() Task will be scheduled, and the Workflow Execution performs cleanup work. + +Use the options listed below to change the behavior of this command. +Make sure to write the command as follows: +`temporal workflow cancel [command options] [arguments]` + +## OPTIONS **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index 9906d2ed..f8ca5e90 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -8,7 +8,14 @@ tags: --- -This information can be used to locate a Workflow Execution that failed. +The `temporal workflow describe` command shows information about a given [Workflow Execution](/concepts/what-is-a-workflow-execution). +This information can be used to locate Workflow Executions that weren't able to run successfully. + +Use the command options listed below to change the information returned by this command. +Make sure to write the command in this format: +`temporal workflow describe [command options] [arguments]` + +## OPTIONS **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index e0136829..852ae9b1 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -8,8 +8,17 @@ tags: --- +The `temporal workflow execute` command starts a new [Workflow Execution](/concepts/what-is-a-workflow-execution) and prints its progress. +The command doesn't finish until the [Workflow](/concepts/what-is-a-workflow) completes. + Single quotes('') are used to wrap input as JSON. +Use the command options listed below to change how the Workflow Execution behaves during its run. +Make sure to write the command in this format: +`temporal workflow execute [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -27,13 +36,13 @@ An optional timeout for the context of an RPC call (in seconds). (default: 5) **--cron** Optional Cron Schedule for the Workflow. Cron spec is formatted as: - ┌───────────── minute (0 - 59) - │ ┌───────────── hour (0 - 23) - │ │ ┌───────────── day of the month (1 - 31) - │ │ │ ┌───────────── month (1 - 12) - │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) - │ │ │ │ │ - * * * * * +┌───────────── minute (0 - 59) +│ ┌───────────── hour (0 - 23) +│ │ ┌───────────── day of the month (1 - 31) +│ │ │ ┌───────────── month (1 - 12) +│ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) +│ │ │ │ │ +* * * * * **--env** Name of the environment to read environmental variables from. (default: default) diff --git a/docs/workflow/list.md b/docs/workflow/list.md index 75438ba8..56da9b40 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -8,7 +8,14 @@ tags: --- -By default, this command lists up to 10 closed Workflow Executions. +The `temporal workflow list` command provides a list of [Workflow Executions](/concepts/what-is-a-workflow-execution) that meet the criteria of a given [Query](/concepts/what-is-a-query). +By default, this command returns a list of up to 10 closed Workflow Executions. + +Use the command options listed below to change the information returned by this command. +Make sure to write the command as follows: +`temporal workflow list [command options] [arguments]` + +## OPTIONS **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/query.md b/docs/workflow/query.md index eb0af3c3..104d8953 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -8,8 +8,16 @@ tags: --- - Queries can retrieve all or part of the Workflow state within given parameters. - Queries can also be used on completed [Workflows](https://docs.temporal.io/workflows/). +The `temporal workflow query` command sends a [Query](/concepts/what-is-a-query) to a [Workflow Execution](/concepts/what-is-a-workflow-execution). + +Queries can retrieve all or part of the Workflow state within given parameters. +Queries can also be used on completed [Workflows](/concepts/what-is-a-workflow). + +Use the command options listed below to change the information returned by this command. +Make sure to write the command as follows: +`temporal workflow query [command options] [arguments]` + +## OPTIONS **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index e190d137..b4b6f810 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -2,7 +2,7 @@ id: reset-batch title: temporal workflow reset-batch sidebar_label: reset-batch -description: Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +description: Reset a batch of Workflow Executions by reset type: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask tags: - cli --- @@ -82,5 +82,5 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 721fd7b2..d775842c 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -39,7 +39,7 @@ Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--reapply-type** -Event types to reapply after the reset point: Signal, None, . (default: All) +Event types to reapply after the reset point: , Signal, None. (default: All) **--reason** Reason to reset. diff --git a/docs/workflow/start.md b/docs/workflow/start.md index f734709f..9423170b 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -8,7 +8,14 @@ tags: --- -When invoked successfully, the Workflow and Run Ids of the recently started [Workflow](https://docs.temporal.io/workflows) are returned. +The `temporal workflow start` command starts a new [Workflow Execution](/concepts/what-is-a-workflow-execution). +When invoked successfully, the Workflow and Run ID are returned immediately after starting the [Workflow](/concepts/what-is-a-workflow). + +Use the command options listed below to change how the Workflow Execution behaves upon starting. +Make sure to write the command in this format: +`temporal workflow start [command options] [arguments]` + +## OPTIONS **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -27,13 +34,13 @@ An optional timeout for the context of an RPC call (in seconds). (default: 5) **--cron** Optional Cron Schedule for the Workflow. Cron spec is formatted as: - ┌───────────── minute (0 - 59) - │ ┌───────────── hour (0 - 23) - │ │ ┌───────────── day of the month (1 - 31) - │ │ │ ┌───────────── month (1 - 12) - │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) - │ │ │ │ │ - * * * * * +┌───────────── minute (0 - 59) +│ ┌───────────── hour (0 - 23) +│ │ ┌───────────── day of the month (1 - 31) +│ │ │ ┌───────────── month (1 - 12) +│ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) +│ │ │ │ │ +* * * * * **--env** Name of the environment to read environmental variables from. (default: default) diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index 49a2e367..6f0ac573 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -8,9 +8,16 @@ tags: --- - Terminating a running Workflow records a [`WorkflowExecutionTerminated` event](https://docs.temporal.io/references/events/#workflowexecutionterminated) as the closing event. - - Any further [Command](https://docs.temporal.io/workflows/#command) tasks cannot be scheduled after running `terminate`. +The `temporal workflow terminate` command terminates a [Workflow Execution](/concepts/what-is-a-workflow-execution) + +Terminating a running Workflow Execution records a [`WorkflowExecutionTerminated` event]() as the closing Event in the [Event History](). +Any further [Command]() Tasks cannot be scheduled after running this command. + +Use the options listed below to change termination behavior. +Make sure to write the command as follows: +`temporal workflow terminate [command options] [arguments]` + +## OPTIONS **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. From bcd1248aa2dc90ebfd1841a7627ebe0719d4ebe6 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 25 Jan 2023 10:28:43 -0600 Subject: [PATCH 51/68] more usagetext moved --- common/defs-cmds.go | 95 ++++++++++++++++++++----------- docs/batch/index.md | 4 +- docs/operator/index.md | 5 +- docs/schedule/index.md | 5 +- docs/task-queue/describe.md | 14 +++-- docs/task-queue/list-partition.md | 2 +- docs/workflow/cancel.md | 6 +- docs/workflow/describe.md | 2 +- docs/workflow/execute.md | 4 +- docs/workflow/list.md | 2 +- docs/workflow/query.md | 4 +- docs/workflow/reset-batch.md | 11 +++- docs/workflow/reset.md | 11 +++- docs/workflow/start.md | 4 +- docs/workflow/terminate.md | 6 +- 15 files changed, 114 insertions(+), 61 deletions(-) diff --git a/common/defs-cmds.go b/common/defs-cmds.go index dc5102ba..418ffe66 100644 --- a/common/defs-cmds.go +++ b/common/defs-cmds.go @@ -24,11 +24,6 @@ const ( TerminateWorkflowDefinition = "Terminate Workflow Execution by Id or List Filter." DeleteWorkflowDefinition = "Deletes a Workflow Execution." ResetWorkflowDefinition = "Resets a Workflow Execution by Event Id or reset type." - // TODO: make string literal usage text - ResetWorkflowUsageText = "A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history)." - // TODO: make string literal usage text - ResetBatchUsageText = "Resetting a Workflow allows the process to resume from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history)." - TraceWorkflowDefinition = "Trace progress of a Workflow Execution and its children." // Activity subcommand definitions @@ -37,24 +32,13 @@ const ( // Task Queue subcommand definitions DescribeTaskQueueDefinition = "Describes the Workers that have recently polled on this Task Queue." - // TODO: make string literal usage text - DescribeTaskQueueUsageText = "The [Server](https://docs.temporal.io/clusters/#temporal-server) records the last time of each poll request.\n\nPoll requests can last up to a minute, so a LastAccessTime under a minute is normal.\nIf it's over a minute, then likely either the Worker is at capacity (all [Workflow](https://docs.temporal.io/workflows/) and [Activity](https://docs.temporal.io/activities) slots are full) or it has shut down.\nOnce it has been 5 minutes since the last poll request, the Worker is removed from the list.\n\nRatePerSecond is the maximum Activities per second the Worker will execute." - - ListPartitionTaskQueueDefinition = "Lists the [Task Queue's](https://docs.temporal.io/tasks/#task-queue) partitions and which matching node they are assigned to." - - // Schedule subcommand definitions - // TODO: make string literal usage text - ScheduleUsageText = "These commands allow [Schedules](https://docs.temporal.io/workflows/#schedule) to be created, used, and updated." + ListPartitionTaskQueueDefinition = "Lists the Task Queue's partitions and which matching node they are assigned to." // Batch subcommand definitions - // TODO: make string literal usage text DescribeBatchJobDefinition = "Describe a Batch operation job." ListBatchJobsDefinition = "List Batch operation jobs." TerminateBatchJobDefinition = "Stop a Batch operation job." - // Operator subcommands and additional text - OperatorUsageText = "These commands enable operations on [Namespaces](https://docs.temporal.io/namespaces), [Search Attributes](https://docs.temporal.io/visibility#search-attribute), and [Temporal Clusters](https://docs.temporal.io/clusters)." - NamespaceDefinition = "Operations applying to Namespaces." SearchAttributeDefinition = "Operations applying to Search Attributes." ClusterDefinition = "Operations for running a Temporal Cluster." @@ -85,8 +69,8 @@ const ( DeleteDefinition = "Delete an environment or environmental property." ) -const BatchUsageText = `Batch commands allow you to change multiple [Workflow Executions](/concepts/what-is-a-workflow-execution) without having to repeat yourself on the command line. -In order to do this, you provide the command with a [List Filter](/concepts/what-is-a-list-filter) and the type of Batch job to execute. +const BatchUsageText = `Batch commands allow you to change multiple [Workflow Executions](/workflows#workflow-execution) without having to repeat yourself on the command line. +In order to do this, you provide the command with a [List Filter](/visibility#list-filter) and the type of Batch job to execute. The List Filter identifies the Workflow Executions that will be affected by the Batch job. The Batch type determines the other parameters that need to be provided, along with what is being affected on the Workflow Executions. @@ -124,8 +108,8 @@ Make sure to write the command as follows: ## OPTIONS ` -const StartWorkflowUsageText = `The `+"`"+`temporal workflow start`+"`"+` command starts a new [Workflow Execution](/concepts/what-is-a-workflow-execution). -When invoked successfully, the Workflow and Run ID are returned immediately after starting the [Workflow](/concepts/what-is-a-workflow). +const StartWorkflowUsageText = `The `+"`"+`temporal workflow start`+"`"+` command starts a new [Workflow Execution](/workflows#workflow-execution). +When invoked successfully, the Workflow and Run ID are returned immediately after starting the [Workflow](/workflows). Use the command options listed below to change how the Workflow Execution behaves upon starting. Make sure to write the command in this format: @@ -133,8 +117,8 @@ Make sure to write the command in this format: ## OPTIONS ` -const ExecuteWorkflowUsageText = `The `+"`"+`temporal workflow execute`+"`"+` command starts a new [Workflow Execution](/concepts/what-is-a-workflow-execution) and prints its progress. -The command doesn't finish until the [Workflow](/concepts/what-is-a-workflow) completes. +const ExecuteWorkflowUsageText = `The `+"`"+`temporal workflow execute`+"`"+` command starts a new [Workflow Execution](/workflows#workflow-execution) and prints its progress. +The command doesn't finish until the [Workflow](/workflows) completes. Single quotes('') are used to wrap input as JSON. @@ -145,7 +129,7 @@ Make sure to write the command in this format: ## OPTIONS ` -const DescribeWorkflowUsageText = `The `+"`"+`temporal workflow describe`+"`"+` command shows information about a given [Workflow Execution](/concepts/what-is-a-workflow-execution). +const DescribeWorkflowUsageText = `The `+"`"+`temporal workflow describe`+"`"+` command shows information about a given [Workflow Execution](/workflows#workflow-execution). This information can be used to locate Workflow Executions that weren't able to run successfully. Use the command options listed below to change the information returned by this command. @@ -155,7 +139,7 @@ Make sure to write the command in this format: ## OPTIONS ` -const ListWorkflowUsageText = `The `+"`"+`temporal workflow list`+"`"+` command provides a list of [Workflow Executions](/concepts/what-is-a-workflow-execution) that meet the criteria of a given [Query](/concepts/what-is-a-query). +const ListWorkflowUsageText = `The `+"`"+`temporal workflow list`+"`"+` command provides a list of [Workflow Executions](/workflows#workflow-execution) that meet the criteria of a given [Query](/workflows#query). By default, this command returns a list of up to 10 closed Workflow Executions. Use the command options listed below to change the information returned by this command. @@ -165,10 +149,10 @@ Make sure to write the command as follows: ## OPTIONS ` -const QueryWorkflowUsageText = `The `+"`"+`temporal workflow query`+"`"+` command sends a [Query](/concepts/what-is-a-query) to a [Workflow Execution](/concepts/what-is-a-workflow-execution). +const QueryWorkflowUsageText = `The `+"`"+`temporal workflow query`+"`"+` command sends a [Query](/workflows#query) to a [Workflow Execution](/workflows#workflow-execution). Queries can retrieve all or part of the Workflow state within given parameters. -Queries can also be used on completed [Workflows](/concepts/what-is-a-workflow). +Queries can also be used on completed [Workflows](/workflows#workflow-execution). Use the command options listed below to change the information returned by this command. Make sure to write the command as follows: @@ -177,10 +161,10 @@ Make sure to write the command as follows: ## OPTIONS ` -const CancelWorkflowUsageText = `The `+"`"+`temporal workflow cancel`+"`"+` command cancels a [Workflow Execution](/concepts/what-is-a-workflow-execution). +const CancelWorkflowUsageText = `The `+"`"+`temporal workflow cancel`+"`"+` command cancels a [Workflow Execution](/workflows#workflow-execution). -Canceling a running Workflow Execution records a [`+"`"+`WorkflowExecutionCancelRequested`+"`"+` event]() in the [Event History](). -A new [Command]() Task will be scheduled, and the Workflow Execution performs cleanup work. +Canceling a running Workflow Execution records a [`+"`"+`WorkflowExecutionCancelRequested`+"`"+` event](/events#workflowexecutioncancelrequested) in the [Event History](/workflows#event-history). +A new [Command](/workflows#command) Task will be scheduled, and the Workflow Execution performs cleanup work. Use the options listed below to change the behavior of this command. Make sure to write the command as follows: @@ -189,10 +173,10 @@ Make sure to write the command as follows: ## OPTIONS ` -const TerminateWorkflowUsageText = `The `+"`"+`temporal workflow terminate`+"`"+` command terminates a [Workflow Execution](/concepts/what-is-a-workflow-execution) +const TerminateWorkflowUsageText = `The `+"`"+`temporal workflow terminate`+"`"+` command terminates a [Workflow Execution](/workflows#workflow-execution) -Terminating a running Workflow Execution records a [`+"`"+`WorkflowExecutionTerminated`+"`"+` event]() as the closing Event in the [Event History](). -Any further [Command]() Tasks cannot be scheduled after running this command. +Terminating a running Workflow Execution records a [`+"`"+`WorkflowExecutionTerminated`+"`"+` event](/events#workflowexecutionterminated) as the closing Event in the [Event History](/workflows#event-history). +Any further [Command](/workflows#command) Tasks cannot be scheduled after running this command. Use the options listed below to change termination behavior. Make sure to write the command as follows: @@ -200,3 +184,48 @@ Make sure to write the command as follows: ## OPTIONS ` + +const ResetWorkflowUsageText = `The `+"`"+`temporal workflow reset`+"`"+` command resets a [Workflow Execution](/workflows#workflow-execution). +A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](/workflows#event-history). + +Use the options listed below to change reset behavior. +Make sure to write the command as follows: +`+"`"+`temporal workflow reset [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const ResetBatchUsageText = `The `+"`"+`temporal workflow reset-batch`+"`"+` command resets a batch of [Workflow Executions](/workflows#workflow-execution) by `+"`"+`resetType`+"`"+`. +Resetting a [Workflow](/workflows) allows the process to resume from a certain point without losing your parameters or [Event History](/workflows#event-history). + +Use the options listed below to change reset behavior. +Make sure to write the command as follows: +`+"`"+`temporal workflow reset-batch [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const DescribeTaskQueueUsageText = `The `+"`"+`temporal task-queue describe`+"`"+` command provides [poller](/applcation-development/worker-performance#poller-count) information for a given [Task Queue](/tasks#task-queue). + +The [Server](/clusters#temporal-server) records the last time of each poll request. +Should `+"`"+`LastAccessTime`+"`"+` exceeds one minute, it's likely that the Worker is at capacity (all Workflow and Activity slots are full) or that the Worker has shut down. +[Workers](/workers) are removed if 5 minutes have passed since the last poll request. + +Use the options listed below to modify what this command returns. +Make sure to write the command as follows: +`+"`"+`temporal task-queue describe [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const ScheduleUsageText = `Schedule commands allow the user to create, use, and update [Schedules](/workflows#schedule). +Schedules control when certain Actions for a Workflow Execution are performed, making it a useful tool for automation. + +To run a Schedule command, run `+"`"+`temporal schedule [command] [command options] [arguments]`+"`"+`. +` + +const OperatorUsageText = `Operator commands enable actions on [Namespaces](/namespaces), [Search Attributes](/visibility#search-attribute), and [Temporal Clusters](/clusters). +These actions are performed through subcommands for each Operator area. + +To run an Operator command, run `+"`"+`temporal operator [command] [subcommand] [command options] [arguments]`+"`"+`. +` diff --git a/docs/batch/index.md b/docs/batch/index.md index 9868d736..5edfb62b 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -8,8 +8,8 @@ tags: --- -Batch commands allow you to change multiple [Workflow Executions](/concepts/what-is-a-workflow-execution) without having to repeat yourself on the command line. -In order to do this, you provide the command with a [List Filter](/concepts/what-is-a-list-filter) and the type of Batch job to execute. +Batch commands allow you to change multiple [Workflow Executions](/workflows#workflow-execution) without having to repeat yourself on the command line. +In order to do this, you provide the command with a [List Filter](/visibility#list-filter) and the type of Batch job to execute. The List Filter identifies the Workflow Executions that will be affected by the Batch job. The Batch type determines the other parameters that need to be provided, along with what is being affected on the Workflow Executions. diff --git a/docs/operator/index.md b/docs/operator/index.md index ea56ca9b..6d8ca513 100644 --- a/docs/operator/index.md +++ b/docs/operator/index.md @@ -8,5 +8,8 @@ tags: --- -These commands enable operations on [Namespaces](https://docs.temporal.io/namespaces), [Search Attributes](https://docs.temporal.io/visibility#search-attribute), and [Temporal Clusters](https://docs.temporal.io/clusters). +Operator commands enable actions on [Namespaces](/namespaces), [Search Attributes](/visibility#search-attribute), and [Temporal Clusters](/clusters). +These actions are performed through subcommands for each Operator area. + +To run an Operator command, run `temporal operator [command] [subcommand] [command options] [arguments]`. diff --git a/docs/schedule/index.md b/docs/schedule/index.md index 154abfdd..a31d49a5 100644 --- a/docs/schedule/index.md +++ b/docs/schedule/index.md @@ -8,5 +8,8 @@ tags: --- -These commands allow [Schedules](https://docs.temporal.io/workflows/#schedule) to be created, used, and updated. +Schedule commands allow the user to create, use, and update [Schedules](/workflows#schedule). +Schedules control when certain Actions for a Workflow Execution are performed, making it a useful tool for automation. + +To run a Schedule command, run `temporal schedule [command] [command options] [arguments]`. diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index c49e432b..c6e2a24d 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -8,13 +8,17 @@ tags: --- -The [Server](https://docs.temporal.io/clusters/#temporal-server) records the last time of each poll request. +The `temporal task-queue describe` command provides [poller](/applcation-development/worker-performance#poller-count) information for a given [Task Queue](/tasks#task-queue). -Poll requests can last up to a minute, so a LastAccessTime under a minute is normal. -If it's over a minute, then likely either the Worker is at capacity (all [Workflow](https://docs.temporal.io/workflows/) and [Activity](https://docs.temporal.io/activities) slots are full) or it has shut down. -Once it has been 5 minutes since the last poll request, the Worker is removed from the list. +The [Server](/clusters#temporal-server) records the last time of each poll request. +Should `LastAccessTime` exceeds one minute, it's likely that the Worker is at capacity (all Workflow and Activity slots are full) or that the Worker has shut down. +[Workers](/workers) are removed if 5 minutes have passed since the last poll request. -RatePerSecond is the maximum Activities per second the Worker will execute. +Use the options listed below to modify what this command returns. +Make sure to write the command as follows: +`temporal task-queue describe [command options] [arguments]` + +## OPTIONS **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index db4ae523..b25753c4 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -2,7 +2,7 @@ id: list-partition title: temporal task-queue list-partition sidebar_label: list-partition -description: Lists the [Task Queue's](https://docs.temporal.io/tasks/#task-queue) partitions and which matching node they are assigned to. +description: Lists the Task Queue's partitions and which matching node they are assigned to. tags: - cli --- diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index 33425870..bb2dd7de 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -8,10 +8,10 @@ tags: --- -The `temporal workflow cancel` command cancels a [Workflow Execution](/concepts/what-is-a-workflow-execution). +The `temporal workflow cancel` command cancels a [Workflow Execution](/workflows#workflow-execution). -Canceling a running Workflow Execution records a [`WorkflowExecutionCancelRequested` event]() in the [Event History](). -A new [Command]() Task will be scheduled, and the Workflow Execution performs cleanup work. +Canceling a running Workflow Execution records a [`WorkflowExecutionCancelRequested` event](/events#workflowexecutioncancelrequested) in the [Event History](/workflows#event-history). +A new [Command](/workflows#command) Task will be scheduled, and the Workflow Execution performs cleanup work. Use the options listed below to change the behavior of this command. Make sure to write the command as follows: diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index f8ca5e90..5ce242bd 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -8,7 +8,7 @@ tags: --- -The `temporal workflow describe` command shows information about a given [Workflow Execution](/concepts/what-is-a-workflow-execution). +The `temporal workflow describe` command shows information about a given [Workflow Execution](/workflows#workflow-execution). This information can be used to locate Workflow Executions that weren't able to run successfully. Use the command options listed below to change the information returned by this command. diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index 852ae9b1..a795d5ea 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -8,8 +8,8 @@ tags: --- -The `temporal workflow execute` command starts a new [Workflow Execution](/concepts/what-is-a-workflow-execution) and prints its progress. -The command doesn't finish until the [Workflow](/concepts/what-is-a-workflow) completes. +The `temporal workflow execute` command starts a new [Workflow Execution](/workflows#workflow-execution) and prints its progress. +The command doesn't finish until the [Workflow](/workflows) completes. Single quotes('') are used to wrap input as JSON. diff --git a/docs/workflow/list.md b/docs/workflow/list.md index 56da9b40..66e5c8c9 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -8,7 +8,7 @@ tags: --- -The `temporal workflow list` command provides a list of [Workflow Executions](/concepts/what-is-a-workflow-execution) that meet the criteria of a given [Query](/concepts/what-is-a-query). +The `temporal workflow list` command provides a list of [Workflow Executions](/workflows#workflow-execution) that meet the criteria of a given [Query](/workflows#query). By default, this command returns a list of up to 10 closed Workflow Executions. Use the command options listed below to change the information returned by this command. diff --git a/docs/workflow/query.md b/docs/workflow/query.md index 104d8953..6d214ee6 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -8,10 +8,10 @@ tags: --- -The `temporal workflow query` command sends a [Query](/concepts/what-is-a-query) to a [Workflow Execution](/concepts/what-is-a-workflow-execution). +The `temporal workflow query` command sends a [Query](/workflows#query) to a [Workflow Execution](/workflows#workflow-execution). Queries can retrieve all or part of the Workflow state within given parameters. -Queries can also be used on completed [Workflows](/concepts/what-is-a-workflow). +Queries can also be used on completed [Workflows](/workflows#workflow-execution). Use the command options listed below to change the information returned by this command. Make sure to write the command as follows: diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index b4b6f810..d3a0a462 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -2,13 +2,20 @@ id: reset-batch title: temporal workflow reset-batch sidebar_label: reset-batch -description: Reset a batch of Workflow Executions by reset type: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask +description: Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew tags: - cli --- -Resetting a Workflow allows the process to resume from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history). +The `temporal workflow reset-batch` command resets a batch of [Workflow Executions](/workflows#workflow-execution) by `resetType`. +Resetting a [Workflow](/workflows) allows the process to resume from a certain point without losing your parameters or [Event History](/workflows#event-history). + +Use the options listed below to change reset behavior. +Make sure to write the command as follows: +`temporal workflow reset-batch [command options] [arguments]` + +## OPTIONS **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index d775842c..73b1494b 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -8,7 +8,14 @@ tags: --- -A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](https://docs.temporal.io/workflows/#event-history). +The `temporal workflow reset` command resets a [Workflow Execution](/workflows#workflow-execution). +A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](/workflows#event-history). + +Use the options listed below to change reset behavior. +Make sure to write the command as follows: +`temporal workflow reset [command options] [arguments]` + +## OPTIONS **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -64,7 +71,7 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask **--workflow-id** Alias: **-w** diff --git a/docs/workflow/start.md b/docs/workflow/start.md index 9423170b..b4a39f1a 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -8,8 +8,8 @@ tags: --- -The `temporal workflow start` command starts a new [Workflow Execution](/concepts/what-is-a-workflow-execution). -When invoked successfully, the Workflow and Run ID are returned immediately after starting the [Workflow](/concepts/what-is-a-workflow). +The `temporal workflow start` command starts a new [Workflow Execution](/workflows#workflow-execution). +When invoked successfully, the Workflow and Run ID are returned immediately after starting the [Workflow](/workflows). Use the command options listed below to change how the Workflow Execution behaves upon starting. Make sure to write the command in this format: diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index 6f0ac573..4bfd3657 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -8,10 +8,10 @@ tags: --- -The `temporal workflow terminate` command terminates a [Workflow Execution](/concepts/what-is-a-workflow-execution) +The `temporal workflow terminate` command terminates a [Workflow Execution](/workflows#workflow-execution) -Terminating a running Workflow Execution records a [`WorkflowExecutionTerminated` event]() as the closing Event in the [Event History](). -Any further [Command]() Tasks cannot be scheduled after running this command. +Terminating a running Workflow Execution records a [`WorkflowExecutionTerminated` event](/events#workflowexecutionterminated) as the closing Event in the [Event History](/workflows#event-history). +Any further [Command](/workflows#command) Tasks cannot be scheduled after running this command. Use the options listed below to change termination behavior. Make sure to write the command as follows: From 2c8b79b82d60aa17a6fb4795023e959f57e1e884 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 25 Jan 2023 12:54:45 -0600 Subject: [PATCH 52/68] variables added --- activity/activity.go | 2 + cluster/cluster.go | 6 + common/defs-cmds.go | 191 +++++++++++++++++++++++++--- completion/completion.go | 3 + env/env.go | 3 + namespace/namespace.go | 5 + schedule/schedule.go | 60 +++++---- searchattribute/search_attribute.go | 3 + taskqueue/task_queue.go | 1 + workflow/workflow.go | 7 +- 10 files changed, 238 insertions(+), 43 deletions(-) diff --git a/activity/activity.go b/activity/activity.go index 86693472..80530597 100644 --- a/activity/activity.go +++ b/activity/activity.go @@ -10,6 +10,7 @@ func NewActivityCommands() []*cli.Command { { Name: "complete", Usage: common.CompleteActivityDefinition, + UsageText: common.CompleteActivityUsageText, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, @@ -51,6 +52,7 @@ func NewActivityCommands() []*cli.Command { { Name: "fail", Usage: common.FailActivityDefinition, + UsageText: common.FailActivityUsageText, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, diff --git a/cluster/cluster.go b/cluster/cluster.go index a77a01b2..c82ee667 100644 --- a/cluster/cluster.go +++ b/cluster/cluster.go @@ -11,6 +11,7 @@ func NewClusterCommands() []*cli.Command { { Name: "health", Usage: common.HealthDefinition, + UsageText: common.HealthUsageText, Action: func(c *cli.Context) error { return HealthCheck(c) }, @@ -18,6 +19,7 @@ func NewClusterCommands() []*cli.Command { { Name: "describe", Usage: common.DescribeDefinition, + UsageText: common.ClusterDescribeUsageText, ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ @@ -40,6 +42,7 @@ func NewClusterCommands() []*cli.Command { { Name: "system", Usage: common.SystemDefinition, + UsageText: common.ClusterSystemUsageText, ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ @@ -62,6 +65,7 @@ func NewClusterCommands() []*cli.Command { { Name: "upsert", Usage: common.UpsertDefinition, + UsageText: common.ClusterUpsertUsageText, ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ @@ -82,6 +86,7 @@ func NewClusterCommands() []*cli.Command { { Name: "list", Usage: common.ListDefinition, + UsageText: common.ClusterListUsageText, ArgsUsage: " ", Flags: common.FlagsForPaginationAndRendering, Action: func(c *cli.Context) error { @@ -91,6 +96,7 @@ func NewClusterCommands() []*cli.Command { { Name: "remove", Usage: common.RemoveDefinition, + UsageText: common.ClusterRemoveUsageText, ArgsUsage: " ", Flags: []cli.Flag{ &cli.StringFlag{ diff --git a/common/defs-cmds.go b/common/defs-cmds.go index 418ffe66..f76aac2a 100644 --- a/common/defs-cmds.go +++ b/common/defs-cmds.go @@ -1,12 +1,14 @@ package common + + const ( // Main command definitions WorkflowDefinition = "Operations that can be performed on Workflows." ActivityDefinition = "Operations that can be performed on Workflow Activities." TaskQueueDefinition = "Operations performed on Task Queues." ScheduleDefinition = "Operations performed on Schedules." - BatchDefinition = "Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs." + BatchDefinition = "Operations performed on Batch jobs." OperatorDefinition = "Operations performed on the Temporal Server." EnvDefinition = "Manage environmental configurations on Temporal Client." @@ -69,6 +71,8 @@ const ( DeleteDefinition = "Delete an environment or environmental property." ) +//TODO: get information checked for all UsageTexts + const BatchUsageText = `Batch commands allow you to change multiple [Workflow Executions](/workflows#workflow-execution) without having to repeat yourself on the command line. In order to do this, you provide the command with a [List Filter](/visibility#list-filter) and the type of Batch job to execute. @@ -79,8 +83,6 @@ To start the Batch job, run `+"`"+`temporal workflow query`+"`"+`. A successfully started Batch job will return a Job ID. Use this Job ID to execute other actions on the Batch job. ` -//TODO: get above info in BatchUsageText checked. - const DescribeBatchUsageText = `The `+"`"+`temporal batch describe`+"`"+` command shows the progress of an ongoing Batch job. Use the command options listed below to change the information returned by this command. @@ -89,7 +91,6 @@ Make sure to write the command in this format: ## OPTIONS ` - const ListBatchUsageText = `When used, `+"`"+`temporal batch list`+"`"+` returns all Batch jobs. Use the command options listed below to change the information returned by this command. @@ -98,7 +99,6 @@ Make sure to write the command in this format: ## OPTIONS ` - const TerminateBatchUsageText = `The `+"`"+`temporal batch terminate`+"`"+` command terminates a Batch job with the provided Job ID. Use the command options listed below to change the behavior of this command. @@ -107,7 +107,6 @@ Make sure to write the command as follows: ## OPTIONS ` - const StartWorkflowUsageText = `The `+"`"+`temporal workflow start`+"`"+` command starts a new [Workflow Execution](/workflows#workflow-execution). When invoked successfully, the Workflow and Run ID are returned immediately after starting the [Workflow](/workflows). @@ -128,7 +127,6 @@ Make sure to write the command in this format: ## OPTIONS ` - const DescribeWorkflowUsageText = `The `+"`"+`temporal workflow describe`+"`"+` command shows information about a given [Workflow Execution](/workflows#workflow-execution). This information can be used to locate Workflow Executions that weren't able to run successfully. @@ -138,7 +136,6 @@ Make sure to write the command in this format: ## OPTIONS ` - const ListWorkflowUsageText = `The `+"`"+`temporal workflow list`+"`"+` command provides a list of [Workflow Executions](/workflows#workflow-execution) that meet the criteria of a given [Query](/workflows#query). By default, this command returns a list of up to 10 closed Workflow Executions. @@ -148,7 +145,6 @@ Make sure to write the command as follows: ## OPTIONS ` - const QueryWorkflowUsageText = `The `+"`"+`temporal workflow query`+"`"+` command sends a [Query](/workflows#query) to a [Workflow Execution](/workflows#workflow-execution). Queries can retrieve all or part of the Workflow state within given parameters. @@ -160,7 +156,6 @@ Make sure to write the command as follows: ## OPTIONS ` - const CancelWorkflowUsageText = `The `+"`"+`temporal workflow cancel`+"`"+` command cancels a [Workflow Execution](/workflows#workflow-execution). Canceling a running Workflow Execution records a [`+"`"+`WorkflowExecutionCancelRequested`+"`"+` event](/events#workflowexecutioncancelrequested) in the [Event History](/workflows#event-history). @@ -172,7 +167,6 @@ Make sure to write the command as follows: ## OPTIONS ` - const TerminateWorkflowUsageText = `The `+"`"+`temporal workflow terminate`+"`"+` command terminates a [Workflow Execution](/workflows#workflow-execution) Terminating a running Workflow Execution records a [`+"`"+`WorkflowExecutionTerminated`+"`"+` event](/events#workflowexecutionterminated) as the closing Event in the [Event History](/workflows#event-history). @@ -184,7 +178,6 @@ Make sure to write the command as follows: ## OPTIONS ` - const ResetWorkflowUsageText = `The `+"`"+`temporal workflow reset`+"`"+` command resets a [Workflow Execution](/workflows#workflow-execution). A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](/workflows#event-history). @@ -194,7 +187,6 @@ Make sure to write the command as follows: ## OPTIONS ` - const ResetBatchUsageText = `The `+"`"+`temporal workflow reset-batch`+"`"+` command resets a batch of [Workflow Executions](/workflows#workflow-execution) by `+"`"+`resetType`+"`"+`. Resetting a [Workflow](/workflows) allows the process to resume from a certain point without losing your parameters or [Event History](/workflows#event-history). @@ -204,7 +196,6 @@ Make sure to write the command as follows: ## OPTIONS ` - const DescribeTaskQueueUsageText = `The `+"`"+`temporal task-queue describe`+"`"+` command provides [poller](/applcation-development/worker-performance#poller-count) information for a given [Task Queue](/tasks#task-queue). The [Server](/clusters#temporal-server) records the last time of each poll request. @@ -217,15 +208,183 @@ Make sure to write the command as follows: ## OPTIONS ` - const ScheduleUsageText = `Schedule commands allow the user to create, use, and update [Schedules](/workflows#schedule). Schedules control when certain Actions for a Workflow Execution are performed, making it a useful tool for automation. To run a Schedule command, run `+"`"+`temporal schedule [command] [command options] [arguments]`+"`"+`. ` - const OperatorUsageText = `Operator commands enable actions on [Namespaces](/namespaces), [Search Attributes](/visibility#search-attribute), and [Temporal Clusters](/clusters). These actions are performed through subcommands for each Operator area. To run an Operator command, run `+"`"+`temporal operator [command] [subcommand] [command options] [arguments]`+"`"+`. ` +const CompleteActivityUsageText = `The `+"`"+`temporal activity complete`+"`"+` command completes an [Activity Execution](/activities#activity-execution). + +Use the options listed below to change the behavior of this command. +Make sure to write the command as follows: +`+"`"+`temporal activity complete [command options] [arguments]`+"`"+` + +## OPTIONS +` +const FailActivityUsageText = `The `+"`"+`temporal activity fail`+"`"+` command fails an [Activity Execution](/activities#activity-execution). + +Use the options listed below to change the behavior of this command. +Make sure to write the command as follows: +`+"`"+`temporal activity fail [command options] [arguments]`+"`"+` + +## OPTIONS +` +const HealthUsageText = `The `+"`"+`temporal operator cluster health`+"`"+` command checks the health of the [Frontend Service](/clusters#frontend-service). + +Use the options listed below to change the behavior and output of this command. +Make sure to write the command as follows: +`+"`"+`temporal operator cluster health [command options] [arguments]`+"`"+` + +## OPTIONS +` +const ClusterDescribeUsageText = `The `+"`"+`temporal operator cluster describe`+"`"+` command shows information about the [Cluster](/clusters). + +Use the options listed below to change the output of this command. +Make sure to write the command as follows: +`+"`"+`temporal operator cluster describe [command options] [arguments]`+"`"+` + +## OPTIONS +` +const ClusterSystemUsageText = `The `+"`"+`temporal operator cluster system`+"`"+` command provides information about the system the Cluster is running on. + +Use the options listed below to change this command's output. +Make sure to write the command as follows: +`+"`"+`temporal operator cluster system [command options] [arguments]`+"`"+` + +## OPTIONS +` +const ClusterUpsertUsageText = `The `+"`"+`temporal operator cluster upsert`+"`"+` command allows the user to add or update a remote [Cluster](/clusters). + +Use the options listed below to change the behavior of this command. +Make sure to write the command as follows: +`+"`"+`temporal operator cluster upsert [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const ClusterListUsageText = `The `+"`"+`temporal operator cluster list`+"`"+` command prints a list of all remote [Clusters](/clusters) on the system. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal operator cluster list [command options] [arguments]`+"`"+` + +## OPTIONS +` +const ClusterRemoveUsageText = `The `+"`"+`temporal operator cluster remove`+"`"+` command removes a remote [Cluster](/clusters) from the system. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal operator cluster remove [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const CompletionBashUsageText = `` + +const CompletionZshUsageText = `` + +const EnvGetUsageText = `The `+"`"+`temporal env get`+"`"+` command prints the environmental properties for the environment in use. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal env get [command options] [arguments]`+"`"+` + +## OPTIONS +` +const EnvSetUsageText = `The `+"`"+`temporal env set`+"`"+` command sets the value for an environmental property. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal env set [command options] [arguments]`+"`"+` + +## OPTIONS +` +const EnvDeleteUsageText = `The `+"`"+`temporal env delete`+"`"+` command deletes a given environment or environmental property. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal env delete [command options] [arguments]`+"`"+` + +## OPTIONS +` +const NamespaceDescribeUsageText = `The `+"`"+`temporal operator namespace describe`+"`"+` command provides a description of a [Namespace](/namespaces). +Namespaces can be identified by name or Namespace ID. + +Use the options listed below to change the command's output. +Make sure to write the command as follows: +`+"`"+`temporal operator namespace describe [command options] [arguments]`+"`"+` + +## OPTIONS +` +const NamespaceListUsageText = `The `+"`"+`temporal operator namespace list`+"`"+` command lists all [Namespaces](/namespaces) on the [Server](/clusters#frontend-server). + +Use the options listed below to change the command's output. +Make sure to write the command as follows: +`+"`"+`temporal operator namespace list [command options] [arguments]`+"`"+` + +## OPTIONS +` +const NamespaceCreateUsageText = `The `+"`"+`temporal operator namespace create`+"`"+` command creates a new [Namespace](/namespaces). + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal operator namespace create [command options] [arguments]`+"`"+` + +## OPTIONS +` +const NamespaceUpdateUsageText = `The `+"`"+`temporal operator namespace update`+"`"+` command updates a given [Namespace](/namespaces). + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal operator namespace update [command options] [arguments]`+"`"+` + +## OPTIONS +` +const NamespaceDeleteUsageText = `The `+"`"+`temporal operator namespace delete`+"`"+` command deletes a given [Namespace](/namespaces) from the system. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal operator namespace delete [command options] [arguments]`+"`"+` + +## OPTIONS +` +const ScheduleCreateUsageText = `` + +const ScheduleUpdateUsageText = `` + +const ScheduleToggleUsageText = `` + +const ScheduleTriggerUsageText = `` + +const ScheduleBackfillUsageText = `` + +const ScheduleDescribeUsageText = `` + +const ScheduleDeleteUsageText = `` + +const ScheduleListUsageText = `` + +const SearchAttributeCreateUsageText = `` + +const SearchAttributeListUsageText = `` + +const SearchAttributeRemoveUsageText = `` + +const TaskQueueListPartitionUsageText = `` + +const WorkflowShowUsageText = `` + +const WorkflowStackUsageText = `` + +const WorkflowSignalUsageText = `` + +const WorkflowCountUsageText = `` + +const WorkflowDeleteUsageText = `` + +const WorkflowTraceUsageText = `` \ No newline at end of file diff --git a/completion/completion.go b/completion/completion.go index 2811d7c8..90917fef 100644 --- a/completion/completion.go +++ b/completion/completion.go @@ -4,6 +4,7 @@ import ( "fmt" "os" + "github.com/temporalio/cli/common" "github.com/urfave/cli/v2" ) @@ -53,6 +54,7 @@ func NewCompletionCommands() []*cli.Command { { Name: "bash", Usage: "bash completion output", + UsageText: common.CompletionBashUsageText, Action: func(c *cli.Context) error { fmt.Fprintln(os.Stdout, bash_script) return nil @@ -61,6 +63,7 @@ func NewCompletionCommands() []*cli.Command { { Name: "zsh", Usage: "zsh completion output", + UsageText: common.CompletionZshUsageText, Action: func(c *cli.Context) error { fmt.Fprintln(os.Stdout, zsh_script) return nil diff --git a/env/env.go b/env/env.go index d6417dc1..a441bfac 100644 --- a/env/env.go +++ b/env/env.go @@ -21,6 +21,7 @@ func NewEnvCommands() []*cli.Command { { Name: "get", Usage: common.GetDefinition, + UsageText: common.EnvGetUsageText, Flags: []cli.Flag{}, ArgsUsage: "env_name or env_name.property_name", Action: func(c *cli.Context) error { @@ -30,6 +31,7 @@ func NewEnvCommands() []*cli.Command { { Name: "set", Usage: common.SetDefinition, + UsageText: common.EnvSetUsageText, Flags: []cli.Flag{}, ArgsUsage: "env_name.property_name value", Action: func(c *cli.Context) error { @@ -39,6 +41,7 @@ func NewEnvCommands() []*cli.Command { { Name: "delete", Usage: common.DeleteDefinition, + UsageText: common.EnvDeleteUsageText, Flags: []cli.Flag{}, ArgsUsage: "env_name or env_name.property_name", Action: func(c *cli.Context) error { diff --git a/namespace/namespace.go b/namespace/namespace.go index 1d278770..efeaa1dc 100644 --- a/namespace/namespace.go +++ b/namespace/namespace.go @@ -18,6 +18,7 @@ func NewNamespaceCommands() []*cli.Command { { Name: "describe", Usage: common.DescribeNamespaceDefinition, + UsageText: common.NamespaceDescribeUsageText, Flags: describeNamespaceFlags, ArgsUsage: "namespace_name", Action: func(c *cli.Context) error { @@ -27,6 +28,7 @@ func NewNamespaceCommands() []*cli.Command { { Name: "list", Usage: common.ListNamespacesDefinition, + UsageText: common.NamespaceListUsageText, ArgsUsage: " ", Action: func(c *cli.Context) error { return ListNamespaces(c) @@ -36,6 +38,7 @@ func NewNamespaceCommands() []*cli.Command { Name: "create", Aliases: []string{"register"}, Usage: "Register a new Namespace", + UsageText: common.NamespaceCreateUsageText, Flags: createNamespaceFlags, ArgsUsage: "namespace_name [cluster_name...]", Action: func(c *cli.Context) error { @@ -45,6 +48,7 @@ func NewNamespaceCommands() []*cli.Command { { Name: "update", Usage: common.UpdateNamespaceDefinition, + UsageText: common.NamespaceUpdateUsageText, Flags: updateNamespaceFlags, ArgsUsage: "namespace_name [cluster_name...]", Action: func(c *cli.Context) error { @@ -54,6 +58,7 @@ func NewNamespaceCommands() []*cli.Command { { Name: "delete", Usage: common.DeleteNamespaceDefinition, + UsageText: common.NamespaceDeleteUsageText, Flags: []cli.Flag{ &cli.BoolFlag{ Name: common.FlagYes, diff --git a/schedule/schedule.go b/schedule/schedule.go index a927f9eb..0d6421d5 100644 --- a/schedule/schedule.go +++ b/schedule/schedule.go @@ -16,7 +16,7 @@ func NewScheduleCommands() []*cli.Command { } overlap := &cli.StringFlag{ Name: common.FlagOverlapPolicy, - Usage: "Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll", + Usage: "Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll.", Category: common.CategoryMain, } @@ -28,7 +28,7 @@ func NewScheduleCommands() []*cli.Command { }, &cli.StringSliceFlag{ Name: common.FlagCronSchedule, - Usage: `Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily"`, + Usage: `Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily".`, Category: common.CategoryMain, }, &cli.StringSliceFlag{ @@ -61,17 +61,17 @@ func NewScheduleCommands() []*cli.Command { scheduleStateFlags := []cli.Flag{ &cli.StringFlag{ Name: common.FlagNotes, - Usage: "Initial value of notes field", + Usage: "Initial value of notes field.", Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagPause, - Usage: "Initial value of paused state", + Usage: "Initial value of paused state.", Category: common.CategoryMain, }, &cli.IntFlag{ Name: common.FlagRemainingActions, - Usage: "Total number of actions allowed", + Usage: "Total number of actions allowed.", Category: common.CategoryMain, }, } @@ -80,12 +80,12 @@ func NewScheduleCommands() []*cli.Command { overlap, &cli.StringFlag{ Name: common.FlagCatchupWindow, - Usage: "Maximum allowed catch-up time if server is down", + Usage: "Maximum allowed catch-up time if server is down.", Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagPauseOnFailure, - Usage: "Pause schedule after any workflow failure", + Usage: "Pause schedule after any workflow failure.", Category: common.CategoryMain, }, } @@ -94,17 +94,17 @@ func NewScheduleCommands() []*cli.Command { scheduleVisibilityFlags := []cli.Flag{ &cli.StringSliceFlag{ Name: common.FlagSearchAttribute, - Usage: "Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value", + Usage: "Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value.", Category: common.CategoryMain, }, &cli.StringSliceFlag{ Name: common.FlagMemo, - Usage: "Set a memo on a schedule. Format: key=value. Use valid JSON formats for value", + Usage: "Set a memo on a schedule. Format: key=value. Use valid JSON formats for value.", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagMemoFile, - Usage: "Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value", + Usage: "Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value.", Category: common.CategoryMain, }, } @@ -123,38 +123,41 @@ func NewScheduleCommands() []*cli.Command { return []*cli.Command{ { Name: "create", - Usage: "Create a new schedule", - Description: "Takes a schedule specification plus all the same args as starting a workflow", + Usage: "Create a new schedule.", + UsageText: common.ScheduleCreateUsageText, + Description: "Takes a schedule specification plus all the same args as starting a workflow.", Flags: createFlags, Action: CreateSchedule, Category: common.CategoryMain, }, { Name: "update", - Usage: "Updates a schedule with a new definition (full replacement, not patch)", - Description: "Takes a schedule specification plus all the same args as starting a workflow", + Usage: "Updates a schedule with a new definition (full replacement, not patch).", + UsageText: common.ScheduleUpdateUsageText, + Description: "Takes a schedule specification plus all the same args as starting a workflow.", Flags: createFlags, Action: UpdateSchedule, Category: common.CategoryMain, }, { Name: "toggle", - Usage: "Pauses or unpauses a schedule", + Usage: "Pauses or unpauses a schedule.", + UsageText: common.ScheduleToggleUsageText, Flags: []cli.Flag{ sid, &cli.BoolFlag{ Name: common.FlagPause, - Usage: "Pauses the schedule", + Usage: "Pauses the schedule.", Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagUnpause, - Usage: "Unpauses the schedule", + Usage: "Unpauses the schedule.", Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Free-form text to describe reason for pause/unpause", + Usage: "Free-form text to describe reason for pause/unpause.", Value: "(no reason provided)", Category: common.CategoryMain, }, @@ -163,7 +166,8 @@ func NewScheduleCommands() []*cli.Command { }, { Name: "trigger", - Usage: "Triggers an immediate action", + Usage: "Triggers an immediate action.", + UsageText: common.ScheduleTriggerUsageText, Flags: []cli.Flag{ sid, overlap, @@ -172,19 +176,20 @@ func NewScheduleCommands() []*cli.Command { }, { Name: "backfill", - Usage: "Backfills a past time range of actions", + Usage: "Backfills a past time range of actions.", + UsageText: common.ScheduleBackfillUsageText, Flags: []cli.Flag{ sid, overlap, &cli.StringFlag{ Name: common.FlagStartTime, - Usage: "Backfill start time", + Usage: "Backfill start time.", Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagEndTime, - Usage: "Backfill end time", + Usage: "Backfill end time.", Required: true, Category: common.CategoryMain, }, @@ -193,12 +198,13 @@ func NewScheduleCommands() []*cli.Command { }, { Name: "describe", - Usage: "Get schedule configuration and current state", + Usage: "Get schedule configuration and current state.", + UsageText: common.ScheduleDescribeUsageText, Flags: append([]cli.Flag{ sid, &cli.BoolFlag{ Name: common.FlagPrintRaw, - Usage: "Print raw data as json (prefer this over -o json for scripting)", + Usage: "Print raw data as json (prefer this over -o json for scripting).", Category: common.CategoryMain, }, }, common.FlagsForFormatting...), @@ -206,7 +212,8 @@ func NewScheduleCommands() []*cli.Command { }, { Name: "delete", - Usage: "Deletes a schedule", + Usage: "Deletes a schedule.", + UsageText: common.ScheduleDeleteUsageText, Flags: []cli.Flag{ sid, }, @@ -214,7 +221,8 @@ func NewScheduleCommands() []*cli.Command { }, { Name: "list", - Usage: "Lists schedules", + Usage: "Lists schedules.", + UsageText: common.ScheduleListUsageText, Flags: common.FlagsForPaginationAndRendering, Action: ListSchedules, }, diff --git a/searchattribute/search_attribute.go b/searchattribute/search_attribute.go index b8703028..731b1a04 100644 --- a/searchattribute/search_attribute.go +++ b/searchattribute/search_attribute.go @@ -14,6 +14,7 @@ func NewSearchAttributeCommands() []*cli.Command { { Name: "create", Usage: common.CreateSearchAttributeDefinition, + UsageText: common.SearchAttributeCreateUsageText, Flags: []cli.Flag{ &cli.StringSliceFlag{ Name: common.FlagName, @@ -41,6 +42,7 @@ func NewSearchAttributeCommands() []*cli.Command { { Name: "list", Usage: common.ListSearchAttributesDefinition, + UsageText: common.SearchAttributeListUsageText, Flags: []cli.Flag{ &cli.StringFlag{ Name: output.FlagOutput, @@ -57,6 +59,7 @@ func NewSearchAttributeCommands() []*cli.Command { { Name: "remove", Usage: common.RemoveSearchAttributesDefinition, + UsageText: common.SearchAttributeRemoveUsageText, Flags: []cli.Flag{ &cli.StringSliceFlag{ Name: common.FlagName, diff --git a/taskqueue/task_queue.go b/taskqueue/task_queue.go index 9dba286e..dd095673 100644 --- a/taskqueue/task_queue.go +++ b/taskqueue/task_queue.go @@ -34,6 +34,7 @@ func NewTaskQueueCommands() []*cli.Command { { Name: "list-partition", Usage: common.ListPartitionTaskQueueDefinition, + UsageText: common.TaskQueueListPartitionUsageText, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagTaskQueue, diff --git a/workflow/workflow.go b/workflow/workflow.go index 1c67de64..433b2379 100644 --- a/workflow/workflow.go +++ b/workflow/workflow.go @@ -60,6 +60,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "show", Usage: common.ShowWorkflowDefinition, + UsageText: common.WorkflowShowUsageText, Flags: append(append(common.FlagsForExecution, common.FlagsForShowWorkflow...), common.FlagsForPaginationAndRendering...), Action: func(c *cli.Context) error { return ShowHistory(c) @@ -84,6 +85,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "stack", Usage: common.StackWorkflowDefinition, + UsageText: common.WorkflowStackUsageText, Flags: common.FlagsForStackTraceQuery, Action: func(c *cli.Context) error { return QueryWorkflowUsingStackTrace(c) @@ -92,7 +94,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "signal", Usage: common.SignalWorkflowDefinition, - UsageText: "", + UsageText: common.WorkflowSignalUsageText, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagWorkflowID, @@ -148,6 +150,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "count", Usage: common.CountWorkflowDefinition, + UsageText: common.WorkflowCountUsageText, Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagQuery, @@ -241,6 +244,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "delete", Usage: common.DeleteWorkflowDefinition, + UsageText: common.WorkflowDeleteUsageText, Flags: common.FlagsForExecution, Action: func(c *cli.Context) error { return DeleteWorkflow(c) @@ -354,6 +358,7 @@ func NewWorkflowCommands() []*cli.Command { { Name: "trace", Usage: common.TraceWorkflowDefinition, + UsageText: common.WorkflowTraceUsageText, Flags: append(common.FlagsForExecution, &cli.IntFlag{ Name: common.FlagDepth, From 1970a7391ca0f9a751553a6b7a84e0932b3b0ffe Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 25 Jan 2023 14:58:03 -0600 Subject: [PATCH 53/68] almost through usagetxt --- common/defs-cmds.go | 90 ++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 81 insertions(+), 9 deletions(-) diff --git a/common/defs-cmds.go b/common/defs-cmds.go index f76aac2a..fbf70155 100644 --- a/common/defs-cmds.go +++ b/common/defs-cmds.go @@ -353,23 +353,95 @@ Make sure to write the command as follows: ## OPTIONS ` -const ScheduleCreateUsageText = `` +const ScheduleCreateUsageText = `The `+"`"+`temporal schedule create`+"`"+` command creates a new [Schedule](/workflows#schedule). +Newly created Schedules return a Schedule ID to be used in other Schedule commands. -const ScheduleUpdateUsageText = `` +Schedules need to follow a format like the example shown here: +`+"`"+``+"`"+``+"`"+` +temporal schedule create \ + --sid 'your-schedule-id' \ + --cron '3 11 * * Fri' \ + --wid 'your-workflow-id' \ + --tq 'your-task-queue' \ + --type 'YourWorkflowType' +`+"`"+``+"`"+``+"`"+` -const ScheduleToggleUsageText = `` +Any combination of `+"`"+`--cal`+"`"+`, `+"`"+`--interval`+"`"+`, and `+"`"+`--cron`+"`"+` is supported. +Actions will be executed at any time specified in the Schedule. -const ScheduleTriggerUsageText = `` +Use the options provided below to change the command's behavior. -const ScheduleBackfillUsageText = `` +## OPTIONS +` +const ScheduleUpdateUsageText = `The `+"`"+`temporal schedule update`+"`"+` command updates an existing [Schedule](/workflows#schedule). + +Like `+"`"+`temporal schedule create`+"`"+`, updated Schedules need to follow a certain format: +`+"`"+``+"`"+``+"`"+` +temporal schedule update \ + --sid 'your-schedule-id' \ + --cron '3 11 * * Fri' \ + --wid 'your-workflow-id' \ + --tq 'your-task-queue' \ + --type 'YourWorkflowType' +`+"`"+``+"`"+``+"`"+` + +Updating a Schedule takes the given options and replaces the entire configuration of the Schedule with what's provided. +If you only change one value of the Schedule, be sure to provide the other unchanged fields to prevent them from being overwritten. + +Use the options provided below to change the command's behavior. + +## OPTIONS +` + +const ScheduleToggleUsageText = `The `+"`"+`temporal schedule toggle`+"`"+` command can pause and unpause a [Schedule](/workflows#schedule). + +Toggling a Schedule requires a reason to be entered on the command line. +Use `+"`"+`--reason`+"`"+` to note the issue leading to the pause or unpause. + +Schedule toggles are passed in this format: +`+"`"+` temporal schedule toggle --sid 'your-schedule-id' --pause --reason "paused because the database is down"`+"`"+` +`+"`"+`temporal schedule toggle --sid 'your-schedule-id' --unpause --reason "the database is back up"`+"`"+` -const ScheduleDescribeUsageText = `` +Use the options provided below to change this command's behavior. + +## OPTIONS +` + +const ScheduleTriggerUsageText = `The `+"`"+`temporal schedule trigger`+"`"+` command triggers an immediate action with a given Schedule. +By default, this action is subject to the Overlap Policy of the Schedule. + +`+"`"+`temporal schedule trigger`+"`"+` can be used to start a Workflow Run immediately. +`+"`"+`temporal schedule trigger --sid 'your-schedule-id'`+"`"+` + +The Overlap Policy of the Schedule can be overridden as well. +`+"`"+`temporal schedule trigger --sid 'your-schedule-id' --overlap-policy 'AllowAll'`+"`"+` + +Use the options provided below to change this command's behavior. + +## OPTIONS +` + +const ScheduleBackfillUsageText = `The `+"`"+`temporal schedule backfill`+"`"+` command executes Actions ahead of their specified time range. +Backfilling can be used to fill in Workflow Runs from a time period when the Schedule was paused, or from before the Schedule was created. + +`+"`"+``+"`"+``+"`"+` +temporal schedule backfill --sid 'your-schedule-id' \ + --overlap-policy 'BufferAll' \ + --start-time '2022-05-0101T00:00:00Z' \ + --end-time '2022-05-31T23:59:59Z' +`+"`"+``+"`"+``+"`"+` + +Use the options provided below to change this command's behavior. + +## OPTIONS +` +const ScheduleDescribeUsageText = `The `+"`"+`temporal schedule describe`+"`"+` command` -const ScheduleDeleteUsageText = `` +const ScheduleDeleteUsageText = `The `+"`"+`temporal schedule delete`+"`"+` command` -const ScheduleListUsageText = `` +const ScheduleListUsageText = `The `+"`"+`temporal schedule list`+"`"+` command` -const SearchAttributeCreateUsageText = `` +const SearchAttributeCreateUsageText = `The `+"`"+`temporal search-attribute create`+"`"+` command` const SearchAttributeListUsageText = `` From ada90992982930cafd428565523f35516bb090ad Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 25 Jan 2023 16:05:18 -0600 Subject: [PATCH 54/68] usagetxt --- common/defs-cmds.go | 126 +++++++++++++++++++++++++++++++++++++------- 1 file changed, 106 insertions(+), 20 deletions(-) diff --git a/common/defs-cmds.go b/common/defs-cmds.go index fbf70155..42b131a9 100644 --- a/common/defs-cmds.go +++ b/common/defs-cmds.go @@ -283,11 +283,6 @@ Make sure to write the command as follows: ## OPTIONS ` - -const CompletionBashUsageText = `` - -const CompletionZshUsageText = `` - const EnvGetUsageText = `The `+"`"+`temporal env get`+"`"+` command prints the environmental properties for the environment in use. Use the options listed below to change the command's behavior. @@ -407,7 +402,7 @@ Use the options provided below to change this command's behavior. ## OPTIONS ` -const ScheduleTriggerUsageText = `The `+"`"+`temporal schedule trigger`+"`"+` command triggers an immediate action with a given Schedule. +const ScheduleTriggerUsageText = `The `+"`"+`temporal schedule trigger`+"`"+` command triggers an immediate action with a given [Schedule](/workflows#schedule). By default, this action is subject to the Overlap Policy of the Schedule. `+"`"+`temporal schedule trigger`+"`"+` can be used to start a Workflow Run immediately. @@ -422,7 +417,7 @@ Use the options provided below to change this command's behavior. ` const ScheduleBackfillUsageText = `The `+"`"+`temporal schedule backfill`+"`"+` command executes Actions ahead of their specified time range. -Backfilling can be used to fill in Workflow Runs from a time period when the Schedule was paused, or from before the Schedule was created. +Backfilling can be used to fill in [Workflow Runs](/workflows#run-id) from a time period when the Schedule was paused, or from before the Schedule was created. `+"`"+``+"`"+``+"`"+` temporal schedule backfill --sid 'your-schedule-id' \ @@ -435,28 +430,119 @@ Use the options provided below to change this command's behavior. ## OPTIONS ` -const ScheduleDescribeUsageText = `The `+"`"+`temporal schedule describe`+"`"+` command` +const ScheduleDescribeUsageText = `The `+"`"+`temporal schedule describe`+"`"+` command shows the current [Schedule](#workflows#schedule) configuration. +This command also provides information about past, current, and future [Workflow Runs](/workflows#run-id). -const ScheduleDeleteUsageText = `The `+"`"+`temporal schedule delete`+"`"+` command` +`+"`"+`temporal schedule describe --sid 'your-schedule-id' [command options] [arguments]`+"`"+` -const ScheduleListUsageText = `The `+"`"+`temporal schedule list`+"`"+` command` +Use the options below to change this command's output. -const SearchAttributeCreateUsageText = `The `+"`"+`temporal search-attribute create`+"`"+` command` +## OPTIONS +` +const ScheduleDeleteUsageText = `The `+"`"+`temporal schedule delete`+"`"+` command deletes a [Schedule](/workflows#schedule). +Deleting a Schedule does not affect any [Workflows](/workflows) started by the Schedule. -const SearchAttributeListUsageText = `` +[Workflow Executions](/workflows#workflow-execution) started by Schedules can be cancelled or terminated like other Workflow Executions. +However, Workflow Executions started by a Schedule can be identified by their [Search Attributes](/visibility#search-attribute), making them targetable by batch command for termination. + +`+"`"+`temporal schedule delete --sid 'your-schedule-id' [command options] [arguments]`+"`"+` + +Use the options below to change the behavior of this command. + +## OPTIONS +` +const ScheduleListUsageText = `The `+"`"+`temporal schedule list`+"`"+` command lists all [Schedule](/workflows#schedule) configurations. +Listing Schedules in [Standard Visibility](/visibility#standard-visibility) will only provide Schedule IDs. + +`+"`"+`temporal schedule list [command options] [arguments]`+"`"+` + +Use the options below to change the behavior of this command. + +## OPTIONS +` +const SearchAttributeCreateUsageText = `The `+"`"+`temporal operator search-attribute create`+"`"+` command adds one or more custom [Search Attributes](/visibility#search-attribute). +These Search Attributes can be used to [filter a list](/visibility#list-filter) of [Workflow Executions](/workflows#workflow-execution) that contain the given Search Attributes in their metadata. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal operator search-attribute create [command options] [arguments]`+"`"+` -const SearchAttributeRemoveUsageText = `` +## OPTIONS +` +const SearchAttributeListUsageText = `The `+"`"+`temporal operator search-attrbute list`+"`"+` command displays a list of all [Search Attributes](/visibility#search-attribute) that can be used in `+"`"+` temporal workflow list --query`+"`"+`. -const TaskQueueListPartitionUsageText = `` +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal operator search-attribute list [command options] [arguments]`+"`"+` -const WorkflowShowUsageText = `` +## OPTIONS +` +const SearchAttributeRemoveUsageText = `The `+"`"+`temporal operator search-attribute remove`+"`"+` command removes custom [Search Attribute](/visibility#search-attribute) metadata. +This command does not remove custom Search Attributes from Elasticsearch. +The index schema is not modified. -const WorkflowStackUsageText = `` +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal operator search-attribute remove [command options] [arguments]`+"`"+` -const WorkflowSignalUsageText = `` +## OPTIONS +` +const TaskQueueListPartitionUsageText = `The `+"`"+`temporal task-queue list-partition`+"`"+` command displays the partitions of a [Task Queue](/tasks#task-queue), along with the matching node they are assigned to. -const WorkflowCountUsageText = `` +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal task-queue list-partition [command options] [arguments]`+"`"+` -const WorkflowDeleteUsageText = `` +## OPTIONS +` +const WorkflowShowUsageText = `The `+"`"+`temporal workflow show`+"`"+` command provides the [Event History](/workflows#event-history) for a specified [Workflow Execution](/workflows#workflow-execution). -const WorkflowTraceUsageText = `` \ No newline at end of file +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal workflow show [command options] [arguments]`+"`"+` + +## OPTIONS +` +const WorkflowStackUsageText = `The `+"`"+`temporal workflow stack`+"`"+` command queries a [Workflow Execution](/workflows#workflow-execution) with `+"`"+`--stack-trace`+"`"+` as the [Query](/workflows#stack-trace-query) type. +Returning the stack trace of all the threads owned by a Workflow Execution can be great for troubleshooting in production. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal workflow stack [command options] [arguments]`+"`"+` + +## OPTIONS +` +const WorkflowSignalUsageText = `The `+"`"+`temporal workflow signal`+"`"+` command is used to [Signal](/workflows#signal) a [Workflow Execution](/workflows#workflow-execution) by ID or [List Filter](/visibility#list-filter). + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal workflow signal [command options] [arguments]`+"`"+` + +## OPTIONS +` +const WorkflowCountUsageText = `The `+"`"+`temporal workflow count`+"`"+` command returns a count of [Workflow Executions](/workflows#workflow-execution). +This command requires Elasticsearch to be enabled. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal workflow count [command options] [arguments]`+"`"+` + +## OPTIONS +` +const WorkflowDeleteUsageText = `The `+"`"+`temporal workflow delete`+"`"+` command deletes the specified [Workflow Execution](/workflows#workflow-execution). + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal workflow delete [command options] [arguments]`+"`"+` + +## OPTIONS +` + +const WorkflowTraceUsageText = `The `+"`"+`temporal workflow trace`+"`"+` command tracks the progress of a [Workflow Execution](/workflows#workflow-execution) and any [Child Workflows](/workflows#child-workflow) it generates. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`+"`"+`temporal workflow trace [command options] [arguments]`+"`"+` + +## OPTIONS +` \ No newline at end of file From 5752d3ef078286fa845a7b8c289628ea54ad9d97 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 25 Jan 2023 16:06:56 -0600 Subject: [PATCH 55/68] changes from main --- completion/completion.go | 13 ------------- namespace/namespace.go | 1 - 2 files changed, 14 deletions(-) diff --git a/completion/completion.go b/completion/completion.go index 57465f66..bbd4fcf8 100644 --- a/completion/completion.go +++ b/completion/completion.go @@ -4,7 +4,6 @@ import ( "fmt" "os" - "github.com/temporalio/cli/common" "github.com/urfave/cli/v2" ) @@ -52,30 +51,18 @@ complete -o bashdefault -o default -o nospace -F _cli_bash_autocomplete temporal func NewCompletionCommands() []*cli.Command { return []*cli.Command{ { -<<<<<<< auto-generate-cli-docs - Name: "bash", - Usage: "bash completion output", - UsageText: common.CompletionBashUsageText, -======= Name: "bash", Usage: "bash completion output", UsageText: "source <(temporal completion bash)", ->>>>>>> main Action: func(c *cli.Context) error { fmt.Fprintln(os.Stdout, bash_script) return nil }, }, { -<<<<<<< auto-generate-cli-docs - Name: "zsh", - Usage: "zsh completion output", - UsageText: common.CompletionZshUsageText, -======= Name: "zsh", Usage: "zsh completion output", UsageText: "source <(temporal completion zsh)", ->>>>>>> main Action: func(c *cli.Context) error { fmt.Fprintln(os.Stdout, zsh_script) return nil diff --git a/namespace/namespace.go b/namespace/namespace.go index efeaa1dc..06568f27 100644 --- a/namespace/namespace.go +++ b/namespace/namespace.go @@ -36,7 +36,6 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "create", - Aliases: []string{"register"}, Usage: "Register a new Namespace", UsageText: common.NamespaceCreateUsageText, Flags: createNamespaceFlags, From 938a263f4ba533b7549ab339584f82014b64e1e3 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 25 Jan 2023 16:07:24 -0600 Subject: [PATCH 56/68] EOD doc generation --- docs/activity/complete.md | 8 ++++ docs/activity/fail.md | 8 ++++ docs/batch/index.md | 2 +- docs/cmd-options/catchup-window.md | 2 +- docs/cmd-options/cron.md | 2 +- docs/cmd-options/end-time.md | 2 +- docs/cmd-options/memo-file.md | 2 +- docs/cmd-options/memo.md | 2 +- docs/cmd-options/metrics-port.md | 2 +- docs/cmd-options/notes.md | 2 +- docs/cmd-options/overlap-policy.md | 2 +- docs/cmd-options/pause-on-failure.md | 2 +- docs/cmd-options/pause.md | 2 +- docs/cmd-options/raw.md | 2 +- docs/cmd-options/reapply-type.md | 2 +- docs/cmd-options/remaining-actions.md | 2 +- docs/cmd-options/search-attribute.md | 2 +- docs/cmd-options/start-time.md | 2 +- docs/cmd-options/unpause.md | 2 +- docs/completion/bash.md | 2 + docs/completion/zsh.md | 2 + docs/env/delete.md | 8 ++++ docs/env/get.md | 8 ++++ docs/env/set.md | 8 ++++ docs/operator/cluster/describe.md | 8 ++++ docs/operator/cluster/health.md | 8 ++++ docs/operator/cluster/list.md | 8 ++++ docs/operator/cluster/remove.md | 8 ++++ docs/operator/cluster/system.md | 8 ++++ docs/operator/cluster/upsert.md | 8 ++++ .../{create, register.md => create.md} | 8 ++++ docs/operator/namespace/delete.md | 8 ++++ docs/operator/namespace/describe.md | 9 ++++ docs/operator/namespace/list.md | 8 ++++ docs/operator/namespace/update.md | 8 ++++ docs/operator/search-attribute/create.md | 9 ++++ docs/operator/search-attribute/list.md | 8 ++++ docs/operator/search-attribute/remove.md | 10 +++++ docs/schedule/backfill.md | 22 ++++++++-- docs/schedule/create.md | 42 ++++++++++++++----- docs/schedule/delete.md | 14 ++++++- docs/schedule/describe.md | 13 +++++- docs/schedule/list.md | 11 ++++- docs/schedule/toggle.md | 21 ++++++++-- docs/schedule/trigger.md | 17 +++++++- docs/schedule/update.md | 41 +++++++++++++----- docs/server/start-dev.md | 2 +- docs/task-queue/list-partition.md | 8 ++++ docs/workflow/count.md | 9 ++++ docs/workflow/delete.md | 8 ++++ docs/workflow/reset-batch.md | 2 +- docs/workflow/reset.md | 4 +- docs/workflow/show.md | 8 ++++ docs/workflow/signal.md | 8 ++++ docs/workflow/stack.md | 9 ++++ docs/workflow/trace.md | 8 ++++ 56 files changed, 384 insertions(+), 57 deletions(-) rename docs/operator/namespace/{create, register.md => create.md} (87%) diff --git a/docs/activity/complete.md b/docs/activity/complete.md index 77d18148..4120a5a4 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -8,6 +8,14 @@ tags: --- +The `temporal activity complete` command completes an [Activity Execution](/activities#activity-execution). + +Use the options listed below to change the behavior of this command. +Make sure to write the command as follows: +`temporal activity complete [command options] [arguments]` + +## OPTIONS + **--activity-id** Identifies the Activity to be completed. diff --git a/docs/activity/fail.md b/docs/activity/fail.md index 1fd3b6f5..ed7082f9 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -8,6 +8,14 @@ tags: --- +The `temporal activity fail` command fails an [Activity Execution](/activities#activity-execution). + +Use the options listed below to change the behavior of this command. +Make sure to write the command as follows: +`temporal activity fail [command options] [arguments]` + +## OPTIONS + **--activity-id** Identifies the Activity to fail. diff --git a/docs/batch/index.md b/docs/batch/index.md index 5edfb62b..d7f304d8 100644 --- a/docs/batch/index.md +++ b/docs/batch/index.md @@ -2,7 +2,7 @@ id: index title: temporal batch sidebar_label: batch -description: Operations performed on Batch jobs. Use Workflow commands with --query flag to start batch jobs. +description: Operations performed on Batch jobs. tags: - cli --- diff --git a/docs/cmd-options/catchup-window.md b/docs/cmd-options/catchup-window.md index 2c8e557c..43e75880 100644 --- a/docs/cmd-options/catchup-window.md +++ b/docs/cmd-options/catchup-window.md @@ -7,4 +7,4 @@ tags: - cli --- - Maximum allowed catch-up time if server is down + Maximum allowed catch-up time if server is down. diff --git a/docs/cmd-options/cron.md b/docs/cmd-options/cron.md index 28c37944..b9397bca 100644 --- a/docs/cmd-options/cron.md +++ b/docs/cmd-options/cron.md @@ -7,4 +7,4 @@ tags: - cli --- - Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" + Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily". diff --git a/docs/cmd-options/end-time.md b/docs/cmd-options/end-time.md index ec760e96..a6198058 100644 --- a/docs/cmd-options/end-time.md +++ b/docs/cmd-options/end-time.md @@ -7,4 +7,4 @@ tags: - cli --- - Backfill end time + Backfill end time. diff --git a/docs/cmd-options/memo-file.md b/docs/cmd-options/memo-file.md index e1fdf611..7454f799 100644 --- a/docs/cmd-options/memo-file.md +++ b/docs/cmd-options/memo-file.md @@ -7,4 +7,4 @@ tags: - cli --- - Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value + Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value. diff --git a/docs/cmd-options/memo.md b/docs/cmd-options/memo.md index f1236019..bd4f3201 100644 --- a/docs/cmd-options/memo.md +++ b/docs/cmd-options/memo.md @@ -7,4 +7,4 @@ tags: - cli --- - Set a memo on a schedule. Format: key=value. Use valid JSON formats for value + Set a memo on a schedule. Format: key=value. Use valid JSON formats for value. diff --git a/docs/cmd-options/metrics-port.md b/docs/cmd-options/metrics-port.md index ebef1c1d..a0dc08a8 100644 --- a/docs/cmd-options/metrics-port.md +++ b/docs/cmd-options/metrics-port.md @@ -7,4 +7,4 @@ tags: - cli --- - Port for /metrics. (default: 0) + Port for /metrics (default: 0) diff --git a/docs/cmd-options/notes.md b/docs/cmd-options/notes.md index 029a696b..973a38c2 100644 --- a/docs/cmd-options/notes.md +++ b/docs/cmd-options/notes.md @@ -7,4 +7,4 @@ tags: - cli --- - Initial value of notes field + Initial value of notes field. diff --git a/docs/cmd-options/overlap-policy.md b/docs/cmd-options/overlap-policy.md index 9a62b306..e1a7440e 100644 --- a/docs/cmd-options/overlap-policy.md +++ b/docs/cmd-options/overlap-policy.md @@ -7,4 +7,4 @@ tags: - cli --- - Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll + Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. diff --git a/docs/cmd-options/pause-on-failure.md b/docs/cmd-options/pause-on-failure.md index 48236cfc..aeecca2e 100644 --- a/docs/cmd-options/pause-on-failure.md +++ b/docs/cmd-options/pause-on-failure.md @@ -7,4 +7,4 @@ tags: - cli --- - Pause schedule after any workflow failure + Pause schedule after any workflow failure. diff --git a/docs/cmd-options/pause.md b/docs/cmd-options/pause.md index df9231e4..3c94256c 100644 --- a/docs/cmd-options/pause.md +++ b/docs/cmd-options/pause.md @@ -7,4 +7,4 @@ tags: - cli --- - Pauses the schedule + Pauses the schedule. diff --git a/docs/cmd-options/raw.md b/docs/cmd-options/raw.md index 9d4b5c0d..e4f154ca 100644 --- a/docs/cmd-options/raw.md +++ b/docs/cmd-options/raw.md @@ -7,4 +7,4 @@ tags: - cli --- - Print raw data as json (prefer this over -o json for scripting) + Print raw data as json (prefer this over -o json for scripting). diff --git a/docs/cmd-options/reapply-type.md b/docs/cmd-options/reapply-type.md index da69e12b..dbd11212 100644 --- a/docs/cmd-options/reapply-type.md +++ b/docs/cmd-options/reapply-type.md @@ -7,4 +7,4 @@ tags: - cli --- - Event types to reapply after the reset point: , Signal, None. (default: All) + Event types to reapply after the reset point: Signal, None, . (default: All) diff --git a/docs/cmd-options/remaining-actions.md b/docs/cmd-options/remaining-actions.md index 425a8d7c..ec6694ff 100644 --- a/docs/cmd-options/remaining-actions.md +++ b/docs/cmd-options/remaining-actions.md @@ -7,4 +7,4 @@ tags: - cli --- - Total number of actions allowed (default: 0) + Total number of actions allowed. (default: 0) diff --git a/docs/cmd-options/search-attribute.md b/docs/cmd-options/search-attribute.md index fdedf58f..3d811e65 100644 --- a/docs/cmd-options/search-attribute.md +++ b/docs/cmd-options/search-attribute.md @@ -7,4 +7,4 @@ tags: - cli --- - Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value + Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value. diff --git a/docs/cmd-options/start-time.md b/docs/cmd-options/start-time.md index c94e1b3e..edae81f8 100644 --- a/docs/cmd-options/start-time.md +++ b/docs/cmd-options/start-time.md @@ -7,4 +7,4 @@ tags: - cli --- - Backfill start time + Backfill start time. diff --git a/docs/cmd-options/unpause.md b/docs/cmd-options/unpause.md index 26004ae0..c2f0be58 100644 --- a/docs/cmd-options/unpause.md +++ b/docs/cmd-options/unpause.md @@ -7,4 +7,4 @@ tags: - cli --- - Unpauses the schedule + Unpauses the schedule. diff --git a/docs/completion/bash.md b/docs/completion/bash.md index 4649c40d..4ee68031 100644 --- a/docs/completion/bash.md +++ b/docs/completion/bash.md @@ -8,3 +8,5 @@ tags: --- +source <(temporal completion bash) + diff --git a/docs/completion/zsh.md b/docs/completion/zsh.md index 9348eb6d..4ecb6224 100644 --- a/docs/completion/zsh.md +++ b/docs/completion/zsh.md @@ -7,3 +7,5 @@ tags: - cli --- + +source <(temporal completion zsh) diff --git a/docs/env/delete.md b/docs/env/delete.md index 9528f7da..3d9dc10d 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -8,6 +8,14 @@ tags: --- +The `temporal env delete` command deletes a given environment or environmental property. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal env delete [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/env/get.md b/docs/env/get.md index e5e23ab7..ad56ace5 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -8,6 +8,14 @@ tags: --- +The `temporal env get` command prints the environmental properties for the environment in use. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal env get [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/env/set.md b/docs/env/set.md index 640b9704..0549d245 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -8,6 +8,14 @@ tags: --- +The `temporal env set` command sets the value for an environmental property. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal env set [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/cluster/describe.md b/docs/operator/cluster/describe.md index 6bc92231..3e6cba47 100644 --- a/docs/operator/cluster/describe.md +++ b/docs/operator/cluster/describe.md @@ -8,6 +8,14 @@ tags: --- +The `temporal operator cluster describe` command shows information about the [Cluster](/clusters). + +Use the options listed below to change the output of this command. +Make sure to write the command as follows: +`temporal operator cluster describe [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/cluster/health.md b/docs/operator/cluster/health.md index 7a82fafe..1c774103 100644 --- a/docs/operator/cluster/health.md +++ b/docs/operator/cluster/health.md @@ -8,6 +8,14 @@ tags: --- +The `temporal operator cluster health` command checks the health of the [Frontend Service](/clusters#frontend-service). + +Use the options listed below to change the behavior and output of this command. +Make sure to write the command as follows: +`temporal operator cluster health [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/cluster/list.md b/docs/operator/cluster/list.md index d5f0e6ba..17621c16 100644 --- a/docs/operator/cluster/list.md +++ b/docs/operator/cluster/list.md @@ -8,6 +8,14 @@ tags: --- +The `temporal operator cluster list` command prints a list of all remote [Clusters](/clusters) on the system. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal operator cluster list [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/cluster/remove.md b/docs/operator/cluster/remove.md index 6157f070..55db55cc 100644 --- a/docs/operator/cluster/remove.md +++ b/docs/operator/cluster/remove.md @@ -8,6 +8,14 @@ tags: --- +The `temporal operator cluster remove` command removes a remote [Cluster](/clusters) from the system. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal operator cluster remove [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/cluster/system.md b/docs/operator/cluster/system.md index 0bbed072..30ef6fd4 100644 --- a/docs/operator/cluster/system.md +++ b/docs/operator/cluster/system.md @@ -8,6 +8,14 @@ tags: --- +The `temporal operator cluster system` command provides information about the system the Cluster is running on. + +Use the options listed below to change this command's output. +Make sure to write the command as follows: +`temporal operator cluster system [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/cluster/upsert.md b/docs/operator/cluster/upsert.md index e07aa726..fcda8b2e 100644 --- a/docs/operator/cluster/upsert.md +++ b/docs/operator/cluster/upsert.md @@ -8,6 +8,14 @@ tags: --- +The `temporal operator cluster upsert` command allows the user to add or update a remote [Cluster](/clusters). + +Use the options listed below to change the behavior of this command. +Make sure to write the command as follows: +`temporal operator cluster upsert [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/namespace/create, register.md b/docs/operator/namespace/create.md similarity index 87% rename from docs/operator/namespace/create, register.md rename to docs/operator/namespace/create.md index 24770b79..8ff3f45b 100644 --- a/docs/operator/namespace/create, register.md +++ b/docs/operator/namespace/create.md @@ -8,6 +8,14 @@ tags: --- +The `temporal operator namespace create` command creates a new [Namespace](/namespaces). + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal operator namespace create [command options] [arguments]` + +## OPTIONS + **--active-cluster** Active cluster name diff --git a/docs/operator/namespace/delete.md b/docs/operator/namespace/delete.md index 7bc7d4bc..573fa66f 100644 --- a/docs/operator/namespace/delete.md +++ b/docs/operator/namespace/delete.md @@ -8,6 +8,14 @@ tags: --- +The `temporal operator namespace delete` command deletes a given [Namespace](/namespaces) from the system. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal operator namespace delete [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/namespace/describe.md b/docs/operator/namespace/describe.md index adb29d1b..3eec89f8 100644 --- a/docs/operator/namespace/describe.md +++ b/docs/operator/namespace/describe.md @@ -8,6 +8,15 @@ tags: --- +The `temporal operator namespace describe` command provides a description of a [Namespace](/namespaces). +Namespaces can be identified by name or Namespace ID. + +Use the options listed below to change the command's output. +Make sure to write the command as follows: +`temporal operator namespace describe [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/namespace/list.md b/docs/operator/namespace/list.md index f699fb02..cab87c7d 100644 --- a/docs/operator/namespace/list.md +++ b/docs/operator/namespace/list.md @@ -8,6 +8,14 @@ tags: --- +The `temporal operator namespace list` command lists all [Namespaces](/namespaces) on the [Server](/clusters#frontend-server). + +Use the options listed below to change the command's output. +Make sure to write the command as follows: +`temporal operator namespace list [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/namespace/update.md b/docs/operator/namespace/update.md index efd2f4f4..769894c4 100644 --- a/docs/operator/namespace/update.md +++ b/docs/operator/namespace/update.md @@ -8,6 +8,14 @@ tags: --- +The `temporal operator namespace update` command updates a given [Namespace](/namespaces). + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal operator namespace update [command options] [arguments]` + +## OPTIONS + **--active-cluster** Active cluster name diff --git a/docs/operator/search-attribute/create.md b/docs/operator/search-attribute/create.md index 1236956a..ac45ccaf 100644 --- a/docs/operator/search-attribute/create.md +++ b/docs/operator/search-attribute/create.md @@ -8,6 +8,15 @@ tags: --- +The `temporal operator search-attribute create` command adds one or more custom [Search Attributes](/visibility#search-attribute). +These Search Attributes can be used to [filter a list](/visibility#list-filter) of [Workflow Executions](/workflows#workflow-execution) that contain the given Search Attributes in their metadata. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal operator search-attribute create [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/search-attribute/list.md b/docs/operator/search-attribute/list.md index 3a3ed0f4..40fb5846 100644 --- a/docs/operator/search-attribute/list.md +++ b/docs/operator/search-attribute/list.md @@ -8,6 +8,14 @@ tags: --- +The `temporal operator search-attrbute list` command displays a list of all [Search Attributes](/visibility#search-attribute) that can be used in ` temporal workflow list --query`. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal operator search-attribute list [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/operator/search-attribute/remove.md b/docs/operator/search-attribute/remove.md index 3352ca6c..eea3c09e 100644 --- a/docs/operator/search-attribute/remove.md +++ b/docs/operator/search-attribute/remove.md @@ -8,6 +8,16 @@ tags: --- +The `temporal operator search-attribute remove` command removes custom [Search Attribute](/visibility#search-attribute) metadata. +This command does not remove custom Search Attributes from Elasticsearch. +The index schema is not modified. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal operator search-attribute remove [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md index 1d2ccb93..056b639c 100644 --- a/docs/schedule/backfill.md +++ b/docs/schedule/backfill.md @@ -2,12 +2,26 @@ id: backfill title: temporal schedule backfill sidebar_label: backfill -description: Backfills a past time range of actions +description: Backfills a past time range of actions. tags: - cli --- +The `temporal schedule backfill` command executes Actions ahead of their specified time range. +Backfilling can be used to fill in [Workflow Runs](/workflows#run-id) from a time period when the Schedule was paused, or from before the Schedule was created. + +``` +temporal schedule backfill --sid 'your-schedule-id' \ +--overlap-policy 'BufferAll' \ +--start-time '2022-05-0101T00:00:00Z' \ +--end-time '2022-05-31T23:59:59Z' +``` + +Use the options provided below to change this command's behavior. + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -24,7 +38,7 @@ when to use color: auto, always, never. (default: auto) An optional timeout for the context of an RPC call (in seconds). (default: 5) **--end-time** -Backfill end time +Backfill end time. **--env** Name of the environment to read environmental variables from. (default: default) @@ -37,14 +51,14 @@ Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--overlap-policy** -Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll +Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. **--schedule-id** Alias: **-s** Schedule Id **--start-time** -Backfill start time +Backfill start time. **--tls-ca-path** Path to server CA certificate. diff --git a/docs/schedule/create.md b/docs/schedule/create.md index 97b5637f..a3889d60 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -2,12 +2,32 @@ id: create title: temporal schedule create sidebar_label: create -description: Create a new schedule +description: Create a new schedule. tags: - cli --- +The `temporal schedule create` command creates a new [Schedule](/workflows#schedule). +Newly created Schedules return a Schedule ID to be used in other Schedule commands. + +Schedules need to follow a format like the example shown here: +``` +temporal schedule create \ +--sid 'your-schedule-id' \ +--cron '3 11 * * Fri' \ +--wid 'your-workflow-id' \ +--tq 'your-task-queue' \ +--type 'YourWorkflowType' +``` + +Any combination of `--cal`, `--interval`, and `--cron` is supported. +Actions will be executed at any time specified in the Schedule. + +Use the options provided below to change the command's behavior. + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -15,7 +35,7 @@ The host and port (formatted as host:port) for the Temporal Frontend Service. Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} **--catchup-window** -Maximum allowed catch-up time if server is down +Maximum allowed catch-up time if server is down. **--codec-auth** Sets the authorization header on requests to the Codec Server. @@ -30,7 +50,7 @@ when to use color: auto, always, never. (default: auto) An optional timeout for the context of an RPC call (in seconds). (default: 5) **--cron** -Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" +Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily". **--end-time** Overall schedule end time. @@ -64,29 +84,29 @@ Jitter duration. Maximum length for each attribute field. (default: 0) **--memo** -Set a memo on a schedule. Format: key=value. Use valid JSON formats for value +Set a memo on a schedule. Format: key=value. Use valid JSON formats for value. **--memo-file** -Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value +Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value. **--namespace** Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--notes** -Initial value of notes field +Initial value of notes field. **--overlap-policy** -Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll +Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. **--pause** -Initial value of paused state +Initial value of paused state. **--pause-on-failure** -Pause schedule after any workflow failure +Pause schedule after any workflow failure. **--remaining-actions** -Total number of actions allowed (default: 0) +Total number of actions allowed. (default: 0) **--run-timeout** Timeout (in seconds) of a single Workflow run. (default: 0) @@ -96,7 +116,7 @@ Alias: **-s** Schedule Id **--search-attribute** -Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value +Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value. **--start-time** Overall schedule start time. diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md index b417d36d..08a53104 100644 --- a/docs/schedule/delete.md +++ b/docs/schedule/delete.md @@ -2,12 +2,24 @@ id: delete title: temporal schedule delete sidebar_label: delete -description: Deletes a schedule +description: Deletes a schedule. tags: - cli --- +The `temporal schedule delete` command deletes a [Schedule](/workflows#schedule). +Deleting a Schedule does not affect any [Workflows](/workflows) started by the Schedule. + +[Workflow Executions](/workflows#workflow-execution) started by Schedules can be cancelled or terminated like other Workflow Executions. +However, Workflow Executions started by a Schedule can be identified by their [Search Attributes](/visibility#search-attribute), making them targetable by batch command for termination. + +`temporal schedule delete --sid 'your-schedule-id' [command options] [arguments]` + +Use the options below to change the behavior of this command. + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 2875191f..840f8f3b 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -2,12 +2,21 @@ id: describe title: temporal schedule describe sidebar_label: describe -description: Get schedule configuration and current state +description: Get schedule configuration and current state. tags: - cli --- +The `temporal schedule describe` command shows the current [Schedule](#workflows#schedule) configuration. +This command also provides information about past, current, and future [Workflow Runs](/workflows#run-id). + +`temporal schedule describe --sid 'your-schedule-id' [command options] [arguments]` + +Use the options below to change this command's output. + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -41,7 +50,7 @@ Alias: **-o** format output as: table, json, card. (default: table) **--raw** -Print raw data as json (prefer this over -o json for scripting) +Print raw data as json (prefer this over -o json for scripting). **--schedule-id** Alias: **-s** diff --git a/docs/schedule/list.md b/docs/schedule/list.md index e7144aad..e2ac95c2 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -2,12 +2,21 @@ id: list title: temporal schedule list sidebar_label: list -description: Lists schedules +description: Lists schedules. tags: - cli --- +The `temporal schedule list` command lists all [Schedule](/workflows#schedule) configurations. +Listing Schedules in [Standard Visibility](/visibility#standard-visibility) will only provide Schedule IDs. + +`temporal schedule list [command options] [arguments]` + +Use the options below to change the behavior of this command. + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md index c4334fbc..f3e69a12 100644 --- a/docs/schedule/toggle.md +++ b/docs/schedule/toggle.md @@ -2,12 +2,25 @@ id: toggle title: temporal schedule toggle sidebar_label: toggle -description: Pauses or unpauses a schedule +description: Pauses or unpauses a schedule. tags: - cli --- +The `temporal schedule toggle` command can pause and unpause a [Schedule](/workflows#schedule). + +Toggling a Schedule requires a reason to be entered on the command line. +Use `--reason` to note the issue leading to the pause or unpause. + +Schedule toggles are passed in this format: +` temporal schedule toggle --sid 'your-schedule-id' --pause --reason "paused because the database is down"` +`temporal schedule toggle --sid 'your-schedule-id' --unpause --reason "the database is back up"` + +Use the options provided below to change this command's behavior. + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -34,10 +47,10 @@ Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--pause** -Pauses the schedule +Pauses the schedule. **--reason** -Free-form text to describe reason for pause/unpause (default: (no reason provided)) +Free-form text to describe reason for pause/unpause. (default: (no reason provided)) **--schedule-id** Alias: **-s** @@ -59,5 +72,5 @@ Path to private certificate key. Provides an override for the target TLS server name. **--unpause** -Unpauses the schedule +Unpauses the schedule. diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md index 25968cb7..194eb716 100644 --- a/docs/schedule/trigger.md +++ b/docs/schedule/trigger.md @@ -2,12 +2,25 @@ id: trigger title: temporal schedule trigger sidebar_label: trigger -description: Triggers an immediate action +description: Triggers an immediate action. tags: - cli --- +The `temporal schedule trigger` command triggers an immediate action with a given [Schedule](/workflows#schedule). +By default, this action is subject to the Overlap Policy of the Schedule. + +`temporal schedule trigger` can be used to start a Workflow Run immediately. +`temporal schedule trigger --sid 'your-schedule-id'` + +The Overlap Policy of the Schedule can be overridden as well. +`temporal schedule trigger --sid 'your-schedule-id' --overlap-policy 'AllowAll'` + +Use the options provided below to change this command's behavior. + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -34,7 +47,7 @@ Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--overlap-policy** -Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll +Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. **--schedule-id** Alias: **-s** diff --git a/docs/schedule/update.md b/docs/schedule/update.md index 15ac619b..0276bb15 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -2,12 +2,31 @@ id: update title: temporal schedule update sidebar_label: update -description: Updates a schedule with a new definition (full replacement, not patch) +description: Updates a schedule with a new definition (full replacement, not patch). tags: - cli --- +The `temporal schedule update` command updates an existing [Schedule](/workflows#schedule). + +Like `temporal schedule create`, updated Schedules need to follow a certain format: +``` +temporal schedule update \ +--sid 'your-schedule-id' \ +--cron '3 11 * * Fri' \ +--wid 'your-workflow-id' \ +--tq 'your-task-queue' \ +--type 'YourWorkflowType' +``` + +Updating a Schedule takes the given options and replaces the entire configuration of the Schedule with what's provided. +If you only change one value of the Schedule, be sure to provide the other unchanged fields to prevent them from being overwritten. + +Use the options provided below to change the command's behavior. + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. @@ -15,7 +34,7 @@ The host and port (formatted as host:port) for the Temporal Frontend Service. Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} **--catchup-window** -Maximum allowed catch-up time if server is down +Maximum allowed catch-up time if server is down. **--codec-auth** Sets the authorization header on requests to the Codec Server. @@ -30,7 +49,7 @@ when to use color: auto, always, never. (default: auto) An optional timeout for the context of an RPC call (in seconds). (default: 5) **--cron** -Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily" +Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily". **--end-time** Overall schedule end time. @@ -64,29 +83,29 @@ Jitter duration. Maximum length for each attribute field. (default: 0) **--memo** -Set a memo on a schedule. Format: key=value. Use valid JSON formats for value +Set a memo on a schedule. Format: key=value. Use valid JSON formats for value. **--memo-file** -Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value +Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value. **--namespace** Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--notes** -Initial value of notes field +Initial value of notes field. **--overlap-policy** -Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll +Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. **--pause** -Initial value of paused state +Initial value of paused state. **--pause-on-failure** -Pause schedule after any workflow failure +Pause schedule after any workflow failure. **--remaining-actions** -Total number of actions allowed (default: 0) +Total number of actions allowed. (default: 0) **--run-timeout** Timeout (in seconds) of a single Workflow run. (default: 0) @@ -96,7 +115,7 @@ Alias: **-s** Schedule Id **--search-attribute** -Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value +Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value. **--start-time** Overall schedule start time. diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index 3b7dd549..f3279b79 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -32,7 +32,7 @@ Set the log formatting. Options: ["json", "pretty"]. (default: json) Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) **--metrics-port** -Port for /metrics. (default: 0) +Port for /metrics (default: 0) **--namespace** Alias: **-n** diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index b25753c4..61ee30ea 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -8,6 +8,14 @@ tags: --- +The `temporal task-queue list-partition` command displays the partitions of a [Task Queue](/tasks#task-queue), along with the matching node they are assigned to. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal task-queue list-partition [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/count.md b/docs/workflow/count.md index 2847f9ee..fe35c3de 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -8,6 +8,15 @@ tags: --- +The `temporal workflow count` command returns a count of [Workflow Executions](/workflows#workflow-execution). +This command requires Elasticsearch to be enabled. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal workflow count [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index 6d2998d8..2dec0ca3 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -8,6 +8,14 @@ tags: --- +The `temporal workflow delete` command deletes the specified [Workflow Execution](/workflows#workflow-execution). + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal workflow delete [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index d3a0a462..b35f726c 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -2,7 +2,7 @@ id: reset-batch title: temporal workflow reset-batch sidebar_label: reset-batch -description: Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +description: Reset a batch of Workflow Executions by reset type: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask tags: - cli --- diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 73b1494b..37cc3f6e 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -46,7 +46,7 @@ Alias: **-n** Identifies a Namespace in the Temporal Workflow. (default: default) **--reapply-type** -Event types to reapply after the reset point: , Signal, None. (default: All) +Event types to reapply after the reset point: Signal, None, . (default: All) **--reason** Reason to reset. @@ -71,7 +71,7 @@ Path to private certificate key. Provides an override for the target TLS server name. **--type** -Event type to which you want to reset: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask +Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew **--workflow-id** Alias: **-w** diff --git a/docs/workflow/show.md b/docs/workflow/show.md index d0a25803..4b1862fb 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -8,6 +8,14 @@ tags: --- +The `temporal workflow show` command provides the [Event History](/workflows#event-history) for a specified [Workflow Execution](/workflows#workflow-execution). + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal workflow show [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index 7bf54f55..9d9afce6 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -8,6 +8,14 @@ tags: --- +The `temporal workflow signal` command is used to [Signal](/workflows#signal) a [Workflow Execution](/workflows#workflow-execution) by ID or [List Filter](/visibility#list-filter). + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal workflow signal [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index 3fa9c553..925a7fb5 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -8,6 +8,15 @@ tags: --- +The `temporal workflow stack` command queries a [Workflow Execution](/workflows#workflow-execution) with `--stack-trace` as the [Query](/workflows#stack-trace-query) type. +Returning the stack trace of all the threads owned by a Workflow Execution can be great for troubleshooting in production. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal workflow stack [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index 72ebd9a1..b8432006 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -8,6 +8,14 @@ tags: --- +The `temporal workflow trace` command tracks the progress of a [Workflow Execution](/workflows#workflow-execution) and any [Child Workflows](/workflows#child-workflow) it generates. + +Use the options listed below to change the command's behavior. +Make sure to write the command as follows: +`temporal workflow trace [command options] [arguments]` + +## OPTIONS + **--address** The host and port (formatted as host:port) for the Temporal Frontend Service. From b6ef7c707ef4f517fd8d81d2ca40db77e5ad9344 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 26 Jan 2023 12:35:23 -0600 Subject: [PATCH 57/68] improved cmd-options list for docusaurus --- cmd/doc/main.go | 14 ++- docs/activity/complete.md | 57 ++++------- docs/activity/fail.md | 60 ++++------- docs/batch/describe.md | 53 ++++------ docs/batch/list.md | 60 ++++------- docs/batch/terminate.md | 46 +++------ docs/cmd-options/config.md | 1 + docs/cmd-options/db-filename.md | 1 + docs/cmd-options/follow.md | 1 + docs/cmd-options/input.md | 1 + docs/cmd-options/namespace.md | 1 + docs/cmd-options/no-pager.md | 1 + docs/cmd-options/output.md | 1 + docs/cmd-options/port.md | 1 + docs/cmd-options/query.md | 1 + docs/cmd-options/reapply-type.md | 2 +- docs/cmd-options/run-id.md | 1 + docs/cmd-options/schedule-id.md | 1 + docs/cmd-options/task-queue.md | 1 + docs/cmd-options/workflow-id.md | 1 + docs/cmd-options/yes.md | 1 + docs/env/delete.md | 40 +++----- docs/env/get.md | 40 +++----- docs/env/set.md | 40 +++----- docs/operator/cluster/describe.md | 60 +++++------ docs/operator/cluster/health.md | 53 +++++----- docs/operator/cluster/list.md | 73 ++++++-------- docs/operator/cluster/remove.md | 56 +++++------ docs/operator/cluster/system.md | 60 +++++------ docs/operator/cluster/upsert.md | 59 +++++------ docs/operator/namespace/create.md | 86 +++++++--------- docs/operator/namespace/delete.md | 57 +++++------ docs/operator/namespace/describe.md | 56 +++++------ docs/operator/namespace/list.md | 53 +++++----- docs/operator/namespace/update.md | 89 +++++++---------- docs/operator/search-attribute/create.md | 63 +++++------- docs/operator/search-attribute/list.md | 57 +++++------ docs/operator/search-attribute/remove.md | 60 +++++------ docs/schedule/backfill.md | 53 ++++------ docs/schedule/create.md | 122 ++++++++--------------- docs/schedule/delete.md | 44 +++----- docs/schedule/describe.md | 57 ++++------- docs/schedule/list.md | 60 ++++------- docs/schedule/toggle.md | 53 ++++------ docs/schedule/trigger.md | 47 +++------ docs/schedule/update.md | 122 ++++++++--------------- docs/server/start-dev.md | 49 +++------ docs/task-queue/describe.md | 57 ++++------- docs/task-queue/list-partition.md | 48 +++------ docs/workflow/cancel.md | 59 ++++------- docs/workflow/count.md | 44 +++----- docs/workflow/delete.md | 48 +++------ docs/workflow/describe.md | 54 ++++------ docs/workflow/execute.md | 105 ++++++------------- docs/workflow/list.md | 67 ++++--------- docs/workflow/query.md | 61 ++++-------- docs/workflow/reset-batch.md | 76 +++++--------- docs/workflow/reset.md | 60 ++++------- docs/workflow/show.md | 81 +++++---------- docs/workflow/signal.md | 69 ++++--------- docs/workflow/stack.md | 58 ++++------- docs/workflow/start.md | 105 ++++++------------- docs/workflow/terminate.md | 59 ++++------- docs/workflow/trace.md | 60 ++++------- 64 files changed, 1058 insertions(+), 1968 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 09684c2e..b6062895 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -38,7 +38,7 @@ type FMStruct struct { IsIndex bool } -var currentHeader, fileName, optionFileName, path, optionFilePath, headerIndexFile string +var currentHeader, fileName, optionFileName, operatorFileName, path, optionFilePath, headerIndexFile string var currentHeaderFile, currentOptionFile *os.File // `BuildApp` takes a string and returns a `*App` and an error @@ -82,7 +82,7 @@ func main() { makeFile(filePath, false, false, scanner, createdFiles) } } else if strings.HasPrefix(line, "#### ") { - operatorFileName := strings.TrimSpace(line[4:]) + operatorFileName = strings.TrimSpace(line[4:]) filePath := filepath.Join(path, fileName, operatorFileName+".md") makeFile(filePath, false, false, scanner, createdFiles) @@ -93,10 +93,11 @@ func main() { if strings.Contains(term, ",") { makeAlias(currentHeaderFile, term) } else { - writeLine(currentHeaderFile, term) + //TODO: change for docusaurus optionFileName = term } - writeLine(currentHeaderFile, strings.TrimSpace(definition)) + //TODO: change for docusaurus + //writeLine(currentHeaderFile, strings.TrimSpace(definition)) log.Info("string split successfully into term and definition (%v)",found) optionFileName = strings.TrimPrefix(optionFileName, "**--") @@ -153,6 +154,9 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, log.Printf("Error when trying to create non-index file %s: %v", path, err) } createdFiles[path] = currentHeaderFile + } + if (strings.Contains(path, "operator")) { + writeFrontMatter(operatorFileName, currentHeader, scanner, false, currentHeaderFile) } writeFrontMatter(fileName, currentHeader, scanner, false, currentHeaderFile) } @@ -182,7 +186,7 @@ func writeFrontMatter(idName string, titleName string, scanner *bufio.Scanner, i for i := 0; i < 2; i++ { scanner.Scan() } - descriptionTxt = scanner.Text() + descriptionTxt = strings.TrimSpace(scanner.Text()) } else { descriptionTxt = "Definition for the " + idName + " command option." } diff --git a/docs/activity/complete.md b/docs/activity/complete.md index 4120a5a4..fad759fe 100644 --- a/docs/activity/complete.md +++ b/docs/activity/complete.md @@ -16,60 +16,39 @@ Make sure to write the command as follows: ## OPTIONS -**--activity-id** -Identifies the Activity to be completed. +- [--activity-id](/cmd-options/activity-id) -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--identity** -Specify operator's identity. +- [--identity](/cmd-options/identity) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--result** -Set the result value of Activity completion. +- [--result](/cmd-options/result) -**--run-id** -Alias: **-r** -Identifies the current Workflow Run. +- [--run-id](/cmd-options/run-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--workflow-id** -Alias: **-w** -Identifies the Workflow that the Activity is running on. +- [--workflow-id](/cmd-options/workflow-id) diff --git a/docs/activity/fail.md b/docs/activity/fail.md index ed7082f9..48f79a0d 100644 --- a/docs/activity/fail.md +++ b/docs/activity/fail.md @@ -16,63 +16,41 @@ Make sure to write the command as follows: ## OPTIONS -**--activity-id** -Identifies the Activity to fail. +- [--activity-id](/cmd-options/activity-id) -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--detail** -Detail to fail the Activity. +- [--detail](/cmd-options/detail) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--identity** -Specify the operator's identity. +- [--identity](/cmd-options/identity) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--reason** -Reason to fail the Activity. +- [--reason](/cmd-options/reason) -**--run-id** -Alias: **-r** -Identifies the current Workflow Run. +- [--run-id](/cmd-options/run-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--workflow-id** -Alias: **-w** -Identifies the Workflow that the Activity is running on. +- [--workflow-id](/cmd-options/workflow-id) diff --git a/docs/batch/describe.md b/docs/batch/describe.md index 3847b642..48ee6432 100644 --- a/docs/batch/describe.md +++ b/docs/batch/describe.md @@ -16,56 +16,37 @@ Make sure to write the command in this format: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. +- [--fields](/cmd-options/fields) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--job-id** -Batch Job Id +- [--job-id](/cmd-options/job-id) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--time-format** -Format time as: relative, iso, raw. (default: relative) +- [--time-format](/cmd-options/time-format) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/batch/list.md b/docs/batch/list.md index 1295293f..765f89a2 100644 --- a/docs/batch/list.md +++ b/docs/batch/list.md @@ -16,64 +16,42 @@ Make sure to write the command in this format: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. +- [--fields](/cmd-options/fields) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--limit** -Number of items to print. (default: 0) +- [--limit](/cmd-options/limit) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--no-pager** -Alias: **-P** -Disables the interactive pager. +- [--no-pager](/cmd-options/no-pager) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--pager** -Sets the pager for Temporal CLI to use. +- [--pager](/cmd-options/pager) Options: less, more, favoritePager. -**--time-format** -Format time as: relative, iso, raw. (default: relative) +- [--time-format](/cmd-options/time-format) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md index 838b2804..a28def9c 100644 --- a/docs/batch/terminate.md +++ b/docs/batch/terminate.md @@ -16,49 +16,33 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--job-id** -Batch Job Id +- [--job-id](/cmd-options/job-id) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--reason** -Reason to stop the Batch job. +- [--reason](/cmd-options/reason) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/cmd-options/config.md b/docs/cmd-options/config.md index 95e21d23..0217e423 100644 --- a/docs/cmd-options/config.md +++ b/docs/cmd-options/config.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-c**="": Path to config directory. Path to config directory. diff --git a/docs/cmd-options/db-filename.md b/docs/cmd-options/db-filename.md index 8109efd2..948b063a 100644 --- a/docs/cmd-options/db-filename.md +++ b/docs/cmd-options/db-filename.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-f**="": File in which to persist Temporal state (by default File in which to persist Temporal state (by default, Workflows are lost when the process dies). diff --git a/docs/cmd-options/follow.md b/docs/cmd-options/follow.md index ef5cf500..9e90039e 100644 --- a/docs/cmd-options/follow.md +++ b/docs/cmd-options/follow.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-f**: Follow the progress of a Workflow Execution. Follow the progress of a Workflow Execution. diff --git a/docs/cmd-options/input.md b/docs/cmd-options/input.md index 761a6ba5..fdbd3055 100644 --- a/docs/cmd-options/input.md +++ b/docs/cmd-options/input.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-i**="": Optional JSON input to provide to the Workflow. Optional JSON input to provide to the Workflow. diff --git a/docs/cmd-options/namespace.md b/docs/cmd-options/namespace.md index fd8a255f..8465ae85 100644 --- a/docs/cmd-options/namespace.md +++ b/docs/cmd-options/namespace.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-n**="": Identifies a Namespace in the Temporal Workflow. (default: default) Identifies a Namespace in the Temporal Workflow. (default: default) diff --git a/docs/cmd-options/no-pager.md b/docs/cmd-options/no-pager.md index e88928d0..c704ee55 100644 --- a/docs/cmd-options/no-pager.md +++ b/docs/cmd-options/no-pager.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-P**: Disables the interactive pager. Disables the interactive pager. diff --git a/docs/cmd-options/output.md b/docs/cmd-options/output.md index bf12c67e..4f30fcc6 100644 --- a/docs/cmd-options/output.md +++ b/docs/cmd-options/output.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-o**="": format output as: table format output as: table, json, card. (default: table) diff --git a/docs/cmd-options/port.md b/docs/cmd-options/port.md index 2a79fde7..df4e365c 100644 --- a/docs/cmd-options/port.md +++ b/docs/cmd-options/port.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-p**="": Port for the frontend gRPC service. (default: 7233) Port for the frontend gRPC service. (default: 7233) diff --git a/docs/cmd-options/query.md b/docs/cmd-options/query.md index 8f986a03..7fef7540 100644 --- a/docs/cmd-options/query.md +++ b/docs/cmd-options/query.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query. Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query. diff --git a/docs/cmd-options/reapply-type.md b/docs/cmd-options/reapply-type.md index dbd11212..da69e12b 100644 --- a/docs/cmd-options/reapply-type.md +++ b/docs/cmd-options/reapply-type.md @@ -7,4 +7,4 @@ tags: - cli --- - Event types to reapply after the reset point: Signal, None, . (default: All) + Event types to reapply after the reset point: , Signal, None. (default: All) diff --git a/docs/cmd-options/run-id.md b/docs/cmd-options/run-id.md index 2ad7ef98..41e07c1e 100644 --- a/docs/cmd-options/run-id.md +++ b/docs/cmd-options/run-id.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-r**="": Identifies the current Workflow Run. Identifies the current Workflow Run. diff --git a/docs/cmd-options/schedule-id.md b/docs/cmd-options/schedule-id.md index d0125526..cbc20b7b 100644 --- a/docs/cmd-options/schedule-id.md +++ b/docs/cmd-options/schedule-id.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-s**="": Schedule Id Schedule Id diff --git a/docs/cmd-options/task-queue.md b/docs/cmd-options/task-queue.md index 9c96dfdf..a1bc97de 100644 --- a/docs/cmd-options/task-queue.md +++ b/docs/cmd-options/task-queue.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-t**="": Task Queue Task Queue diff --git a/docs/cmd-options/workflow-id.md b/docs/cmd-options/workflow-id.md index ecee629d..65accdcb 100644 --- a/docs/cmd-options/workflow-id.md +++ b/docs/cmd-options/workflow-id.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-w**="": Workflow Id Workflow Id diff --git a/docs/cmd-options/yes.md b/docs/cmd-options/yes.md index af429a7e..9038abf0 100644 --- a/docs/cmd-options/yes.md +++ b/docs/cmd-options/yes.md @@ -7,4 +7,5 @@ tags: - cli --- +Alias: **-y**: Confirm all prompts. Confirm all prompts. diff --git a/docs/env/delete.md b/docs/env/delete.md index 3d9dc10d..01f71f19 100644 --- a/docs/env/delete.md +++ b/docs/env/delete.md @@ -16,43 +16,29 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/env/get.md b/docs/env/get.md index ad56ace5..38fd0dee 100644 --- a/docs/env/get.md +++ b/docs/env/get.md @@ -16,43 +16,29 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/env/set.md b/docs/env/set.md index 0549d245..1812bf7a 100644 --- a/docs/env/set.md +++ b/docs/env/set.md @@ -16,43 +16,29 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/operator/cluster/describe.md b/docs/operator/cluster/describe.md index 3e6cba47..c04365ff 100644 --- a/docs/operator/cluster/describe.md +++ b/docs/operator/cluster/describe.md @@ -1,65 +1,55 @@ +--- +id: describe +title: temporal operator describe +sidebar_label: describe +description: Show information about the Cluster. +tags: + - cli +--- + --- id: cluster title: temporal operator cluster sidebar_label: cluster -description: Show information about the Cluster. +description: The `temporal operator cluster describe` command shows information about the [Cluster](/clusters). tags: - cli --- -The `temporal operator cluster describe` command shows information about the [Cluster](/clusters). - Use the options listed below to change the output of this command. Make sure to write the command as follows: `temporal operator cluster describe [command options] [arguments]` ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. +- [--fields](/cmd-options/fields) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/operator/cluster/health.md b/docs/operator/cluster/health.md index 1c774103..62c6d451 100644 --- a/docs/operator/cluster/health.md +++ b/docs/operator/cluster/health.md @@ -1,58 +1,51 @@ +--- +id: health +title: temporal operator health +sidebar_label: health +description: Checks the health of the Frontend Service. +tags: + - cli +--- + --- id: cluster title: temporal operator cluster sidebar_label: cluster -description: Checks the health of the Frontend Service. +description: The `temporal operator cluster health` command checks the health of the [Frontend Service](/clusters#frontend-service). tags: - cli --- -The `temporal operator cluster health` command checks the health of the [Frontend Service](/clusters#frontend-service). - Use the options listed below to change the behavior and output of this command. Make sure to write the command as follows: `temporal operator cluster health [command options] [arguments]` ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/operator/cluster/list.md b/docs/operator/cluster/list.md index 17621c16..6edc31fd 100644 --- a/docs/operator/cluster/list.md +++ b/docs/operator/cluster/list.md @@ -1,79 +1,64 @@ +--- +id: list +title: temporal operator list +sidebar_label: list +description: List all remote Clusters. +tags: + - cli +--- + --- id: cluster title: temporal operator cluster sidebar_label: cluster -description: List all remote Clusters. +description: The `temporal operator cluster list` command prints a list of all remote [Clusters](/clusters) on the system. tags: - cli --- -The `temporal operator cluster list` command prints a list of all remote [Clusters](/clusters) on the system. - Use the options listed below to change the command's behavior. Make sure to write the command as follows: `temporal operator cluster list [command options] [arguments]` ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. +- [--fields](/cmd-options/fields) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--limit** -Number of items to print. (default: 0) +- [--limit](/cmd-options/limit) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--no-pager** -Alias: **-P** -Disables the interactive pager. +- [--no-pager](/cmd-options/no-pager) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--pager** -Sets the pager for Temporal CLI to use. +- [--pager](/cmd-options/pager) Options: less, more, favoritePager. -**--time-format** -Format time as: relative, iso, raw. (default: relative) +- [--time-format](/cmd-options/time-format) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/operator/cluster/remove.md b/docs/operator/cluster/remove.md index 55db55cc..4a65a501 100644 --- a/docs/operator/cluster/remove.md +++ b/docs/operator/cluster/remove.md @@ -1,61 +1,53 @@ +--- +id: remove +title: temporal operator remove +sidebar_label: remove +description: Remove a remote Cluster. +tags: + - cli +--- + --- id: cluster title: temporal operator cluster sidebar_label: cluster -description: Remove a remote Cluster. +description: The `temporal operator cluster remove` command removes a remote [Cluster](/clusters) from the system. tags: - cli --- -The `temporal operator cluster remove` command removes a remote [Cluster](/clusters) from the system. - Use the options listed below to change the command's behavior. Make sure to write the command as follows: `temporal operator cluster remove [command options] [arguments]` ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--name** -Frontend address of the remote Cluster. +- [--name](/cmd-options/name) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/operator/cluster/system.md b/docs/operator/cluster/system.md index 30ef6fd4..e4d90bfa 100644 --- a/docs/operator/cluster/system.md +++ b/docs/operator/cluster/system.md @@ -1,65 +1,55 @@ +--- +id: system +title: temporal operator system +sidebar_label: system +description: Shows information about the system and its capabilities. +tags: + - cli +--- + --- id: cluster title: temporal operator cluster sidebar_label: cluster -description: Shows information about the system and its capabilities. +description: The `temporal operator cluster system` command provides information about the system the Cluster is running on. tags: - cli --- -The `temporal operator cluster system` command provides information about the system the Cluster is running on. - Use the options listed below to change this command's output. Make sure to write the command as follows: `temporal operator cluster system [command options] [arguments]` ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. +- [--fields](/cmd-options/fields) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/operator/cluster/upsert.md b/docs/operator/cluster/upsert.md index fcda8b2e..075592bf 100644 --- a/docs/operator/cluster/upsert.md +++ b/docs/operator/cluster/upsert.md @@ -1,64 +1,55 @@ +--- +id: upsert +title: temporal operator upsert +sidebar_label: upsert +description: Add or update a remote Cluster. +tags: + - cli +--- + --- id: cluster title: temporal operator cluster sidebar_label: cluster -description: Add or update a remote Cluster. +description: The `temporal operator cluster upsert` command allows the user to add or update a remote [Cluster](/clusters). tags: - cli --- -The `temporal operator cluster upsert` command allows the user to add or update a remote [Cluster](/clusters). - Use the options listed below to change the behavior of this command. Make sure to write the command as follows: `temporal operator cluster upsert [command options] [arguments]` ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--enable-connection** -Enable cross-cluster connection. +- [--enable-connection](/cmd-options/enable-connection) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--frontend-address** -Frontend address of the remote Cluster. +- [--frontend-address](/cmd-options/frontend-address) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/operator/namespace/create.md b/docs/operator/namespace/create.md index 8ff3f45b..bb1e1af0 100644 --- a/docs/operator/namespace/create.md +++ b/docs/operator/namespace/create.md @@ -1,91 +1,73 @@ +--- +id: create +title: temporal operator create +sidebar_label: create +description: Register a new Namespace +tags: + - cli +--- + --- id: namespace title: temporal operator namespace sidebar_label: namespace -description: Register a new Namespace +description: The `temporal operator namespace create` command creates a new [Namespace](/namespaces). tags: - cli --- -The `temporal operator namespace create` command creates a new [Namespace](/namespaces). - Use the options listed below to change the command's behavior. Make sure to write the command as follows: `temporal operator namespace create [command options] [arguments]` ## OPTIONS -**--active-cluster** -Active cluster name +- [--active-cluster](/cmd-options/active-cluster) -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--cluster** -Cluster name +- [--cluster](/cmd-options/cluster) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--data** -Namespace data in a format key=value +- [--data](/cmd-options/data) -**--description** -Namespace description +- [--description](/cmd-options/description) -**--email** -Owner email +- [--email](/cmd-options/email) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--global** -Flag to indicate whether namespace is a global namespace +- [--global](/cmd-options/global) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--history-archival-state** -Flag to set history archival state, valid values are "disabled" and "enabled" +- [--history-archival-state](/cmd-options/history-archival-state) -**--history-uri** -Optionally specify history archival URI (cannot be changed after first time archival is enabled) +- [--history-uri](/cmd-options/history-uri) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--retention** -Workflow Execution retention +- [--retention](/cmd-options/retention) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--visibility-archival-state** -Flag to set visibility archival state, valid values are "disabled" and "enabled" +- [--visibility-archival-state](/cmd-options/visibility-archival-state) -**--visibility-uri** -Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) +- [--visibility-uri](/cmd-options/visibility-uri) diff --git a/docs/operator/namespace/delete.md b/docs/operator/namespace/delete.md index 573fa66f..79294bd1 100644 --- a/docs/operator/namespace/delete.md +++ b/docs/operator/namespace/delete.md @@ -1,62 +1,53 @@ +--- +id: delete +title: temporal operator delete +sidebar_label: delete +description: Deletes an existing Namespace. +tags: + - cli +--- + --- id: namespace title: temporal operator namespace sidebar_label: namespace -description: Deletes an existing Namespace. +description: The `temporal operator namespace delete` command deletes a given [Namespace](/namespaces) from the system. tags: - cli --- -The `temporal operator namespace delete` command deletes a given [Namespace](/namespaces) from the system. - Use the options listed below to change the command's behavior. Make sure to write the command as follows: `temporal operator namespace delete [command options] [arguments]` ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--yes** -Alias: **-y** -Confirm all prompts. +- [--yes](/cmd-options/yes) diff --git a/docs/operator/namespace/describe.md b/docs/operator/namespace/describe.md index 3eec89f8..355c4bc4 100644 --- a/docs/operator/namespace/describe.md +++ b/docs/operator/namespace/describe.md @@ -1,14 +1,21 @@ +--- +id: describe +title: temporal operator describe +sidebar_label: describe +description: Describe a Namespace by its name or Id. +tags: + - cli +--- + --- id: namespace title: temporal operator namespace sidebar_label: namespace -description: Describe a Namespace by its name or Id. +description: The `temporal operator namespace describe` command provides a description of a [Namespace](/namespaces). tags: - cli --- - -The `temporal operator namespace describe` command provides a description of a [Namespace](/namespaces). Namespaces can be identified by name or Namespace ID. Use the options listed below to change the command's output. @@ -17,46 +24,31 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--namespace-id** -Namespace Id +- [--namespace-id](/cmd-options/namespace-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/operator/namespace/list.md b/docs/operator/namespace/list.md index cab87c7d..5436997a 100644 --- a/docs/operator/namespace/list.md +++ b/docs/operator/namespace/list.md @@ -1,58 +1,51 @@ +--- +id: list +title: temporal operator list +sidebar_label: list +description: List all Namespaces. +tags: + - cli +--- + --- id: namespace title: temporal operator namespace sidebar_label: namespace -description: List all Namespaces. +description: The `temporal operator namespace list` command lists all [Namespaces](/namespaces) on the [Server](/clusters#frontend-server). tags: - cli --- -The `temporal operator namespace list` command lists all [Namespaces](/namespaces) on the [Server](/clusters#frontend-server). - Use the options listed below to change the command's output. Make sure to write the command as follows: `temporal operator namespace list [command options] [arguments]` ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/operator/namespace/update.md b/docs/operator/namespace/update.md index 769894c4..e3fac40d 100644 --- a/docs/operator/namespace/update.md +++ b/docs/operator/namespace/update.md @@ -1,94 +1,75 @@ +--- +id: update +title: temporal operator update +sidebar_label: update +description: Updates a Namespace. +tags: + - cli +--- + --- id: namespace title: temporal operator namespace sidebar_label: namespace -description: Updates a Namespace. +description: The `temporal operator namespace update` command updates a given [Namespace](/namespaces). tags: - cli --- -The `temporal operator namespace update` command updates a given [Namespace](/namespaces). - Use the options listed below to change the command's behavior. Make sure to write the command as follows: `temporal operator namespace update [command options] [arguments]` ## OPTIONS -**--active-cluster** -Active cluster name +- [--active-cluster](/cmd-options/active-cluster) -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--cluster** -Cluster name +- [--cluster](/cmd-options/cluster) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--data** -Namespace data in a format key=value +- [--data](/cmd-options/data) -**--description** -Namespace description +- [--description](/cmd-options/description) -**--email** -Owner email +- [--email](/cmd-options/email) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--history-archival-state** -Flag to set history archival state, valid values are "disabled" and "enabled" +- [--history-archival-state](/cmd-options/history-archival-state) -**--history-uri** -Optionally specify history archival URI (cannot be changed after first time archival is enabled) +- [--history-uri](/cmd-options/history-uri) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--promote-global** -Promote local namespace to global namespace +- [--promote-global](/cmd-options/promote-global) -**--reason** -Reason for the operation +- [--reason](/cmd-options/reason) -**--retention** -Workflow Execution retention +- [--retention](/cmd-options/retention) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--visibility-archival-state** -Flag to set visibility archival state, valid values are "disabled" and "enabled" +- [--visibility-archival-state](/cmd-options/visibility-archival-state) -**--visibility-uri** -Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) +- [--visibility-uri](/cmd-options/visibility-uri) diff --git a/docs/operator/search-attribute/create.md b/docs/operator/search-attribute/create.md index ac45ccaf..0076ac4d 100644 --- a/docs/operator/search-attribute/create.md +++ b/docs/operator/search-attribute/create.md @@ -1,14 +1,21 @@ +--- +id: create +title: temporal operator create +sidebar_label: create +description: Adds one or more custom Search Attributes. +tags: + - cli +--- + --- id: search-attribute title: temporal operator search-attribute sidebar_label: search-attribute -description: Adds one or more custom Search Attributes. +description: The `temporal operator search-attribute create` command adds one or more custom [Search Attributes](/visibility#search-attribute). tags: - cli --- - -The `temporal operator search-attribute create` command adds one or more custom [Search Attributes](/visibility#search-attribute). These Search Attributes can be used to [filter a list](/visibility#list-filter) of [Workflow Executions](/workflows#workflow-execution) that contain the given Search Attributes in their metadata. Use the options listed below to change the command's behavior. @@ -17,53 +24,35 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--name** -Search attribute name. +- [--name](/cmd-options/name) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--type** -Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] +- [--type](/cmd-options/type) -**--yes** -Alias: **-y** -Confirm all prompts. +- [--yes](/cmd-options/yes) diff --git a/docs/operator/search-attribute/list.md b/docs/operator/search-attribute/list.md index 40fb5846..f3a5acac 100644 --- a/docs/operator/search-attribute/list.md +++ b/docs/operator/search-attribute/list.md @@ -1,62 +1,53 @@ +--- +id: list +title: temporal operator list +sidebar_label: list +description: Lists all Search Attributes that can be used in list Workflow Queries. +tags: + - cli +--- + --- id: search-attribute title: temporal operator search-attribute sidebar_label: search-attribute -description: Lists all Search Attributes that can be used in list Workflow Queries. +description: The `temporal operator search-attrbute list` command displays a list of all [Search Attributes](/visibility#search-attribute) that can be used in ` temporal workflow list --query`. tags: - cli --- -The `temporal operator search-attrbute list` command displays a list of all [Search Attributes](/visibility#search-attribute) that can be used in ` temporal workflow list --query`. - Use the options listed below to change the command's behavior. Make sure to write the command as follows: `temporal operator search-attribute list [command options] [arguments]` ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/operator/search-attribute/remove.md b/docs/operator/search-attribute/remove.md index eea3c09e..d90ffca8 100644 --- a/docs/operator/search-attribute/remove.md +++ b/docs/operator/search-attribute/remove.md @@ -1,14 +1,21 @@ +--- +id: remove +title: temporal operator remove +sidebar_label: remove +description: Removes custom search attribute metadata only (Elasticsearch index schema is not modified). +tags: + - cli +--- + --- id: search-attribute title: temporal operator search-attribute sidebar_label: search-attribute -description: Removes custom search attribute metadata only (Elasticsearch index schema is not modified). +description: The `temporal operator search-attribute remove` command removes custom [Search Attribute](/visibility#search-attribute) metadata. tags: - cli --- - -The `temporal operator search-attribute remove` command removes custom [Search Attribute](/visibility#search-attribute) metadata. This command does not remove custom Search Attributes from Elasticsearch. The index schema is not modified. @@ -18,50 +25,33 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--name** -Search attribute name. +- [--name](/cmd-options/name) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--yes** -Alias: **-y** -Confirm all prompts. +- [--yes](/cmd-options/yes) diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md index 056b639c..7d28051e 100644 --- a/docs/schedule/backfill.md +++ b/docs/schedule/backfill.md @@ -22,56 +22,37 @@ Use the options provided below to change this command's behavior. ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--end-time** -Backfill end time. +- [--end-time](/cmd-options/end-time) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--overlap-policy** -Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. +- [--overlap-policy](/cmd-options/overlap-policy) -**--schedule-id** -Alias: **-s** -Schedule Id +- [--schedule-id](/cmd-options/schedule-id) -**--start-time** -Backfill start time. +- [--start-time](/cmd-options/start-time) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/schedule/create.md b/docs/schedule/create.md index a3889d60..1870e17a 100644 --- a/docs/schedule/create.md +++ b/docs/schedule/create.md @@ -28,128 +28,84 @@ Use the options provided below to change the command's behavior. ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--calendar** -Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} +- [--calendar](/cmd-options/calendar) -**--catchup-window** -Maximum allowed catch-up time if server is down. +- [--catchup-window](/cmd-options/catchup-window) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--cron** -Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily". +- [--cron](/cmd-options/cron) -**--end-time** -Overall schedule end time. +- [--end-time](/cmd-options/end-time) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--execution-timeout** -Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) +- [--execution-timeout](/cmd-options/execution-timeout) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--input** -Alias: **-i** -Optional JSON input to provide to the Workflow. +- [--input](/cmd-options/input) Pass "null" for null values. -**--input-file** -Passes optional input for the Workflow from a JSON file. +- [--input-file](/cmd-options/input-file) If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line will overwrite file input. -**--interval** -Interval duration, e.g. 90m, or 90m/13m to include phase offset. +- [--interval](/cmd-options/interval) -**--jitter** -Jitter duration. +- [--jitter](/cmd-options/jitter) -**--max-field-length** -Maximum length for each attribute field. (default: 0) +- [--max-field-length](/cmd-options/max-field-length) -**--memo** -Set a memo on a schedule. Format: key=value. Use valid JSON formats for value. +- [--memo](/cmd-options/memo) -**--memo-file** -Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value. +- [--memo-file](/cmd-options/memo-file) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--notes** -Initial value of notes field. +- [--notes](/cmd-options/notes) -**--overlap-policy** -Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. +- [--overlap-policy](/cmd-options/overlap-policy) -**--pause** -Initial value of paused state. +- [--pause](/cmd-options/pause) -**--pause-on-failure** -Pause schedule after any workflow failure. +- [--pause-on-failure](/cmd-options/pause-on-failure) -**--remaining-actions** -Total number of actions allowed. (default: 0) +- [--remaining-actions](/cmd-options/remaining-actions) -**--run-timeout** -Timeout (in seconds) of a single Workflow run. (default: 0) +- [--run-timeout](/cmd-options/run-timeout) -**--schedule-id** -Alias: **-s** -Schedule Id +- [--schedule-id](/cmd-options/schedule-id) -**--search-attribute** -Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value. +- [--search-attribute](/cmd-options/search-attribute) -**--start-time** -Overall schedule start time. +- [--start-time](/cmd-options/start-time) -**--task-queue** -Alias: **-t** -Task Queue +- [--task-queue](/cmd-options/task-queue) -**--task-timeout** -Start-to-close timeout for a Workflow Task (in seconds). (default: 10) +- [--task-timeout](/cmd-options/task-timeout) -**--time-zone** -Time zone (IANA name). +- [--time-zone](/cmd-options/time-zone) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--workflow-id** -Alias: **-w** -Workflow Id +- [--workflow-id](/cmd-options/workflow-id) -**--workflow-type** -Workflow type name. +- [--workflow-type](/cmd-options/workflow-type) diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md index 08a53104..93c50c6c 100644 --- a/docs/schedule/delete.md +++ b/docs/schedule/delete.md @@ -20,47 +20,31 @@ Use the options below to change the behavior of this command. ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--schedule-id** -Alias: **-s** -Schedule Id +- [--schedule-id](/cmd-options/schedule-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md index 840f8f3b..e58df399 100644 --- a/docs/schedule/describe.md +++ b/docs/schedule/describe.md @@ -17,60 +17,39 @@ Use the options below to change this command's output. ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. +- [--fields](/cmd-options/fields) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--raw** -Print raw data as json (prefer this over -o json for scripting). +- [--raw](/cmd-options/raw) -**--schedule-id** -Alias: **-s** -Schedule Id +- [--schedule-id](/cmd-options/schedule-id) -**--time-format** -Format time as: relative, iso, raw. (default: relative) +- [--time-format](/cmd-options/time-format) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/schedule/list.md b/docs/schedule/list.md index e2ac95c2..0dcb8d3b 100644 --- a/docs/schedule/list.md +++ b/docs/schedule/list.md @@ -17,64 +17,42 @@ Use the options below to change the behavior of this command. ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. +- [--fields](/cmd-options/fields) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--limit** -Number of items to print. (default: 0) +- [--limit](/cmd-options/limit) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--no-pager** -Alias: **-P** -Disables the interactive pager. +- [--no-pager](/cmd-options/no-pager) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--pager** -Sets the pager for Temporal CLI to use. +- [--pager](/cmd-options/pager) Options: less, more, favoritePager. -**--time-format** -Format time as: relative, iso, raw. (default: relative) +- [--time-format](/cmd-options/time-format) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md index f3e69a12..14a867b4 100644 --- a/docs/schedule/toggle.md +++ b/docs/schedule/toggle.md @@ -21,56 +21,37 @@ Use the options provided below to change this command's behavior. ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--pause** -Pauses the schedule. +- [--pause](/cmd-options/pause) -**--reason** -Free-form text to describe reason for pause/unpause. (default: (no reason provided)) +- [--reason](/cmd-options/reason) -**--schedule-id** -Alias: **-s** -Schedule Id +- [--schedule-id](/cmd-options/schedule-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--unpause** -Unpauses the schedule. +- [--unpause](/cmd-options/unpause) diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md index 194eb716..c2b0659d 100644 --- a/docs/schedule/trigger.md +++ b/docs/schedule/trigger.md @@ -21,50 +21,33 @@ Use the options provided below to change this command's behavior. ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--overlap-policy** -Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. +- [--overlap-policy](/cmd-options/overlap-policy) -**--schedule-id** -Alias: **-s** -Schedule Id +- [--schedule-id](/cmd-options/schedule-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/schedule/update.md b/docs/schedule/update.md index 0276bb15..2d33dcbb 100644 --- a/docs/schedule/update.md +++ b/docs/schedule/update.md @@ -27,128 +27,84 @@ Use the options provided below to change the command's behavior. ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--calendar** -Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} +- [--calendar](/cmd-options/calendar) -**--catchup-window** -Maximum allowed catch-up time if server is down. +- [--catchup-window](/cmd-options/catchup-window) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--cron** -Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily". +- [--cron](/cmd-options/cron) -**--end-time** -Overall schedule end time. +- [--end-time](/cmd-options/end-time) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--execution-timeout** -Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) +- [--execution-timeout](/cmd-options/execution-timeout) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--input** -Alias: **-i** -Optional JSON input to provide to the Workflow. +- [--input](/cmd-options/input) Pass "null" for null values. -**--input-file** -Passes optional input for the Workflow from a JSON file. +- [--input-file](/cmd-options/input-file) If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line will overwrite file input. -**--interval** -Interval duration, e.g. 90m, or 90m/13m to include phase offset. +- [--interval](/cmd-options/interval) -**--jitter** -Jitter duration. +- [--jitter](/cmd-options/jitter) -**--max-field-length** -Maximum length for each attribute field. (default: 0) +- [--max-field-length](/cmd-options/max-field-length) -**--memo** -Set a memo on a schedule. Format: key=value. Use valid JSON formats for value. +- [--memo](/cmd-options/memo) -**--memo-file** -Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value. +- [--memo-file](/cmd-options/memo-file) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--notes** -Initial value of notes field. +- [--notes](/cmd-options/notes) -**--overlap-policy** -Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. +- [--overlap-policy](/cmd-options/overlap-policy) -**--pause** -Initial value of paused state. +- [--pause](/cmd-options/pause) -**--pause-on-failure** -Pause schedule after any workflow failure. +- [--pause-on-failure](/cmd-options/pause-on-failure) -**--remaining-actions** -Total number of actions allowed. (default: 0) +- [--remaining-actions](/cmd-options/remaining-actions) -**--run-timeout** -Timeout (in seconds) of a single Workflow run. (default: 0) +- [--run-timeout](/cmd-options/run-timeout) -**--schedule-id** -Alias: **-s** -Schedule Id +- [--schedule-id](/cmd-options/schedule-id) -**--search-attribute** -Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value. +- [--search-attribute](/cmd-options/search-attribute) -**--start-time** -Overall schedule start time. +- [--start-time](/cmd-options/start-time) -**--task-queue** -Alias: **-t** -Task Queue +- [--task-queue](/cmd-options/task-queue) -**--task-timeout** -Start-to-close timeout for a Workflow Task (in seconds). (default: 10) +- [--task-timeout](/cmd-options/task-timeout) -**--time-zone** -Time zone (IANA name). +- [--time-zone](/cmd-options/time-zone) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--workflow-id** -Alias: **-w** -Workflow Id +- [--workflow-id](/cmd-options/workflow-id) -**--workflow-type** -Workflow type name. +- [--workflow-type](/cmd-options/workflow-type) diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md index f3279b79..4decf497 100644 --- a/docs/server/start-dev.md +++ b/docs/server/start-dev.md @@ -8,52 +8,33 @@ tags: --- -**--config** -Alias: **-c** -Path to config directory. +- [--config](/cmd-options/config) -**--db-filename** -Alias: **-f** -File in which to persist Temporal state (by default, Workflows are lost when the process dies). +- [--db-filename](/cmd-options/db-filename) -**--dynamic-config-value** -Dynamic config value, as KEY=JSON_VALUE (string values need quotes). +- [--dynamic-config-value](/cmd-options/dynamic-config-value) -**--headless** -Disable the Web UI. +- [--headless](/cmd-options/headless) -**--ip** -IPv4 address to bind the frontend service to. (default: 127.0.0.1) +- [--ip](/cmd-options/ip) -**--log-format** -Set the log formatting. Options: ["json", "pretty"]. (default: json) +- [--log-format](/cmd-options/log-format) -**--log-level** -Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) +- [--log-level](/cmd-options/log-level) -**--metrics-port** -Port for /metrics (default: 0) +- [--metrics-port](/cmd-options/metrics-port) -**--namespace** -Alias: **-n** -Specify namespaces that should be pre-created (namespace "default" is always created). +- [--namespace](/cmd-options/namespace) -**--port** -Alias: **-p** -Port for the frontend gRPC service. (default: 7233) +- [--port](/cmd-options/port) -**--sqlite-pragma** -Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. +- [--sqlite-pragma](/cmd-options/sqlite-pragma) -**--ui-asset-path** -UI Custom Assets path. +- [--ui-asset-path](/cmd-options/ui-asset-path) -**--ui-codec-endpoint** -UI Remote data converter HTTP endpoint. +- [--ui-codec-endpoint](/cmd-options/ui-codec-endpoint) -**--ui-ip** -IPv4 address to bind the Web UI to. +- [--ui-ip](/cmd-options/ui-ip) -**--ui-port** -Port for the Web UI. (default: 0) +- [--ui-port](/cmd-options/ui-port) diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md index c6e2a24d..fe988e21 100644 --- a/docs/task-queue/describe.md +++ b/docs/task-queue/describe.md @@ -20,60 +20,39 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. +- [--fields](/cmd-options/fields) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--task-queue** -Alias: **-t** -Task Queue name. +- [--task-queue](/cmd-options/task-queue) -**--task-queue-type** -Task Queue type [workflow|activity] (default: workflow) +- [--task-queue-type](/cmd-options/task-queue-type) -**--time-format** -Format time as: relative, iso, raw. (default: relative) +- [--time-format](/cmd-options/time-format) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md index 61ee30ea..e1d7e0cb 100644 --- a/docs/task-queue/list-partition.md +++ b/docs/task-queue/list-partition.md @@ -16,51 +16,33 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--task-queue** -Alias: **-t** -Task Queue name. +- [--task-queue](/cmd-options/task-queue) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md index bb2dd7de..15bb0f87 100644 --- a/docs/workflow/cancel.md +++ b/docs/workflow/cancel.md @@ -19,62 +19,39 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--query** -Alias: **-q** -Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/. +- [--query](/cmd-options/query) -**--reason** -Reason for canceling with List Filter. +- [--reason](/cmd-options/reason) -**--run-id** -Alias: **-r** -Run Id +- [--run-id](/cmd-options/run-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--workflow-id** -Alias: **-w** -Cancel Workflow Execution by Id. +- [--workflow-id](/cmd-options/workflow-id) -**--yes** -Alias: **-y** -Confirm all prompts. +- [--yes](/cmd-options/yes) diff --git a/docs/workflow/count.md b/docs/workflow/count.md index fe35c3de..667e9788 100644 --- a/docs/workflow/count.md +++ b/docs/workflow/count.md @@ -17,47 +17,31 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--query** -Alias: **-q** -Filter results using an SQL-like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for more information. +- [--query](/cmd-options/query) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md index 2dec0ca3..566f691a 100644 --- a/docs/workflow/delete.md +++ b/docs/workflow/delete.md @@ -16,51 +16,33 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--run-id** -Alias: **-r** -Run Id +- [--run-id](/cmd-options/run-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--workflow-id** -Alias: **-w** -Workflow Id +- [--workflow-id](/cmd-options/workflow-id) diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md index 5ce242bd..a03be641 100644 --- a/docs/workflow/describe.md +++ b/docs/workflow/describe.md @@ -17,57 +17,37 @@ Make sure to write the command in this format: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--raw** -Print properties as they are stored. +- [--raw](/cmd-options/raw) -**--reset-points** -Only show auto-reset points. +- [--reset-points](/cmd-options/reset-points) -**--run-id** -Alias: **-r** -Run Id +- [--run-id](/cmd-options/run-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--workflow-id** -Alias: **-w** -Workflow Id +- [--workflow-id](/cmd-options/workflow-id) diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md index a795d5ea..49057d81 100644 --- a/docs/workflow/execute.md +++ b/docs/workflow/execute.md @@ -19,23 +19,17 @@ Make sure to write the command in this format: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--cron** -Optional Cron Schedule for the Workflow. Cron spec is formatted as: +- [--cron](/cmd-options/cron) ┌───────────── minute (0 - 59) │ ┌───────────── hour (0 - 23) │ │ ┌───────────── day of the month (1 - 31) @@ -44,94 +38,61 @@ Optional Cron Schedule for the Workflow. Cron spec is formatted as: │ │ │ │ │ * * * * * -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--execution-timeout** -Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) +- [--execution-timeout](/cmd-options/execution-timeout) -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. +- [--fields](/cmd-options/fields) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--id-reuse-policy** -Allows the same Workflow Id to be used in a new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. +- [--id-reuse-policy](/cmd-options/id-reuse-policy) -**--input** -Alias: **-i** -Optional JSON input to provide to the Workflow. +- [--input](/cmd-options/input) Pass "null" for null values. -**--input-file** -Passes optional input for the Workflow from a JSON file. +- [--input-file](/cmd-options/input-file) If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line will overwrite file input. -**--limit** -Number of items to print. (default: 0) +- [--limit](/cmd-options/limit) -**--max-field-length** -Maximum length for each attribute field. (default: 0) +- [--max-field-length](/cmd-options/max-field-length) -**--memo** -Passes a memo in key=value format. Use valid JSON formats for value. +- [--memo](/cmd-options/memo) -**--memo-file** -Passes a memo as file input, with each line following key=value format. Use valid JSON formats for value. +- [--memo-file](/cmd-options/memo-file) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--no-pager** -Alias: **-P** -Disables the interactive pager. +- [--no-pager](/cmd-options/no-pager) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--pager** -Sets the pager for Temporal CLI to use. +- [--pager](/cmd-options/pager) Options: less, more, favoritePager. -**--run-timeout** -Timeout (in seconds) of a single Workflow run. (default: 0) +- [--run-timeout](/cmd-options/run-timeout) -**--search-attribute** -Passes Search Attribute in key=value format. Use valid JSON formats for value. +- [--search-attribute](/cmd-options/search-attribute) -**--task-queue** -Alias: **-t** -Task Queue +- [--task-queue](/cmd-options/task-queue) -**--task-timeout** -Start-to-close timeout for a Workflow Task (in seconds). (default: 10) +- [--task-timeout](/cmd-options/task-timeout) -**--time-format** -Format time as: relative, iso, raw. (default: relative) +- [--time-format](/cmd-options/time-format) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--type** -Workflow type name. +- [--type](/cmd-options/type) -**--workflow-id** -Alias: **-w** -Workflow Id +- [--workflow-id](/cmd-options/workflow-id) diff --git a/docs/workflow/list.md b/docs/workflow/list.md index 66e5c8c9..1c098869 100644 --- a/docs/workflow/list.md +++ b/docs/workflow/list.md @@ -17,72 +17,47 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--archived** -List archived Workflow Executions. +- [--archived](/cmd-options/archived) Currently an experimental feature. -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. +- [--fields](/cmd-options/fields) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--limit** -Number of items to print. (default: 0) +- [--limit](/cmd-options/limit) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--no-pager** -Alias: **-P** -Disables the interactive pager. +- [--no-pager](/cmd-options/no-pager) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--pager** -Sets the pager for Temporal CLI to use. +- [--pager](/cmd-options/pager) Options: less, more, favoritePager. -**--query** -Alias: **-q** -Filter results using an SQL-like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for more information. +- [--query](/cmd-options/query) -**--time-format** -Format time as: relative, iso, raw. (default: relative) +- [--time-format](/cmd-options/time-format) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) diff --git a/docs/workflow/query.md b/docs/workflow/query.md index 6d214ee6..6d301146 100644 --- a/docs/workflow/query.md +++ b/docs/workflow/query.md @@ -19,66 +19,43 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--input** -Alias: **-i** -Optional query input, in JSON format. For multiple parameters, concatenate them and separate by space. +- [--input](/cmd-options/input) -**--input-file** -Passes optional Query input from a JSON file. +- [--input-file](/cmd-options/input-file) If there are multiple JSON, concatenate them and separate by space or newline. Input from the command line will overwrite file input. -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--reject-condition** -Optional flag for rejecting Queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly". +- [--reject-condition](/cmd-options/reject-condition) -**--run-id** -Alias: **-r** -Run Id +- [--run-id](/cmd-options/run-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--type** -The query type you want to run. +- [--type](/cmd-options/type) -**--workflow-id** -Alias: **-w** -Workflow Id +- [--workflow-id](/cmd-options/workflow-id) diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index b35f726c..85a6f48b 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -2,7 +2,7 @@ id: reset-batch title: temporal workflow reset-batch sidebar_label: reset-batch -description: Reset a batch of Workflow Executions by reset type: LastContinuedAsNew, FirstWorkflowTask, LastWorkflowTask +description: Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew tags: - cli --- @@ -17,77 +17,51 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--dry-run** -Simulate reset without resetting any Workflow Executions. +- [--dry-run](/cmd-options/dry-run) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--exclude-file** -Input file that specifies Workflow Executions to exclude from resetting. +- [--exclude-file](/cmd-options/exclude-file) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--input-file** -Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id. +- [--input-file](/cmd-options/input-file) -**--input-parallelism** -Number of goroutines to run in parallel. Each goroutine processes one line for every second. (default: 1) +- [--input-parallelism](/cmd-options/input-parallelism) -**--input-separator** -Separator for the input file. The default is a tab ( ). (default: ) +- [--input-separator](/cmd-options/input-separator) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--non-deterministic** -Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error. +- [--non-deterministic](/cmd-options/non-deterministic) -**--query** -Alias: **-q** -Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query. +- [--query](/cmd-options/query) -**--reason** -Reason for resetting the Workflow Executions. +- [--reason](/cmd-options/reason) -**--skip-base-is-not-current** -Skip a Workflow Execution if the base Run is not the current Run. +- [--skip-base-is-not-current](/cmd-options/skip-base-is-not-current) -**--skip-current-open** -Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run. +- [--skip-current-open](/cmd-options/skip-current-open) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +- [--type](/cmd-options/type) diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md index 37cc3f6e..280eb2f3 100644 --- a/docs/workflow/reset.md +++ b/docs/workflow/reset.md @@ -17,63 +17,41 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--event-id** -The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others. +- [--event-id](/cmd-options/event-id) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--reapply-type** -Event types to reapply after the reset point: Signal, None, . (default: All) +- [--reapply-type](/cmd-options/reapply-type) -**--reason** -Reason to reset. +- [--reason](/cmd-options/reason) -**--run-id** -Alias: **-r** -Run Id +- [--run-id](/cmd-options/run-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--type** -Event type to which you want to reset: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +- [--type](/cmd-options/type) -**--workflow-id** -Alias: **-w** -Workflow Id +- [--workflow-id](/cmd-options/workflow-id) diff --git a/docs/workflow/show.md b/docs/workflow/show.md index 4b1862fb..57bddda9 100644 --- a/docs/workflow/show.md +++ b/docs/workflow/show.md @@ -16,85 +16,54 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. +- [--fields](/cmd-options/fields) -**--follow** -Alias: **-f** -Follow the progress of a Workflow Execution. +- [--follow](/cmd-options/follow) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--limit** -Number of items to print. (default: 0) +- [--limit](/cmd-options/limit) -**--max-field-length** -Maximum length for each attribute field. (default: 500) +- [--max-field-length](/cmd-options/max-field-length) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--no-pager** -Alias: **-P** -Disables the interactive pager. +- [--no-pager](/cmd-options/no-pager) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--output-filename** -Serializes Event History to a file. +- [--output-filename](/cmd-options/output-filename) -**--pager** -Sets the pager for Temporal CLI to use. +- [--pager](/cmd-options/pager) Options: less, more, favoritePager. -**--reset-points** -Only show Workflow Events that are eligible for reset. +- [--reset-points](/cmd-options/reset-points) -**--run-id** -Alias: **-r** -Run Id +- [--run-id](/cmd-options/run-id) -**--time-format** -Format time as: relative, iso, raw. (default: relative) +- [--time-format](/cmd-options/time-format) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--workflow-id** -Alias: **-w** -Workflow Id +- [--workflow-id](/cmd-options/workflow-id) diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md index 9d9afce6..97ac3651 100644 --- a/docs/workflow/signal.md +++ b/docs/workflow/signal.md @@ -16,72 +16,45 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--input** -Alias: **-i** -Input for the signal (JSON). +- [--input](/cmd-options/input) -**--input-file** -Input for the signal from file (JSON). +- [--input-file](/cmd-options/input-file) -**--name** -Signal Name +- [--name](/cmd-options/name) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--query** -Alias: **-q** -Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/. +- [--query](/cmd-options/query) -**--reason** -Reason for signaling with List Filter. +- [--reason](/cmd-options/reason) -**--run-id** -Alias: **-r** -Run Id +- [--run-id](/cmd-options/run-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--workflow-id** -Alias: **-w** -Signal Workflow Execution by Id. +- [--workflow-id](/cmd-options/workflow-id) -**--yes** -Alias: **-y** -Confirm all prompts. +- [--yes](/cmd-options/yes) diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md index 925a7fb5..09a761f7 100644 --- a/docs/workflow/stack.md +++ b/docs/workflow/stack.md @@ -17,63 +17,41 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--input** -Alias: **-i** -Optional query input, in JSON format. For multiple parameters, concatenate them and separate by space. +- [--input](/cmd-options/input) -**--input-file** -Passes optional Query input from a JSON file. +- [--input-file](/cmd-options/input-file) If there are multiple JSON, concatenate them and separate by space or newline. Input from the command line will overwrite file input. -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--reject-condition** -Optional flag for rejecting Queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly". +- [--reject-condition](/cmd-options/reject-condition) -**--run-id** -Alias: **-r** -Run Id +- [--run-id](/cmd-options/run-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--workflow-id** -Alias: **-w** -Workflow Id +- [--workflow-id](/cmd-options/workflow-id) diff --git a/docs/workflow/start.md b/docs/workflow/start.md index b4a39f1a..9e424ec0 100644 --- a/docs/workflow/start.md +++ b/docs/workflow/start.md @@ -17,23 +17,17 @@ Make sure to write the command in this format: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--cron** -Optional Cron Schedule for the Workflow. Cron spec is formatted as: +- [--cron](/cmd-options/cron) ┌───────────── minute (0 - 59) │ ┌───────────── hour (0 - 23) │ │ ┌───────────── day of the month (1 - 31) @@ -42,94 +36,61 @@ Optional Cron Schedule for the Workflow. Cron spec is formatted as: │ │ │ │ │ * * * * * -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--execution-timeout** -Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) +- [--execution-timeout](/cmd-options/execution-timeout) -**--fields** -Customize fields to print. Set to 'long' to automatically print more of main fields. +- [--fields](/cmd-options/fields) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--id-reuse-policy** -Allows the same Workflow Id to be used in a new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. +- [--id-reuse-policy](/cmd-options/id-reuse-policy) -**--input** -Alias: **-i** -Optional JSON input to provide to the Workflow. +- [--input](/cmd-options/input) Pass "null" for null values. -**--input-file** -Passes optional input for the Workflow from a JSON file. +- [--input-file](/cmd-options/input-file) If there are multiple JSON files, concatenate them and separate by space or newline. Input from the command line will overwrite file input. -**--limit** -Number of items to print. (default: 0) +- [--limit](/cmd-options/limit) -**--max-field-length** -Maximum length for each attribute field. (default: 0) +- [--max-field-length](/cmd-options/max-field-length) -**--memo** -Passes a memo in key=value format. Use valid JSON formats for value. +- [--memo](/cmd-options/memo) -**--memo-file** -Passes a memo as file input, with each line following key=value format. Use valid JSON formats for value. +- [--memo-file](/cmd-options/memo-file) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--no-pager** -Alias: **-P** -Disables the interactive pager. +- [--no-pager](/cmd-options/no-pager) -**--output** -Alias: **-o** -format output as: table, json, card. (default: table) +- [--output](/cmd-options/output) -**--pager** -Sets the pager for Temporal CLI to use. +- [--pager](/cmd-options/pager) Options: less, more, favoritePager. -**--run-timeout** -Timeout (in seconds) of a single Workflow run. (default: 0) +- [--run-timeout](/cmd-options/run-timeout) -**--search-attribute** -Passes Search Attribute in key=value format. Use valid JSON formats for value. +- [--search-attribute](/cmd-options/search-attribute) -**--task-queue** -Alias: **-t** -Task Queue +- [--task-queue](/cmd-options/task-queue) -**--task-timeout** -Start-to-close timeout for a Workflow Task (in seconds). (default: 10) +- [--task-timeout](/cmd-options/task-timeout) -**--time-format** -Format time as: relative, iso, raw. (default: relative) +- [--time-format](/cmd-options/time-format) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--type** -Workflow type name. +- [--type](/cmd-options/type) -**--workflow-id** -Alias: **-w** -Workflow Id +- [--workflow-id](/cmd-options/workflow-id) diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md index 4bfd3657..debc497a 100644 --- a/docs/workflow/terminate.md +++ b/docs/workflow/terminate.md @@ -19,62 +19,39 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--query** -Alias: **-q** -Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/. +- [--query](/cmd-options/query) -**--reason** -Reason for termination. +- [--reason](/cmd-options/reason) -**--run-id** -Alias: **-r** -Run Id +- [--run-id](/cmd-options/run-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--workflow-id** -Alias: **-w** -Terminate Workflow Execution by Id. +- [--workflow-id](/cmd-options/workflow-id) -**--yes** -Alias: **-y** -Confirm all prompts. +- [--yes](/cmd-options/yes) diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md index b8432006..ec74cb04 100644 --- a/docs/workflow/trace.md +++ b/docs/workflow/trace.md @@ -16,63 +16,41 @@ Make sure to write the command as follows: ## OPTIONS -**--address** -The host and port (formatted as host:port) for the Temporal Frontend Service. +- [--address](/cmd-options/address) -**--codec-auth** -Sets the authorization header on requests to the Codec Server. +- [--codec-auth](/cmd-options/codec-auth) -**--codec-endpoint** -Endpoint for a remote Codec Server. +- [--codec-endpoint](/cmd-options/codec-endpoint) -**--color** -when to use color: auto, always, never. (default: auto) +- [--color](/cmd-options/color) -**--concurrency** -Request concurrency (default: 10) +- [--concurrency](/cmd-options/concurrency) -**--context-timeout** -An optional timeout for the context of an RPC call (in seconds). (default: 5) +- [--context-timeout](/cmd-options/context-timeout) -**--depth** -Number of Child Workflows to expand, -1 to expand all Child Workflows. (default: -1) +- [--depth](/cmd-options/depth) -**--env** -Name of the environment to read environmental variables from. (default: default) +- [--env](/cmd-options/env) -**--fold** -Statuses for which Child Workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied. (default: completed,canceled,terminated) +- [--fold](/cmd-options/fold) -**--grpc-meta** -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +- [--grpc-meta](/cmd-options/grpc-meta) -**--namespace** -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) +- [--namespace](/cmd-options/namespace) -**--no-fold** -Disable folding. All Child Workflows within the set depth will be fetched and displayed. +- [--no-fold](/cmd-options/no-fold) -**--run-id** -Alias: **-r** -Run Id +- [--run-id](/cmd-options/run-id) -**--tls-ca-path** -Path to server CA certificate. +- [--tls-ca-path](/cmd-options/tls-ca-path) -**--tls-cert-path** -Path to x509 certificate. +- [--tls-cert-path](/cmd-options/tls-cert-path) -**--tls-disable-host-verification** -Disables TLS host name verification if already enabled. +- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) -**--tls-key-path** -Path to private certificate key. +- [--tls-key-path](/cmd-options/tls-key-path) -**--tls-server-name** -Provides an override for the target TLS server name. +- [--tls-server-name](/cmd-options/tls-server-name) -**--workflow-id** -Alias: **-w** -Workflow Id +- [--workflow-id](/cmd-options/workflow-id) From 16f583325bf3c945a86e8fdc0bbac5812f4a96b7 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 26 Jan 2023 13:22:19 -0600 Subject: [PATCH 58/68] more spacing issues --- cmd/doc/main.go | 26 ++++++++----------- docs/cmd-options/active-cluster.md | 3 ++- docs/cmd-options/activity-id.md | 3 ++- docs/cmd-options/address.md | 3 ++- docs/cmd-options/archived.md | 3 ++- docs/cmd-options/calendar.md | 3 ++- docs/cmd-options/catchup-window.md | 3 ++- docs/cmd-options/cluster.md | 3 ++- docs/cmd-options/codec-auth.md | 3 ++- docs/cmd-options/codec-endpoint.md | 3 ++- docs/cmd-options/color.md | 3 ++- docs/cmd-options/concurrency.md | 3 ++- docs/cmd-options/config.md | 4 +-- docs/cmd-options/context-timeout.md | 3 ++- docs/cmd-options/cron.md | 3 ++- docs/cmd-options/data.md | 3 ++- docs/cmd-options/db-filename.md | 4 +-- docs/cmd-options/depth.md | 3 ++- docs/cmd-options/description.md | 3 ++- docs/cmd-options/detail.md | 3 ++- docs/cmd-options/dry-run.md | 3 ++- docs/cmd-options/dynamic-config-value.md | 3 ++- docs/cmd-options/email.md | 3 ++- docs/cmd-options/enable-connection.md | 3 ++- docs/cmd-options/end-time.md | 3 ++- docs/cmd-options/env.md | 3 ++- docs/cmd-options/event-id.md | 3 ++- docs/cmd-options/exclude-file.md | 3 ++- docs/cmd-options/execution-timeout.md | 3 ++- docs/cmd-options/fields.md | 3 ++- docs/cmd-options/fold.md | 3 ++- docs/cmd-options/follow.md | 2 +- docs/cmd-options/frontend-address.md | 3 ++- docs/cmd-options/global.md | 3 ++- docs/cmd-options/grpc-meta.md | 3 ++- docs/cmd-options/headless.md | 3 ++- docs/cmd-options/history-archival-state.md | 3 ++- docs/cmd-options/history-uri.md | 3 ++- docs/cmd-options/id-reuse-policy.md | 3 ++- docs/cmd-options/identity.md | 3 ++- docs/cmd-options/input-file.md | 3 ++- docs/cmd-options/input-parallelism.md | 3 ++- docs/cmd-options/input-separator.md | 3 ++- docs/cmd-options/input.md | 4 +-- docs/cmd-options/interval.md | 3 ++- docs/cmd-options/ip.md | 3 ++- docs/cmd-options/jitter.md | 3 ++- docs/cmd-options/job-id.md | 3 ++- docs/cmd-options/limit.md | 3 ++- docs/cmd-options/log-format.md | 3 ++- docs/cmd-options/log-level.md | 3 ++- docs/cmd-options/max-field-length.md | 3 ++- docs/cmd-options/memo-file.md | 3 ++- docs/cmd-options/memo.md | 3 ++- docs/cmd-options/metrics-port.md | 3 ++- docs/cmd-options/name.md | 3 ++- docs/cmd-options/namespace-id.md | 3 ++- docs/cmd-options/namespace.md | 4 +-- docs/cmd-options/no-fold.md | 3 ++- docs/cmd-options/no-pager.md | 2 +- docs/cmd-options/non-deterministic.md | 3 ++- docs/cmd-options/notes.md | 3 ++- docs/cmd-options/output-filename.md | 3 ++- docs/cmd-options/output.md | 4 +-- docs/cmd-options/overlap-policy.md | 3 ++- docs/cmd-options/pager.md | 3 ++- docs/cmd-options/pause-on-failure.md | 3 ++- docs/cmd-options/pause.md | 3 ++- docs/cmd-options/port.md | 4 +-- docs/cmd-options/promote-global.md | 3 ++- docs/cmd-options/query.md | 4 +-- docs/cmd-options/raw.md | 3 ++- docs/cmd-options/reapply-type.md | 3 ++- docs/cmd-options/reason.md | 3 ++- docs/cmd-options/reject-condition.md | 3 ++- docs/cmd-options/remaining-actions.md | 3 ++- docs/cmd-options/reset-points.md | 3 ++- docs/cmd-options/result.md | 3 ++- docs/cmd-options/retention.md | 3 ++- docs/cmd-options/run-id.md | 4 +-- docs/cmd-options/run-timeout.md | 3 ++- docs/cmd-options/schedule-id.md | 4 +-- docs/cmd-options/search-attribute.md | 3 ++- docs/cmd-options/skip-base-is-not-current.md | 3 ++- docs/cmd-options/skip-current-open.md | 3 ++- docs/cmd-options/sqlite-pragma.md | 3 ++- docs/cmd-options/start-time.md | 3 ++- docs/cmd-options/task-queue-type.md | 3 ++- docs/cmd-options/task-queue.md | 4 +-- docs/cmd-options/task-timeout.md | 3 ++- docs/cmd-options/time-format.md | 3 ++- docs/cmd-options/time-zone.md | 3 ++- docs/cmd-options/tls-ca-path.md | 3 ++- docs/cmd-options/tls-cert-path.md | 3 ++- .../tls-disable-host-verification.md | 3 ++- docs/cmd-options/tls-key-path.md | 3 ++- docs/cmd-options/tls-server-name.md | 3 ++- docs/cmd-options/type.md | 3 ++- docs/cmd-options/ui-asset-path.md | 3 ++- docs/cmd-options/ui-codec-endpoint.md | 3 ++- docs/cmd-options/ui-ip.md | 3 ++- docs/cmd-options/ui-port.md | 3 ++- docs/cmd-options/unpause.md | 3 ++- docs/cmd-options/visibility-archival-state.md | 3 ++- docs/cmd-options/visibility-uri.md | 3 ++- docs/cmd-options/workflow-id.md | 4 +-- docs/cmd-options/workflow-type.md | 3 ++- docs/cmd-options/yes.md | 2 +- docs/workflow/reset-batch.md | 2 +- 109 files changed, 223 insertions(+), 134 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index b6062895..10388758 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -38,7 +38,7 @@ type FMStruct struct { IsIndex bool } -var currentHeader, fileName, optionFileName, operatorFileName, path, optionFilePath, headerIndexFile string +var currentHeader, fileName, optionFileName, operatorFileName, path, optionFilePath, headerIndexFile, aliasName string var currentHeaderFile, currentOptionFile *os.File // `BuildApp` takes a string and returns a `*App` and an error @@ -91,13 +91,12 @@ func main() { term, definition, found := strings.Cut(line, ":") term = strings.TrimSuffix(term, "=\"\"") if strings.Contains(term, ",") { - makeAlias(currentHeaderFile, term) + termArray := strings.Split(line, ",") + optionFileName = termArray[0] + "**" + aliasName = "Alias: **" + strings.TrimSpace(termArray[1]) } else { - //TODO: change for docusaurus optionFileName = term } - //TODO: change for docusaurus - //writeLine(currentHeaderFile, strings.TrimSpace(definition)) log.Info("string split successfully into term and definition (%v)",found) optionFileName = strings.TrimPrefix(optionFileName, "**--") @@ -105,8 +104,14 @@ func main() { optionFilePath = filepath.Join(docsPath, optionsPath, optionFileName+".md") + termLink := "- [--" + optionFileName + "](/cmd-options/" + optionFileName + ")" makeFile(optionFilePath, false, true, scanner, createdFiles) - writeLine(currentOptionFile, definition) + writeLine(currentHeaderFile, termLink) + if (aliasName != "") { + aliasArray := strings.Split(aliasName, "=") + writeLine(currentOptionFile, aliasArray[0]) + } + writeLine(currentOptionFile, strings.TrimSpace(definition)) } else if strings.Contains(line, ">") { writeLine(currentHeaderFile, strings.Trim(line, ">")) @@ -170,15 +175,6 @@ func writeLine(file *os.File, line string) { } } -// separates aliases from terms -func makeAlias(file *os.File, line string) { - - termArray := strings.Split(line, ",") - writeLine(file, termArray[0] + "**") - writeLine(file, "Alias: **" + strings.TrimSpace(termArray[1])) - optionFileName = termArray[0] -} - // write front matter func writeFrontMatter(idName string, titleName string, scanner *bufio.Scanner, isIndex bool, currentHeaderFile *os.File) { var descriptionTxt string diff --git a/docs/cmd-options/active-cluster.md b/docs/cmd-options/active-cluster.md index 251175bc..10a1a5f3 100644 --- a/docs/cmd-options/active-cluster.md +++ b/docs/cmd-options/active-cluster.md @@ -7,4 +7,5 @@ tags: - cli --- - Active cluster name +Alias: **-n** +Active cluster name diff --git a/docs/cmd-options/activity-id.md b/docs/cmd-options/activity-id.md index 0dbd3606..c6baeca7 100644 --- a/docs/cmd-options/activity-id.md +++ b/docs/cmd-options/activity-id.md @@ -7,4 +7,5 @@ tags: - cli --- - Identifies the Activity to fail. +Alias: **-w** +Identifies the Activity to fail. diff --git a/docs/cmd-options/address.md b/docs/cmd-options/address.md index 71b4309b..88d332f0 100644 --- a/docs/cmd-options/address.md +++ b/docs/cmd-options/address.md @@ -7,4 +7,5 @@ tags: - cli --- - The host and port (formatted as host:port) for the Temporal Frontend Service. +Alias: **-n** +The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/cmd-options/archived.md b/docs/cmd-options/archived.md index d21844a4..c16b5302 100644 --- a/docs/cmd-options/archived.md +++ b/docs/cmd-options/archived.md @@ -7,4 +7,5 @@ tags: - cli --- - List archived Workflow Executions. +Alias: **-w** +List archived Workflow Executions. diff --git a/docs/cmd-options/calendar.md b/docs/cmd-options/calendar.md index ff83e2e2..00cbd73a 100644 --- a/docs/cmd-options/calendar.md +++ b/docs/cmd-options/calendar.md @@ -7,4 +7,5 @@ tags: - cli --- - Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} +Alias: **-w** +Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} diff --git a/docs/cmd-options/catchup-window.md b/docs/cmd-options/catchup-window.md index 43e75880..fdb15d5e 100644 --- a/docs/cmd-options/catchup-window.md +++ b/docs/cmd-options/catchup-window.md @@ -7,4 +7,5 @@ tags: - cli --- - Maximum allowed catch-up time if server is down. +Alias: **-w** +Maximum allowed catch-up time if server is down. diff --git a/docs/cmd-options/cluster.md b/docs/cmd-options/cluster.md index 1a15fb4e..67be0b95 100644 --- a/docs/cmd-options/cluster.md +++ b/docs/cmd-options/cluster.md @@ -7,4 +7,5 @@ tags: - cli --- - Cluster name +Alias: **-n** +Cluster name diff --git a/docs/cmd-options/codec-auth.md b/docs/cmd-options/codec-auth.md index d4e4bea0..76ae2c98 100644 --- a/docs/cmd-options/codec-auth.md +++ b/docs/cmd-options/codec-auth.md @@ -7,4 +7,5 @@ tags: - cli --- - Sets the authorization header on requests to the Codec Server. +Alias: **-n** +Sets the authorization header on requests to the Codec Server. diff --git a/docs/cmd-options/codec-endpoint.md b/docs/cmd-options/codec-endpoint.md index 8619f9e2..180a26df 100644 --- a/docs/cmd-options/codec-endpoint.md +++ b/docs/cmd-options/codec-endpoint.md @@ -7,4 +7,5 @@ tags: - cli --- - Endpoint for a remote Codec Server. +Alias: **-n** +Endpoint for a remote Codec Server. diff --git a/docs/cmd-options/color.md b/docs/cmd-options/color.md index 73e19cdb..85d58c68 100644 --- a/docs/cmd-options/color.md +++ b/docs/cmd-options/color.md @@ -7,4 +7,5 @@ tags: - cli --- - when to use color: auto, always, never. (default: auto) +Alias: **-n** +when to use color: auto, always, never. (default: auto) diff --git a/docs/cmd-options/concurrency.md b/docs/cmd-options/concurrency.md index 58c8129b..9b09af0e 100644 --- a/docs/cmd-options/concurrency.md +++ b/docs/cmd-options/concurrency.md @@ -7,4 +7,5 @@ tags: - cli --- - Request concurrency (default: 10) +Alias: **-q** +Request concurrency (default: 10) diff --git a/docs/cmd-options/config.md b/docs/cmd-options/config.md index 0217e423..7ed04290 100644 --- a/docs/cmd-options/config.md +++ b/docs/cmd-options/config.md @@ -7,5 +7,5 @@ tags: - cli --- -Alias: **-c**="": Path to config directory. - Path to config directory. +Alias: **-c** +Path to config directory. diff --git a/docs/cmd-options/context-timeout.md b/docs/cmd-options/context-timeout.md index 6130118e..e5fdfd8a 100644 --- a/docs/cmd-options/context-timeout.md +++ b/docs/cmd-options/context-timeout.md @@ -7,4 +7,5 @@ tags: - cli --- - An optional timeout for the context of an RPC call (in seconds). (default: 5) +Alias: **-n** +An optional timeout for the context of an RPC call (in seconds). (default: 5) diff --git a/docs/cmd-options/cron.md b/docs/cmd-options/cron.md index b9397bca..c64a33d6 100644 --- a/docs/cmd-options/cron.md +++ b/docs/cmd-options/cron.md @@ -7,4 +7,5 @@ tags: - cli --- - Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily". +Alias: **-w** +Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily". diff --git a/docs/cmd-options/data.md b/docs/cmd-options/data.md index e0cfc7d9..cd31dc01 100644 --- a/docs/cmd-options/data.md +++ b/docs/cmd-options/data.md @@ -7,4 +7,5 @@ tags: - cli --- - Namespace data in a format key=value +Alias: **-n** +Namespace data in a format key=value diff --git a/docs/cmd-options/db-filename.md b/docs/cmd-options/db-filename.md index 948b063a..a0dfbe6b 100644 --- a/docs/cmd-options/db-filename.md +++ b/docs/cmd-options/db-filename.md @@ -7,5 +7,5 @@ tags: - cli --- -Alias: **-f**="": File in which to persist Temporal state (by default - File in which to persist Temporal state (by default, Workflows are lost when the process dies). +Alias: **-f** +File in which to persist Temporal state (by default, Workflows are lost when the process dies). diff --git a/docs/cmd-options/depth.md b/docs/cmd-options/depth.md index a54df4d0..303d8fff 100644 --- a/docs/cmd-options/depth.md +++ b/docs/cmd-options/depth.md @@ -7,4 +7,5 @@ tags: - cli --- - Number of Child Workflows to expand, -1 to expand all Child Workflows. (default: -1) +Alias: **-q** +Number of Child Workflows to expand, -1 to expand all Child Workflows. (default: -1) diff --git a/docs/cmd-options/description.md b/docs/cmd-options/description.md index 13011745..49197721 100644 --- a/docs/cmd-options/description.md +++ b/docs/cmd-options/description.md @@ -7,4 +7,5 @@ tags: - cli --- - Namespace description +Alias: **-n** +Namespace description diff --git a/docs/cmd-options/detail.md b/docs/cmd-options/detail.md index f1acab4c..a7bba621 100644 --- a/docs/cmd-options/detail.md +++ b/docs/cmd-options/detail.md @@ -7,4 +7,5 @@ tags: - cli --- - Detail to fail the Activity. +Alias: **-w** +Detail to fail the Activity. diff --git a/docs/cmd-options/dry-run.md b/docs/cmd-options/dry-run.md index dcb360ca..d5584d11 100644 --- a/docs/cmd-options/dry-run.md +++ b/docs/cmd-options/dry-run.md @@ -7,4 +7,5 @@ tags: - cli --- - Simulate reset without resetting any Workflow Executions. +Alias: **-w** +Simulate reset without resetting any Workflow Executions. diff --git a/docs/cmd-options/dynamic-config-value.md b/docs/cmd-options/dynamic-config-value.md index 94ba2f01..746a2bac 100644 --- a/docs/cmd-options/dynamic-config-value.md +++ b/docs/cmd-options/dynamic-config-value.md @@ -7,4 +7,5 @@ tags: - cli --- - Dynamic config value, as KEY=JSON_VALUE (string values need quotes). +Alias: **-f** +Dynamic config value, as KEY=JSON_VALUE (string values need quotes). diff --git a/docs/cmd-options/email.md b/docs/cmd-options/email.md index 102e7014..cc1dc193 100644 --- a/docs/cmd-options/email.md +++ b/docs/cmd-options/email.md @@ -7,4 +7,5 @@ tags: - cli --- - Owner email +Alias: **-n** +Owner email diff --git a/docs/cmd-options/enable-connection.md b/docs/cmd-options/enable-connection.md index f5920ba9..80485c61 100644 --- a/docs/cmd-options/enable-connection.md +++ b/docs/cmd-options/enable-connection.md @@ -7,4 +7,5 @@ tags: - cli --- - Enable cross-cluster connection. +Alias: **-o** +Enable cross-cluster connection. diff --git a/docs/cmd-options/end-time.md b/docs/cmd-options/end-time.md index a6198058..5c250f09 100644 --- a/docs/cmd-options/end-time.md +++ b/docs/cmd-options/end-time.md @@ -7,4 +7,5 @@ tags: - cli --- - Backfill end time. +Alias: **-s** +Backfill end time. diff --git a/docs/cmd-options/env.md b/docs/cmd-options/env.md index 544fec42..8756fd0a 100644 --- a/docs/cmd-options/env.md +++ b/docs/cmd-options/env.md @@ -7,4 +7,5 @@ tags: - cli --- - Name of the environment to read environmental variables from. (default: default) +Alias: **-n** +Name of the environment to read environmental variables from. (default: default) diff --git a/docs/cmd-options/event-id.md b/docs/cmd-options/event-id.md index 86cca561..4e80ab3e 100644 --- a/docs/cmd-options/event-id.md +++ b/docs/cmd-options/event-id.md @@ -7,4 +7,5 @@ tags: - cli --- - The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others. +Alias: **-w** +The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others. diff --git a/docs/cmd-options/exclude-file.md b/docs/cmd-options/exclude-file.md index 188ebdd9..6f4392db 100644 --- a/docs/cmd-options/exclude-file.md +++ b/docs/cmd-options/exclude-file.md @@ -7,4 +7,5 @@ tags: - cli --- - Input file that specifies Workflow Executions to exclude from resetting. +Alias: **-w** +Input file that specifies Workflow Executions to exclude from resetting. diff --git a/docs/cmd-options/execution-timeout.md b/docs/cmd-options/execution-timeout.md index 3b17bb63..25e0616c 100644 --- a/docs/cmd-options/execution-timeout.md +++ b/docs/cmd-options/execution-timeout.md @@ -7,4 +7,5 @@ tags: - cli --- - Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) +Alias: **-w** +Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) diff --git a/docs/cmd-options/fields.md b/docs/cmd-options/fields.md index ca5a50e3..55e96aaf 100644 --- a/docs/cmd-options/fields.md +++ b/docs/cmd-options/fields.md @@ -7,4 +7,5 @@ tags: - cli --- - Customize fields to print. Set to 'long' to automatically print more of main fields. +Alias: **-n** +Customize fields to print. Set to 'long' to automatically print more of main fields. diff --git a/docs/cmd-options/fold.md b/docs/cmd-options/fold.md index 5125fabb..1328d2ee 100644 --- a/docs/cmd-options/fold.md +++ b/docs/cmd-options/fold.md @@ -7,4 +7,5 @@ tags: - cli --- - Statuses for which Child Workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied. (default: completed,canceled,terminated) +Alias: **-q** +Statuses for which Child Workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied. (default: completed,canceled,terminated) diff --git a/docs/cmd-options/follow.md b/docs/cmd-options/follow.md index 9e90039e..23c08de6 100644 --- a/docs/cmd-options/follow.md +++ b/docs/cmd-options/follow.md @@ -8,4 +8,4 @@ tags: --- Alias: **-f**: Follow the progress of a Workflow Execution. - Follow the progress of a Workflow Execution. +Follow the progress of a Workflow Execution. diff --git a/docs/cmd-options/frontend-address.md b/docs/cmd-options/frontend-address.md index 6a15973f..d9719a15 100644 --- a/docs/cmd-options/frontend-address.md +++ b/docs/cmd-options/frontend-address.md @@ -7,4 +7,5 @@ tags: - cli --- - Frontend address of the remote Cluster. +Alias: **-o** +Frontend address of the remote Cluster. diff --git a/docs/cmd-options/global.md b/docs/cmd-options/global.md index f0a21c19..44e56beb 100644 --- a/docs/cmd-options/global.md +++ b/docs/cmd-options/global.md @@ -7,4 +7,5 @@ tags: - cli --- - Flag to indicate whether namespace is a global namespace +Alias: **-n** +Flag to indicate whether namespace is a global namespace diff --git a/docs/cmd-options/grpc-meta.md b/docs/cmd-options/grpc-meta.md index 0454d6c3..7b846aa6 100644 --- a/docs/cmd-options/grpc-meta.md +++ b/docs/cmd-options/grpc-meta.md @@ -7,4 +7,5 @@ tags: - cli --- - Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. +Alias: **-n** +Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. diff --git a/docs/cmd-options/headless.md b/docs/cmd-options/headless.md index 33e3aa48..362b78dd 100644 --- a/docs/cmd-options/headless.md +++ b/docs/cmd-options/headless.md @@ -7,4 +7,5 @@ tags: - cli --- - Disable the Web UI. +Alias: **-f** +Disable the Web UI. diff --git a/docs/cmd-options/history-archival-state.md b/docs/cmd-options/history-archival-state.md index 7d27d9ff..6b4301b8 100644 --- a/docs/cmd-options/history-archival-state.md +++ b/docs/cmd-options/history-archival-state.md @@ -7,4 +7,5 @@ tags: - cli --- - Flag to set history archival state, valid values are "disabled" and "enabled" +Alias: **-n** +Flag to set history archival state, valid values are "disabled" and "enabled" diff --git a/docs/cmd-options/history-uri.md b/docs/cmd-options/history-uri.md index 1ba42565..ee0a871c 100644 --- a/docs/cmd-options/history-uri.md +++ b/docs/cmd-options/history-uri.md @@ -7,4 +7,5 @@ tags: - cli --- - Optionally specify history archival URI (cannot be changed after first time archival is enabled) +Alias: **-n** +Optionally specify history archival URI (cannot be changed after first time archival is enabled) diff --git a/docs/cmd-options/id-reuse-policy.md b/docs/cmd-options/id-reuse-policy.md index 0fff91e8..d6ffca3c 100644 --- a/docs/cmd-options/id-reuse-policy.md +++ b/docs/cmd-options/id-reuse-policy.md @@ -7,4 +7,5 @@ tags: - cli --- - Allows the same Workflow Id to be used in a new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. +Alias: **-w** +Allows the same Workflow Id to be used in a new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. diff --git a/docs/cmd-options/identity.md b/docs/cmd-options/identity.md index 62dfd63c..1cc135e4 100644 --- a/docs/cmd-options/identity.md +++ b/docs/cmd-options/identity.md @@ -7,4 +7,5 @@ tags: - cli --- - Specify the operator's identity. +Alias: **-w** +Specify the operator's identity. diff --git a/docs/cmd-options/input-file.md b/docs/cmd-options/input-file.md index 85233de5..6c78a2e8 100644 --- a/docs/cmd-options/input-file.md +++ b/docs/cmd-options/input-file.md @@ -7,4 +7,5 @@ tags: - cli --- - Passes optional input for the Workflow from a JSON file. +Alias: **-i** +Passes optional input for the Workflow from a JSON file. diff --git a/docs/cmd-options/input-parallelism.md b/docs/cmd-options/input-parallelism.md index 051116c3..1379bf58 100644 --- a/docs/cmd-options/input-parallelism.md +++ b/docs/cmd-options/input-parallelism.md @@ -7,4 +7,5 @@ tags: - cli --- - Number of goroutines to run in parallel. Each goroutine processes one line for every second. (default: 1) +Alias: **-w** +Number of goroutines to run in parallel. Each goroutine processes one line for every second. (default: 1) diff --git a/docs/cmd-options/input-separator.md b/docs/cmd-options/input-separator.md index e64f85d5..570db29c 100644 --- a/docs/cmd-options/input-separator.md +++ b/docs/cmd-options/input-separator.md @@ -7,4 +7,5 @@ tags: - cli --- - Separator for the input file. The default is a tab ( ). (default: ) +Alias: **-w** +Separator for the input file. The default is a tab ( ). (default: ) diff --git a/docs/cmd-options/input.md b/docs/cmd-options/input.md index fdbd3055..fc71e3c4 100644 --- a/docs/cmd-options/input.md +++ b/docs/cmd-options/input.md @@ -7,5 +7,5 @@ tags: - cli --- -Alias: **-i**="": Optional JSON input to provide to the Workflow. - Optional JSON input to provide to the Workflow. +Alias: **-i** +Optional JSON input to provide to the Workflow. diff --git a/docs/cmd-options/interval.md b/docs/cmd-options/interval.md index 1e0e1f26..9818224a 100644 --- a/docs/cmd-options/interval.md +++ b/docs/cmd-options/interval.md @@ -7,4 +7,5 @@ tags: - cli --- - Interval duration, e.g. 90m, or 90m/13m to include phase offset. +Alias: **-i** +Interval duration, e.g. 90m, or 90m/13m to include phase offset. diff --git a/docs/cmd-options/ip.md b/docs/cmd-options/ip.md index a934e780..f1261ef7 100644 --- a/docs/cmd-options/ip.md +++ b/docs/cmd-options/ip.md @@ -7,4 +7,5 @@ tags: - cli --- - IPv4 address to bind the frontend service to. (default: 127.0.0.1) +Alias: **-f** +IPv4 address to bind the frontend service to. (default: 127.0.0.1) diff --git a/docs/cmd-options/jitter.md b/docs/cmd-options/jitter.md index 71fd0feb..7444c081 100644 --- a/docs/cmd-options/jitter.md +++ b/docs/cmd-options/jitter.md @@ -7,4 +7,5 @@ tags: - cli --- - Jitter duration. +Alias: **-i** +Jitter duration. diff --git a/docs/cmd-options/job-id.md b/docs/cmd-options/job-id.md index afa41889..41d902e8 100644 --- a/docs/cmd-options/job-id.md +++ b/docs/cmd-options/job-id.md @@ -7,4 +7,5 @@ tags: - cli --- - Batch Job Id +Alias: **-o** +Batch Job Id diff --git a/docs/cmd-options/limit.md b/docs/cmd-options/limit.md index c82b5737..7aaccc55 100644 --- a/docs/cmd-options/limit.md +++ b/docs/cmd-options/limit.md @@ -7,4 +7,5 @@ tags: - cli --- - Number of items to print. (default: 0) +Alias: **-n** +Number of items to print. (default: 0) diff --git a/docs/cmd-options/log-format.md b/docs/cmd-options/log-format.md index fc01afb2..db025310 100644 --- a/docs/cmd-options/log-format.md +++ b/docs/cmd-options/log-format.md @@ -7,4 +7,5 @@ tags: - cli --- - Set the log formatting. Options: ["json", "pretty"]. (default: json) +Alias: **-f** +Set the log formatting. Options: ["json", "pretty"]. (default: json) diff --git a/docs/cmd-options/log-level.md b/docs/cmd-options/log-level.md index a82db6e1..55eca0dc 100644 --- a/docs/cmd-options/log-level.md +++ b/docs/cmd-options/log-level.md @@ -7,4 +7,5 @@ tags: - cli --- - Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) +Alias: **-f** +Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) diff --git a/docs/cmd-options/max-field-length.md b/docs/cmd-options/max-field-length.md index 403a21cd..c835b65a 100644 --- a/docs/cmd-options/max-field-length.md +++ b/docs/cmd-options/max-field-length.md @@ -7,4 +7,5 @@ tags: - cli --- - Maximum length for each attribute field. (default: 0) +Alias: **-i** +Maximum length for each attribute field. (default: 0) diff --git a/docs/cmd-options/memo-file.md b/docs/cmd-options/memo-file.md index 7454f799..66a1b1f8 100644 --- a/docs/cmd-options/memo-file.md +++ b/docs/cmd-options/memo-file.md @@ -7,4 +7,5 @@ tags: - cli --- - Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value. +Alias: **-i** +Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value. diff --git a/docs/cmd-options/memo.md b/docs/cmd-options/memo.md index bd4f3201..c188e6de 100644 --- a/docs/cmd-options/memo.md +++ b/docs/cmd-options/memo.md @@ -7,4 +7,5 @@ tags: - cli --- - Set a memo on a schedule. Format: key=value. Use valid JSON formats for value. +Alias: **-i** +Set a memo on a schedule. Format: key=value. Use valid JSON formats for value. diff --git a/docs/cmd-options/metrics-port.md b/docs/cmd-options/metrics-port.md index a0dc08a8..070896b8 100644 --- a/docs/cmd-options/metrics-port.md +++ b/docs/cmd-options/metrics-port.md @@ -7,4 +7,5 @@ tags: - cli --- - Port for /metrics (default: 0) +Alias: **-f** +Port for /metrics (default: 0) diff --git a/docs/cmd-options/name.md b/docs/cmd-options/name.md index b1b6d4f0..1e579b76 100644 --- a/docs/cmd-options/name.md +++ b/docs/cmd-options/name.md @@ -7,4 +7,5 @@ tags: - cli --- - Frontend address of the remote Cluster. +Alias: **-o** +Frontend address of the remote Cluster. diff --git a/docs/cmd-options/namespace-id.md b/docs/cmd-options/namespace-id.md index 0951644b..b795ea74 100644 --- a/docs/cmd-options/namespace-id.md +++ b/docs/cmd-options/namespace-id.md @@ -7,4 +7,5 @@ tags: - cli --- - Namespace Id +Alias: **-n** +Namespace Id diff --git a/docs/cmd-options/namespace.md b/docs/cmd-options/namespace.md index 8465ae85..84694b61 100644 --- a/docs/cmd-options/namespace.md +++ b/docs/cmd-options/namespace.md @@ -7,5 +7,5 @@ tags: - cli --- -Alias: **-n**="": Identifies a Namespace in the Temporal Workflow. (default: default) - Identifies a Namespace in the Temporal Workflow. (default: default) +Alias: **-n** +Identifies a Namespace in the Temporal Workflow. (default: default) diff --git a/docs/cmd-options/no-fold.md b/docs/cmd-options/no-fold.md index a3cdd790..8123ba65 100644 --- a/docs/cmd-options/no-fold.md +++ b/docs/cmd-options/no-fold.md @@ -7,4 +7,5 @@ tags: - cli --- - Disable folding. All Child Workflows within the set depth will be fetched and displayed. +Alias: **-n** +Disable folding. All Child Workflows within the set depth will be fetched and displayed. diff --git a/docs/cmd-options/no-pager.md b/docs/cmd-options/no-pager.md index c704ee55..f2786a65 100644 --- a/docs/cmd-options/no-pager.md +++ b/docs/cmd-options/no-pager.md @@ -8,4 +8,4 @@ tags: --- Alias: **-P**: Disables the interactive pager. - Disables the interactive pager. +Disables the interactive pager. diff --git a/docs/cmd-options/non-deterministic.md b/docs/cmd-options/non-deterministic.md index 8c189786..bc1ff99a 100644 --- a/docs/cmd-options/non-deterministic.md +++ b/docs/cmd-options/non-deterministic.md @@ -7,4 +7,5 @@ tags: - cli --- - Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error. +Alias: **-n** +Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error. diff --git a/docs/cmd-options/notes.md b/docs/cmd-options/notes.md index 973a38c2..b3431a5a 100644 --- a/docs/cmd-options/notes.md +++ b/docs/cmd-options/notes.md @@ -7,4 +7,5 @@ tags: - cli --- - Initial value of notes field. +Alias: **-n** +Initial value of notes field. diff --git a/docs/cmd-options/output-filename.md b/docs/cmd-options/output-filename.md index 24692f52..c41a1a6b 100644 --- a/docs/cmd-options/output-filename.md +++ b/docs/cmd-options/output-filename.md @@ -7,4 +7,5 @@ tags: - cli --- - Serializes Event History to a file. +Alias: **-o** +Serializes Event History to a file. diff --git a/docs/cmd-options/output.md b/docs/cmd-options/output.md index 4f30fcc6..2ea28045 100644 --- a/docs/cmd-options/output.md +++ b/docs/cmd-options/output.md @@ -7,5 +7,5 @@ tags: - cli --- -Alias: **-o**="": format output as: table - format output as: table, json, card. (default: table) +Alias: **-o** +format output as: table, json, card. (default: table) diff --git a/docs/cmd-options/overlap-policy.md b/docs/cmd-options/overlap-policy.md index e1a7440e..27871083 100644 --- a/docs/cmd-options/overlap-policy.md +++ b/docs/cmd-options/overlap-policy.md @@ -7,4 +7,5 @@ tags: - cli --- - Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. +Alias: **-n** +Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. diff --git a/docs/cmd-options/pager.md b/docs/cmd-options/pager.md index c5599e17..cbf40750 100644 --- a/docs/cmd-options/pager.md +++ b/docs/cmd-options/pager.md @@ -7,4 +7,5 @@ tags: - cli --- - Sets the pager for Temporal CLI to use. +Alias: **-o** +Sets the pager for Temporal CLI to use. diff --git a/docs/cmd-options/pause-on-failure.md b/docs/cmd-options/pause-on-failure.md index aeecca2e..514010a2 100644 --- a/docs/cmd-options/pause-on-failure.md +++ b/docs/cmd-options/pause-on-failure.md @@ -7,4 +7,5 @@ tags: - cli --- - Pause schedule after any workflow failure. +Alias: **-n** +Pause schedule after any workflow failure. diff --git a/docs/cmd-options/pause.md b/docs/cmd-options/pause.md index 3c94256c..049ba877 100644 --- a/docs/cmd-options/pause.md +++ b/docs/cmd-options/pause.md @@ -7,4 +7,5 @@ tags: - cli --- - Pauses the schedule. +Alias: **-n** +Pauses the schedule. diff --git a/docs/cmd-options/port.md b/docs/cmd-options/port.md index df4e365c..c6a3c14c 100644 --- a/docs/cmd-options/port.md +++ b/docs/cmd-options/port.md @@ -7,5 +7,5 @@ tags: - cli --- -Alias: **-p**="": Port for the frontend gRPC service. (default: 7233) - Port for the frontend gRPC service. (default: 7233) +Alias: **-p** +Port for the frontend gRPC service. (default: 7233) diff --git a/docs/cmd-options/promote-global.md b/docs/cmd-options/promote-global.md index 783406f5..77946427 100644 --- a/docs/cmd-options/promote-global.md +++ b/docs/cmd-options/promote-global.md @@ -7,4 +7,5 @@ tags: - cli --- - Promote local namespace to global namespace +Alias: **-n** +Promote local namespace to global namespace diff --git a/docs/cmd-options/query.md b/docs/cmd-options/query.md index 7fef7540..22ca4b56 100644 --- a/docs/cmd-options/query.md +++ b/docs/cmd-options/query.md @@ -7,5 +7,5 @@ tags: - cli --- -Alias: **-q**="": Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query. - Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query. +Alias: **-q** +Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query. diff --git a/docs/cmd-options/raw.md b/docs/cmd-options/raw.md index e4f154ca..3fd8b656 100644 --- a/docs/cmd-options/raw.md +++ b/docs/cmd-options/raw.md @@ -7,4 +7,5 @@ tags: - cli --- - Print raw data as json (prefer this over -o json for scripting). +Alias: **-o** +Print raw data as json (prefer this over -o json for scripting). diff --git a/docs/cmd-options/reapply-type.md b/docs/cmd-options/reapply-type.md index da69e12b..b74a2da4 100644 --- a/docs/cmd-options/reapply-type.md +++ b/docs/cmd-options/reapply-type.md @@ -7,4 +7,5 @@ tags: - cli --- - Event types to reapply after the reset point: , Signal, None. (default: All) +Alias: **-n** +Event types to reapply after the reset point: None, , Signal. (default: All) diff --git a/docs/cmd-options/reason.md b/docs/cmd-options/reason.md index c5e30ccb..27ffc7b4 100644 --- a/docs/cmd-options/reason.md +++ b/docs/cmd-options/reason.md @@ -7,4 +7,5 @@ tags: - cli --- - Reason for the operation +Alias: **-n** +Reason for the operation diff --git a/docs/cmd-options/reject-condition.md b/docs/cmd-options/reject-condition.md index 8e02c758..fb755e13 100644 --- a/docs/cmd-options/reject-condition.md +++ b/docs/cmd-options/reject-condition.md @@ -7,4 +7,5 @@ tags: - cli --- - Optional flag for rejecting Queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly". +Alias: **-n** +Optional flag for rejecting Queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly". diff --git a/docs/cmd-options/remaining-actions.md b/docs/cmd-options/remaining-actions.md index ec6694ff..4086550a 100644 --- a/docs/cmd-options/remaining-actions.md +++ b/docs/cmd-options/remaining-actions.md @@ -7,4 +7,5 @@ tags: - cli --- - Total number of actions allowed. (default: 0) +Alias: **-n** +Total number of actions allowed. (default: 0) diff --git a/docs/cmd-options/reset-points.md b/docs/cmd-options/reset-points.md index 0ae0c440..4a3eda63 100644 --- a/docs/cmd-options/reset-points.md +++ b/docs/cmd-options/reset-points.md @@ -7,4 +7,5 @@ tags: - cli --- - Only show Workflow Events that are eligible for reset. +Alias: **-o** +Only show Workflow Events that are eligible for reset. diff --git a/docs/cmd-options/result.md b/docs/cmd-options/result.md index c36cf649..e1b2da58 100644 --- a/docs/cmd-options/result.md +++ b/docs/cmd-options/result.md @@ -7,4 +7,5 @@ tags: - cli --- - Set the result value of Activity completion. +Alias: **-n** +Set the result value of Activity completion. diff --git a/docs/cmd-options/retention.md b/docs/cmd-options/retention.md index 49ef9b13..987faf5f 100644 --- a/docs/cmd-options/retention.md +++ b/docs/cmd-options/retention.md @@ -7,4 +7,5 @@ tags: - cli --- - Workflow Execution retention +Alias: **-n** +Workflow Execution retention diff --git a/docs/cmd-options/run-id.md b/docs/cmd-options/run-id.md index 41e07c1e..98c97fb4 100644 --- a/docs/cmd-options/run-id.md +++ b/docs/cmd-options/run-id.md @@ -7,5 +7,5 @@ tags: - cli --- -Alias: **-r**="": Identifies the current Workflow Run. - Identifies the current Workflow Run. +Alias: **-r** +Identifies the current Workflow Run. diff --git a/docs/cmd-options/run-timeout.md b/docs/cmd-options/run-timeout.md index 55ec2975..3d63a902 100644 --- a/docs/cmd-options/run-timeout.md +++ b/docs/cmd-options/run-timeout.md @@ -7,4 +7,5 @@ tags: - cli --- - Timeout (in seconds) of a single Workflow run. (default: 0) +Alias: **-n** +Timeout (in seconds) of a single Workflow run. (default: 0) diff --git a/docs/cmd-options/schedule-id.md b/docs/cmd-options/schedule-id.md index cbc20b7b..7b6612ca 100644 --- a/docs/cmd-options/schedule-id.md +++ b/docs/cmd-options/schedule-id.md @@ -7,5 +7,5 @@ tags: - cli --- -Alias: **-s**="": Schedule Id - Schedule Id +Alias: **-s** +Schedule Id diff --git a/docs/cmd-options/search-attribute.md b/docs/cmd-options/search-attribute.md index 3d811e65..07b1a72e 100644 --- a/docs/cmd-options/search-attribute.md +++ b/docs/cmd-options/search-attribute.md @@ -7,4 +7,5 @@ tags: - cli --- - Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value. +Alias: **-s** +Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value. diff --git a/docs/cmd-options/skip-base-is-not-current.md b/docs/cmd-options/skip-base-is-not-current.md index a816e379..b5ea0274 100644 --- a/docs/cmd-options/skip-base-is-not-current.md +++ b/docs/cmd-options/skip-base-is-not-current.md @@ -7,4 +7,5 @@ tags: - cli --- - Skip a Workflow Execution if the base Run is not the current Run. +Alias: **-q** +Skip a Workflow Execution if the base Run is not the current Run. diff --git a/docs/cmd-options/skip-current-open.md b/docs/cmd-options/skip-current-open.md index 5669ebea..d60c29f0 100644 --- a/docs/cmd-options/skip-current-open.md +++ b/docs/cmd-options/skip-current-open.md @@ -7,4 +7,5 @@ tags: - cli --- - Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run. +Alias: **-q** +Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run. diff --git a/docs/cmd-options/sqlite-pragma.md b/docs/cmd-options/sqlite-pragma.md index c737f17d..0bc979e7 100644 --- a/docs/cmd-options/sqlite-pragma.md +++ b/docs/cmd-options/sqlite-pragma.md @@ -7,4 +7,5 @@ tags: - cli --- - Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. +Alias: **-p** +Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. diff --git a/docs/cmd-options/start-time.md b/docs/cmd-options/start-time.md index edae81f8..aabf848c 100644 --- a/docs/cmd-options/start-time.md +++ b/docs/cmd-options/start-time.md @@ -7,4 +7,5 @@ tags: - cli --- - Backfill start time. +Alias: **-s** +Backfill start time. diff --git a/docs/cmd-options/task-queue-type.md b/docs/cmd-options/task-queue-type.md index 0d96dc12..c453da5c 100644 --- a/docs/cmd-options/task-queue-type.md +++ b/docs/cmd-options/task-queue-type.md @@ -7,4 +7,5 @@ tags: - cli --- - Task Queue type [workflow|activity] (default: workflow) +Alias: **-t** +Task Queue type [workflow|activity] (default: workflow) diff --git a/docs/cmd-options/task-queue.md b/docs/cmd-options/task-queue.md index a1bc97de..6361f00c 100644 --- a/docs/cmd-options/task-queue.md +++ b/docs/cmd-options/task-queue.md @@ -7,5 +7,5 @@ tags: - cli --- -Alias: **-t**="": Task Queue - Task Queue +Alias: **-t** +Task Queue diff --git a/docs/cmd-options/task-timeout.md b/docs/cmd-options/task-timeout.md index 292f2a0a..7dcd455f 100644 --- a/docs/cmd-options/task-timeout.md +++ b/docs/cmd-options/task-timeout.md @@ -7,4 +7,5 @@ tags: - cli --- - Start-to-close timeout for a Workflow Task (in seconds). (default: 10) +Alias: **-t** +Start-to-close timeout for a Workflow Task (in seconds). (default: 10) diff --git a/docs/cmd-options/time-format.md b/docs/cmd-options/time-format.md index c09ad107..ed8f4f03 100644 --- a/docs/cmd-options/time-format.md +++ b/docs/cmd-options/time-format.md @@ -7,4 +7,5 @@ tags: - cli --- - Format time as: relative, iso, raw. (default: relative) +Alias: **-o** +Format time as: relative, iso, raw. (default: relative) diff --git a/docs/cmd-options/time-zone.md b/docs/cmd-options/time-zone.md index f384a595..e615d34b 100644 --- a/docs/cmd-options/time-zone.md +++ b/docs/cmd-options/time-zone.md @@ -7,4 +7,5 @@ tags: - cli --- - Time zone (IANA name). +Alias: **-t** +Time zone (IANA name). diff --git a/docs/cmd-options/tls-ca-path.md b/docs/cmd-options/tls-ca-path.md index eeb24eb5..9b96b8b9 100644 --- a/docs/cmd-options/tls-ca-path.md +++ b/docs/cmd-options/tls-ca-path.md @@ -7,4 +7,5 @@ tags: - cli --- - Path to server CA certificate. +Alias: **-n** +Path to server CA certificate. diff --git a/docs/cmd-options/tls-cert-path.md b/docs/cmd-options/tls-cert-path.md index 6caa85a4..a0b3aaa0 100644 --- a/docs/cmd-options/tls-cert-path.md +++ b/docs/cmd-options/tls-cert-path.md @@ -7,4 +7,5 @@ tags: - cli --- - Path to x509 certificate. +Alias: **-n** +Path to x509 certificate. diff --git a/docs/cmd-options/tls-disable-host-verification.md b/docs/cmd-options/tls-disable-host-verification.md index 05f5b8e7..d1c2d923 100644 --- a/docs/cmd-options/tls-disable-host-verification.md +++ b/docs/cmd-options/tls-disable-host-verification.md @@ -7,4 +7,5 @@ tags: - cli --- - Disables TLS host name verification if already enabled. +Alias: **-n** +Disables TLS host name verification if already enabled. diff --git a/docs/cmd-options/tls-key-path.md b/docs/cmd-options/tls-key-path.md index 03c47caa..43634778 100644 --- a/docs/cmd-options/tls-key-path.md +++ b/docs/cmd-options/tls-key-path.md @@ -7,4 +7,5 @@ tags: - cli --- - Path to private certificate key. +Alias: **-n** +Path to private certificate key. diff --git a/docs/cmd-options/tls-server-name.md b/docs/cmd-options/tls-server-name.md index 68d24000..99188953 100644 --- a/docs/cmd-options/tls-server-name.md +++ b/docs/cmd-options/tls-server-name.md @@ -7,4 +7,5 @@ tags: - cli --- - Provides an override for the target TLS server name. +Alias: **-n** +Provides an override for the target TLS server name. diff --git a/docs/cmd-options/type.md b/docs/cmd-options/type.md index 5d9495f7..8e076e2a 100644 --- a/docs/cmd-options/type.md +++ b/docs/cmd-options/type.md @@ -7,4 +7,5 @@ tags: - cli --- - Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] +Alias: **-n** +Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] diff --git a/docs/cmd-options/ui-asset-path.md b/docs/cmd-options/ui-asset-path.md index e95368b8..91b0a76b 100644 --- a/docs/cmd-options/ui-asset-path.md +++ b/docs/cmd-options/ui-asset-path.md @@ -7,4 +7,5 @@ tags: - cli --- - UI Custom Assets path. +Alias: **-p** +UI Custom Assets path. diff --git a/docs/cmd-options/ui-codec-endpoint.md b/docs/cmd-options/ui-codec-endpoint.md index 97028e1c..07b24163 100644 --- a/docs/cmd-options/ui-codec-endpoint.md +++ b/docs/cmd-options/ui-codec-endpoint.md @@ -7,4 +7,5 @@ tags: - cli --- - UI Remote data converter HTTP endpoint. +Alias: **-p** +UI Remote data converter HTTP endpoint. diff --git a/docs/cmd-options/ui-ip.md b/docs/cmd-options/ui-ip.md index 88e16258..a5582390 100644 --- a/docs/cmd-options/ui-ip.md +++ b/docs/cmd-options/ui-ip.md @@ -7,4 +7,5 @@ tags: - cli --- - IPv4 address to bind the Web UI to. +Alias: **-p** +IPv4 address to bind the Web UI to. diff --git a/docs/cmd-options/ui-port.md b/docs/cmd-options/ui-port.md index 8f864ac1..169bbf7e 100644 --- a/docs/cmd-options/ui-port.md +++ b/docs/cmd-options/ui-port.md @@ -7,4 +7,5 @@ tags: - cli --- - Port for the Web UI. (default: 0) +Alias: **-p** +Port for the Web UI. (default: 0) diff --git a/docs/cmd-options/unpause.md b/docs/cmd-options/unpause.md index c2f0be58..9aa9ce39 100644 --- a/docs/cmd-options/unpause.md +++ b/docs/cmd-options/unpause.md @@ -7,4 +7,5 @@ tags: - cli --- - Unpauses the schedule. +Alias: **-s** +Unpauses the schedule. diff --git a/docs/cmd-options/visibility-archival-state.md b/docs/cmd-options/visibility-archival-state.md index c953c7d8..94a1474f 100644 --- a/docs/cmd-options/visibility-archival-state.md +++ b/docs/cmd-options/visibility-archival-state.md @@ -7,4 +7,5 @@ tags: - cli --- - Flag to set visibility archival state, valid values are "disabled" and "enabled" +Alias: **-n** +Flag to set visibility archival state, valid values are "disabled" and "enabled" diff --git a/docs/cmd-options/visibility-uri.md b/docs/cmd-options/visibility-uri.md index c5c72162..d0fcdc82 100644 --- a/docs/cmd-options/visibility-uri.md +++ b/docs/cmd-options/visibility-uri.md @@ -7,4 +7,5 @@ tags: - cli --- - Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) +Alias: **-n** +Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) diff --git a/docs/cmd-options/workflow-id.md b/docs/cmd-options/workflow-id.md index 65accdcb..6bec5098 100644 --- a/docs/cmd-options/workflow-id.md +++ b/docs/cmd-options/workflow-id.md @@ -7,5 +7,5 @@ tags: - cli --- -Alias: **-w**="": Workflow Id - Workflow Id +Alias: **-w** +Workflow Id diff --git a/docs/cmd-options/workflow-type.md b/docs/cmd-options/workflow-type.md index 5a4e2f81..f81b3242 100644 --- a/docs/cmd-options/workflow-type.md +++ b/docs/cmd-options/workflow-type.md @@ -7,4 +7,5 @@ tags: - cli --- - Workflow type name. +Alias: **-w** +Workflow type name. diff --git a/docs/cmd-options/yes.md b/docs/cmd-options/yes.md index 9038abf0..700fa779 100644 --- a/docs/cmd-options/yes.md +++ b/docs/cmd-options/yes.md @@ -8,4 +8,4 @@ tags: --- Alias: **-y**: Confirm all prompts. - Confirm all prompts. +Confirm all prompts. diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 85a6f48b..5e0f86f3 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -2,7 +2,7 @@ id: reset-batch title: temporal workflow reset-batch sidebar_label: reset-batch -description: Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew +description: Reset a batch of Workflow Executions by reset type: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask tags: - cli --- From d97dc7c3c52f7039fcde690cb0cd53018ea3362b Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 26 Jan 2023 13:40:29 -0600 Subject: [PATCH 59/68] pretty much all there --- cmd/doc/main.go | 3 ++- docs/cmd-options/active-cluster.md | 1 - docs/cmd-options/activity-id.md | 1 - docs/cmd-options/address.md | 1 - docs/cmd-options/archived.md | 1 - docs/cmd-options/calendar.md | 1 - docs/cmd-options/catchup-window.md | 1 - docs/cmd-options/cluster.md | 1 - docs/cmd-options/codec-auth.md | 1 - docs/cmd-options/codec-endpoint.md | 1 - docs/cmd-options/color.md | 1 - docs/cmd-options/concurrency.md | 1 - docs/cmd-options/context-timeout.md | 1 - docs/cmd-options/cron.md | 1 - docs/cmd-options/data.md | 1 - docs/cmd-options/depth.md | 1 - docs/cmd-options/description.md | 1 - docs/cmd-options/detail.md | 1 - docs/cmd-options/dry-run.md | 1 - docs/cmd-options/dynamic-config-value.md | 1 - docs/cmd-options/email.md | 1 - docs/cmd-options/enable-connection.md | 1 - docs/cmd-options/end-time.md | 1 - docs/cmd-options/env.md | 1 - docs/cmd-options/event-id.md | 1 - docs/cmd-options/exclude-file.md | 1 - docs/cmd-options/execution-timeout.md | 1 - docs/cmd-options/fields.md | 1 - docs/cmd-options/fold.md | 1 - docs/cmd-options/frontend-address.md | 1 - docs/cmd-options/global.md | 1 - docs/cmd-options/grpc-meta.md | 1 - docs/cmd-options/headless.md | 1 - docs/cmd-options/history-archival-state.md | 1 - docs/cmd-options/history-uri.md | 1 - docs/cmd-options/id-reuse-policy.md | 1 - docs/cmd-options/identity.md | 1 - docs/cmd-options/input-file.md | 1 - docs/cmd-options/input-parallelism.md | 1 - docs/cmd-options/input-separator.md | 1 - docs/cmd-options/interval.md | 1 - docs/cmd-options/ip.md | 1 - docs/cmd-options/jitter.md | 1 - docs/cmd-options/job-id.md | 1 - docs/cmd-options/limit.md | 1 - docs/cmd-options/log-format.md | 1 - docs/cmd-options/log-level.md | 1 - docs/cmd-options/max-field-length.md | 1 - docs/cmd-options/memo-file.md | 1 - docs/cmd-options/memo.md | 1 - docs/cmd-options/metrics-port.md | 1 - docs/cmd-options/name.md | 1 - docs/cmd-options/namespace-id.md | 1 - docs/cmd-options/no-fold.md | 1 - docs/cmd-options/non-deterministic.md | 1 - docs/cmd-options/notes.md | 1 - docs/cmd-options/output-filename.md | 1 - docs/cmd-options/overlap-policy.md | 1 - docs/cmd-options/pager.md | 1 - docs/cmd-options/pause-on-failure.md | 1 - docs/cmd-options/pause.md | 1 - docs/cmd-options/promote-global.md | 1 - docs/cmd-options/raw.md | 1 - docs/cmd-options/reapply-type.md | 3 +-- docs/cmd-options/reason.md | 1 - docs/cmd-options/reject-condition.md | 1 - docs/cmd-options/remaining-actions.md | 1 - docs/cmd-options/reset-points.md | 1 - docs/cmd-options/result.md | 1 - docs/cmd-options/retention.md | 1 - docs/cmd-options/run-timeout.md | 1 - docs/cmd-options/search-attribute.md | 1 - docs/cmd-options/skip-base-is-not-current.md | 1 - docs/cmd-options/skip-current-open.md | 1 - docs/cmd-options/sqlite-pragma.md | 1 - docs/cmd-options/start-time.md | 1 - docs/cmd-options/task-queue-type.md | 1 - docs/cmd-options/task-timeout.md | 1 - docs/cmd-options/time-format.md | 1 - docs/cmd-options/time-zone.md | 1 - docs/cmd-options/tls-ca-path.md | 1 - docs/cmd-options/tls-cert-path.md | 1 - docs/cmd-options/tls-disable-host-verification.md | 1 - docs/cmd-options/tls-key-path.md | 1 - docs/cmd-options/tls-server-name.md | 1 - docs/cmd-options/type.md | 1 - docs/cmd-options/ui-asset-path.md | 1 - docs/cmd-options/ui-codec-endpoint.md | 1 - docs/cmd-options/ui-ip.md | 1 - docs/cmd-options/ui-port.md | 1 - docs/cmd-options/unpause.md | 1 - docs/cmd-options/visibility-archival-state.md | 1 - docs/cmd-options/visibility-uri.md | 1 - docs/cmd-options/workflow-type.md | 1 - docs/workflow/reset-batch.md | 2 +- 95 files changed, 4 insertions(+), 96 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 10388758..347328a4 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -110,6 +110,7 @@ func main() { if (aliasName != "") { aliasArray := strings.Split(aliasName, "=") writeLine(currentOptionFile, aliasArray[0]) + aliasName = "" } writeLine(currentOptionFile, strings.TrimSpace(definition)) @@ -136,7 +137,7 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, log.Printf("Error when trying to create option file %s: %v", optionFilePath, err) } createdFiles[optionFileName] = currentOptionFile - writeFrontMatter(optionFileName, "", scanner, false, currentOptionFile) + writeFrontMatter(strings.TrimSpace(optionFileName), "", scanner, false, currentOptionFile) } else if (isIndex) { err = os.MkdirAll(path, os.ModePerm) diff --git a/docs/cmd-options/active-cluster.md b/docs/cmd-options/active-cluster.md index 10a1a5f3..3a88c934 100644 --- a/docs/cmd-options/active-cluster.md +++ b/docs/cmd-options/active-cluster.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Active cluster name diff --git a/docs/cmd-options/activity-id.md b/docs/cmd-options/activity-id.md index c6baeca7..89736348 100644 --- a/docs/cmd-options/activity-id.md +++ b/docs/cmd-options/activity-id.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Identifies the Activity to fail. diff --git a/docs/cmd-options/address.md b/docs/cmd-options/address.md index 88d332f0..34143a31 100644 --- a/docs/cmd-options/address.md +++ b/docs/cmd-options/address.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/cmd-options/archived.md b/docs/cmd-options/archived.md index c16b5302..1034198a 100644 --- a/docs/cmd-options/archived.md +++ b/docs/cmd-options/archived.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** List archived Workflow Executions. diff --git a/docs/cmd-options/calendar.md b/docs/cmd-options/calendar.md index 00cbd73a..aad47b5e 100644 --- a/docs/cmd-options/calendar.md +++ b/docs/cmd-options/calendar.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} diff --git a/docs/cmd-options/catchup-window.md b/docs/cmd-options/catchup-window.md index fdb15d5e..d012ce9d 100644 --- a/docs/cmd-options/catchup-window.md +++ b/docs/cmd-options/catchup-window.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Maximum allowed catch-up time if server is down. diff --git a/docs/cmd-options/cluster.md b/docs/cmd-options/cluster.md index 67be0b95..80a9e107 100644 --- a/docs/cmd-options/cluster.md +++ b/docs/cmd-options/cluster.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Cluster name diff --git a/docs/cmd-options/codec-auth.md b/docs/cmd-options/codec-auth.md index 76ae2c98..ac07a1ef 100644 --- a/docs/cmd-options/codec-auth.md +++ b/docs/cmd-options/codec-auth.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Sets the authorization header on requests to the Codec Server. diff --git a/docs/cmd-options/codec-endpoint.md b/docs/cmd-options/codec-endpoint.md index 180a26df..07c9d9bd 100644 --- a/docs/cmd-options/codec-endpoint.md +++ b/docs/cmd-options/codec-endpoint.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Endpoint for a remote Codec Server. diff --git a/docs/cmd-options/color.md b/docs/cmd-options/color.md index 85d58c68..1f3ce3d1 100644 --- a/docs/cmd-options/color.md +++ b/docs/cmd-options/color.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** when to use color: auto, always, never. (default: auto) diff --git a/docs/cmd-options/concurrency.md b/docs/cmd-options/concurrency.md index 9b09af0e..27b7e9e4 100644 --- a/docs/cmd-options/concurrency.md +++ b/docs/cmd-options/concurrency.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-q** Request concurrency (default: 10) diff --git a/docs/cmd-options/context-timeout.md b/docs/cmd-options/context-timeout.md index e5fdfd8a..1b949cf4 100644 --- a/docs/cmd-options/context-timeout.md +++ b/docs/cmd-options/context-timeout.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** An optional timeout for the context of an RPC call (in seconds). (default: 5) diff --git a/docs/cmd-options/cron.md b/docs/cmd-options/cron.md index c64a33d6..d12ad640 100644 --- a/docs/cmd-options/cron.md +++ b/docs/cmd-options/cron.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily". diff --git a/docs/cmd-options/data.md b/docs/cmd-options/data.md index cd31dc01..875b2a1c 100644 --- a/docs/cmd-options/data.md +++ b/docs/cmd-options/data.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Namespace data in a format key=value diff --git a/docs/cmd-options/depth.md b/docs/cmd-options/depth.md index 303d8fff..f8d37cb3 100644 --- a/docs/cmd-options/depth.md +++ b/docs/cmd-options/depth.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-q** Number of Child Workflows to expand, -1 to expand all Child Workflows. (default: -1) diff --git a/docs/cmd-options/description.md b/docs/cmd-options/description.md index 49197721..edc4361c 100644 --- a/docs/cmd-options/description.md +++ b/docs/cmd-options/description.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Namespace description diff --git a/docs/cmd-options/detail.md b/docs/cmd-options/detail.md index a7bba621..e915758f 100644 --- a/docs/cmd-options/detail.md +++ b/docs/cmd-options/detail.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Detail to fail the Activity. diff --git a/docs/cmd-options/dry-run.md b/docs/cmd-options/dry-run.md index d5584d11..70965d77 100644 --- a/docs/cmd-options/dry-run.md +++ b/docs/cmd-options/dry-run.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Simulate reset without resetting any Workflow Executions. diff --git a/docs/cmd-options/dynamic-config-value.md b/docs/cmd-options/dynamic-config-value.md index 746a2bac..ed97214f 100644 --- a/docs/cmd-options/dynamic-config-value.md +++ b/docs/cmd-options/dynamic-config-value.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-f** Dynamic config value, as KEY=JSON_VALUE (string values need quotes). diff --git a/docs/cmd-options/email.md b/docs/cmd-options/email.md index cc1dc193..912dd967 100644 --- a/docs/cmd-options/email.md +++ b/docs/cmd-options/email.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Owner email diff --git a/docs/cmd-options/enable-connection.md b/docs/cmd-options/enable-connection.md index 80485c61..cde3e2ea 100644 --- a/docs/cmd-options/enable-connection.md +++ b/docs/cmd-options/enable-connection.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-o** Enable cross-cluster connection. diff --git a/docs/cmd-options/end-time.md b/docs/cmd-options/end-time.md index 5c250f09..7c485608 100644 --- a/docs/cmd-options/end-time.md +++ b/docs/cmd-options/end-time.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-s** Backfill end time. diff --git a/docs/cmd-options/env.md b/docs/cmd-options/env.md index 8756fd0a..a516abc2 100644 --- a/docs/cmd-options/env.md +++ b/docs/cmd-options/env.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Name of the environment to read environmental variables from. (default: default) diff --git a/docs/cmd-options/event-id.md b/docs/cmd-options/event-id.md index 4e80ab3e..3afdb245 100644 --- a/docs/cmd-options/event-id.md +++ b/docs/cmd-options/event-id.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others. diff --git a/docs/cmd-options/exclude-file.md b/docs/cmd-options/exclude-file.md index 6f4392db..28e189f7 100644 --- a/docs/cmd-options/exclude-file.md +++ b/docs/cmd-options/exclude-file.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Input file that specifies Workflow Executions to exclude from resetting. diff --git a/docs/cmd-options/execution-timeout.md b/docs/cmd-options/execution-timeout.md index 25e0616c..8c04fa2b 100644 --- a/docs/cmd-options/execution-timeout.md +++ b/docs/cmd-options/execution-timeout.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) diff --git a/docs/cmd-options/fields.md b/docs/cmd-options/fields.md index 55e96aaf..11ff75af 100644 --- a/docs/cmd-options/fields.md +++ b/docs/cmd-options/fields.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Customize fields to print. Set to 'long' to automatically print more of main fields. diff --git a/docs/cmd-options/fold.md b/docs/cmd-options/fold.md index 1328d2ee..ccf62b10 100644 --- a/docs/cmd-options/fold.md +++ b/docs/cmd-options/fold.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-q** Statuses for which Child Workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied. (default: completed,canceled,terminated) diff --git a/docs/cmd-options/frontend-address.md b/docs/cmd-options/frontend-address.md index d9719a15..da34c3a3 100644 --- a/docs/cmd-options/frontend-address.md +++ b/docs/cmd-options/frontend-address.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-o** Frontend address of the remote Cluster. diff --git a/docs/cmd-options/global.md b/docs/cmd-options/global.md index 44e56beb..d11a06df 100644 --- a/docs/cmd-options/global.md +++ b/docs/cmd-options/global.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Flag to indicate whether namespace is a global namespace diff --git a/docs/cmd-options/grpc-meta.md b/docs/cmd-options/grpc-meta.md index 7b846aa6..63ad80c5 100644 --- a/docs/cmd-options/grpc-meta.md +++ b/docs/cmd-options/grpc-meta.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. diff --git a/docs/cmd-options/headless.md b/docs/cmd-options/headless.md index 362b78dd..bb99fed0 100644 --- a/docs/cmd-options/headless.md +++ b/docs/cmd-options/headless.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-f** Disable the Web UI. diff --git a/docs/cmd-options/history-archival-state.md b/docs/cmd-options/history-archival-state.md index 6b4301b8..335e0263 100644 --- a/docs/cmd-options/history-archival-state.md +++ b/docs/cmd-options/history-archival-state.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Flag to set history archival state, valid values are "disabled" and "enabled" diff --git a/docs/cmd-options/history-uri.md b/docs/cmd-options/history-uri.md index ee0a871c..1628a842 100644 --- a/docs/cmd-options/history-uri.md +++ b/docs/cmd-options/history-uri.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Optionally specify history archival URI (cannot be changed after first time archival is enabled) diff --git a/docs/cmd-options/id-reuse-policy.md b/docs/cmd-options/id-reuse-policy.md index d6ffca3c..66093404 100644 --- a/docs/cmd-options/id-reuse-policy.md +++ b/docs/cmd-options/id-reuse-policy.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Allows the same Workflow Id to be used in a new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. diff --git a/docs/cmd-options/identity.md b/docs/cmd-options/identity.md index 1cc135e4..445ea8f3 100644 --- a/docs/cmd-options/identity.md +++ b/docs/cmd-options/identity.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Specify the operator's identity. diff --git a/docs/cmd-options/input-file.md b/docs/cmd-options/input-file.md index 6c78a2e8..72c650d5 100644 --- a/docs/cmd-options/input-file.md +++ b/docs/cmd-options/input-file.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-i** Passes optional input for the Workflow from a JSON file. diff --git a/docs/cmd-options/input-parallelism.md b/docs/cmd-options/input-parallelism.md index 1379bf58..09a4ac39 100644 --- a/docs/cmd-options/input-parallelism.md +++ b/docs/cmd-options/input-parallelism.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Number of goroutines to run in parallel. Each goroutine processes one line for every second. (default: 1) diff --git a/docs/cmd-options/input-separator.md b/docs/cmd-options/input-separator.md index 570db29c..e1c6fa3c 100644 --- a/docs/cmd-options/input-separator.md +++ b/docs/cmd-options/input-separator.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Separator for the input file. The default is a tab ( ). (default: ) diff --git a/docs/cmd-options/interval.md b/docs/cmd-options/interval.md index 9818224a..d29c9d0b 100644 --- a/docs/cmd-options/interval.md +++ b/docs/cmd-options/interval.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-i** Interval duration, e.g. 90m, or 90m/13m to include phase offset. diff --git a/docs/cmd-options/ip.md b/docs/cmd-options/ip.md index f1261ef7..b175ef70 100644 --- a/docs/cmd-options/ip.md +++ b/docs/cmd-options/ip.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-f** IPv4 address to bind the frontend service to. (default: 127.0.0.1) diff --git a/docs/cmd-options/jitter.md b/docs/cmd-options/jitter.md index 7444c081..7d721268 100644 --- a/docs/cmd-options/jitter.md +++ b/docs/cmd-options/jitter.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-i** Jitter duration. diff --git a/docs/cmd-options/job-id.md b/docs/cmd-options/job-id.md index 41d902e8..8ccb649c 100644 --- a/docs/cmd-options/job-id.md +++ b/docs/cmd-options/job-id.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-o** Batch Job Id diff --git a/docs/cmd-options/limit.md b/docs/cmd-options/limit.md index 7aaccc55..901e863a 100644 --- a/docs/cmd-options/limit.md +++ b/docs/cmd-options/limit.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Number of items to print. (default: 0) diff --git a/docs/cmd-options/log-format.md b/docs/cmd-options/log-format.md index db025310..b33f4ec4 100644 --- a/docs/cmd-options/log-format.md +++ b/docs/cmd-options/log-format.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-f** Set the log formatting. Options: ["json", "pretty"]. (default: json) diff --git a/docs/cmd-options/log-level.md b/docs/cmd-options/log-level.md index 55eca0dc..dff509e4 100644 --- a/docs/cmd-options/log-level.md +++ b/docs/cmd-options/log-level.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-f** Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) diff --git a/docs/cmd-options/max-field-length.md b/docs/cmd-options/max-field-length.md index c835b65a..e33330ba 100644 --- a/docs/cmd-options/max-field-length.md +++ b/docs/cmd-options/max-field-length.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-i** Maximum length for each attribute field. (default: 0) diff --git a/docs/cmd-options/memo-file.md b/docs/cmd-options/memo-file.md index 66a1b1f8..dcf4f389 100644 --- a/docs/cmd-options/memo-file.md +++ b/docs/cmd-options/memo-file.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-i** Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value. diff --git a/docs/cmd-options/memo.md b/docs/cmd-options/memo.md index c188e6de..7eb837fb 100644 --- a/docs/cmd-options/memo.md +++ b/docs/cmd-options/memo.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-i** Set a memo on a schedule. Format: key=value. Use valid JSON formats for value. diff --git a/docs/cmd-options/metrics-port.md b/docs/cmd-options/metrics-port.md index 070896b8..e8d0b540 100644 --- a/docs/cmd-options/metrics-port.md +++ b/docs/cmd-options/metrics-port.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-f** Port for /metrics (default: 0) diff --git a/docs/cmd-options/name.md b/docs/cmd-options/name.md index 1e579b76..176f01ab 100644 --- a/docs/cmd-options/name.md +++ b/docs/cmd-options/name.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-o** Frontend address of the remote Cluster. diff --git a/docs/cmd-options/namespace-id.md b/docs/cmd-options/namespace-id.md index b795ea74..8352431f 100644 --- a/docs/cmd-options/namespace-id.md +++ b/docs/cmd-options/namespace-id.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Namespace Id diff --git a/docs/cmd-options/no-fold.md b/docs/cmd-options/no-fold.md index 8123ba65..bdb270cf 100644 --- a/docs/cmd-options/no-fold.md +++ b/docs/cmd-options/no-fold.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Disable folding. All Child Workflows within the set depth will be fetched and displayed. diff --git a/docs/cmd-options/non-deterministic.md b/docs/cmd-options/non-deterministic.md index bc1ff99a..3169c212 100644 --- a/docs/cmd-options/non-deterministic.md +++ b/docs/cmd-options/non-deterministic.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error. diff --git a/docs/cmd-options/notes.md b/docs/cmd-options/notes.md index b3431a5a..933f042a 100644 --- a/docs/cmd-options/notes.md +++ b/docs/cmd-options/notes.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Initial value of notes field. diff --git a/docs/cmd-options/output-filename.md b/docs/cmd-options/output-filename.md index c41a1a6b..df704fc6 100644 --- a/docs/cmd-options/output-filename.md +++ b/docs/cmd-options/output-filename.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-o** Serializes Event History to a file. diff --git a/docs/cmd-options/overlap-policy.md b/docs/cmd-options/overlap-policy.md index 27871083..6feca798 100644 --- a/docs/cmd-options/overlap-policy.md +++ b/docs/cmd-options/overlap-policy.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. diff --git a/docs/cmd-options/pager.md b/docs/cmd-options/pager.md index cbf40750..617f4a58 100644 --- a/docs/cmd-options/pager.md +++ b/docs/cmd-options/pager.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-o** Sets the pager for Temporal CLI to use. diff --git a/docs/cmd-options/pause-on-failure.md b/docs/cmd-options/pause-on-failure.md index 514010a2..bb6cf2aa 100644 --- a/docs/cmd-options/pause-on-failure.md +++ b/docs/cmd-options/pause-on-failure.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Pause schedule after any workflow failure. diff --git a/docs/cmd-options/pause.md b/docs/cmd-options/pause.md index 049ba877..d414dfd7 100644 --- a/docs/cmd-options/pause.md +++ b/docs/cmd-options/pause.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Pauses the schedule. diff --git a/docs/cmd-options/promote-global.md b/docs/cmd-options/promote-global.md index 77946427..6bbf0029 100644 --- a/docs/cmd-options/promote-global.md +++ b/docs/cmd-options/promote-global.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Promote local namespace to global namespace diff --git a/docs/cmd-options/raw.md b/docs/cmd-options/raw.md index 3fd8b656..203348aa 100644 --- a/docs/cmd-options/raw.md +++ b/docs/cmd-options/raw.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-o** Print raw data as json (prefer this over -o json for scripting). diff --git a/docs/cmd-options/reapply-type.md b/docs/cmd-options/reapply-type.md index b74a2da4..6cdc3223 100644 --- a/docs/cmd-options/reapply-type.md +++ b/docs/cmd-options/reapply-type.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** -Event types to reapply after the reset point: None, , Signal. (default: All) +Event types to reapply after the reset point: , Signal, None. (default: All) diff --git a/docs/cmd-options/reason.md b/docs/cmd-options/reason.md index 27ffc7b4..07f01d30 100644 --- a/docs/cmd-options/reason.md +++ b/docs/cmd-options/reason.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Reason for the operation diff --git a/docs/cmd-options/reject-condition.md b/docs/cmd-options/reject-condition.md index fb755e13..b66bbc48 100644 --- a/docs/cmd-options/reject-condition.md +++ b/docs/cmd-options/reject-condition.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Optional flag for rejecting Queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly". diff --git a/docs/cmd-options/remaining-actions.md b/docs/cmd-options/remaining-actions.md index 4086550a..46731c9e 100644 --- a/docs/cmd-options/remaining-actions.md +++ b/docs/cmd-options/remaining-actions.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Total number of actions allowed. (default: 0) diff --git a/docs/cmd-options/reset-points.md b/docs/cmd-options/reset-points.md index 4a3eda63..86edc605 100644 --- a/docs/cmd-options/reset-points.md +++ b/docs/cmd-options/reset-points.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-o** Only show Workflow Events that are eligible for reset. diff --git a/docs/cmd-options/result.md b/docs/cmd-options/result.md index e1b2da58..4efffc82 100644 --- a/docs/cmd-options/result.md +++ b/docs/cmd-options/result.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Set the result value of Activity completion. diff --git a/docs/cmd-options/retention.md b/docs/cmd-options/retention.md index 987faf5f..02a6b106 100644 --- a/docs/cmd-options/retention.md +++ b/docs/cmd-options/retention.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Workflow Execution retention diff --git a/docs/cmd-options/run-timeout.md b/docs/cmd-options/run-timeout.md index 3d63a902..7fa90274 100644 --- a/docs/cmd-options/run-timeout.md +++ b/docs/cmd-options/run-timeout.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Timeout (in seconds) of a single Workflow run. (default: 0) diff --git a/docs/cmd-options/search-attribute.md b/docs/cmd-options/search-attribute.md index 07b1a72e..4a371698 100644 --- a/docs/cmd-options/search-attribute.md +++ b/docs/cmd-options/search-attribute.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-s** Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value. diff --git a/docs/cmd-options/skip-base-is-not-current.md b/docs/cmd-options/skip-base-is-not-current.md index b5ea0274..50c1f8b2 100644 --- a/docs/cmd-options/skip-base-is-not-current.md +++ b/docs/cmd-options/skip-base-is-not-current.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-q** Skip a Workflow Execution if the base Run is not the current Run. diff --git a/docs/cmd-options/skip-current-open.md b/docs/cmd-options/skip-current-open.md index d60c29f0..de6a6264 100644 --- a/docs/cmd-options/skip-current-open.md +++ b/docs/cmd-options/skip-current-open.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-q** Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run. diff --git a/docs/cmd-options/sqlite-pragma.md b/docs/cmd-options/sqlite-pragma.md index 0bc979e7..b17378a6 100644 --- a/docs/cmd-options/sqlite-pragma.md +++ b/docs/cmd-options/sqlite-pragma.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-p** Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. diff --git a/docs/cmd-options/start-time.md b/docs/cmd-options/start-time.md index aabf848c..07a2b6e2 100644 --- a/docs/cmd-options/start-time.md +++ b/docs/cmd-options/start-time.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-s** Backfill start time. diff --git a/docs/cmd-options/task-queue-type.md b/docs/cmd-options/task-queue-type.md index c453da5c..3305062b 100644 --- a/docs/cmd-options/task-queue-type.md +++ b/docs/cmd-options/task-queue-type.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-t** Task Queue type [workflow|activity] (default: workflow) diff --git a/docs/cmd-options/task-timeout.md b/docs/cmd-options/task-timeout.md index 7dcd455f..d026b53f 100644 --- a/docs/cmd-options/task-timeout.md +++ b/docs/cmd-options/task-timeout.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-t** Start-to-close timeout for a Workflow Task (in seconds). (default: 10) diff --git a/docs/cmd-options/time-format.md b/docs/cmd-options/time-format.md index ed8f4f03..fbe26cf9 100644 --- a/docs/cmd-options/time-format.md +++ b/docs/cmd-options/time-format.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-o** Format time as: relative, iso, raw. (default: relative) diff --git a/docs/cmd-options/time-zone.md b/docs/cmd-options/time-zone.md index e615d34b..a47e988c 100644 --- a/docs/cmd-options/time-zone.md +++ b/docs/cmd-options/time-zone.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-t** Time zone (IANA name). diff --git a/docs/cmd-options/tls-ca-path.md b/docs/cmd-options/tls-ca-path.md index 9b96b8b9..e2181a68 100644 --- a/docs/cmd-options/tls-ca-path.md +++ b/docs/cmd-options/tls-ca-path.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Path to server CA certificate. diff --git a/docs/cmd-options/tls-cert-path.md b/docs/cmd-options/tls-cert-path.md index a0b3aaa0..af74b767 100644 --- a/docs/cmd-options/tls-cert-path.md +++ b/docs/cmd-options/tls-cert-path.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Path to x509 certificate. diff --git a/docs/cmd-options/tls-disable-host-verification.md b/docs/cmd-options/tls-disable-host-verification.md index d1c2d923..b4993641 100644 --- a/docs/cmd-options/tls-disable-host-verification.md +++ b/docs/cmd-options/tls-disable-host-verification.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Disables TLS host name verification if already enabled. diff --git a/docs/cmd-options/tls-key-path.md b/docs/cmd-options/tls-key-path.md index 43634778..36a6603a 100644 --- a/docs/cmd-options/tls-key-path.md +++ b/docs/cmd-options/tls-key-path.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Path to private certificate key. diff --git a/docs/cmd-options/tls-server-name.md b/docs/cmd-options/tls-server-name.md index 99188953..92e8b161 100644 --- a/docs/cmd-options/tls-server-name.md +++ b/docs/cmd-options/tls-server-name.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Provides an override for the target TLS server name. diff --git a/docs/cmd-options/type.md b/docs/cmd-options/type.md index 8e076e2a..cac22915 100644 --- a/docs/cmd-options/type.md +++ b/docs/cmd-options/type.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] diff --git a/docs/cmd-options/ui-asset-path.md b/docs/cmd-options/ui-asset-path.md index 91b0a76b..e05c8789 100644 --- a/docs/cmd-options/ui-asset-path.md +++ b/docs/cmd-options/ui-asset-path.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-p** UI Custom Assets path. diff --git a/docs/cmd-options/ui-codec-endpoint.md b/docs/cmd-options/ui-codec-endpoint.md index 07b24163..0770bc0d 100644 --- a/docs/cmd-options/ui-codec-endpoint.md +++ b/docs/cmd-options/ui-codec-endpoint.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-p** UI Remote data converter HTTP endpoint. diff --git a/docs/cmd-options/ui-ip.md b/docs/cmd-options/ui-ip.md index a5582390..4e569da0 100644 --- a/docs/cmd-options/ui-ip.md +++ b/docs/cmd-options/ui-ip.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-p** IPv4 address to bind the Web UI to. diff --git a/docs/cmd-options/ui-port.md b/docs/cmd-options/ui-port.md index 169bbf7e..24098cc8 100644 --- a/docs/cmd-options/ui-port.md +++ b/docs/cmd-options/ui-port.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-p** Port for the Web UI. (default: 0) diff --git a/docs/cmd-options/unpause.md b/docs/cmd-options/unpause.md index 9aa9ce39..ef3ae044 100644 --- a/docs/cmd-options/unpause.md +++ b/docs/cmd-options/unpause.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-s** Unpauses the schedule. diff --git a/docs/cmd-options/visibility-archival-state.md b/docs/cmd-options/visibility-archival-state.md index 94a1474f..e1ba9e11 100644 --- a/docs/cmd-options/visibility-archival-state.md +++ b/docs/cmd-options/visibility-archival-state.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Flag to set visibility archival state, valid values are "disabled" and "enabled" diff --git a/docs/cmd-options/visibility-uri.md b/docs/cmd-options/visibility-uri.md index d0fcdc82..58d58818 100644 --- a/docs/cmd-options/visibility-uri.md +++ b/docs/cmd-options/visibility-uri.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-n** Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) diff --git a/docs/cmd-options/workflow-type.md b/docs/cmd-options/workflow-type.md index f81b3242..f2711154 100644 --- a/docs/cmd-options/workflow-type.md +++ b/docs/cmd-options/workflow-type.md @@ -7,5 +7,4 @@ tags: - cli --- -Alias: **-w** Workflow type name. diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md index 5e0f86f3..85a6f48b 100644 --- a/docs/workflow/reset-batch.md +++ b/docs/workflow/reset-batch.md @@ -2,7 +2,7 @@ id: reset-batch title: temporal workflow reset-batch sidebar_label: reset-batch -description: Reset a batch of Workflow Executions by reset type: LastWorkflowTask, LastContinuedAsNew, FirstWorkflowTask +description: Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew tags: - cli --- From 0e02a3c0405a5163891e18d95e6431cc632c3310 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Mon, 30 Jan 2023 12:06:17 -0600 Subject: [PATCH 60/68] remove generated docs --- docs/activity/complete.md | 54 --------- docs/activity/fail.md | 56 --------- docs/activity/index.md | 10 -- docs/batch/describe.md | 52 -------- docs/batch/index.md | 20 ---- docs/batch/list.md | 57 --------- docs/batch/terminate.md | 48 -------- docs/cmd-options/active-cluster.md | 10 -- docs/cmd-options/activity-id.md | 10 -- docs/cmd-options/address.md | 10 -- docs/cmd-options/archived.md | 10 -- docs/cmd-options/calendar.md | 10 -- docs/cmd-options/catchup-window.md | 10 -- docs/cmd-options/cluster.md | 10 -- docs/cmd-options/codec-auth.md | 10 -- docs/cmd-options/codec-endpoint.md | 10 -- docs/cmd-options/color.md | 10 -- docs/cmd-options/concurrency.md | 10 -- docs/cmd-options/config.md | 11 -- docs/cmd-options/context-timeout.md | 10 -- docs/cmd-options/cron.md | 10 -- docs/cmd-options/data.md | 10 -- docs/cmd-options/db-filename.md | 11 -- docs/cmd-options/depth.md | 10 -- docs/cmd-options/description.md | 10 -- docs/cmd-options/detail.md | 10 -- docs/cmd-options/dry-run.md | 10 -- docs/cmd-options/dynamic-config-value.md | 10 -- docs/cmd-options/email.md | 10 -- docs/cmd-options/enable-connection.md | 10 -- docs/cmd-options/end-time.md | 10 -- docs/cmd-options/env.md | 10 -- docs/cmd-options/event-id.md | 10 -- docs/cmd-options/exclude-file.md | 10 -- docs/cmd-options/execution-timeout.md | 10 -- docs/cmd-options/fields.md | 10 -- docs/cmd-options/fold.md | 10 -- docs/cmd-options/follow.md | 11 -- docs/cmd-options/frontend-address.md | 10 -- docs/cmd-options/global.md | 10 -- docs/cmd-options/grpc-meta.md | 10 -- docs/cmd-options/headless.md | 10 -- docs/cmd-options/history-archival-state.md | 10 -- docs/cmd-options/history-uri.md | 10 -- docs/cmd-options/id-reuse-policy.md | 10 -- docs/cmd-options/identity.md | 10 -- docs/cmd-options/input-file.md | 10 -- docs/cmd-options/input-parallelism.md | 10 -- docs/cmd-options/input-separator.md | 10 -- docs/cmd-options/input.md | 11 -- docs/cmd-options/interval.md | 10 -- docs/cmd-options/ip.md | 10 -- docs/cmd-options/jitter.md | 10 -- docs/cmd-options/job-id.md | 10 -- docs/cmd-options/limit.md | 10 -- docs/cmd-options/log-format.md | 10 -- docs/cmd-options/log-level.md | 10 -- docs/cmd-options/max-field-length.md | 10 -- docs/cmd-options/memo-file.md | 10 -- docs/cmd-options/memo.md | 10 -- docs/cmd-options/metrics-port.md | 10 -- docs/cmd-options/name.md | 10 -- docs/cmd-options/namespace-id.md | 10 -- docs/cmd-options/namespace.md | 11 -- docs/cmd-options/no-fold.md | 10 -- docs/cmd-options/no-pager.md | 11 -- docs/cmd-options/non-deterministic.md | 10 -- docs/cmd-options/notes.md | 10 -- docs/cmd-options/output-filename.md | 10 -- docs/cmd-options/output.md | 11 -- docs/cmd-options/overlap-policy.md | 10 -- docs/cmd-options/pager.md | 10 -- docs/cmd-options/pause-on-failure.md | 10 -- docs/cmd-options/pause.md | 10 -- docs/cmd-options/port.md | 11 -- docs/cmd-options/promote-global.md | 10 -- docs/cmd-options/query.md | 11 -- docs/cmd-options/raw.md | 10 -- docs/cmd-options/reapply-type.md | 10 -- docs/cmd-options/reason.md | 10 -- docs/cmd-options/reject-condition.md | 10 -- docs/cmd-options/remaining-actions.md | 10 -- docs/cmd-options/reset-points.md | 10 -- docs/cmd-options/result.md | 10 -- docs/cmd-options/retention.md | 10 -- docs/cmd-options/run-id.md | 11 -- docs/cmd-options/run-timeout.md | 10 -- docs/cmd-options/schedule-id.md | 11 -- docs/cmd-options/search-attribute.md | 10 -- docs/cmd-options/skip-base-is-not-current.md | 10 -- docs/cmd-options/skip-current-open.md | 10 -- docs/cmd-options/sqlite-pragma.md | 10 -- docs/cmd-options/start-time.md | 10 -- docs/cmd-options/task-queue-type.md | 10 -- docs/cmd-options/task-queue.md | 11 -- docs/cmd-options/task-timeout.md | 10 -- docs/cmd-options/time-format.md | 10 -- docs/cmd-options/time-zone.md | 10 -- docs/cmd-options/tls-ca-path.md | 10 -- docs/cmd-options/tls-cert-path.md | 10 -- .../tls-disable-host-verification.md | 10 -- docs/cmd-options/tls-key-path.md | 10 -- docs/cmd-options/tls-server-name.md | 10 -- docs/cmd-options/type.md | 10 -- docs/cmd-options/ui-asset-path.md | 10 -- docs/cmd-options/ui-codec-endpoint.md | 10 -- docs/cmd-options/ui-ip.md | 10 -- docs/cmd-options/ui-port.md | 10 -- docs/cmd-options/unpause.md | 10 -- docs/cmd-options/visibility-archival-state.md | 10 -- docs/cmd-options/visibility-uri.md | 10 -- docs/cmd-options/workflow-id.md | 11 -- docs/cmd-options/workflow-type.md | 10 -- docs/cmd-options/yes.md | 11 -- docs/completion/bash.md | 12 -- docs/completion/index.md | 10 -- docs/completion/zsh.md | 11 -- docs/env/delete.md | 44 ------- docs/env/get.md | 44 ------- docs/env/index.md | 10 -- docs/env/set.md | 44 ------- docs/operator/cluster/describe.md | 55 --------- docs/operator/cluster/health.md | 51 -------- docs/operator/cluster/index.md | 10 -- docs/operator/cluster/list.md | 64 ---------- docs/operator/cluster/remove.md | 53 --------- docs/operator/cluster/system.md | 55 --------- docs/operator/cluster/upsert.md | 55 --------- docs/operator/index.md | 15 --- docs/operator/namespace/create.md | 73 ------------ docs/operator/namespace/delete.md | 53 --------- docs/operator/namespace/describe.md | 54 --------- docs/operator/namespace/index.md | 10 -- docs/operator/namespace/list.md | 51 -------- docs/operator/namespace/update.md | 75 ------------ docs/operator/search-attribute/create.md | 58 --------- docs/operator/search-attribute/index.md | 10 -- docs/operator/search-attribute/list.md | 53 --------- docs/operator/search-attribute/remove.md | 57 --------- docs/schedule/backfill.md | 58 --------- docs/schedule/create.md | 111 ------------------ docs/schedule/delete.md | 50 -------- docs/schedule/describe.md | 55 --------- docs/schedule/index.md | 15 --- docs/schedule/list.md | 58 --------- docs/schedule/toggle.md | 57 --------- docs/schedule/trigger.md | 53 --------- docs/schedule/update.md | 110 ----------------- docs/server/index.md | 10 -- docs/server/start-dev.md | 40 ------- docs/task-queue/describe.md | 58 --------- docs/task-queue/index.md | 10 -- docs/task-queue/list-partition.md | 48 -------- docs/workflow/cancel.md | 57 --------- docs/workflow/count.md | 47 -------- docs/workflow/delete.md | 48 -------- docs/workflow/describe.md | 53 --------- docs/workflow/execute.md | 98 ---------------- docs/workflow/index.md | 10 -- docs/workflow/list.md | 63 ---------- docs/workflow/query.md | 61 ---------- docs/workflow/reset-batch.md | 67 ----------- docs/workflow/reset.md | 57 --------- docs/workflow/show.md | 69 ----------- docs/workflow/signal.md | 60 ---------- docs/workflow/stack.md | 57 --------- docs/workflow/start.md | 96 --------------- docs/workflow/terminate.md | 57 --------- docs/workflow/trace.md | 56 --------- 169 files changed, 4097 deletions(-) delete mode 100644 docs/activity/complete.md delete mode 100644 docs/activity/fail.md delete mode 100644 docs/activity/index.md delete mode 100644 docs/batch/describe.md delete mode 100644 docs/batch/index.md delete mode 100644 docs/batch/list.md delete mode 100644 docs/batch/terminate.md delete mode 100644 docs/cmd-options/active-cluster.md delete mode 100644 docs/cmd-options/activity-id.md delete mode 100644 docs/cmd-options/address.md delete mode 100644 docs/cmd-options/archived.md delete mode 100644 docs/cmd-options/calendar.md delete mode 100644 docs/cmd-options/catchup-window.md delete mode 100644 docs/cmd-options/cluster.md delete mode 100644 docs/cmd-options/codec-auth.md delete mode 100644 docs/cmd-options/codec-endpoint.md delete mode 100644 docs/cmd-options/color.md delete mode 100644 docs/cmd-options/concurrency.md delete mode 100644 docs/cmd-options/config.md delete mode 100644 docs/cmd-options/context-timeout.md delete mode 100644 docs/cmd-options/cron.md delete mode 100644 docs/cmd-options/data.md delete mode 100644 docs/cmd-options/db-filename.md delete mode 100644 docs/cmd-options/depth.md delete mode 100644 docs/cmd-options/description.md delete mode 100644 docs/cmd-options/detail.md delete mode 100644 docs/cmd-options/dry-run.md delete mode 100644 docs/cmd-options/dynamic-config-value.md delete mode 100644 docs/cmd-options/email.md delete mode 100644 docs/cmd-options/enable-connection.md delete mode 100644 docs/cmd-options/end-time.md delete mode 100644 docs/cmd-options/env.md delete mode 100644 docs/cmd-options/event-id.md delete mode 100644 docs/cmd-options/exclude-file.md delete mode 100644 docs/cmd-options/execution-timeout.md delete mode 100644 docs/cmd-options/fields.md delete mode 100644 docs/cmd-options/fold.md delete mode 100644 docs/cmd-options/follow.md delete mode 100644 docs/cmd-options/frontend-address.md delete mode 100644 docs/cmd-options/global.md delete mode 100644 docs/cmd-options/grpc-meta.md delete mode 100644 docs/cmd-options/headless.md delete mode 100644 docs/cmd-options/history-archival-state.md delete mode 100644 docs/cmd-options/history-uri.md delete mode 100644 docs/cmd-options/id-reuse-policy.md delete mode 100644 docs/cmd-options/identity.md delete mode 100644 docs/cmd-options/input-file.md delete mode 100644 docs/cmd-options/input-parallelism.md delete mode 100644 docs/cmd-options/input-separator.md delete mode 100644 docs/cmd-options/input.md delete mode 100644 docs/cmd-options/interval.md delete mode 100644 docs/cmd-options/ip.md delete mode 100644 docs/cmd-options/jitter.md delete mode 100644 docs/cmd-options/job-id.md delete mode 100644 docs/cmd-options/limit.md delete mode 100644 docs/cmd-options/log-format.md delete mode 100644 docs/cmd-options/log-level.md delete mode 100644 docs/cmd-options/max-field-length.md delete mode 100644 docs/cmd-options/memo-file.md delete mode 100644 docs/cmd-options/memo.md delete mode 100644 docs/cmd-options/metrics-port.md delete mode 100644 docs/cmd-options/name.md delete mode 100644 docs/cmd-options/namespace-id.md delete mode 100644 docs/cmd-options/namespace.md delete mode 100644 docs/cmd-options/no-fold.md delete mode 100644 docs/cmd-options/no-pager.md delete mode 100644 docs/cmd-options/non-deterministic.md delete mode 100644 docs/cmd-options/notes.md delete mode 100644 docs/cmd-options/output-filename.md delete mode 100644 docs/cmd-options/output.md delete mode 100644 docs/cmd-options/overlap-policy.md delete mode 100644 docs/cmd-options/pager.md delete mode 100644 docs/cmd-options/pause-on-failure.md delete mode 100644 docs/cmd-options/pause.md delete mode 100644 docs/cmd-options/port.md delete mode 100644 docs/cmd-options/promote-global.md delete mode 100644 docs/cmd-options/query.md delete mode 100644 docs/cmd-options/raw.md delete mode 100644 docs/cmd-options/reapply-type.md delete mode 100644 docs/cmd-options/reason.md delete mode 100644 docs/cmd-options/reject-condition.md delete mode 100644 docs/cmd-options/remaining-actions.md delete mode 100644 docs/cmd-options/reset-points.md delete mode 100644 docs/cmd-options/result.md delete mode 100644 docs/cmd-options/retention.md delete mode 100644 docs/cmd-options/run-id.md delete mode 100644 docs/cmd-options/run-timeout.md delete mode 100644 docs/cmd-options/schedule-id.md delete mode 100644 docs/cmd-options/search-attribute.md delete mode 100644 docs/cmd-options/skip-base-is-not-current.md delete mode 100644 docs/cmd-options/skip-current-open.md delete mode 100644 docs/cmd-options/sqlite-pragma.md delete mode 100644 docs/cmd-options/start-time.md delete mode 100644 docs/cmd-options/task-queue-type.md delete mode 100644 docs/cmd-options/task-queue.md delete mode 100644 docs/cmd-options/task-timeout.md delete mode 100644 docs/cmd-options/time-format.md delete mode 100644 docs/cmd-options/time-zone.md delete mode 100644 docs/cmd-options/tls-ca-path.md delete mode 100644 docs/cmd-options/tls-cert-path.md delete mode 100644 docs/cmd-options/tls-disable-host-verification.md delete mode 100644 docs/cmd-options/tls-key-path.md delete mode 100644 docs/cmd-options/tls-server-name.md delete mode 100644 docs/cmd-options/type.md delete mode 100644 docs/cmd-options/ui-asset-path.md delete mode 100644 docs/cmd-options/ui-codec-endpoint.md delete mode 100644 docs/cmd-options/ui-ip.md delete mode 100644 docs/cmd-options/ui-port.md delete mode 100644 docs/cmd-options/unpause.md delete mode 100644 docs/cmd-options/visibility-archival-state.md delete mode 100644 docs/cmd-options/visibility-uri.md delete mode 100644 docs/cmd-options/workflow-id.md delete mode 100644 docs/cmd-options/workflow-type.md delete mode 100644 docs/cmd-options/yes.md delete mode 100644 docs/completion/bash.md delete mode 100644 docs/completion/index.md delete mode 100644 docs/completion/zsh.md delete mode 100644 docs/env/delete.md delete mode 100644 docs/env/get.md delete mode 100644 docs/env/index.md delete mode 100644 docs/env/set.md delete mode 100644 docs/operator/cluster/describe.md delete mode 100644 docs/operator/cluster/health.md delete mode 100644 docs/operator/cluster/index.md delete mode 100644 docs/operator/cluster/list.md delete mode 100644 docs/operator/cluster/remove.md delete mode 100644 docs/operator/cluster/system.md delete mode 100644 docs/operator/cluster/upsert.md delete mode 100644 docs/operator/index.md delete mode 100644 docs/operator/namespace/create.md delete mode 100644 docs/operator/namespace/delete.md delete mode 100644 docs/operator/namespace/describe.md delete mode 100644 docs/operator/namespace/index.md delete mode 100644 docs/operator/namespace/list.md delete mode 100644 docs/operator/namespace/update.md delete mode 100644 docs/operator/search-attribute/create.md delete mode 100644 docs/operator/search-attribute/index.md delete mode 100644 docs/operator/search-attribute/list.md delete mode 100644 docs/operator/search-attribute/remove.md delete mode 100644 docs/schedule/backfill.md delete mode 100644 docs/schedule/create.md delete mode 100644 docs/schedule/delete.md delete mode 100644 docs/schedule/describe.md delete mode 100644 docs/schedule/index.md delete mode 100644 docs/schedule/list.md delete mode 100644 docs/schedule/toggle.md delete mode 100644 docs/schedule/trigger.md delete mode 100644 docs/schedule/update.md delete mode 100644 docs/server/index.md delete mode 100644 docs/server/start-dev.md delete mode 100644 docs/task-queue/describe.md delete mode 100644 docs/task-queue/index.md delete mode 100644 docs/task-queue/list-partition.md delete mode 100644 docs/workflow/cancel.md delete mode 100644 docs/workflow/count.md delete mode 100644 docs/workflow/delete.md delete mode 100644 docs/workflow/describe.md delete mode 100644 docs/workflow/execute.md delete mode 100644 docs/workflow/index.md delete mode 100644 docs/workflow/list.md delete mode 100644 docs/workflow/query.md delete mode 100644 docs/workflow/reset-batch.md delete mode 100644 docs/workflow/reset.md delete mode 100644 docs/workflow/show.md delete mode 100644 docs/workflow/signal.md delete mode 100644 docs/workflow/stack.md delete mode 100644 docs/workflow/start.md delete mode 100644 docs/workflow/terminate.md delete mode 100644 docs/workflow/trace.md diff --git a/docs/activity/complete.md b/docs/activity/complete.md deleted file mode 100644 index fad759fe..00000000 --- a/docs/activity/complete.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: complete -title: temporal activity complete -sidebar_label: complete -description: Completes an Activity. -tags: - - cli ---- - - -The `temporal activity complete` command completes an [Activity Execution](/activities#activity-execution). - -Use the options listed below to change the behavior of this command. -Make sure to write the command as follows: -`temporal activity complete [command options] [arguments]` - -## OPTIONS - -- [--activity-id](/cmd-options/activity-id) - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--identity](/cmd-options/identity) - -- [--namespace](/cmd-options/namespace) - -- [--result](/cmd-options/result) - -- [--run-id](/cmd-options/run-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--workflow-id](/cmd-options/workflow-id) - diff --git a/docs/activity/fail.md b/docs/activity/fail.md deleted file mode 100644 index 48f79a0d..00000000 --- a/docs/activity/fail.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -id: fail -title: temporal activity fail -sidebar_label: fail -description: Fails an Activity. -tags: - - cli ---- - - -The `temporal activity fail` command fails an [Activity Execution](/activities#activity-execution). - -Use the options listed below to change the behavior of this command. -Make sure to write the command as follows: -`temporal activity fail [command options] [arguments]` - -## OPTIONS - -- [--activity-id](/cmd-options/activity-id) - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--detail](/cmd-options/detail) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--identity](/cmd-options/identity) - -- [--namespace](/cmd-options/namespace) - -- [--reason](/cmd-options/reason) - -- [--run-id](/cmd-options/run-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--workflow-id](/cmd-options/workflow-id) - diff --git a/docs/activity/index.md b/docs/activity/index.md deleted file mode 100644 index 71eda627..00000000 --- a/docs/activity/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: index -title: temporal activity -sidebar_label: activity -description: Operations that can be performed on Workflow Activities. -tags: - - cli ---- - - diff --git a/docs/batch/describe.md b/docs/batch/describe.md deleted file mode 100644 index 48ee6432..00000000 --- a/docs/batch/describe.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -id: describe -title: temporal batch describe -sidebar_label: describe -description: Describe a Batch operation job. -tags: - - cli ---- - - -The `temporal batch describe` command shows the progress of an ongoing Batch job. - -Use the command options listed below to change the information returned by this command. -Make sure to write the command in this format: -`temporal batch describe [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--fields](/cmd-options/fields) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--job-id](/cmd-options/job-id) - -- [--namespace](/cmd-options/namespace) - -- [--output](/cmd-options/output) - -- [--time-format](/cmd-options/time-format) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/batch/index.md b/docs/batch/index.md deleted file mode 100644 index d7f304d8..00000000 --- a/docs/batch/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: index -title: temporal batch -sidebar_label: batch -description: Operations performed on Batch jobs. -tags: - - cli ---- - - -Batch commands allow you to change multiple [Workflow Executions](/workflows#workflow-execution) without having to repeat yourself on the command line. -In order to do this, you provide the command with a [List Filter](/visibility#list-filter) and the type of Batch job to execute. - -The List Filter identifies the Workflow Executions that will be affected by the Batch job. -The Batch type determines the other parameters that need to be provided, along with what is being affected on the Workflow Executions. - -To start the Batch job, run `temporal workflow query`. -A successfully started Batch job will return a Job ID. -Use this Job ID to execute other actions on the Batch job. - diff --git a/docs/batch/list.md b/docs/batch/list.md deleted file mode 100644 index 765f89a2..00000000 --- a/docs/batch/list.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: list -title: temporal batch list -sidebar_label: list -description: List Batch operation jobs. -tags: - - cli ---- - - -When used, `temporal batch list` returns all Batch jobs. - -Use the command options listed below to change the information returned by this command. -Make sure to write the command in this format: -`temporal batch list [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--fields](/cmd-options/fields) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--limit](/cmd-options/limit) - -- [--namespace](/cmd-options/namespace) - -- [--no-pager](/cmd-options/no-pager) - -- [--output](/cmd-options/output) - -- [--pager](/cmd-options/pager) -Options: less, more, favoritePager. - -- [--time-format](/cmd-options/time-format) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/batch/terminate.md b/docs/batch/terminate.md deleted file mode 100644 index a28def9c..00000000 --- a/docs/batch/terminate.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: terminate -title: temporal batch terminate -sidebar_label: terminate -description: Stop a Batch operation job. -tags: - - cli ---- - - -The `temporal batch terminate` command terminates a Batch job with the provided Job ID. - -Use the command options listed below to change the behavior of this command. -Make sure to write the command as follows: -`temporal batch terminate [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--job-id](/cmd-options/job-id) - -- [--namespace](/cmd-options/namespace) - -- [--reason](/cmd-options/reason) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/cmd-options/active-cluster.md b/docs/cmd-options/active-cluster.md deleted file mode 100644 index 3a88c934..00000000 --- a/docs/cmd-options/active-cluster.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: active-cluster -title: temporal active-cluster -sidebar_label: active-cluster -description: Definition for the active-cluster command option. -tags: - - cli ---- - -Active cluster name diff --git a/docs/cmd-options/activity-id.md b/docs/cmd-options/activity-id.md deleted file mode 100644 index 89736348..00000000 --- a/docs/cmd-options/activity-id.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: activity-id -title: temporal activity-id -sidebar_label: activity-id -description: Definition for the activity-id command option. -tags: - - cli ---- - -Identifies the Activity to fail. diff --git a/docs/cmd-options/address.md b/docs/cmd-options/address.md deleted file mode 100644 index 34143a31..00000000 --- a/docs/cmd-options/address.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: address -title: temporal address -sidebar_label: address -description: Definition for the address command option. -tags: - - cli ---- - -The host and port (formatted as host:port) for the Temporal Frontend Service. diff --git a/docs/cmd-options/archived.md b/docs/cmd-options/archived.md deleted file mode 100644 index 1034198a..00000000 --- a/docs/cmd-options/archived.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: archived -title: temporal archived -sidebar_label: archived -description: Definition for the archived command option. -tags: - - cli ---- - -List archived Workflow Executions. diff --git a/docs/cmd-options/calendar.md b/docs/cmd-options/calendar.md deleted file mode 100644 index aad47b5e..00000000 --- a/docs/cmd-options/calendar.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: calendar -title: temporal calendar -sidebar_label: calendar -description: Definition for the calendar command option. -tags: - - cli ---- - -Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"} diff --git a/docs/cmd-options/catchup-window.md b/docs/cmd-options/catchup-window.md deleted file mode 100644 index d012ce9d..00000000 --- a/docs/cmd-options/catchup-window.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: catchup-window -title: temporal catchup-window -sidebar_label: catchup-window -description: Definition for the catchup-window command option. -tags: - - cli ---- - -Maximum allowed catch-up time if server is down. diff --git a/docs/cmd-options/cluster.md b/docs/cmd-options/cluster.md deleted file mode 100644 index 80a9e107..00000000 --- a/docs/cmd-options/cluster.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: cluster -title: temporal cluster -sidebar_label: cluster -description: Definition for the cluster command option. -tags: - - cli ---- - -Cluster name diff --git a/docs/cmd-options/codec-auth.md b/docs/cmd-options/codec-auth.md deleted file mode 100644 index ac07a1ef..00000000 --- a/docs/cmd-options/codec-auth.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: codec-auth -title: temporal codec-auth -sidebar_label: codec-auth -description: Definition for the codec-auth command option. -tags: - - cli ---- - -Sets the authorization header on requests to the Codec Server. diff --git a/docs/cmd-options/codec-endpoint.md b/docs/cmd-options/codec-endpoint.md deleted file mode 100644 index 07c9d9bd..00000000 --- a/docs/cmd-options/codec-endpoint.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: codec-endpoint -title: temporal codec-endpoint -sidebar_label: codec-endpoint -description: Definition for the codec-endpoint command option. -tags: - - cli ---- - -Endpoint for a remote Codec Server. diff --git a/docs/cmd-options/color.md b/docs/cmd-options/color.md deleted file mode 100644 index 1f3ce3d1..00000000 --- a/docs/cmd-options/color.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: color -title: temporal color -sidebar_label: color -description: Definition for the color command option. -tags: - - cli ---- - -when to use color: auto, always, never. (default: auto) diff --git a/docs/cmd-options/concurrency.md b/docs/cmd-options/concurrency.md deleted file mode 100644 index 27b7e9e4..00000000 --- a/docs/cmd-options/concurrency.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: concurrency -title: temporal concurrency -sidebar_label: concurrency -description: Definition for the concurrency command option. -tags: - - cli ---- - -Request concurrency (default: 10) diff --git a/docs/cmd-options/config.md b/docs/cmd-options/config.md deleted file mode 100644 index 7ed04290..00000000 --- a/docs/cmd-options/config.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: config -title: temporal config -sidebar_label: config -description: Definition for the config command option. -tags: - - cli ---- - -Alias: **-c** -Path to config directory. diff --git a/docs/cmd-options/context-timeout.md b/docs/cmd-options/context-timeout.md deleted file mode 100644 index 1b949cf4..00000000 --- a/docs/cmd-options/context-timeout.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: context-timeout -title: temporal context-timeout -sidebar_label: context-timeout -description: Definition for the context-timeout command option. -tags: - - cli ---- - -An optional timeout for the context of an RPC call (in seconds). (default: 5) diff --git a/docs/cmd-options/cron.md b/docs/cmd-options/cron.md deleted file mode 100644 index d12ad640..00000000 --- a/docs/cmd-options/cron.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: cron -title: temporal cron -sidebar_label: cron -description: Definition for the cron command option. -tags: - - cli ---- - -Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily". diff --git a/docs/cmd-options/data.md b/docs/cmd-options/data.md deleted file mode 100644 index 875b2a1c..00000000 --- a/docs/cmd-options/data.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: data -title: temporal data -sidebar_label: data -description: Definition for the data command option. -tags: - - cli ---- - -Namespace data in a format key=value diff --git a/docs/cmd-options/db-filename.md b/docs/cmd-options/db-filename.md deleted file mode 100644 index a0dfbe6b..00000000 --- a/docs/cmd-options/db-filename.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: db-filename -title: temporal db-filename -sidebar_label: db-filename -description: Definition for the db-filename command option. -tags: - - cli ---- - -Alias: **-f** -File in which to persist Temporal state (by default, Workflows are lost when the process dies). diff --git a/docs/cmd-options/depth.md b/docs/cmd-options/depth.md deleted file mode 100644 index f8d37cb3..00000000 --- a/docs/cmd-options/depth.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: depth -title: temporal depth -sidebar_label: depth -description: Definition for the depth command option. -tags: - - cli ---- - -Number of Child Workflows to expand, -1 to expand all Child Workflows. (default: -1) diff --git a/docs/cmd-options/description.md b/docs/cmd-options/description.md deleted file mode 100644 index edc4361c..00000000 --- a/docs/cmd-options/description.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: description -title: temporal description -sidebar_label: description -description: Definition for the description command option. -tags: - - cli ---- - -Namespace description diff --git a/docs/cmd-options/detail.md b/docs/cmd-options/detail.md deleted file mode 100644 index e915758f..00000000 --- a/docs/cmd-options/detail.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: detail -title: temporal detail -sidebar_label: detail -description: Definition for the detail command option. -tags: - - cli ---- - -Detail to fail the Activity. diff --git a/docs/cmd-options/dry-run.md b/docs/cmd-options/dry-run.md deleted file mode 100644 index 70965d77..00000000 --- a/docs/cmd-options/dry-run.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: dry-run -title: temporal dry-run -sidebar_label: dry-run -description: Definition for the dry-run command option. -tags: - - cli ---- - -Simulate reset without resetting any Workflow Executions. diff --git a/docs/cmd-options/dynamic-config-value.md b/docs/cmd-options/dynamic-config-value.md deleted file mode 100644 index ed97214f..00000000 --- a/docs/cmd-options/dynamic-config-value.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: dynamic-config-value -title: temporal dynamic-config-value -sidebar_label: dynamic-config-value -description: Definition for the dynamic-config-value command option. -tags: - - cli ---- - -Dynamic config value, as KEY=JSON_VALUE (string values need quotes). diff --git a/docs/cmd-options/email.md b/docs/cmd-options/email.md deleted file mode 100644 index 912dd967..00000000 --- a/docs/cmd-options/email.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: email -title: temporal email -sidebar_label: email -description: Definition for the email command option. -tags: - - cli ---- - -Owner email diff --git a/docs/cmd-options/enable-connection.md b/docs/cmd-options/enable-connection.md deleted file mode 100644 index cde3e2ea..00000000 --- a/docs/cmd-options/enable-connection.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: enable-connection -title: temporal enable-connection -sidebar_label: enable-connection -description: Definition for the enable-connection command option. -tags: - - cli ---- - -Enable cross-cluster connection. diff --git a/docs/cmd-options/end-time.md b/docs/cmd-options/end-time.md deleted file mode 100644 index 7c485608..00000000 --- a/docs/cmd-options/end-time.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: end-time -title: temporal end-time -sidebar_label: end-time -description: Definition for the end-time command option. -tags: - - cli ---- - -Backfill end time. diff --git a/docs/cmd-options/env.md b/docs/cmd-options/env.md deleted file mode 100644 index a516abc2..00000000 --- a/docs/cmd-options/env.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: env -title: temporal env -sidebar_label: env -description: Definition for the env command option. -tags: - - cli ---- - -Name of the environment to read environmental variables from. (default: default) diff --git a/docs/cmd-options/event-id.md b/docs/cmd-options/event-id.md deleted file mode 100644 index 3afdb245..00000000 --- a/docs/cmd-options/event-id.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: event-id -title: temporal event-id -sidebar_label: event-id -description: Definition for the event-id command option. -tags: - - cli ---- - -The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others. diff --git a/docs/cmd-options/exclude-file.md b/docs/cmd-options/exclude-file.md deleted file mode 100644 index 28e189f7..00000000 --- a/docs/cmd-options/exclude-file.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: exclude-file -title: temporal exclude-file -sidebar_label: exclude-file -description: Definition for the exclude-file command option. -tags: - - cli ---- - -Input file that specifies Workflow Executions to exclude from resetting. diff --git a/docs/cmd-options/execution-timeout.md b/docs/cmd-options/execution-timeout.md deleted file mode 100644 index 8c04fa2b..00000000 --- a/docs/cmd-options/execution-timeout.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: execution-timeout -title: temporal execution-timeout -sidebar_label: execution-timeout -description: Definition for the execution-timeout command option. -tags: - - cli ---- - -Timeout (in seconds) for a WorkflowExecution, including retries and continue-as-new tasks. (default: 0) diff --git a/docs/cmd-options/fields.md b/docs/cmd-options/fields.md deleted file mode 100644 index 11ff75af..00000000 --- a/docs/cmd-options/fields.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: fields -title: temporal fields -sidebar_label: fields -description: Definition for the fields command option. -tags: - - cli ---- - -Customize fields to print. Set to 'long' to automatically print more of main fields. diff --git a/docs/cmd-options/fold.md b/docs/cmd-options/fold.md deleted file mode 100644 index ccf62b10..00000000 --- a/docs/cmd-options/fold.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: fold -title: temporal fold -sidebar_label: fold -description: Definition for the fold command option. -tags: - - cli ---- - -Statuses for which Child Workflows will be folded in (this will reduce the number of information fetched and displayed). Case-insensitive and ignored if --no-fold supplied. (default: completed,canceled,terminated) diff --git a/docs/cmd-options/follow.md b/docs/cmd-options/follow.md deleted file mode 100644 index 23c08de6..00000000 --- a/docs/cmd-options/follow.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: follow -title: temporal follow -sidebar_label: follow -description: Definition for the follow command option. -tags: - - cli ---- - -Alias: **-f**: Follow the progress of a Workflow Execution. -Follow the progress of a Workflow Execution. diff --git a/docs/cmd-options/frontend-address.md b/docs/cmd-options/frontend-address.md deleted file mode 100644 index da34c3a3..00000000 --- a/docs/cmd-options/frontend-address.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: frontend-address -title: temporal frontend-address -sidebar_label: frontend-address -description: Definition for the frontend-address command option. -tags: - - cli ---- - -Frontend address of the remote Cluster. diff --git a/docs/cmd-options/global.md b/docs/cmd-options/global.md deleted file mode 100644 index d11a06df..00000000 --- a/docs/cmd-options/global.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: global -title: temporal global -sidebar_label: global -description: Definition for the global command option. -tags: - - cli ---- - -Flag to indicate whether namespace is a global namespace diff --git a/docs/cmd-options/grpc-meta.md b/docs/cmd-options/grpc-meta.md deleted file mode 100644 index 63ad80c5..00000000 --- a/docs/cmd-options/grpc-meta.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: grpc-meta -title: temporal grpc-meta -sidebar_label: grpc-meta -description: Definition for the grpc-meta command option. -tags: - - cli ---- - -Contains gRPC metadata to send with requests (Format: key=value). Values must be in a valid JSON format. diff --git a/docs/cmd-options/headless.md b/docs/cmd-options/headless.md deleted file mode 100644 index bb99fed0..00000000 --- a/docs/cmd-options/headless.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: headless -title: temporal headless -sidebar_label: headless -description: Definition for the headless command option. -tags: - - cli ---- - -Disable the Web UI. diff --git a/docs/cmd-options/history-archival-state.md b/docs/cmd-options/history-archival-state.md deleted file mode 100644 index 335e0263..00000000 --- a/docs/cmd-options/history-archival-state.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: history-archival-state -title: temporal history-archival-state -sidebar_label: history-archival-state -description: Definition for the history-archival-state command option. -tags: - - cli ---- - -Flag to set history archival state, valid values are "disabled" and "enabled" diff --git a/docs/cmd-options/history-uri.md b/docs/cmd-options/history-uri.md deleted file mode 100644 index 1628a842..00000000 --- a/docs/cmd-options/history-uri.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: history-uri -title: temporal history-uri -sidebar_label: history-uri -description: Definition for the history-uri command option. -tags: - - cli ---- - -Optionally specify history archival URI (cannot be changed after first time archival is enabled) diff --git a/docs/cmd-options/id-reuse-policy.md b/docs/cmd-options/id-reuse-policy.md deleted file mode 100644 index 66093404..00000000 --- a/docs/cmd-options/id-reuse-policy.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: id-reuse-policy -title: temporal id-reuse-policy -sidebar_label: id-reuse-policy -description: Definition for the id-reuse-policy command option. -tags: - - cli ---- - -Allows the same Workflow Id to be used in a new Workflow Execution. Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. diff --git a/docs/cmd-options/identity.md b/docs/cmd-options/identity.md deleted file mode 100644 index 445ea8f3..00000000 --- a/docs/cmd-options/identity.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: identity -title: temporal identity -sidebar_label: identity -description: Definition for the identity command option. -tags: - - cli ---- - -Specify the operator's identity. diff --git a/docs/cmd-options/input-file.md b/docs/cmd-options/input-file.md deleted file mode 100644 index 72c650d5..00000000 --- a/docs/cmd-options/input-file.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: input-file -title: temporal input-file -sidebar_label: input-file -description: Definition for the input-file command option. -tags: - - cli ---- - -Passes optional input for the Workflow from a JSON file. diff --git a/docs/cmd-options/input-parallelism.md b/docs/cmd-options/input-parallelism.md deleted file mode 100644 index 09a4ac39..00000000 --- a/docs/cmd-options/input-parallelism.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: input-parallelism -title: temporal input-parallelism -sidebar_label: input-parallelism -description: Definition for the input-parallelism command option. -tags: - - cli ---- - -Number of goroutines to run in parallel. Each goroutine processes one line for every second. (default: 1) diff --git a/docs/cmd-options/input-separator.md b/docs/cmd-options/input-separator.md deleted file mode 100644 index e1c6fa3c..00000000 --- a/docs/cmd-options/input-separator.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: input-separator -title: temporal input-separator -sidebar_label: input-separator -description: Definition for the input-separator command option. -tags: - - cli ---- - -Separator for the input file. The default is a tab ( ). (default: ) diff --git a/docs/cmd-options/input.md b/docs/cmd-options/input.md deleted file mode 100644 index fc71e3c4..00000000 --- a/docs/cmd-options/input.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: input -title: temporal input -sidebar_label: input -description: Definition for the input command option. -tags: - - cli ---- - -Alias: **-i** -Optional JSON input to provide to the Workflow. diff --git a/docs/cmd-options/interval.md b/docs/cmd-options/interval.md deleted file mode 100644 index d29c9d0b..00000000 --- a/docs/cmd-options/interval.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: interval -title: temporal interval -sidebar_label: interval -description: Definition for the interval command option. -tags: - - cli ---- - -Interval duration, e.g. 90m, or 90m/13m to include phase offset. diff --git a/docs/cmd-options/ip.md b/docs/cmd-options/ip.md deleted file mode 100644 index b175ef70..00000000 --- a/docs/cmd-options/ip.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: ip -title: temporal ip -sidebar_label: ip -description: Definition for the ip command option. -tags: - - cli ---- - -IPv4 address to bind the frontend service to. (default: 127.0.0.1) diff --git a/docs/cmd-options/jitter.md b/docs/cmd-options/jitter.md deleted file mode 100644 index 7d721268..00000000 --- a/docs/cmd-options/jitter.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: jitter -title: temporal jitter -sidebar_label: jitter -description: Definition for the jitter command option. -tags: - - cli ---- - -Jitter duration. diff --git a/docs/cmd-options/job-id.md b/docs/cmd-options/job-id.md deleted file mode 100644 index 8ccb649c..00000000 --- a/docs/cmd-options/job-id.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: job-id -title: temporal job-id -sidebar_label: job-id -description: Definition for the job-id command option. -tags: - - cli ---- - -Batch Job Id diff --git a/docs/cmd-options/limit.md b/docs/cmd-options/limit.md deleted file mode 100644 index 901e863a..00000000 --- a/docs/cmd-options/limit.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: limit -title: temporal limit -sidebar_label: limit -description: Definition for the limit command option. -tags: - - cli ---- - -Number of items to print. (default: 0) diff --git a/docs/cmd-options/log-format.md b/docs/cmd-options/log-format.md deleted file mode 100644 index b33f4ec4..00000000 --- a/docs/cmd-options/log-format.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: log-format -title: temporal log-format -sidebar_label: log-format -description: Definition for the log-format command option. -tags: - - cli ---- - -Set the log formatting. Options: ["json", "pretty"]. (default: json) diff --git a/docs/cmd-options/log-level.md b/docs/cmd-options/log-level.md deleted file mode 100644 index dff509e4..00000000 --- a/docs/cmd-options/log-level.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: log-level -title: temporal log-level -sidebar_label: log-level -description: Definition for the log-level command option. -tags: - - cli ---- - -Set the log level. Options: ["debug" "info" "warn" "error" "fatal"]. (default: info) diff --git a/docs/cmd-options/max-field-length.md b/docs/cmd-options/max-field-length.md deleted file mode 100644 index e33330ba..00000000 --- a/docs/cmd-options/max-field-length.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: max-field-length -title: temporal max-field-length -sidebar_label: max-field-length -description: Definition for the max-field-length command option. -tags: - - cli ---- - -Maximum length for each attribute field. (default: 0) diff --git a/docs/cmd-options/memo-file.md b/docs/cmd-options/memo-file.md deleted file mode 100644 index dcf4f389..00000000 --- a/docs/cmd-options/memo-file.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: memo-file -title: temporal memo-file -sidebar_label: memo-file -description: Definition for the memo-file command option. -tags: - - cli ---- - -Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value. diff --git a/docs/cmd-options/memo.md b/docs/cmd-options/memo.md deleted file mode 100644 index 7eb837fb..00000000 --- a/docs/cmd-options/memo.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: memo -title: temporal memo -sidebar_label: memo -description: Definition for the memo command option. -tags: - - cli ---- - -Set a memo on a schedule. Format: key=value. Use valid JSON formats for value. diff --git a/docs/cmd-options/metrics-port.md b/docs/cmd-options/metrics-port.md deleted file mode 100644 index e8d0b540..00000000 --- a/docs/cmd-options/metrics-port.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: metrics-port -title: temporal metrics-port -sidebar_label: metrics-port -description: Definition for the metrics-port command option. -tags: - - cli ---- - -Port for /metrics (default: 0) diff --git a/docs/cmd-options/name.md b/docs/cmd-options/name.md deleted file mode 100644 index 176f01ab..00000000 --- a/docs/cmd-options/name.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: name -title: temporal name -sidebar_label: name -description: Definition for the name command option. -tags: - - cli ---- - -Frontend address of the remote Cluster. diff --git a/docs/cmd-options/namespace-id.md b/docs/cmd-options/namespace-id.md deleted file mode 100644 index 8352431f..00000000 --- a/docs/cmd-options/namespace-id.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: namespace-id -title: temporal namespace-id -sidebar_label: namespace-id -description: Definition for the namespace-id command option. -tags: - - cli ---- - -Namespace Id diff --git a/docs/cmd-options/namespace.md b/docs/cmd-options/namespace.md deleted file mode 100644 index 84694b61..00000000 --- a/docs/cmd-options/namespace.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: namespace -title: temporal namespace -sidebar_label: namespace -description: Definition for the namespace command option. -tags: - - cli ---- - -Alias: **-n** -Identifies a Namespace in the Temporal Workflow. (default: default) diff --git a/docs/cmd-options/no-fold.md b/docs/cmd-options/no-fold.md deleted file mode 100644 index bdb270cf..00000000 --- a/docs/cmd-options/no-fold.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: no-fold -title: temporal no-fold -sidebar_label: no-fold -description: Definition for the no-fold command option. -tags: - - cli ---- - -Disable folding. All Child Workflows within the set depth will be fetched and displayed. diff --git a/docs/cmd-options/no-pager.md b/docs/cmd-options/no-pager.md deleted file mode 100644 index f2786a65..00000000 --- a/docs/cmd-options/no-pager.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: no-pager -title: temporal no-pager -sidebar_label: no-pager -description: Definition for the no-pager command option. -tags: - - cli ---- - -Alias: **-P**: Disables the interactive pager. -Disables the interactive pager. diff --git a/docs/cmd-options/non-deterministic.md b/docs/cmd-options/non-deterministic.md deleted file mode 100644 index 3169c212..00000000 --- a/docs/cmd-options/non-deterministic.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: non-deterministic -title: temporal non-deterministic -sidebar_label: non-deterministic -description: Definition for the non-deterministic command option. -tags: - - cli ---- - -Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error. diff --git a/docs/cmd-options/notes.md b/docs/cmd-options/notes.md deleted file mode 100644 index 933f042a..00000000 --- a/docs/cmd-options/notes.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: notes -title: temporal notes -sidebar_label: notes -description: Definition for the notes command option. -tags: - - cli ---- - -Initial value of notes field. diff --git a/docs/cmd-options/output-filename.md b/docs/cmd-options/output-filename.md deleted file mode 100644 index df704fc6..00000000 --- a/docs/cmd-options/output-filename.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: output-filename -title: temporal output-filename -sidebar_label: output-filename -description: Definition for the output-filename command option. -tags: - - cli ---- - -Serializes Event History to a file. diff --git a/docs/cmd-options/output.md b/docs/cmd-options/output.md deleted file mode 100644 index 2ea28045..00000000 --- a/docs/cmd-options/output.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: output -title: temporal output -sidebar_label: output -description: Definition for the output command option. -tags: - - cli ---- - -Alias: **-o** -format output as: table, json, card. (default: table) diff --git a/docs/cmd-options/overlap-policy.md b/docs/cmd-options/overlap-policy.md deleted file mode 100644 index 6feca798..00000000 --- a/docs/cmd-options/overlap-policy.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: overlap-policy -title: temporal overlap-policy -sidebar_label: overlap-policy -description: Definition for the overlap-policy command option. -tags: - - cli ---- - -Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. diff --git a/docs/cmd-options/pager.md b/docs/cmd-options/pager.md deleted file mode 100644 index 617f4a58..00000000 --- a/docs/cmd-options/pager.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: pager -title: temporal pager -sidebar_label: pager -description: Definition for the pager command option. -tags: - - cli ---- - -Sets the pager for Temporal CLI to use. diff --git a/docs/cmd-options/pause-on-failure.md b/docs/cmd-options/pause-on-failure.md deleted file mode 100644 index bb6cf2aa..00000000 --- a/docs/cmd-options/pause-on-failure.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: pause-on-failure -title: temporal pause-on-failure -sidebar_label: pause-on-failure -description: Definition for the pause-on-failure command option. -tags: - - cli ---- - -Pause schedule after any workflow failure. diff --git a/docs/cmd-options/pause.md b/docs/cmd-options/pause.md deleted file mode 100644 index d414dfd7..00000000 --- a/docs/cmd-options/pause.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: pause -title: temporal pause -sidebar_label: pause -description: Definition for the pause command option. -tags: - - cli ---- - -Pauses the schedule. diff --git a/docs/cmd-options/port.md b/docs/cmd-options/port.md deleted file mode 100644 index c6a3c14c..00000000 --- a/docs/cmd-options/port.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: port -title: temporal port -sidebar_label: port -description: Definition for the port command option. -tags: - - cli ---- - -Alias: **-p** -Port for the frontend gRPC service. (default: 7233) diff --git a/docs/cmd-options/promote-global.md b/docs/cmd-options/promote-global.md deleted file mode 100644 index 6bbf0029..00000000 --- a/docs/cmd-options/promote-global.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: promote-global -title: temporal promote-global -sidebar_label: promote-global -description: Definition for the promote-global command option. -tags: - - cli ---- - -Promote local namespace to global namespace diff --git a/docs/cmd-options/query.md b/docs/cmd-options/query.md deleted file mode 100644 index 22ca4b56..00000000 --- a/docs/cmd-options/query.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: query -title: temporal query -sidebar_label: query -description: Definition for the query command option. -tags: - - cli ---- - -Alias: **-q** -Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query. diff --git a/docs/cmd-options/raw.md b/docs/cmd-options/raw.md deleted file mode 100644 index 203348aa..00000000 --- a/docs/cmd-options/raw.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: raw -title: temporal raw -sidebar_label: raw -description: Definition for the raw command option. -tags: - - cli ---- - -Print raw data as json (prefer this over -o json for scripting). diff --git a/docs/cmd-options/reapply-type.md b/docs/cmd-options/reapply-type.md deleted file mode 100644 index 6cdc3223..00000000 --- a/docs/cmd-options/reapply-type.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: reapply-type -title: temporal reapply-type -sidebar_label: reapply-type -description: Definition for the reapply-type command option. -tags: - - cli ---- - -Event types to reapply after the reset point: , Signal, None. (default: All) diff --git a/docs/cmd-options/reason.md b/docs/cmd-options/reason.md deleted file mode 100644 index 07f01d30..00000000 --- a/docs/cmd-options/reason.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: reason -title: temporal reason -sidebar_label: reason -description: Definition for the reason command option. -tags: - - cli ---- - -Reason for the operation diff --git a/docs/cmd-options/reject-condition.md b/docs/cmd-options/reject-condition.md deleted file mode 100644 index b66bbc48..00000000 --- a/docs/cmd-options/reject-condition.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: reject-condition -title: temporal reject-condition -sidebar_label: reject-condition -description: Definition for the reject-condition command option. -tags: - - cli ---- - -Optional flag for rejecting Queries based on Workflow state. Valid values are "not_open" and "not_completed_cleanly". diff --git a/docs/cmd-options/remaining-actions.md b/docs/cmd-options/remaining-actions.md deleted file mode 100644 index 46731c9e..00000000 --- a/docs/cmd-options/remaining-actions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: remaining-actions -title: temporal remaining-actions -sidebar_label: remaining-actions -description: Definition for the remaining-actions command option. -tags: - - cli ---- - -Total number of actions allowed. (default: 0) diff --git a/docs/cmd-options/reset-points.md b/docs/cmd-options/reset-points.md deleted file mode 100644 index 86edc605..00000000 --- a/docs/cmd-options/reset-points.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: reset-points -title: temporal reset-points -sidebar_label: reset-points -description: Definition for the reset-points command option. -tags: - - cli ---- - -Only show Workflow Events that are eligible for reset. diff --git a/docs/cmd-options/result.md b/docs/cmd-options/result.md deleted file mode 100644 index 4efffc82..00000000 --- a/docs/cmd-options/result.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: result -title: temporal result -sidebar_label: result -description: Definition for the result command option. -tags: - - cli ---- - -Set the result value of Activity completion. diff --git a/docs/cmd-options/retention.md b/docs/cmd-options/retention.md deleted file mode 100644 index 02a6b106..00000000 --- a/docs/cmd-options/retention.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: retention -title: temporal retention -sidebar_label: retention -description: Definition for the retention command option. -tags: - - cli ---- - -Workflow Execution retention diff --git a/docs/cmd-options/run-id.md b/docs/cmd-options/run-id.md deleted file mode 100644 index 98c97fb4..00000000 --- a/docs/cmd-options/run-id.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: run-id -title: temporal run-id -sidebar_label: run-id -description: Definition for the run-id command option. -tags: - - cli ---- - -Alias: **-r** -Identifies the current Workflow Run. diff --git a/docs/cmd-options/run-timeout.md b/docs/cmd-options/run-timeout.md deleted file mode 100644 index 7fa90274..00000000 --- a/docs/cmd-options/run-timeout.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: run-timeout -title: temporal run-timeout -sidebar_label: run-timeout -description: Definition for the run-timeout command option. -tags: - - cli ---- - -Timeout (in seconds) of a single Workflow run. (default: 0) diff --git a/docs/cmd-options/schedule-id.md b/docs/cmd-options/schedule-id.md deleted file mode 100644 index 7b6612ca..00000000 --- a/docs/cmd-options/schedule-id.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: schedule-id -title: temporal schedule-id -sidebar_label: schedule-id -description: Definition for the schedule-id command option. -tags: - - cli ---- - -Alias: **-s** -Schedule Id diff --git a/docs/cmd-options/search-attribute.md b/docs/cmd-options/search-attribute.md deleted file mode 100644 index 4a371698..00000000 --- a/docs/cmd-options/search-attribute.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: search-attribute -title: temporal search-attribute -sidebar_label: search-attribute -description: Definition for the search-attribute command option. -tags: - - cli ---- - -Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value. diff --git a/docs/cmd-options/skip-base-is-not-current.md b/docs/cmd-options/skip-base-is-not-current.md deleted file mode 100644 index 50c1f8b2..00000000 --- a/docs/cmd-options/skip-base-is-not-current.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: skip-base-is-not-current -title: temporal skip-base-is-not-current -sidebar_label: skip-base-is-not-current -description: Definition for the skip-base-is-not-current command option. -tags: - - cli ---- - -Skip a Workflow Execution if the base Run is not the current Run. diff --git a/docs/cmd-options/skip-current-open.md b/docs/cmd-options/skip-current-open.md deleted file mode 100644 index de6a6264..00000000 --- a/docs/cmd-options/skip-current-open.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: skip-current-open -title: temporal skip-current-open -sidebar_label: skip-current-open -description: Definition for the skip-current-open command option. -tags: - - cli ---- - -Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run. diff --git a/docs/cmd-options/sqlite-pragma.md b/docs/cmd-options/sqlite-pragma.md deleted file mode 100644 index b17378a6..00000000 --- a/docs/cmd-options/sqlite-pragma.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: sqlite-pragma -title: temporal sqlite-pragma -sidebar_label: sqlite-pragma -description: Definition for the sqlite-pragma command option. -tags: - - cli ---- - -Specify sqlite pragma statements in pragma=value format. Pragma options: ["journal_mode" "synchronous"]. diff --git a/docs/cmd-options/start-time.md b/docs/cmd-options/start-time.md deleted file mode 100644 index 07a2b6e2..00000000 --- a/docs/cmd-options/start-time.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: start-time -title: temporal start-time -sidebar_label: start-time -description: Definition for the start-time command option. -tags: - - cli ---- - -Backfill start time. diff --git a/docs/cmd-options/task-queue-type.md b/docs/cmd-options/task-queue-type.md deleted file mode 100644 index 3305062b..00000000 --- a/docs/cmd-options/task-queue-type.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: task-queue-type -title: temporal task-queue-type -sidebar_label: task-queue-type -description: Definition for the task-queue-type command option. -tags: - - cli ---- - -Task Queue type [workflow|activity] (default: workflow) diff --git a/docs/cmd-options/task-queue.md b/docs/cmd-options/task-queue.md deleted file mode 100644 index 6361f00c..00000000 --- a/docs/cmd-options/task-queue.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: task-queue -title: temporal task-queue -sidebar_label: task-queue -description: Definition for the task-queue command option. -tags: - - cli ---- - -Alias: **-t** -Task Queue diff --git a/docs/cmd-options/task-timeout.md b/docs/cmd-options/task-timeout.md deleted file mode 100644 index d026b53f..00000000 --- a/docs/cmd-options/task-timeout.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: task-timeout -title: temporal task-timeout -sidebar_label: task-timeout -description: Definition for the task-timeout command option. -tags: - - cli ---- - -Start-to-close timeout for a Workflow Task (in seconds). (default: 10) diff --git a/docs/cmd-options/time-format.md b/docs/cmd-options/time-format.md deleted file mode 100644 index fbe26cf9..00000000 --- a/docs/cmd-options/time-format.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: time-format -title: temporal time-format -sidebar_label: time-format -description: Definition for the time-format command option. -tags: - - cli ---- - -Format time as: relative, iso, raw. (default: relative) diff --git a/docs/cmd-options/time-zone.md b/docs/cmd-options/time-zone.md deleted file mode 100644 index a47e988c..00000000 --- a/docs/cmd-options/time-zone.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: time-zone -title: temporal time-zone -sidebar_label: time-zone -description: Definition for the time-zone command option. -tags: - - cli ---- - -Time zone (IANA name). diff --git a/docs/cmd-options/tls-ca-path.md b/docs/cmd-options/tls-ca-path.md deleted file mode 100644 index e2181a68..00000000 --- a/docs/cmd-options/tls-ca-path.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: tls-ca-path -title: temporal tls-ca-path -sidebar_label: tls-ca-path -description: Definition for the tls-ca-path command option. -tags: - - cli ---- - -Path to server CA certificate. diff --git a/docs/cmd-options/tls-cert-path.md b/docs/cmd-options/tls-cert-path.md deleted file mode 100644 index af74b767..00000000 --- a/docs/cmd-options/tls-cert-path.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: tls-cert-path -title: temporal tls-cert-path -sidebar_label: tls-cert-path -description: Definition for the tls-cert-path command option. -tags: - - cli ---- - -Path to x509 certificate. diff --git a/docs/cmd-options/tls-disable-host-verification.md b/docs/cmd-options/tls-disable-host-verification.md deleted file mode 100644 index b4993641..00000000 --- a/docs/cmd-options/tls-disable-host-verification.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: tls-disable-host-verification -title: temporal tls-disable-host-verification -sidebar_label: tls-disable-host-verification -description: Definition for the tls-disable-host-verification command option. -tags: - - cli ---- - -Disables TLS host name verification if already enabled. diff --git a/docs/cmd-options/tls-key-path.md b/docs/cmd-options/tls-key-path.md deleted file mode 100644 index 36a6603a..00000000 --- a/docs/cmd-options/tls-key-path.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: tls-key-path -title: temporal tls-key-path -sidebar_label: tls-key-path -description: Definition for the tls-key-path command option. -tags: - - cli ---- - -Path to private certificate key. diff --git a/docs/cmd-options/tls-server-name.md b/docs/cmd-options/tls-server-name.md deleted file mode 100644 index 92e8b161..00000000 --- a/docs/cmd-options/tls-server-name.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: tls-server-name -title: temporal tls-server-name -sidebar_label: tls-server-name -description: Definition for the tls-server-name command option. -tags: - - cli ---- - -Provides an override for the target TLS server name. diff --git a/docs/cmd-options/type.md b/docs/cmd-options/type.md deleted file mode 100644 index cac22915..00000000 --- a/docs/cmd-options/type.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: type -title: temporal type -sidebar_label: type -description: Definition for the type command option. -tags: - - cli ---- - -Search attribute type: [Text Keyword Int Double Bool Datetime KeywordList] diff --git a/docs/cmd-options/ui-asset-path.md b/docs/cmd-options/ui-asset-path.md deleted file mode 100644 index e05c8789..00000000 --- a/docs/cmd-options/ui-asset-path.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: ui-asset-path -title: temporal ui-asset-path -sidebar_label: ui-asset-path -description: Definition for the ui-asset-path command option. -tags: - - cli ---- - -UI Custom Assets path. diff --git a/docs/cmd-options/ui-codec-endpoint.md b/docs/cmd-options/ui-codec-endpoint.md deleted file mode 100644 index 0770bc0d..00000000 --- a/docs/cmd-options/ui-codec-endpoint.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: ui-codec-endpoint -title: temporal ui-codec-endpoint -sidebar_label: ui-codec-endpoint -description: Definition for the ui-codec-endpoint command option. -tags: - - cli ---- - -UI Remote data converter HTTP endpoint. diff --git a/docs/cmd-options/ui-ip.md b/docs/cmd-options/ui-ip.md deleted file mode 100644 index 4e569da0..00000000 --- a/docs/cmd-options/ui-ip.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: ui-ip -title: temporal ui-ip -sidebar_label: ui-ip -description: Definition for the ui-ip command option. -tags: - - cli ---- - -IPv4 address to bind the Web UI to. diff --git a/docs/cmd-options/ui-port.md b/docs/cmd-options/ui-port.md deleted file mode 100644 index 24098cc8..00000000 --- a/docs/cmd-options/ui-port.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: ui-port -title: temporal ui-port -sidebar_label: ui-port -description: Definition for the ui-port command option. -tags: - - cli ---- - -Port for the Web UI. (default: 0) diff --git a/docs/cmd-options/unpause.md b/docs/cmd-options/unpause.md deleted file mode 100644 index ef3ae044..00000000 --- a/docs/cmd-options/unpause.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: unpause -title: temporal unpause -sidebar_label: unpause -description: Definition for the unpause command option. -tags: - - cli ---- - -Unpauses the schedule. diff --git a/docs/cmd-options/visibility-archival-state.md b/docs/cmd-options/visibility-archival-state.md deleted file mode 100644 index e1ba9e11..00000000 --- a/docs/cmd-options/visibility-archival-state.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: visibility-archival-state -title: temporal visibility-archival-state -sidebar_label: visibility-archival-state -description: Definition for the visibility-archival-state command option. -tags: - - cli ---- - -Flag to set visibility archival state, valid values are "disabled" and "enabled" diff --git a/docs/cmd-options/visibility-uri.md b/docs/cmd-options/visibility-uri.md deleted file mode 100644 index 58d58818..00000000 --- a/docs/cmd-options/visibility-uri.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: visibility-uri -title: temporal visibility-uri -sidebar_label: visibility-uri -description: Definition for the visibility-uri command option. -tags: - - cli ---- - -Optionally specify visibility archival URI (cannot be changed after first time archival is enabled) diff --git a/docs/cmd-options/workflow-id.md b/docs/cmd-options/workflow-id.md deleted file mode 100644 index 6bec5098..00000000 --- a/docs/cmd-options/workflow-id.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: workflow-id -title: temporal workflow-id -sidebar_label: workflow-id -description: Definition for the workflow-id command option. -tags: - - cli ---- - -Alias: **-w** -Workflow Id diff --git a/docs/cmd-options/workflow-type.md b/docs/cmd-options/workflow-type.md deleted file mode 100644 index f2711154..00000000 --- a/docs/cmd-options/workflow-type.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: workflow-type -title: temporal workflow-type -sidebar_label: workflow-type -description: Definition for the workflow-type command option. -tags: - - cli ---- - -Workflow type name. diff --git a/docs/cmd-options/yes.md b/docs/cmd-options/yes.md deleted file mode 100644 index 700fa779..00000000 --- a/docs/cmd-options/yes.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: yes -title: temporal yes -sidebar_label: yes -description: Definition for the yes command option. -tags: - - cli ---- - -Alias: **-y**: Confirm all prompts. -Confirm all prompts. diff --git a/docs/completion/bash.md b/docs/completion/bash.md deleted file mode 100644 index 4ee68031..00000000 --- a/docs/completion/bash.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: bash -title: temporal completion bash -sidebar_label: bash -description: bash completion output -tags: - - cli ---- - - -source <(temporal completion bash) - diff --git a/docs/completion/index.md b/docs/completion/index.md deleted file mode 100644 index 3bc2668a..00000000 --- a/docs/completion/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: index -title: temporal completion -sidebar_label: completion -description: Output shell completion code for the specified shell (zsh, bash). -tags: - - cli ---- - - diff --git a/docs/completion/zsh.md b/docs/completion/zsh.md deleted file mode 100644 index 4ecb6224..00000000 --- a/docs/completion/zsh.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: zsh -title: temporal completion zsh -sidebar_label: zsh -description: zsh completion output -tags: - - cli ---- - - -source <(temporal completion zsh) diff --git a/docs/env/delete.md b/docs/env/delete.md deleted file mode 100644 index 01f71f19..00000000 --- a/docs/env/delete.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -id: delete -title: temporal env delete -sidebar_label: delete -description: Delete an environment or environmental property. -tags: - - cli ---- - - -The `temporal env delete` command deletes a given environment or environmental property. - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal env delete [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/env/get.md b/docs/env/get.md deleted file mode 100644 index 38fd0dee..00000000 --- a/docs/env/get.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -id: get -title: temporal env get -sidebar_label: get -description: Prints environmental properties. -tags: - - cli ---- - - -The `temporal env get` command prints the environmental properties for the environment in use. - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal env get [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/env/index.md b/docs/env/index.md deleted file mode 100644 index 55b3cb66..00000000 --- a/docs/env/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: index -title: temporal env -sidebar_label: env -description: Manage environmental configurations on Temporal Client. -tags: - - cli ---- - - diff --git a/docs/env/set.md b/docs/env/set.md deleted file mode 100644 index 1812bf7a..00000000 --- a/docs/env/set.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -id: set -title: temporal env set -sidebar_label: set -description: Set environmental properties. -tags: - - cli ---- - - -The `temporal env set` command sets the value for an environmental property. - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal env set [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/operator/cluster/describe.md b/docs/operator/cluster/describe.md deleted file mode 100644 index c04365ff..00000000 --- a/docs/operator/cluster/describe.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: describe -title: temporal operator describe -sidebar_label: describe -description: Show information about the Cluster. -tags: - - cli ---- - ---- -id: cluster -title: temporal operator cluster -sidebar_label: cluster -description: The `temporal operator cluster describe` command shows information about the [Cluster](/clusters). -tags: - - cli ---- - - -Use the options listed below to change the output of this command. -Make sure to write the command as follows: -`temporal operator cluster describe [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--fields](/cmd-options/fields) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--output](/cmd-options/output) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/operator/cluster/health.md b/docs/operator/cluster/health.md deleted file mode 100644 index 62c6d451..00000000 --- a/docs/operator/cluster/health.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: health -title: temporal operator health -sidebar_label: health -description: Checks the health of the Frontend Service. -tags: - - cli ---- - ---- -id: cluster -title: temporal operator cluster -sidebar_label: cluster -description: The `temporal operator cluster health` command checks the health of the [Frontend Service](/clusters#frontend-service). -tags: - - cli ---- - - -Use the options listed below to change the behavior and output of this command. -Make sure to write the command as follows: -`temporal operator cluster health [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/operator/cluster/index.md b/docs/operator/cluster/index.md deleted file mode 100644 index 6780481e..00000000 --- a/docs/operator/cluster/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: index -title: temporal operator -sidebar_label: operator -description: Operations for running a Temporal Cluster. -tags: - - cli ---- - - diff --git a/docs/operator/cluster/list.md b/docs/operator/cluster/list.md deleted file mode 100644 index 6edc31fd..00000000 --- a/docs/operator/cluster/list.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: list -title: temporal operator list -sidebar_label: list -description: List all remote Clusters. -tags: - - cli ---- - ---- -id: cluster -title: temporal operator cluster -sidebar_label: cluster -description: The `temporal operator cluster list` command prints a list of all remote [Clusters](/clusters) on the system. -tags: - - cli ---- - - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal operator cluster list [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--fields](/cmd-options/fields) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--limit](/cmd-options/limit) - -- [--namespace](/cmd-options/namespace) - -- [--no-pager](/cmd-options/no-pager) - -- [--output](/cmd-options/output) - -- [--pager](/cmd-options/pager) -Options: less, more, favoritePager. - -- [--time-format](/cmd-options/time-format) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/operator/cluster/remove.md b/docs/operator/cluster/remove.md deleted file mode 100644 index 4a65a501..00000000 --- a/docs/operator/cluster/remove.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: remove -title: temporal operator remove -sidebar_label: remove -description: Remove a remote Cluster. -tags: - - cli ---- - ---- -id: cluster -title: temporal operator cluster -sidebar_label: cluster -description: The `temporal operator cluster remove` command removes a remote [Cluster](/clusters) from the system. -tags: - - cli ---- - - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal operator cluster remove [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--name](/cmd-options/name) - -- [--namespace](/cmd-options/namespace) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/operator/cluster/system.md b/docs/operator/cluster/system.md deleted file mode 100644 index e4d90bfa..00000000 --- a/docs/operator/cluster/system.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: system -title: temporal operator system -sidebar_label: system -description: Shows information about the system and its capabilities. -tags: - - cli ---- - ---- -id: cluster -title: temporal operator cluster -sidebar_label: cluster -description: The `temporal operator cluster system` command provides information about the system the Cluster is running on. -tags: - - cli ---- - - -Use the options listed below to change this command's output. -Make sure to write the command as follows: -`temporal operator cluster system [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--fields](/cmd-options/fields) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--output](/cmd-options/output) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/operator/cluster/upsert.md b/docs/operator/cluster/upsert.md deleted file mode 100644 index 075592bf..00000000 --- a/docs/operator/cluster/upsert.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: upsert -title: temporal operator upsert -sidebar_label: upsert -description: Add or update a remote Cluster. -tags: - - cli ---- - ---- -id: cluster -title: temporal operator cluster -sidebar_label: cluster -description: The `temporal operator cluster upsert` command allows the user to add or update a remote [Cluster](/clusters). -tags: - - cli ---- - - -Use the options listed below to change the behavior of this command. -Make sure to write the command as follows: -`temporal operator cluster upsert [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--enable-connection](/cmd-options/enable-connection) - -- [--env](/cmd-options/env) - -- [--frontend-address](/cmd-options/frontend-address) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/operator/index.md b/docs/operator/index.md deleted file mode 100644 index 6d8ca513..00000000 --- a/docs/operator/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: index -title: temporal operator -sidebar_label: operator -description: Operations performed on the Temporal Server. -tags: - - cli ---- - - -Operator commands enable actions on [Namespaces](/namespaces), [Search Attributes](/visibility#search-attribute), and [Temporal Clusters](/clusters). -These actions are performed through subcommands for each Operator area. - -To run an Operator command, run `temporal operator [command] [subcommand] [command options] [arguments]`. - diff --git a/docs/operator/namespace/create.md b/docs/operator/namespace/create.md deleted file mode 100644 index bb1e1af0..00000000 --- a/docs/operator/namespace/create.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -id: create -title: temporal operator create -sidebar_label: create -description: Register a new Namespace -tags: - - cli ---- - ---- -id: namespace -title: temporal operator namespace -sidebar_label: namespace -description: The `temporal operator namespace create` command creates a new [Namespace](/namespaces). -tags: - - cli ---- - - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal operator namespace create [command options] [arguments]` - -## OPTIONS - -- [--active-cluster](/cmd-options/active-cluster) - -- [--address](/cmd-options/address) - -- [--cluster](/cmd-options/cluster) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--data](/cmd-options/data) - -- [--description](/cmd-options/description) - -- [--email](/cmd-options/email) - -- [--env](/cmd-options/env) - -- [--global](/cmd-options/global) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--history-archival-state](/cmd-options/history-archival-state) - -- [--history-uri](/cmd-options/history-uri) - -- [--namespace](/cmd-options/namespace) - -- [--retention](/cmd-options/retention) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--visibility-archival-state](/cmd-options/visibility-archival-state) - -- [--visibility-uri](/cmd-options/visibility-uri) - diff --git a/docs/operator/namespace/delete.md b/docs/operator/namespace/delete.md deleted file mode 100644 index 79294bd1..00000000 --- a/docs/operator/namespace/delete.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: delete -title: temporal operator delete -sidebar_label: delete -description: Deletes an existing Namespace. -tags: - - cli ---- - ---- -id: namespace -title: temporal operator namespace -sidebar_label: namespace -description: The `temporal operator namespace delete` command deletes a given [Namespace](/namespaces) from the system. -tags: - - cli ---- - - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal operator namespace delete [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--yes](/cmd-options/yes) - diff --git a/docs/operator/namespace/describe.md b/docs/operator/namespace/describe.md deleted file mode 100644 index 355c4bc4..00000000 --- a/docs/operator/namespace/describe.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: describe -title: temporal operator describe -sidebar_label: describe -description: Describe a Namespace by its name or Id. -tags: - - cli ---- - ---- -id: namespace -title: temporal operator namespace -sidebar_label: namespace -description: The `temporal operator namespace describe` command provides a description of a [Namespace](/namespaces). -tags: - - cli ---- - -Namespaces can be identified by name or Namespace ID. - -Use the options listed below to change the command's output. -Make sure to write the command as follows: -`temporal operator namespace describe [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--namespace-id](/cmd-options/namespace-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/operator/namespace/index.md b/docs/operator/namespace/index.md deleted file mode 100644 index 208da637..00000000 --- a/docs/operator/namespace/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: index -title: temporal operator -sidebar_label: operator -description: Operations applying to Namespaces. -tags: - - cli ---- - - diff --git a/docs/operator/namespace/list.md b/docs/operator/namespace/list.md deleted file mode 100644 index 5436997a..00000000 --- a/docs/operator/namespace/list.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: list -title: temporal operator list -sidebar_label: list -description: List all Namespaces. -tags: - - cli ---- - ---- -id: namespace -title: temporal operator namespace -sidebar_label: namespace -description: The `temporal operator namespace list` command lists all [Namespaces](/namespaces) on the [Server](/clusters#frontend-server). -tags: - - cli ---- - - -Use the options listed below to change the command's output. -Make sure to write the command as follows: -`temporal operator namespace list [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/operator/namespace/update.md b/docs/operator/namespace/update.md deleted file mode 100644 index e3fac40d..00000000 --- a/docs/operator/namespace/update.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -id: update -title: temporal operator update -sidebar_label: update -description: Updates a Namespace. -tags: - - cli ---- - ---- -id: namespace -title: temporal operator namespace -sidebar_label: namespace -description: The `temporal operator namespace update` command updates a given [Namespace](/namespaces). -tags: - - cli ---- - - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal operator namespace update [command options] [arguments]` - -## OPTIONS - -- [--active-cluster](/cmd-options/active-cluster) - -- [--address](/cmd-options/address) - -- [--cluster](/cmd-options/cluster) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--data](/cmd-options/data) - -- [--description](/cmd-options/description) - -- [--email](/cmd-options/email) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--history-archival-state](/cmd-options/history-archival-state) - -- [--history-uri](/cmd-options/history-uri) - -- [--namespace](/cmd-options/namespace) - -- [--promote-global](/cmd-options/promote-global) - -- [--reason](/cmd-options/reason) - -- [--retention](/cmd-options/retention) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--visibility-archival-state](/cmd-options/visibility-archival-state) - -- [--visibility-uri](/cmd-options/visibility-uri) - diff --git a/docs/operator/search-attribute/create.md b/docs/operator/search-attribute/create.md deleted file mode 100644 index 0076ac4d..00000000 --- a/docs/operator/search-attribute/create.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: create -title: temporal operator create -sidebar_label: create -description: Adds one or more custom Search Attributes. -tags: - - cli ---- - ---- -id: search-attribute -title: temporal operator search-attribute -sidebar_label: search-attribute -description: The `temporal operator search-attribute create` command adds one or more custom [Search Attributes](/visibility#search-attribute). -tags: - - cli ---- - -These Search Attributes can be used to [filter a list](/visibility#list-filter) of [Workflow Executions](/workflows#workflow-execution) that contain the given Search Attributes in their metadata. - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal operator search-attribute create [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--name](/cmd-options/name) - -- [--namespace](/cmd-options/namespace) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--type](/cmd-options/type) - -- [--yes](/cmd-options/yes) - diff --git a/docs/operator/search-attribute/index.md b/docs/operator/search-attribute/index.md deleted file mode 100644 index 9c4b8ecd..00000000 --- a/docs/operator/search-attribute/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: index -title: temporal operator -sidebar_label: operator -description: Operations applying to Search Attributes. -tags: - - cli ---- - - diff --git a/docs/operator/search-attribute/list.md b/docs/operator/search-attribute/list.md deleted file mode 100644 index f3a5acac..00000000 --- a/docs/operator/search-attribute/list.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: list -title: temporal operator list -sidebar_label: list -description: Lists all Search Attributes that can be used in list Workflow Queries. -tags: - - cli ---- - ---- -id: search-attribute -title: temporal operator search-attribute -sidebar_label: search-attribute -description: The `temporal operator search-attrbute list` command displays a list of all [Search Attributes](/visibility#search-attribute) that can be used in ` temporal workflow list --query`. -tags: - - cli ---- - - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal operator search-attribute list [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--output](/cmd-options/output) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/operator/search-attribute/remove.md b/docs/operator/search-attribute/remove.md deleted file mode 100644 index d90ffca8..00000000 --- a/docs/operator/search-attribute/remove.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: remove -title: temporal operator remove -sidebar_label: remove -description: Removes custom search attribute metadata only (Elasticsearch index schema is not modified). -tags: - - cli ---- - ---- -id: search-attribute -title: temporal operator search-attribute -sidebar_label: search-attribute -description: The `temporal operator search-attribute remove` command removes custom [Search Attribute](/visibility#search-attribute) metadata. -tags: - - cli ---- - -This command does not remove custom Search Attributes from Elasticsearch. -The index schema is not modified. - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal operator search-attribute remove [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--name](/cmd-options/name) - -- [--namespace](/cmd-options/namespace) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--yes](/cmd-options/yes) - diff --git a/docs/schedule/backfill.md b/docs/schedule/backfill.md deleted file mode 100644 index 7d28051e..00000000 --- a/docs/schedule/backfill.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: backfill -title: temporal schedule backfill -sidebar_label: backfill -description: Backfills a past time range of actions. -tags: - - cli ---- - - -The `temporal schedule backfill` command executes Actions ahead of their specified time range. -Backfilling can be used to fill in [Workflow Runs](/workflows#run-id) from a time period when the Schedule was paused, or from before the Schedule was created. - -``` -temporal schedule backfill --sid 'your-schedule-id' \ ---overlap-policy 'BufferAll' \ ---start-time '2022-05-0101T00:00:00Z' \ ---end-time '2022-05-31T23:59:59Z' -``` - -Use the options provided below to change this command's behavior. - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--end-time](/cmd-options/end-time) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--overlap-policy](/cmd-options/overlap-policy) - -- [--schedule-id](/cmd-options/schedule-id) - -- [--start-time](/cmd-options/start-time) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/schedule/create.md b/docs/schedule/create.md deleted file mode 100644 index 1870e17a..00000000 --- a/docs/schedule/create.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -id: create -title: temporal schedule create -sidebar_label: create -description: Create a new schedule. -tags: - - cli ---- - - -The `temporal schedule create` command creates a new [Schedule](/workflows#schedule). -Newly created Schedules return a Schedule ID to be used in other Schedule commands. - -Schedules need to follow a format like the example shown here: -``` -temporal schedule create \ ---sid 'your-schedule-id' \ ---cron '3 11 * * Fri' \ ---wid 'your-workflow-id' \ ---tq 'your-task-queue' \ ---type 'YourWorkflowType' -``` - -Any combination of `--cal`, `--interval`, and `--cron` is supported. -Actions will be executed at any time specified in the Schedule. - -Use the options provided below to change the command's behavior. - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--calendar](/cmd-options/calendar) - -- [--catchup-window](/cmd-options/catchup-window) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--cron](/cmd-options/cron) - -- [--end-time](/cmd-options/end-time) - -- [--env](/cmd-options/env) - -- [--execution-timeout](/cmd-options/execution-timeout) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--input](/cmd-options/input) -Pass "null" for null values. - -- [--input-file](/cmd-options/input-file) -If there are multiple JSON files, concatenate them and separate by space or newline. -Input from the command line will overwrite file input. - -- [--interval](/cmd-options/interval) - -- [--jitter](/cmd-options/jitter) - -- [--max-field-length](/cmd-options/max-field-length) - -- [--memo](/cmd-options/memo) - -- [--memo-file](/cmd-options/memo-file) - -- [--namespace](/cmd-options/namespace) - -- [--notes](/cmd-options/notes) - -- [--overlap-policy](/cmd-options/overlap-policy) - -- [--pause](/cmd-options/pause) - -- [--pause-on-failure](/cmd-options/pause-on-failure) - -- [--remaining-actions](/cmd-options/remaining-actions) - -- [--run-timeout](/cmd-options/run-timeout) - -- [--schedule-id](/cmd-options/schedule-id) - -- [--search-attribute](/cmd-options/search-attribute) - -- [--start-time](/cmd-options/start-time) - -- [--task-queue](/cmd-options/task-queue) - -- [--task-timeout](/cmd-options/task-timeout) - -- [--time-zone](/cmd-options/time-zone) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--workflow-id](/cmd-options/workflow-id) - -- [--workflow-type](/cmd-options/workflow-type) - diff --git a/docs/schedule/delete.md b/docs/schedule/delete.md deleted file mode 100644 index 93c50c6c..00000000 --- a/docs/schedule/delete.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: delete -title: temporal schedule delete -sidebar_label: delete -description: Deletes a schedule. -tags: - - cli ---- - - -The `temporal schedule delete` command deletes a [Schedule](/workflows#schedule). -Deleting a Schedule does not affect any [Workflows](/workflows) started by the Schedule. - -[Workflow Executions](/workflows#workflow-execution) started by Schedules can be cancelled or terminated like other Workflow Executions. -However, Workflow Executions started by a Schedule can be identified by their [Search Attributes](/visibility#search-attribute), making them targetable by batch command for termination. - -`temporal schedule delete --sid 'your-schedule-id' [command options] [arguments]` - -Use the options below to change the behavior of this command. - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--schedule-id](/cmd-options/schedule-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/schedule/describe.md b/docs/schedule/describe.md deleted file mode 100644 index e58df399..00000000 --- a/docs/schedule/describe.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: describe -title: temporal schedule describe -sidebar_label: describe -description: Get schedule configuration and current state. -tags: - - cli ---- - - -The `temporal schedule describe` command shows the current [Schedule](#workflows#schedule) configuration. -This command also provides information about past, current, and future [Workflow Runs](/workflows#run-id). - -`temporal schedule describe --sid 'your-schedule-id' [command options] [arguments]` - -Use the options below to change this command's output. - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--fields](/cmd-options/fields) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--output](/cmd-options/output) - -- [--raw](/cmd-options/raw) - -- [--schedule-id](/cmd-options/schedule-id) - -- [--time-format](/cmd-options/time-format) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/schedule/index.md b/docs/schedule/index.md deleted file mode 100644 index a31d49a5..00000000 --- a/docs/schedule/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: index -title: temporal schedule -sidebar_label: schedule -description: Operations performed on Schedules. -tags: - - cli ---- - - -Schedule commands allow the user to create, use, and update [Schedules](/workflows#schedule). -Schedules control when certain Actions for a Workflow Execution are performed, making it a useful tool for automation. - -To run a Schedule command, run `temporal schedule [command] [command options] [arguments]`. - diff --git a/docs/schedule/list.md b/docs/schedule/list.md deleted file mode 100644 index 0dcb8d3b..00000000 --- a/docs/schedule/list.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: list -title: temporal schedule list -sidebar_label: list -description: Lists schedules. -tags: - - cli ---- - - -The `temporal schedule list` command lists all [Schedule](/workflows#schedule) configurations. -Listing Schedules in [Standard Visibility](/visibility#standard-visibility) will only provide Schedule IDs. - -`temporal schedule list [command options] [arguments]` - -Use the options below to change the behavior of this command. - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--fields](/cmd-options/fields) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--limit](/cmd-options/limit) - -- [--namespace](/cmd-options/namespace) - -- [--no-pager](/cmd-options/no-pager) - -- [--output](/cmd-options/output) - -- [--pager](/cmd-options/pager) -Options: less, more, favoritePager. - -- [--time-format](/cmd-options/time-format) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/schedule/toggle.md b/docs/schedule/toggle.md deleted file mode 100644 index 14a867b4..00000000 --- a/docs/schedule/toggle.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: toggle -title: temporal schedule toggle -sidebar_label: toggle -description: Pauses or unpauses a schedule. -tags: - - cli ---- - - -The `temporal schedule toggle` command can pause and unpause a [Schedule](/workflows#schedule). - -Toggling a Schedule requires a reason to be entered on the command line. -Use `--reason` to note the issue leading to the pause or unpause. - -Schedule toggles are passed in this format: -` temporal schedule toggle --sid 'your-schedule-id' --pause --reason "paused because the database is down"` -`temporal schedule toggle --sid 'your-schedule-id' --unpause --reason "the database is back up"` - -Use the options provided below to change this command's behavior. - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--pause](/cmd-options/pause) - -- [--reason](/cmd-options/reason) - -- [--schedule-id](/cmd-options/schedule-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--unpause](/cmd-options/unpause) - diff --git a/docs/schedule/trigger.md b/docs/schedule/trigger.md deleted file mode 100644 index c2b0659d..00000000 --- a/docs/schedule/trigger.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: trigger -title: temporal schedule trigger -sidebar_label: trigger -description: Triggers an immediate action. -tags: - - cli ---- - - -The `temporal schedule trigger` command triggers an immediate action with a given [Schedule](/workflows#schedule). -By default, this action is subject to the Overlap Policy of the Schedule. - -`temporal schedule trigger` can be used to start a Workflow Run immediately. -`temporal schedule trigger --sid 'your-schedule-id'` - -The Overlap Policy of the Schedule can be overridden as well. -`temporal schedule trigger --sid 'your-schedule-id' --overlap-policy 'AllowAll'` - -Use the options provided below to change this command's behavior. - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--overlap-policy](/cmd-options/overlap-policy) - -- [--schedule-id](/cmd-options/schedule-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/schedule/update.md b/docs/schedule/update.md deleted file mode 100644 index 2d33dcbb..00000000 --- a/docs/schedule/update.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -id: update -title: temporal schedule update -sidebar_label: update -description: Updates a schedule with a new definition (full replacement, not patch). -tags: - - cli ---- - - -The `temporal schedule update` command updates an existing [Schedule](/workflows#schedule). - -Like `temporal schedule create`, updated Schedules need to follow a certain format: -``` -temporal schedule update \ ---sid 'your-schedule-id' \ ---cron '3 11 * * Fri' \ ---wid 'your-workflow-id' \ ---tq 'your-task-queue' \ ---type 'YourWorkflowType' -``` - -Updating a Schedule takes the given options and replaces the entire configuration of the Schedule with what's provided. -If you only change one value of the Schedule, be sure to provide the other unchanged fields to prevent them from being overwritten. - -Use the options provided below to change the command's behavior. - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--calendar](/cmd-options/calendar) - -- [--catchup-window](/cmd-options/catchup-window) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--cron](/cmd-options/cron) - -- [--end-time](/cmd-options/end-time) - -- [--env](/cmd-options/env) - -- [--execution-timeout](/cmd-options/execution-timeout) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--input](/cmd-options/input) -Pass "null" for null values. - -- [--input-file](/cmd-options/input-file) -If there are multiple JSON files, concatenate them and separate by space or newline. -Input from the command line will overwrite file input. - -- [--interval](/cmd-options/interval) - -- [--jitter](/cmd-options/jitter) - -- [--max-field-length](/cmd-options/max-field-length) - -- [--memo](/cmd-options/memo) - -- [--memo-file](/cmd-options/memo-file) - -- [--namespace](/cmd-options/namespace) - -- [--notes](/cmd-options/notes) - -- [--overlap-policy](/cmd-options/overlap-policy) - -- [--pause](/cmd-options/pause) - -- [--pause-on-failure](/cmd-options/pause-on-failure) - -- [--remaining-actions](/cmd-options/remaining-actions) - -- [--run-timeout](/cmd-options/run-timeout) - -- [--schedule-id](/cmd-options/schedule-id) - -- [--search-attribute](/cmd-options/search-attribute) - -- [--start-time](/cmd-options/start-time) - -- [--task-queue](/cmd-options/task-queue) - -- [--task-timeout](/cmd-options/task-timeout) - -- [--time-zone](/cmd-options/time-zone) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--workflow-id](/cmd-options/workflow-id) - -- [--workflow-type](/cmd-options/workflow-type) - diff --git a/docs/server/index.md b/docs/server/index.md deleted file mode 100644 index 576e4b45..00000000 --- a/docs/server/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: index -title: temporal server -sidebar_label: server -description: Commands for managing the Temporal Server. -tags: - - cli ---- - - diff --git a/docs/server/start-dev.md b/docs/server/start-dev.md deleted file mode 100644 index 4decf497..00000000 --- a/docs/server/start-dev.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: start-dev -title: temporal server start-dev -sidebar_label: start-dev -description: Start Temporal development server. -tags: - - cli ---- - - -- [--config](/cmd-options/config) - -- [--db-filename](/cmd-options/db-filename) - -- [--dynamic-config-value](/cmd-options/dynamic-config-value) - -- [--headless](/cmd-options/headless) - -- [--ip](/cmd-options/ip) - -- [--log-format](/cmd-options/log-format) - -- [--log-level](/cmd-options/log-level) - -- [--metrics-port](/cmd-options/metrics-port) - -- [--namespace](/cmd-options/namespace) - -- [--port](/cmd-options/port) - -- [--sqlite-pragma](/cmd-options/sqlite-pragma) - -- [--ui-asset-path](/cmd-options/ui-asset-path) - -- [--ui-codec-endpoint](/cmd-options/ui-codec-endpoint) - -- [--ui-ip](/cmd-options/ui-ip) - -- [--ui-port](/cmd-options/ui-port) - diff --git a/docs/task-queue/describe.md b/docs/task-queue/describe.md deleted file mode 100644 index fe988e21..00000000 --- a/docs/task-queue/describe.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: describe -title: temporal task-queue describe -sidebar_label: describe -description: Describes the Workers that have recently polled on this Task Queue. -tags: - - cli ---- - - -The `temporal task-queue describe` command provides [poller](/applcation-development/worker-performance#poller-count) information for a given [Task Queue](/tasks#task-queue). - -The [Server](/clusters#temporal-server) records the last time of each poll request. -Should `LastAccessTime` exceeds one minute, it's likely that the Worker is at capacity (all Workflow and Activity slots are full) or that the Worker has shut down. -[Workers](/workers) are removed if 5 minutes have passed since the last poll request. - -Use the options listed below to modify what this command returns. -Make sure to write the command as follows: -`temporal task-queue describe [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--fields](/cmd-options/fields) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--output](/cmd-options/output) - -- [--task-queue](/cmd-options/task-queue) - -- [--task-queue-type](/cmd-options/task-queue-type) - -- [--time-format](/cmd-options/time-format) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/task-queue/index.md b/docs/task-queue/index.md deleted file mode 100644 index 51b0f073..00000000 --- a/docs/task-queue/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: index -title: temporal task-queue -sidebar_label: task-queue -description: Operations performed on Task Queues. -tags: - - cli ---- - - diff --git a/docs/task-queue/list-partition.md b/docs/task-queue/list-partition.md deleted file mode 100644 index e1d7e0cb..00000000 --- a/docs/task-queue/list-partition.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: list-partition -title: temporal task-queue list-partition -sidebar_label: list-partition -description: Lists the Task Queue's partitions and which matching node they are assigned to. -tags: - - cli ---- - - -The `temporal task-queue list-partition` command displays the partitions of a [Task Queue](/tasks#task-queue), along with the matching node they are assigned to. - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal task-queue list-partition [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--output](/cmd-options/output) - -- [--task-queue](/cmd-options/task-queue) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/workflow/cancel.md b/docs/workflow/cancel.md deleted file mode 100644 index 15bb0f87..00000000 --- a/docs/workflow/cancel.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: cancel -title: temporal workflow cancel -sidebar_label: cancel -description: Cancel a Workflow Execution. -tags: - - cli ---- - - -The `temporal workflow cancel` command cancels a [Workflow Execution](/workflows#workflow-execution). - -Canceling a running Workflow Execution records a [`WorkflowExecutionCancelRequested` event](/events#workflowexecutioncancelrequested) in the [Event History](/workflows#event-history). -A new [Command](/workflows#command) Task will be scheduled, and the Workflow Execution performs cleanup work. - -Use the options listed below to change the behavior of this command. -Make sure to write the command as follows: -`temporal workflow cancel [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--query](/cmd-options/query) - -- [--reason](/cmd-options/reason) - -- [--run-id](/cmd-options/run-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--workflow-id](/cmd-options/workflow-id) - -- [--yes](/cmd-options/yes) - diff --git a/docs/workflow/count.md b/docs/workflow/count.md deleted file mode 100644 index 667e9788..00000000 --- a/docs/workflow/count.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: count -title: temporal workflow count -sidebar_label: count -description: Count Workflow Executions (requires ElasticSearch to be enabled). -tags: - - cli ---- - - -The `temporal workflow count` command returns a count of [Workflow Executions](/workflows#workflow-execution). -This command requires Elasticsearch to be enabled. - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal workflow count [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--query](/cmd-options/query) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/workflow/delete.md b/docs/workflow/delete.md deleted file mode 100644 index 566f691a..00000000 --- a/docs/workflow/delete.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: delete -title: temporal workflow delete -sidebar_label: delete -description: Deletes a Workflow Execution. -tags: - - cli ---- - - -The `temporal workflow delete` command deletes the specified [Workflow Execution](/workflows#workflow-execution). - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal workflow delete [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--run-id](/cmd-options/run-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--workflow-id](/cmd-options/workflow-id) - diff --git a/docs/workflow/describe.md b/docs/workflow/describe.md deleted file mode 100644 index a03be641..00000000 --- a/docs/workflow/describe.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: describe -title: temporal workflow describe -sidebar_label: describe -description: Show information about a Workflow Execution. -tags: - - cli ---- - - -The `temporal workflow describe` command shows information about a given [Workflow Execution](/workflows#workflow-execution). -This information can be used to locate Workflow Executions that weren't able to run successfully. - -Use the command options listed below to change the information returned by this command. -Make sure to write the command in this format: -`temporal workflow describe [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--raw](/cmd-options/raw) - -- [--reset-points](/cmd-options/reset-points) - -- [--run-id](/cmd-options/run-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--workflow-id](/cmd-options/workflow-id) - diff --git a/docs/workflow/execute.md b/docs/workflow/execute.md deleted file mode 100644 index 49057d81..00000000 --- a/docs/workflow/execute.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -id: execute -title: temporal workflow execute -sidebar_label: execute -description: Start a new Workflow Execution and prints its progress. -tags: - - cli ---- - - -The `temporal workflow execute` command starts a new [Workflow Execution](/workflows#workflow-execution) and prints its progress. -The command doesn't finish until the [Workflow](/workflows) completes. - -Single quotes('') are used to wrap input as JSON. - -Use the command options listed below to change how the Workflow Execution behaves during its run. -Make sure to write the command in this format: -`temporal workflow execute [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--cron](/cmd-options/cron) -┌───────────── minute (0 - 59) -│ ┌───────────── hour (0 - 23) -│ │ ┌───────────── day of the month (1 - 31) -│ │ │ ┌───────────── month (1 - 12) -│ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) -│ │ │ │ │ -* * * * * - -- [--env](/cmd-options/env) - -- [--execution-timeout](/cmd-options/execution-timeout) - -- [--fields](/cmd-options/fields) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--id-reuse-policy](/cmd-options/id-reuse-policy) - -- [--input](/cmd-options/input) -Pass "null" for null values. - -- [--input-file](/cmd-options/input-file) -If there are multiple JSON files, concatenate them and separate by space or newline. -Input from the command line will overwrite file input. - -- [--limit](/cmd-options/limit) - -- [--max-field-length](/cmd-options/max-field-length) - -- [--memo](/cmd-options/memo) - -- [--memo-file](/cmd-options/memo-file) - -- [--namespace](/cmd-options/namespace) - -- [--no-pager](/cmd-options/no-pager) - -- [--output](/cmd-options/output) - -- [--pager](/cmd-options/pager) -Options: less, more, favoritePager. - -- [--run-timeout](/cmd-options/run-timeout) - -- [--search-attribute](/cmd-options/search-attribute) - -- [--task-queue](/cmd-options/task-queue) - -- [--task-timeout](/cmd-options/task-timeout) - -- [--time-format](/cmd-options/time-format) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--type](/cmd-options/type) - -- [--workflow-id](/cmd-options/workflow-id) - diff --git a/docs/workflow/index.md b/docs/workflow/index.md deleted file mode 100644 index 4bf80a24..00000000 --- a/docs/workflow/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: index -title: temporal workflow -sidebar_label: workflow -description: Operations that can be performed on Workflows. -tags: - - cli ---- - - diff --git a/docs/workflow/list.md b/docs/workflow/list.md deleted file mode 100644 index 1c098869..00000000 --- a/docs/workflow/list.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: list -title: temporal workflow list -sidebar_label: list -description: List Workflow Executions based on a Query. -tags: - - cli ---- - - -The `temporal workflow list` command provides a list of [Workflow Executions](/workflows#workflow-execution) that meet the criteria of a given [Query](/workflows#query). -By default, this command returns a list of up to 10 closed Workflow Executions. - -Use the command options listed below to change the information returned by this command. -Make sure to write the command as follows: -`temporal workflow list [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--archived](/cmd-options/archived) -Currently an experimental feature. - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--fields](/cmd-options/fields) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--limit](/cmd-options/limit) - -- [--namespace](/cmd-options/namespace) - -- [--no-pager](/cmd-options/no-pager) - -- [--output](/cmd-options/output) - -- [--pager](/cmd-options/pager) -Options: less, more, favoritePager. - -- [--query](/cmd-options/query) - -- [--time-format](/cmd-options/time-format) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - diff --git a/docs/workflow/query.md b/docs/workflow/query.md deleted file mode 100644 index 6d301146..00000000 --- a/docs/workflow/query.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: query -title: temporal workflow query -sidebar_label: query -description: Query a Workflow Execution. -tags: - - cli ---- - - -The `temporal workflow query` command sends a [Query](/workflows#query) to a [Workflow Execution](/workflows#workflow-execution). - -Queries can retrieve all or part of the Workflow state within given parameters. -Queries can also be used on completed [Workflows](/workflows#workflow-execution). - -Use the command options listed below to change the information returned by this command. -Make sure to write the command as follows: -`temporal workflow query [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--input](/cmd-options/input) - -- [--input-file](/cmd-options/input-file) -If there are multiple JSON, concatenate them and separate by space or newline. -Input from the command line will overwrite file input. - -- [--namespace](/cmd-options/namespace) - -- [--reject-condition](/cmd-options/reject-condition) - -- [--run-id](/cmd-options/run-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--type](/cmd-options/type) - -- [--workflow-id](/cmd-options/workflow-id) - diff --git a/docs/workflow/reset-batch.md b/docs/workflow/reset-batch.md deleted file mode 100644 index 85a6f48b..00000000 --- a/docs/workflow/reset-batch.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: reset-batch -title: temporal workflow reset-batch -sidebar_label: reset-batch -description: Reset a batch of Workflow Executions by reset type: FirstWorkflowTask, LastWorkflowTask, LastContinuedAsNew -tags: - - cli ---- - - -The `temporal workflow reset-batch` command resets a batch of [Workflow Executions](/workflows#workflow-execution) by `resetType`. -Resetting a [Workflow](/workflows) allows the process to resume from a certain point without losing your parameters or [Event History](/workflows#event-history). - -Use the options listed below to change reset behavior. -Make sure to write the command as follows: -`temporal workflow reset-batch [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--dry-run](/cmd-options/dry-run) - -- [--env](/cmd-options/env) - -- [--exclude-file](/cmd-options/exclude-file) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--input-file](/cmd-options/input-file) - -- [--input-parallelism](/cmd-options/input-parallelism) - -- [--input-separator](/cmd-options/input-separator) - -- [--namespace](/cmd-options/namespace) - -- [--non-deterministic](/cmd-options/non-deterministic) - -- [--query](/cmd-options/query) - -- [--reason](/cmd-options/reason) - -- [--skip-base-is-not-current](/cmd-options/skip-base-is-not-current) - -- [--skip-current-open](/cmd-options/skip-current-open) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--type](/cmd-options/type) - diff --git a/docs/workflow/reset.md b/docs/workflow/reset.md deleted file mode 100644 index 280eb2f3..00000000 --- a/docs/workflow/reset.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: reset -title: temporal workflow reset -sidebar_label: reset -description: Resets a Workflow Execution by Event Id or reset type. -tags: - - cli ---- - - -The `temporal workflow reset` command resets a [Workflow Execution](/workflows#workflow-execution). -A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](/workflows#event-history). - -Use the options listed below to change reset behavior. -Make sure to write the command as follows: -`temporal workflow reset [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--event-id](/cmd-options/event-id) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--reapply-type](/cmd-options/reapply-type) - -- [--reason](/cmd-options/reason) - -- [--run-id](/cmd-options/run-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--type](/cmd-options/type) - -- [--workflow-id](/cmd-options/workflow-id) - diff --git a/docs/workflow/show.md b/docs/workflow/show.md deleted file mode 100644 index 57bddda9..00000000 --- a/docs/workflow/show.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: show -title: temporal workflow show -sidebar_label: show -description: Show Event History for a Workflow Execution. -tags: - - cli ---- - - -The `temporal workflow show` command provides the [Event History](/workflows#event-history) for a specified [Workflow Execution](/workflows#workflow-execution). - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal workflow show [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--fields](/cmd-options/fields) - -- [--follow](/cmd-options/follow) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--limit](/cmd-options/limit) - -- [--max-field-length](/cmd-options/max-field-length) - -- [--namespace](/cmd-options/namespace) - -- [--no-pager](/cmd-options/no-pager) - -- [--output](/cmd-options/output) - -- [--output-filename](/cmd-options/output-filename) - -- [--pager](/cmd-options/pager) -Options: less, more, favoritePager. - -- [--reset-points](/cmd-options/reset-points) - -- [--run-id](/cmd-options/run-id) - -- [--time-format](/cmd-options/time-format) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--workflow-id](/cmd-options/workflow-id) - diff --git a/docs/workflow/signal.md b/docs/workflow/signal.md deleted file mode 100644 index 97ac3651..00000000 --- a/docs/workflow/signal.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -id: signal -title: temporal workflow signal -sidebar_label: signal -description: Signal Workflow Execution by Id or List Filter. -tags: - - cli ---- - - -The `temporal workflow signal` command is used to [Signal](/workflows#signal) a [Workflow Execution](/workflows#workflow-execution) by ID or [List Filter](/visibility#list-filter). - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal workflow signal [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--input](/cmd-options/input) - -- [--input-file](/cmd-options/input-file) - -- [--name](/cmd-options/name) - -- [--namespace](/cmd-options/namespace) - -- [--query](/cmd-options/query) - -- [--reason](/cmd-options/reason) - -- [--run-id](/cmd-options/run-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--workflow-id](/cmd-options/workflow-id) - -- [--yes](/cmd-options/yes) - diff --git a/docs/workflow/stack.md b/docs/workflow/stack.md deleted file mode 100644 index 09a761f7..00000000 --- a/docs/workflow/stack.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: stack -title: temporal workflow stack -sidebar_label: stack -description: Query a Workflow Execution with __stack_trace as the query type. -tags: - - cli ---- - - -The `temporal workflow stack` command queries a [Workflow Execution](/workflows#workflow-execution) with `--stack-trace` as the [Query](/workflows#stack-trace-query) type. -Returning the stack trace of all the threads owned by a Workflow Execution can be great for troubleshooting in production. - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal workflow stack [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--input](/cmd-options/input) - -- [--input-file](/cmd-options/input-file) -If there are multiple JSON, concatenate them and separate by space or newline. -Input from the command line will overwrite file input. - -- [--namespace](/cmd-options/namespace) - -- [--reject-condition](/cmd-options/reject-condition) - -- [--run-id](/cmd-options/run-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--workflow-id](/cmd-options/workflow-id) - diff --git a/docs/workflow/start.md b/docs/workflow/start.md deleted file mode 100644 index 9e424ec0..00000000 --- a/docs/workflow/start.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -id: start -title: temporal workflow start -sidebar_label: start -description: Starts a new Workflow Execution. -tags: - - cli ---- - - -The `temporal workflow start` command starts a new [Workflow Execution](/workflows#workflow-execution). -When invoked successfully, the Workflow and Run ID are returned immediately after starting the [Workflow](/workflows). - -Use the command options listed below to change how the Workflow Execution behaves upon starting. -Make sure to write the command in this format: -`temporal workflow start [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--cron](/cmd-options/cron) -┌───────────── minute (0 - 59) -│ ┌───────────── hour (0 - 23) -│ │ ┌───────────── day of the month (1 - 31) -│ │ │ ┌───────────── month (1 - 12) -│ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday) -│ │ │ │ │ -* * * * * - -- [--env](/cmd-options/env) - -- [--execution-timeout](/cmd-options/execution-timeout) - -- [--fields](/cmd-options/fields) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--id-reuse-policy](/cmd-options/id-reuse-policy) - -- [--input](/cmd-options/input) -Pass "null" for null values. - -- [--input-file](/cmd-options/input-file) -If there are multiple JSON files, concatenate them and separate by space or newline. -Input from the command line will overwrite file input. - -- [--limit](/cmd-options/limit) - -- [--max-field-length](/cmd-options/max-field-length) - -- [--memo](/cmd-options/memo) - -- [--memo-file](/cmd-options/memo-file) - -- [--namespace](/cmd-options/namespace) - -- [--no-pager](/cmd-options/no-pager) - -- [--output](/cmd-options/output) - -- [--pager](/cmd-options/pager) -Options: less, more, favoritePager. - -- [--run-timeout](/cmd-options/run-timeout) - -- [--search-attribute](/cmd-options/search-attribute) - -- [--task-queue](/cmd-options/task-queue) - -- [--task-timeout](/cmd-options/task-timeout) - -- [--time-format](/cmd-options/time-format) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--type](/cmd-options/type) - -- [--workflow-id](/cmd-options/workflow-id) - diff --git a/docs/workflow/terminate.md b/docs/workflow/terminate.md deleted file mode 100644 index debc497a..00000000 --- a/docs/workflow/terminate.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: terminate -title: temporal workflow terminate -sidebar_label: terminate -description: Terminate Workflow Execution by Id or List Filter. -tags: - - cli ---- - - -The `temporal workflow terminate` command terminates a [Workflow Execution](/workflows#workflow-execution) - -Terminating a running Workflow Execution records a [`WorkflowExecutionTerminated` event](/events#workflowexecutionterminated) as the closing Event in the [Event History](/workflows#event-history). -Any further [Command](/workflows#command) Tasks cannot be scheduled after running this command. - -Use the options listed below to change termination behavior. -Make sure to write the command as follows: -`temporal workflow terminate [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--env](/cmd-options/env) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--query](/cmd-options/query) - -- [--reason](/cmd-options/reason) - -- [--run-id](/cmd-options/run-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--workflow-id](/cmd-options/workflow-id) - -- [--yes](/cmd-options/yes) - diff --git a/docs/workflow/trace.md b/docs/workflow/trace.md deleted file mode 100644 index ec74cb04..00000000 --- a/docs/workflow/trace.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -id: trace -title: temporal workflow trace -sidebar_label: trace -description: Trace progress of a Workflow Execution and its children. -tags: - - cli ---- - - -The `temporal workflow trace` command tracks the progress of a [Workflow Execution](/workflows#workflow-execution) and any [Child Workflows](/workflows#child-workflow) it generates. - -Use the options listed below to change the command's behavior. -Make sure to write the command as follows: -`temporal workflow trace [command options] [arguments]` - -## OPTIONS - -- [--address](/cmd-options/address) - -- [--codec-auth](/cmd-options/codec-auth) - -- [--codec-endpoint](/cmd-options/codec-endpoint) - -- [--color](/cmd-options/color) - -- [--concurrency](/cmd-options/concurrency) - -- [--context-timeout](/cmd-options/context-timeout) - -- [--depth](/cmd-options/depth) - -- [--env](/cmd-options/env) - -- [--fold](/cmd-options/fold) - -- [--grpc-meta](/cmd-options/grpc-meta) - -- [--namespace](/cmd-options/namespace) - -- [--no-fold](/cmd-options/no-fold) - -- [--run-id](/cmd-options/run-id) - -- [--tls-ca-path](/cmd-options/tls-ca-path) - -- [--tls-cert-path](/cmd-options/tls-cert-path) - -- [--tls-disable-host-verification](/cmd-options/tls-disable-host-verification) - -- [--tls-key-path](/cmd-options/tls-key-path) - -- [--tls-server-name](/cmd-options/tls-server-name) - -- [--workflow-id](/cmd-options/workflow-id) - From 5bb77b86359854080e615d43850212a54f43dcdd Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Wed, 1 Feb 2023 15:20:32 -0600 Subject: [PATCH 61/68] minor change --- cmd/doc/main.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 347328a4..9f20346e 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -31,7 +31,7 @@ tags: ` -type FMStruct struct { +type FrontMatter struct { ID string Title string Description string @@ -188,7 +188,7 @@ func writeFrontMatter(idName string, titleName string, scanner *bufio.Scanner, i descriptionTxt = "Definition for the " + idName + " command option." } - data := FMStruct{ + data := FrontMatter{ ID: idName, Title: titleName, Description: descriptionTxt, From 290d3a0f9b4b7199c58fc08046e04502f9bd978c Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 2 Feb 2023 11:16:33 -0600 Subject: [PATCH 62/68] changed %v to %s --- cmd/doc/main.go | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 9f20346e..9d3a0adf 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -47,17 +47,17 @@ func main() { doc, err := app.BuildApp("").ToMarkdown() if err != nil { - log.Fatalf("Error when trying to build app: %v", err) + log.Fatalf("Error when trying to build app: %s", err) } err = os.WriteFile(cliFile, []byte(doc), filePerm) if err != nil { - log.Fatalf("Error when trying to write markdown to %s file: %v", cliFile, err) + log.Fatalf("Error when trying to write markdown to %s file: %s", cliFile, err) } readFile, err := os.Open(cliFile) if err != nil { - log.Fatalf("Error when trying to open %s file: %v", cliFile, err) + log.Fatalf("Error when trying to open %s file: %s", cliFile, err) } scanner := bufio.NewScanner(readFile) @@ -97,7 +97,7 @@ func main() { } else { optionFileName = term } - log.Info("string split successfully into term and definition (%v)",found) + log.Info("string split successfully into term and definition (%s)",found) optionFileName = strings.TrimPrefix(optionFileName, "**--") optionFileName = strings.TrimSuffix(optionFileName, "**") @@ -130,11 +130,11 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, if (isOptions) { err = os.MkdirAll(filepath.Join(docsPath, optionsPath), os.ModePerm) if err != nil { - log.Printf("Error when trying to create options directory %s: %v", path, err) + log.Printf("Error when trying to create options directory %s: %s", path, err) } currentOptionFile, err = os.Create(optionFilePath) if err != nil { - log.Printf("Error when trying to create option file %s: %v", optionFilePath, err) + log.Printf("Error when trying to create option file %s: %s", optionFilePath, err) } createdFiles[optionFileName] = currentOptionFile writeFrontMatter(strings.TrimSpace(optionFileName), "", scanner, false, currentOptionFile) @@ -142,12 +142,12 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, } else if (isIndex) { err = os.MkdirAll(path, os.ModePerm) if err != nil { - log.Printf("Error when trying to create a directory %s: %v", path, err) + log.Printf("Error when trying to create a directory %s: %s", path, err) } headerIndexFile = filepath.Join(path, indexFile) currentHeaderFile, err = os.Create(headerIndexFile) if err != nil { - log.Printf("Error when trying to create index file %s: %v", headerIndexFile, err) + log.Printf("Error when trying to create index file %s: %s", headerIndexFile, err) } createdFiles[headerIndexFile] = currentHeaderFile writeFrontMatter(strings.Trim(indexFile, ".md"), currentHeader, scanner, true, currentHeaderFile) @@ -157,7 +157,7 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, if currentHeaderFile == nil { currentHeaderFile, err = os.Create(path) if err != nil { - log.Printf("Error when trying to create non-index file %s: %v", path, err) + log.Printf("Error when trying to create non-index file %s: %s", path, err) } createdFiles[path] = currentHeaderFile } @@ -172,7 +172,7 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, func writeLine(file *os.File, line string) { _, err := file.WriteString(line + "\n") if err != nil { - log.Printf("Error when trying to write to file: %v", err) + log.Printf("Error when trying to write to file: %s", err) } } @@ -211,6 +211,6 @@ func deleteExistingFolder() { return } os.RemoveAll(docsPath) - log.Println("deleted docs folder %v", folderinfo) + log.Println("deleted docs folder %s", folderinfo) } From d02c41035a9094079de9e34ef0b50a7f7ff352e0 Mon Sep 17 00:00:00 2001 From: feedmeapples Date: Thu, 2 Feb 2023 13:06:07 -0500 Subject: [PATCH 63/68] address ci failure --- cmd/doc/main.go | 54 ++++++++++++++++++++++++------------------------- go.mod | 6 +----- go.sum | 2 -- 3 files changed, 27 insertions(+), 35 deletions(-) diff --git a/cmd/doc/main.go b/cmd/doc/main.go index 9d3a0adf..6dd0af6c 100644 --- a/cmd/doc/main.go +++ b/cmd/doc/main.go @@ -2,25 +2,24 @@ package main import ( "bufio" + "log" "os" "path/filepath" "strings" "text/template" - log "github.com/sirupsen/logrus" "github.com/temporalio/cli/app" ) const ( - docsPath = "docs" - cliFile = "cli.md" - filePerm = 0644 - indexFile = "index.md" - optionsPath = "cmd-options" + docsPath = "docs" + cliFile = "cli.md" + filePerm = 0644 + indexFile = "index.md" + optionsPath = "cmd-options" ) -const FrontMatterTemplate = -`--- +const FrontMatterTemplate = `--- id: {{.ID}} title: temporal {{.Title}}{{if not .IsIndex}} {{.ID}}{{end}} sidebar_label:{{if .IsIndex}} {{.Title}}{{else}} {{.ID}}{{end}} @@ -32,10 +31,10 @@ tags: ` type FrontMatter struct { - ID string - Title string + ID string + Title string Description string - IsIndex bool + IsIndex bool } var currentHeader, fileName, optionFileName, operatorFileName, path, optionFilePath, headerIndexFile, aliasName string @@ -85,7 +84,7 @@ func main() { operatorFileName = strings.TrimSpace(line[4:]) filePath := filepath.Join(path, fileName, operatorFileName+".md") makeFile(filePath, false, false, scanner, createdFiles) - + } else if strings.HasPrefix(line, "**--") { // split into term and definition term, definition, found := strings.Cut(line, ":") @@ -97,7 +96,7 @@ func main() { } else { optionFileName = term } - log.Info("string split successfully into term and definition (%s)",found) + log.Printf("string split successfully into term and definition (%v)", found) optionFileName = strings.TrimPrefix(optionFileName, "**--") optionFileName = strings.TrimSuffix(optionFileName, "**") @@ -107,7 +106,7 @@ func main() { termLink := "- [--" + optionFileName + "](/cmd-options/" + optionFileName + ")" makeFile(optionFilePath, false, true, scanner, createdFiles) writeLine(currentHeaderFile, termLink) - if (aliasName != "") { + if aliasName != "" { aliasArray := strings.Split(aliasName, "=") writeLine(currentOptionFile, aliasArray[0]) aliasName = "" @@ -118,7 +117,7 @@ func main() { writeLine(currentHeaderFile, strings.Trim(line, ">")) } else { writeLine(currentHeaderFile, strings.TrimSpace(line)) - } + } } // close file descriptor after for loop has completed readFile.Close() @@ -127,7 +126,7 @@ func main() { func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, createdFiles map[string]*os.File) { var err error - if (isOptions) { + if isOptions { err = os.MkdirAll(filepath.Join(docsPath, optionsPath), os.ModePerm) if err != nil { log.Printf("Error when trying to create options directory %s: %s", path, err) @@ -138,8 +137,8 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, } createdFiles[optionFileName] = currentOptionFile writeFrontMatter(strings.TrimSpace(optionFileName), "", scanner, false, currentOptionFile) - - } else if (isIndex) { + + } else if isIndex { err = os.MkdirAll(path, os.ModePerm) if err != nil { log.Printf("Error when trying to create a directory %s: %s", path, err) @@ -160,8 +159,8 @@ func makeFile(path string, isIndex bool, isOptions bool, scanner *bufio.Scanner, log.Printf("Error when trying to create non-index file %s: %s", path, err) } createdFiles[path] = currentHeaderFile - } - if (strings.Contains(path, "operator")) { + } + if strings.Contains(path, "operator") { writeFrontMatter(operatorFileName, currentHeader, scanner, false, currentHeaderFile) } writeFrontMatter(fileName, currentHeader, scanner, false, currentHeaderFile) @@ -179,7 +178,7 @@ func writeLine(file *os.File, line string) { // write front matter func writeFrontMatter(idName string, titleName string, scanner *bufio.Scanner, isIndex bool, currentHeaderFile *os.File) { var descriptionTxt string - if (titleName != "") { + if titleName != "" { for i := 0; i < 2; i++ { scanner.Scan() } @@ -189,14 +188,14 @@ func writeFrontMatter(idName string, titleName string, scanner *bufio.Scanner, i } data := FrontMatter{ - ID: idName, - Title: titleName, + ID: idName, + Title: titleName, Description: descriptionTxt, - IsIndex: isIndex, + IsIndex: isIndex, } tmpl := template.Must(template.New("fm").Parse(FrontMatterTemplate)) - + err := tmpl.ExecuteTemplate(currentHeaderFile, "fm", data) if err != nil { log.Println("Execute: ", err) @@ -207,10 +206,9 @@ func writeFrontMatter(idName string, titleName string, scanner *bufio.Scanner, i func deleteExistingFolder() { folderinfo, err := os.Stat(docsPath) if os.IsNotExist(err) { - log.Info("Folder doesn't exist.") + log.Printf("Folder doesn't exist.") return } os.RemoveAll(docsPath) - log.Println("deleted docs folder %s", folderinfo) + log.Printf("deleted docs folder %s", folderinfo) } - diff --git a/go.mod b/go.mod index eab70d93..4a113b16 100644 --- a/go.mod +++ b/go.mod @@ -22,14 +22,10 @@ require ( google.golang.org/grpc v1.52.3 ) -require ( - cloud.google.com/go/compute/metadata v0.2.1 // indirect - github.com/gomarkdown/markdown v0.0.0-20221013030248-663e2500819c // indirect -) - require ( cloud.google.com/go v0.105.0 // indirect cloud.google.com/go/compute v1.13.0 // indirect + cloud.google.com/go/compute/metadata v0.2.1 // indirect cloud.google.com/go/iam v0.8.0 // indirect cloud.google.com/go/storage v1.27.0 // indirect github.com/apache/thrift v0.17.0 // indirect diff --git a/go.sum b/go.sum index 80deda45..67dd84c9 100644 --- a/go.sum +++ b/go.sum @@ -548,8 +548,6 @@ github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiu github.com/golang/snappy v0.0.3/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= github.com/golang/snappy v0.0.4 h1:yAGX7huGHXlcLOEtBnF4w7FQwA26wojNCwOYAEhLjQM= github.com/golang/snappy v0.0.4/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= -github.com/gomarkdown/markdown v0.0.0-20221013030248-663e2500819c h1:iyaGYbCmcYK0Ja9a3OUa2Fo+EaN0cbLu0eKpBwPFzc8= -github.com/gomarkdown/markdown v0.0.0-20221013030248-663e2500819c/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA= github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= From fd90237e48f29313b0f51f7328d036c6bf0a4e1f Mon Sep 17 00:00:00 2001 From: feedmeapples Date: Thu, 2 Feb 2023 13:36:02 -0500 Subject: [PATCH 64/68] gitignore docs --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 53c5b8b0..032dcbf0 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,9 @@ __debug_bin # Output of the go coverage tool, specifically when used with LiteIDE *.out +# ./cmd/docs output +docs + # Dependency directories (remove the comment below to include it) # vendor/ From c6703f41becbedd61861eb1ddbe4b1d8be823976 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 2 Feb 2023 14:32:36 -0600 Subject: [PATCH 65/68] more varaibles created from flags --- common/defs-cmds.go | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/common/defs-cmds.go b/common/defs-cmds.go index 42b131a9..265e7ddf 100644 --- a/common/defs-cmds.go +++ b/common/defs-cmds.go @@ -48,7 +48,7 @@ const ( // Namespace subcommand definitions DescribeNamespaceDefinition = "Describe a Namespace by its name or Id." ListNamespacesDefinition = "List all Namespaces." - RegisterNamespaceDefinition = "Registers a new Namespace." + CreateNamespaceDefinition = "Registers a new Namespace." UpdateNamespaceDefinition = "Updates a Namespace." DeleteNamespaceDefinition = "Deletes an existing Namespace." @@ -69,6 +69,18 @@ const ( GetDefinition = "Prints environmental properties." SetDefinition = "Set environmental properties." DeleteDefinition = "Delete an environment or environmental property." + + // Schedule definitions + ScheduleCreateDefinition = "Create a new Schedule." + ScheduleCreateDescription = "Takes a Schedule specification plus all the same args as starting a Workflow." + ScheduleUpdateDefinition = "Updates a Schedule with a new definition (full replacement, not patch)." + ScheduleUpdateDescription = "Takes a Schedule specification plus all the same args as starting a Workflow." + ScheduleToggleDefinition = "Pauses or unpauses a Schedule." + ScheduleTriggerDefinition = "Triggers an immediate action." + ScheduleBackfillDefinition = "Backfills a past time range of actions." + ScheduleDescribeDefinition = "Get Schedule configuration and current state." + ScheduleDeleteDefinition = "Deletes a Schedule." + ScheduleListDefinition = "Lists Schedules." ) //TODO: get information checked for all UsageTexts From c649f8161a4c3018e32540efeb432c339770381d Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 2 Feb 2023 14:32:43 -0600 Subject: [PATCH 66/68] flag variables created --- activity/activity.go | 22 +++---- batch/batch.go | 6 +- cluster/cluster.go | 10 ++-- common/defs-flags.go | 90 ++++++++++++++++++++++++++++- common/flags.go | 8 +-- namespace/namespace.go | 2 +- schedule/schedule.go | 66 ++++++++++----------- searchattribute/search_attribute.go | 8 +-- taskqueue/task_queue.go | 6 +- workflow/workflow.go | 72 +++++++++++------------ 10 files changed, 188 insertions(+), 102 deletions(-) diff --git a/activity/activity.go b/activity/activity.go index 80530597..a0c8af92 100644 --- a/activity/activity.go +++ b/activity/activity.go @@ -15,32 +15,32 @@ func NewActivityCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagWorkflowID, Aliases: common.FlagWorkflowIDAlias, - Usage: "Identifies the Workflow that the Activity is running on.", + Usage: common.FlagWorkflowIDDefinition, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagRunID, Aliases: common.FlagRunIDAlias, - Usage: "Identifies the current Workflow Run.", + Usage: common.FlagRunIDDefinition, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagActivityID, - Usage: "Identifies the Activity to be completed.", + Usage: common.FlagActivityCompleteDefinition, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagResult, - Usage: "Set the result value of Activity completion.", + Usage: common.FlagResultDefinition, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagIdentity, - Usage: "Specify operator's identity.", + Usage: common.FlagIdentityDefinition, Required: true, Category: common.CategoryMain, }, @@ -57,38 +57,38 @@ func NewActivityCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagWorkflowID, Aliases: common.FlagWorkflowIDAlias, - Usage: "Identifies the Workflow that the Activity is running on.", + Usage: common.FlagWorkflowIDDefinition, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagRunID, Aliases: common.FlagRunIDAlias, - Usage: "Identifies the current Workflow Run.", + Usage: common.FlagRunIDDefinition, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagActivityID, - Usage: "Identifies the Activity to fail.", + Usage: common.FlagActivityFailDefinition, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason to fail the Activity.", + Usage: common.FlagReasonDefinition, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagDetail, - Usage: "Detail to fail the Activity.", + Usage: common.FlagDetailDefinition, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagIdentity, - Usage: "Specify the operator's identity.", + Usage: common.FlagIdentityDefinition, Required: true, Category: common.CategoryMain, }, diff --git a/batch/batch.go b/batch/batch.go index 8fa2398f..5748485a 100644 --- a/batch/batch.go +++ b/batch/batch.go @@ -14,7 +14,7 @@ func NewBatchCommands() []*cli.Command { Flags: append([]cli.Flag{ &cli.StringFlag{ Name: common.FlagJobID, - Usage: "Batch Job Id", + Usage: common.FlagJobIDDefinition, Required: true, Category: common.CategoryMain, }, @@ -40,13 +40,13 @@ func NewBatchCommands() []*cli.Command { Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagJobID, - Usage: "Batch Job Id", + Usage: common.FlagJobIDDefinition, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason to stop the Batch job.", + Usage: common.FlagReasonBatchDefinition, Required: true, Category: common.CategoryMain, }, diff --git a/cluster/cluster.go b/cluster/cluster.go index c82ee667..fd75187b 100644 --- a/cluster/cluster.go +++ b/cluster/cluster.go @@ -31,7 +31,7 @@ func NewClusterCommands() []*cli.Command { }, &cli.StringFlag{ Name: output.FlagFields, - Usage: "Customize fields to print. Set to 'long' to automatically print more of main fields.", + Usage: common.FlagFieldsDefinition, Category: common.CategoryDisplay, }, }, @@ -54,7 +54,7 @@ func NewClusterCommands() []*cli.Command { }, &cli.StringFlag{ Name: output.FlagFields, - Usage: "Customize fields to print. Set to 'long' to automatically print more of main fields.", + Usage: common.FlagFieldsDefinition, Category: common.CategoryDisplay, }, }, @@ -70,12 +70,12 @@ func NewClusterCommands() []*cli.Command { Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagClusterAddress, - Usage: "Frontend address of the remote Cluster.", + Usage: common.FlagClusterAddressDefinition, Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagClusterEnableConnection, - Usage: "Enable cross-cluster connection.", + Usage: common.FlagClusterEnableConnectionDefinition, Category: common.CategoryMain, }, }, @@ -101,7 +101,7 @@ func NewClusterCommands() []*cli.Command { Flags: []cli.Flag{ &cli.StringFlag{ Name: common.FlagName, - Usage: "Frontend address of the remote Cluster.", + Usage: common.FlagNameDefinition, Required: true, Category: common.CategoryMain, }, diff --git a/common/defs-flags.go b/common/defs-flags.go index 1f86102a..45c2b53a 100644 --- a/common/defs-flags.go +++ b/common/defs-flags.go @@ -13,10 +13,13 @@ const ( FlagContextTimeoutDefinition = "An optional timeout for the context of an RPC call (in seconds)." FlagCodecEndpointDefinition = "Endpoint for a remote Codec Server." FlagCodecAuthDefinition = "Sets the authorization header on requests to the Codec Server." + FlagArchiveDefinition = "List archived Workflow Executions.\nCurrently an experimental feature." // Execution flags - FlagWorkflowIdDefinition = "Workflow Id" + FlagWorkflowId = "Workflow Id" FlagRunIdDefinition = "Run Id" + FlagJobIDDefinition = "Batch Job Id" + FlagScheduleIDDefinition = "Schedule Id" // ShowWorkflow flags FlagOutputFilenameDefinition = "Serializes Event History to a file." @@ -48,8 +51,40 @@ const ( FlagMemoDefinition = "Passes a memo in key=value format. Use valid JSON formats for value." FlagMemoFileDefinition = "Passes a memo as file input, with each line following key=value format. Use valid JSON formats for value." + // Other Workflow flags + FlagResetPointsUsage = "Only show auto-reset points." + FlagPrintRawUsage = "Print properties as they are stored." + QueryFlagTypeUsage = "The Query type you want to run." + FlagWorkflowSignalUsage = "Signal Workflow Execution by Id." + FlagQueryDefinition = "Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/." + FlagSignalName = "Signal Name" + FlagInputSignal = "Input for the Signal (JSON)." + FlagInputFileSignal = "Input for the Signal from file (JSON)." + FlagReasonSignal = "Reason for signaling with List Filter." + FlagCancelWorkflow = "Cancel Workflow Execution by Id." + FlagReasonCancel = "Reason for canceling with List Filter." + FlagWorkflowIDTerminate = "Terminate Workflow Execution by Id." + FlagQueryTerminate = "Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/." + FlagReasonTerminate = "Reason for termination." + FlagEventIDDefinition = "The Event Id for any Event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others." + FlagReasonReset = "Reason to reset." + FlagQueryResetBatch = "Visibility Query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query." + FlagInputFileReset = "Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id." + FlagExcludeFileDefinition = "Input file that specifies Workflow Executions to exclude from resetting." + FlagInputSeparatorDefinition = "Separator for the input file. The default is a tab (\t)." + FlagReasonResetBatch = "Reason for resetting the Workflow Executions." + FlagParallelismDefinition = "Number of goroutines to run in parallel. Each goroutine processes one line for every second." + FlagSkipCurrentOpenDefinition = "Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run." + FlagSkipBaseDefinition = "Skip a Workflow Execution if the base Run is not the current Run." + FlagNonDeterministicDefinition = "Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error." + FlagDryRunDefinition = "Simulate reset without resetting any Workflow Executions." + FlagDepthDefinition = "Number of Child Workflows to expand, -1 to expand all Child Workflows." + FlagConcurrencyDefinition = "Request concurrency." + FlagNoFoldDefinition = "Disable folding. All Child Workflows within the set depth will be fetched and displayed." + + // Stack trace query flag definitions - FlagInputSTQDefinition = "Optional query input, in JSON format. For multiple parameters, concatenate them and separate by space." + FlagInputSTQDefinition = "Optional Query input, in JSON format. For multiple parameters, concatenate them and separate by space." FlagInputFileSTQDefinition = "Passes optional Query input from a JSON file.\nIf there are multiple JSON, concatenate them and separate by space or newline.\n" + "Input from the command line will overwrite file input." FlagQueryRejectConditionDefinition = "Optional flag for rejecting Queries based on Workflow state. Valid values are \"not_open\" and \"not_completed_cleanly\"." @@ -57,4 +92,55 @@ const ( FlagLimitDefinition = "Number of items to print." FlagPagerDefinition = "Sets the pager for Temporal CLI to use.\nOptions: less, more, favoritePager." FlagNoPagerDefinition = "Disables the interactive pager." + FlagFieldsDefinition = "Customize fields to print. Set to 'long' to automatically print more of main fields." + + // Activity flag definitions + FlagWorkflowIDDefinition = "Identifies the Workflow that the Activity is running on." + FlagRunIDDefinition = "Identifies the current Workflow Run." + FlagActivityCompleteDefinition = "Identifies the Activity to be completed." + FlagResultDefinition = "Set the result value of Activity completion." + FlagIdentityDefinition = "Specify operator's identity." + FlagActivityFailDefinition = "Identifies the Activity to fail." + FlagReasonDefinition = "Reason to fail the Activity." + FlagDetailDefinition = "Detail to fail the Activity." + + // Batch flag definitions + FlagReasonBatchDefinition = "Reason to stop the Batch job." + + // Cluster flag definition + FlagClusterAddressDefinition = "Frontend address of the remote Cluster." + FlagClusterEnableConnectionDefinition = "Enable cross-cluster connection." + FlagNameDefinition = "Frontend address of the remote Cluster." + + // Schedule flag definition + FlagOverlapPolicyDefinition = "Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll." + FlagCalenderDefinition = `Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"}` + FlagCronScheduleShortDefinition = `Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily".` + FlagIntervalDefinition = "Interval duration, e.g. 90m, or 90m/13m to include phase offset." + FlagStartTimeDefinition = "Overall schedule start time." + FlagEndTimeDefinition = "Overall schedule end time." + FlagJitterDefinition = "Jitter duration." + FlagTimeZoneDefinition = "Time zone (IANA name)." + FlagNotesDefinition = "Initial value of notes field." + FlagPauseDefinition = "Initial value of paused state." + FlagRemainingActionsDefinition = "Total number of actions allowed." + FlagCatchupWindowDefinition = "Maximum allowed catch-up time if server is down." + FlagPauseOnFailureDefinition = "Pause schedule after any workflow failure." + FlagSearchAttributeScheduleDefinition = "Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value." + FlagMemoScheduleDefinition = "Set a memo on a schedule. Format: key=value. Use valid JSON formats for value." + FlagMemoFileScheduleDefinition = "Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value." + FlagPauseScheduleDefinition = "Pauses the Schedule." + FlagUnpauseDefinition = "Unpauses the Schedule." + FlagReasonScheduleDefinition = "Free-form text to describe reason for pause/unpause." + FlagBackfillStartTime = "Backfill start time." + FlagBackfillEndTime = "Backfill end time." + FlagPrintRawDefinition = "Print raw data as json (prefer this over -o json for scripting)." + + // Search Attribute flags + FlagNameSearchAttribute = "Search Attribute name." + FlagYesDefinition = "Confirm all prompts." + + // Task Queue flags + FlagTaskQueueName = "Task Queue name." + FlagTaskQueueTypeDefinition = "Task Queue type [workflow|activity]" ) \ No newline at end of file diff --git a/common/flags.go b/common/flags.go index 71e6b45e..a2e25da8 100644 --- a/common/flags.go +++ b/common/flags.go @@ -227,7 +227,7 @@ var FlagsForExecution = []cli.Flag{ &cli.StringFlag{ Name: FlagWorkflowID, Aliases: FlagWorkflowIDAlias, - Usage: "Workflow Id", + Usage: FlagWorkflowId, Required: true, Category: CategoryMain, }, @@ -285,7 +285,7 @@ var FlagsForStartWorkflowT = []cli.Flag{ &cli.StringFlag{ Name: FlagWorkflowID, Aliases: FlagWorkflowIDAlias, - Usage: FlagWorkflowIdDefinition, + Usage: FlagWorkflowId, Category: CategoryMain, }, &cli.StringFlag{ @@ -363,7 +363,7 @@ var FlagsForWorkflowFiltering = []cli.Flag{ }, &cli.BoolFlag{ Name: FlagArchive, - Usage: "List archived Workflow Executions.\nCurrently an experimental feature.", + Usage: FlagArchiveDefinition, Category: CategoryMain, }, } @@ -423,7 +423,7 @@ var FlagsForFormatting = []cli.Flag{ }, &cli.StringFlag{ Name: output.FlagFields, - Usage: "Customize fields to print. Set to 'long' to automatically print more of main fields.", + Usage: FlagFieldsDefinition, Category: CategoryDisplay, }, } diff --git a/namespace/namespace.go b/namespace/namespace.go index 06568f27..9132c08e 100644 --- a/namespace/namespace.go +++ b/namespace/namespace.go @@ -36,7 +36,7 @@ func NewNamespaceCommands() []*cli.Command { }, { Name: "create", - Usage: "Register a new Namespace", + Usage: common.CreateNamespaceDefinition, UsageText: common.NamespaceCreateUsageText, Flags: createNamespaceFlags, ArgsUsage: "namespace_name [cluster_name...]", diff --git a/schedule/schedule.go b/schedule/schedule.go index 0d6421d5..47894e48 100644 --- a/schedule/schedule.go +++ b/schedule/schedule.go @@ -10,50 +10,50 @@ func NewScheduleCommands() []*cli.Command { sid := &cli.StringFlag{ Name: common.FlagScheduleID, Aliases: common.FlagScheduleIDAlias, - Usage: "Schedule Id", + Usage: common.FlagScheduleIDDefinition, Required: true, Category: common.CategoryMain, } overlap := &cli.StringFlag{ Name: common.FlagOverlapPolicy, - Usage: "Overlap policy: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll.", + Usage: common.FlagOverlapPolicyDefinition, Category: common.CategoryMain, } scheduleSpecFlags := []cli.Flag{ &cli.StringSliceFlag{ Name: common.FlagCalendar, - Usage: `Calendar specification in JSON, e.g. {"dayOfWeek":"Fri","hour":"17","minute":"5"}`, + Usage: common.FlagCalenderDefinition, Category: common.CategoryMain, }, &cli.StringSliceFlag{ Name: common.FlagCronSchedule, - Usage: `Calendar specification as cron string, e.g. "30 2 * * 5" or "@daily".`, + Usage: common.FlagCronScheduleShortDefinition, Category: common.CategoryMain, }, &cli.StringSliceFlag{ Name: common.FlagInterval, - Usage: "Interval duration, e.g. 90m, or 90m/13m to include phase offset.", + Usage: common.FlagIntervalDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagStartTime, - Usage: "Overall schedule start time.", + Usage: common.FlagStartTimeDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagEndTime, - Usage: "Overall schedule end time.", + Usage: common.FlagEndTimeDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagJitter, - Usage: "Jitter duration.", + Usage: common.FlagJitterDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagTimeZone, - Usage: "Time zone (IANA name).", + Usage: common.FlagTimeZoneDefinition, Category: common.CategoryMain, }, } @@ -61,17 +61,17 @@ func NewScheduleCommands() []*cli.Command { scheduleStateFlags := []cli.Flag{ &cli.StringFlag{ Name: common.FlagNotes, - Usage: "Initial value of notes field.", + Usage: common.FlagNotesDefinition, Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagPause, - Usage: "Initial value of paused state.", + Usage: common.FlagPauseDefinition, Category: common.CategoryMain, }, &cli.IntFlag{ Name: common.FlagRemainingActions, - Usage: "Total number of actions allowed.", + Usage: common.FlagRemainingActionsDefinition, Category: common.CategoryMain, }, } @@ -80,12 +80,12 @@ func NewScheduleCommands() []*cli.Command { overlap, &cli.StringFlag{ Name: common.FlagCatchupWindow, - Usage: "Maximum allowed catch-up time if server is down.", + Usage: common.FlagCatchupWindowDefinition, Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagPauseOnFailure, - Usage: "Pause schedule after any workflow failure.", + Usage: common.FlagPauseOnFailureDefinition, Category: common.CategoryMain, }, } @@ -94,17 +94,17 @@ func NewScheduleCommands() []*cli.Command { scheduleVisibilityFlags := []cli.Flag{ &cli.StringSliceFlag{ Name: common.FlagSearchAttribute, - Usage: "Set Search Attribute on a schedule. Format: key=value. Use valid JSON formats for value.", + Usage: common.FlagSearchAttributeScheduleDefinition, Category: common.CategoryMain, }, &cli.StringSliceFlag{ Name: common.FlagMemo, - Usage: "Set a memo on a schedule. Format: key=value. Use valid JSON formats for value.", + Usage: common.FlagMemoScheduleDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagMemoFile, - Usage: "Set a memo from a file. Each line should follow the format key=value. Use valid JSON formats for value.", + Usage: common.FlagMemoFileScheduleDefinition, Category: common.CategoryMain, }, } @@ -123,41 +123,41 @@ func NewScheduleCommands() []*cli.Command { return []*cli.Command{ { Name: "create", - Usage: "Create a new schedule.", + Usage: common.ScheduleCreateDefinition, UsageText: common.ScheduleCreateUsageText, - Description: "Takes a schedule specification plus all the same args as starting a workflow.", + Description: common.ScheduleCreateDescription, Flags: createFlags, Action: CreateSchedule, Category: common.CategoryMain, }, { Name: "update", - Usage: "Updates a schedule with a new definition (full replacement, not patch).", + Usage: common.ScheduleUpdateDefinition, UsageText: common.ScheduleUpdateUsageText, - Description: "Takes a schedule specification plus all the same args as starting a workflow.", + Description: common.ScheduleUpdateDescription, Flags: createFlags, Action: UpdateSchedule, Category: common.CategoryMain, }, { Name: "toggle", - Usage: "Pauses or unpauses a schedule.", + Usage: common.ScheduleToggleDefinition, UsageText: common.ScheduleToggleUsageText, Flags: []cli.Flag{ sid, &cli.BoolFlag{ Name: common.FlagPause, - Usage: "Pauses the schedule.", + Usage: common.FlagPauseScheduleDefinition, Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagUnpause, - Usage: "Unpauses the schedule.", + Usage: common.FlagUnpauseDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Free-form text to describe reason for pause/unpause.", + Usage: common.FlagReasonScheduleDefinition, Value: "(no reason provided)", Category: common.CategoryMain, }, @@ -166,7 +166,7 @@ func NewScheduleCommands() []*cli.Command { }, { Name: "trigger", - Usage: "Triggers an immediate action.", + Usage: common.ScheduleTriggerDefinition, UsageText: common.ScheduleTriggerUsageText, Flags: []cli.Flag{ sid, @@ -176,20 +176,20 @@ func NewScheduleCommands() []*cli.Command { }, { Name: "backfill", - Usage: "Backfills a past time range of actions.", + Usage: common.ScheduleBackfillDefinition, UsageText: common.ScheduleBackfillUsageText, Flags: []cli.Flag{ sid, overlap, &cli.StringFlag{ Name: common.FlagStartTime, - Usage: "Backfill start time.", + Usage: common.FlagBackfillStartTime, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagEndTime, - Usage: "Backfill end time.", + Usage: common.FlagBackfillEndTime, Required: true, Category: common.CategoryMain, }, @@ -198,13 +198,13 @@ func NewScheduleCommands() []*cli.Command { }, { Name: "describe", - Usage: "Get schedule configuration and current state.", + Usage: common.ScheduleDescribeDefinition, UsageText: common.ScheduleDescribeUsageText, Flags: append([]cli.Flag{ sid, &cli.BoolFlag{ Name: common.FlagPrintRaw, - Usage: "Print raw data as json (prefer this over -o json for scripting).", + Usage: common.FlagPrintRawDefinition, Category: common.CategoryMain, }, }, common.FlagsForFormatting...), @@ -212,7 +212,7 @@ func NewScheduleCommands() []*cli.Command { }, { Name: "delete", - Usage: "Deletes a schedule.", + Usage: common.ScheduleDeleteDefinition, UsageText: common.ScheduleDeleteUsageText, Flags: []cli.Flag{ sid, @@ -221,7 +221,7 @@ func NewScheduleCommands() []*cli.Command { }, { Name: "list", - Usage: "Lists schedules.", + Usage: common.ScheduleListDefinition, UsageText: common.ScheduleListUsageText, Flags: common.FlagsForPaginationAndRendering, Action: ListSchedules, diff --git a/searchattribute/search_attribute.go b/searchattribute/search_attribute.go index 731b1a04..99b291da 100644 --- a/searchattribute/search_attribute.go +++ b/searchattribute/search_attribute.go @@ -19,7 +19,7 @@ func NewSearchAttributeCommands() []*cli.Command { &cli.StringSliceFlag{ Name: common.FlagName, Required: true, - Usage: "Search attribute name.", + Usage: common.FlagNameSearchAttribute, Category: common.CategoryMain, }, &cli.StringSliceFlag{ @@ -31,7 +31,7 @@ func NewSearchAttributeCommands() []*cli.Command { &cli.BoolFlag{ Name: common.FlagYes, Aliases: common.FlagYesAlias, - Usage: "Confirm all prompts.", + Usage: common.FlagYesDefinition, Category: common.CategoryMain, }, }, @@ -64,13 +64,13 @@ func NewSearchAttributeCommands() []*cli.Command { &cli.StringSliceFlag{ Name: common.FlagName, Required: true, - Usage: "Search attribute name.", + Usage: common.FlagNameSearchAttribute, Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagYes, Aliases: common.FlagYesAlias, - Usage: "Confirm all prompts.", + Usage: common.FlagYesDefinition, Category: common.CategoryMain, }, }, diff --git a/taskqueue/task_queue.go b/taskqueue/task_queue.go index dd095673..7b2711f5 100644 --- a/taskqueue/task_queue.go +++ b/taskqueue/task_queue.go @@ -16,14 +16,14 @@ func NewTaskQueueCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagTaskQueue, Aliases: common.FlagTaskQueueAlias, - Usage: "Task Queue name.", + Usage: common.FlagTaskQueueName, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagTaskQueueType, Value: "workflow", - Usage: "Task Queue type [workflow|activity]", + Usage: common.FlagTaskQueueTypeDefinition, Category: common.CategoryMain, }, }, common.FlagsForFormatting...), @@ -39,7 +39,7 @@ func NewTaskQueueCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagTaskQueue, Aliases: common.FlagTaskQueueAlias, - Usage: "Task Queue name.", + Usage: common.FlagTaskQueueName, Required: true, Category: common.CategoryMain, }, diff --git a/workflow/workflow.go b/workflow/workflow.go index 433b2379..ef979675 100644 --- a/workflow/workflow.go +++ b/workflow/workflow.go @@ -35,12 +35,12 @@ func NewWorkflowCommands() []*cli.Command { Flags: append(common.FlagsForExecution, []cli.Flag{ &cli.BoolFlag{ Name: common.FlagResetPointsOnly, - Usage: "Only show auto-reset points.", + Usage: common.FlagResetPointsUsage, Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagPrintRaw, - Usage: "Print properties as they are stored.", + Usage: common.FlagPrintRawUsage, Category: common.CategoryMain, }, }...), @@ -73,7 +73,7 @@ func NewWorkflowCommands() []*cli.Command { Flags: append(common.FlagsForStackTraceQuery, &cli.StringFlag{ Name: common.FlagType, - Usage: "The query type you want to run.", + Usage: common.QueryFlagTypeUsage, Required: true, Category: common.CategoryMain, }), @@ -99,47 +99,47 @@ func NewWorkflowCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagWorkflowID, Aliases: common.FlagWorkflowIDAlias, - Usage: "Signal Workflow Execution by Id.", + Usage: common.FlagWorkflowSignalUsage, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagRunID, Aliases: common.FlagRunIDAlias, - Usage: "Run Id", + Usage: common.FlagRunIdDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagQuery, Aliases: common.FlagQueryAlias, - Usage: "Signal Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/.", + Usage: common.FlagQueryDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagName, - Usage: "Signal Name", + Usage: common.FlagSignalName, Required: true, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagInput, Aliases: common.FlagInputAlias, - Usage: "Input for the signal (JSON).", + Usage: common.FlagInputSignal, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagInputFile, - Usage: "Input for the signal from file (JSON).", + Usage: common.FlagInputFileSignal, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason for signaling with List Filter.", + Usage: common.FlagReasonSignal, Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagYes, Aliases: common.FlagYesAlias, - Usage: "Confirm all prompts.", + Usage: common.FlagYesDefinition, Category: common.CategoryMain, }, }, @@ -171,30 +171,30 @@ func NewWorkflowCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagWorkflowID, Aliases: common.FlagWorkflowIDAlias, - Usage: "Cancel Workflow Execution by Id.", + Usage: common.FlagCancelWorkflow, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagRunID, Aliases: common.FlagRunIDAlias, - Usage: "Run Id", + Usage: common.FlagRunIdDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagQuery, Aliases: common.FlagQueryAlias, - Usage: "Cancel Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/.", + Usage: common.FlagQueryDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason for canceling with List Filter.", + Usage: common.FlagReasonCancel, Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagYes, Aliases: common.FlagYesAlias, - Usage: "Confirm all prompts.", + Usage: common.FlagYesDefinition, Category: common.CategoryMain, }, }, @@ -210,30 +210,30 @@ func NewWorkflowCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagWorkflowID, Aliases: common.FlagWorkflowIDAlias, - Usage: "Terminate Workflow Execution by Id.", + Usage: common.FlagWorkflowIDTerminate, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagRunID, Aliases: common.FlagRunIDAlias, - Usage: "Run Id", + Usage: common.FlagRunIdDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagQuery, Aliases: common.FlagQueryAlias, - Usage: "Terminate Workflow Executions by List Filter. See https://docs.temporal.io/concepts/what-is-a-list-filter/.", + Usage: common.FlagQueryTerminate, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason for termination.", + Usage: common.FlagReasonTerminate, Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagYes, Aliases: common.FlagYesAlias, - Usage: "Confirm all prompts.", + Usage: common.FlagYesDefinition, Category: common.CategoryMain, }, }, @@ -257,12 +257,12 @@ func NewWorkflowCommands() []*cli.Command { Flags: append(common.FlagsForExecution, []cli.Flag{ &cli.StringFlag{ Name: common.FlagEventID, - Usage: "The eventId of any event after WorkflowTaskStarted you want to reset to (exclusive). It can be WorkflowTaskCompleted, WorkflowTaskFailed or others.", + Usage: common.FlagEventIDDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason to reset.", + Usage: common.FlagReasonReset, Required: true, Category: common.CategoryMain, }, @@ -290,40 +290,40 @@ func NewWorkflowCommands() []*cli.Command { &cli.StringFlag{ Name: common.FlagQuery, Aliases: common.FlagQueryAlias, - Usage: "Visibility query of Search Attributes describing the Workflow Executions to reset. See https://docs.temporal.io/docs/tctl/workflow/list#--query.", + Usage: common.FlagQueryResetBatch, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagInputFile, - Usage: "Input file that specifies Workflow Executions to reset. Each line contains one Workflow Id as the base Run and, optionally, a Run Id.", + Usage: common.FlagInputFileReset, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagExcludeFile, Value: "", - Usage: "Input file that specifies Workflow Executions to exclude from resetting.", + Usage: common.FlagExcludeFileDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagInputSeparator, Value: "\t", - Usage: "Separator for the input file. The default is a tab (\t).", + Usage: common.FlagInputSeparatorDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ Name: common.FlagReason, - Usage: "Reason for resetting the Workflow Executions.", + Usage: common.FlagReasonResetBatch, Required: true, Category: common.CategoryMain, }, &cli.IntFlag{ Name: common.FlagParallelism, Value: 1, - Usage: "Number of goroutines to run in parallel. Each goroutine processes one line for every second.", + Usage: common.FlagParallelismDefinition, Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagSkipCurrentOpen, - Usage: "Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run.", + Usage: common.FlagSkipCurrentOpenDefinition, Category: common.CategoryMain, }, &cli.BoolFlag{ @@ -331,12 +331,12 @@ func NewWorkflowCommands() []*cli.Command { // TODO https://github.com/uber/cadence/issues/2930 // The right way to prevent needs server side implementation . // This client side is only best effort - Usage: "Skip a Workflow Execution if the base Run is not the current Run.", + Usage: common.FlagSkipBaseDefinition, Category: common.CategoryMain, }, &cli.BoolFlag{ Name: common.FlagNonDeterministic, - Usage: "Reset Workflow Execution only if its last Event is WorkflowTaskFailed with a nondeterministic error.", + Usage: common.FlagNonDeterministicDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ @@ -347,7 +347,7 @@ func NewWorkflowCommands() []*cli.Command { }, &cli.BoolFlag{ Name: common.FlagDryRun, - Usage: "Simulate reset without resetting any Workflow Executions.", + Usage: common.FlagDryRunDefinition, Category: common.CategoryMain, }, }, @@ -363,13 +363,13 @@ func NewWorkflowCommands() []*cli.Command { &cli.IntFlag{ Name: common.FlagDepth, Value: -1, - Usage: "Number of Child Workflows to expand, -1 to expand all Child Workflows.", + Usage: common.FlagDepthDefinition, Category: common.CategoryMain, }, &cli.IntFlag{ Name: common.FlagConcurrency, Value: 10, - Usage: "Request concurrency", + Usage: common.FlagConcurrencyDefinition, Category: common.CategoryMain, }, &cli.StringFlag{ @@ -380,7 +380,7 @@ func NewWorkflowCommands() []*cli.Command { }, &cli.BoolFlag{ Name: common.FlagNoFold, - Usage: "Disable folding. All Child Workflows within the set depth will be fetched and displayed.", + Usage: common.FlagNoFoldDefinition, Category: common.CategoryMain, }), Action: TraceWorkflow, From da268ef5ac00a6dc3e3cad0dffe6797c4546a157 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Thu, 2 Feb 2023 14:42:29 -0600 Subject: [PATCH 67/68] reviewed usagetext --- common/defs-cmds.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/common/defs-cmds.go b/common/defs-cmds.go index 265e7ddf..2bf4e540 100644 --- a/common/defs-cmds.go +++ b/common/defs-cmds.go @@ -92,8 +92,11 @@ The List Filter identifies the Workflow Executions that will be affected by the The Batch type determines the other parameters that need to be provided, along with what is being affected on the Workflow Executions. To start the Batch job, run `+"`"+`temporal workflow query`+"`"+`. +Running Signal, Terminate, or Cancel with the `+"`"+`--query`+"`"+` modifier will start a Batch job automatically. + A successfully started Batch job will return a Job ID. Use this Job ID to execute other actions on the Batch job. + ` const DescribeBatchUsageText = `The `+"`"+`temporal batch describe`+"`"+` command shows the progress of an ongoing Batch job. From 3480934668a7bdc80a57ecded70f480744973b56 Mon Sep 17 00:00:00 2001 From: Samantha Santiago Date: Fri, 3 Feb 2023 15:55:45 -0600 Subject: [PATCH 68/68] changed links --- common/defs-cmds.go | 171 ++++++++++++++++---------------------------- 1 file changed, 61 insertions(+), 110 deletions(-) diff --git a/common/defs-cmds.go b/common/defs-cmds.go index 2bf4e540..af36b14c 100644 --- a/common/defs-cmds.go +++ b/common/defs-cmds.go @@ -83,10 +83,8 @@ const ( ScheduleListDefinition = "Lists Schedules." ) -//TODO: get information checked for all UsageTexts - -const BatchUsageText = `Batch commands allow you to change multiple [Workflow Executions](/workflows#workflow-execution) without having to repeat yourself on the command line. -In order to do this, you provide the command with a [List Filter](/visibility#list-filter) and the type of Batch job to execute. +const BatchUsageText = `Batch commands allow you to change multiple [Workflow Executions](/concepts/what-is-a-workflow-execution) without having to repeat yourself on the command line. +In order to do this, you provide the command with a [List Filter](/concepts/what-is-visibility) and the type of Batch job to execute. The List Filter identifies the Workflow Executions that will be affected by the Batch job. The Batch type determines the other parameters that need to be provided, along with what is being affected on the Workflow Executions. @@ -104,7 +102,6 @@ Use the command options listed below to change the information returned by this Make sure to write the command in this format: `+"`"+`temporal batch describe [command options] [arguments]`+"`"+` -## OPTIONS ` const ListBatchUsageText = `When used, `+"`"+`temporal batch list`+"`"+` returns all Batch jobs. @@ -112,7 +109,6 @@ Use the command options listed below to change the information returned by this Make sure to write the command in this format: `+"`"+`temporal batch list [command options] [arguments]`+"`"+` -## OPTIONS ` const TerminateBatchUsageText = `The `+"`"+`temporal batch terminate`+"`"+` command terminates a Batch job with the provided Job ID. @@ -120,19 +116,17 @@ Use the command options listed below to change the behavior of this command. Make sure to write the command as follows: `+"`"+`temporal batch terminate [command options] [arguments]`+"`"+` -## OPTIONS ` -const StartWorkflowUsageText = `The `+"`"+`temporal workflow start`+"`"+` command starts a new [Workflow Execution](/workflows#workflow-execution). -When invoked successfully, the Workflow and Run ID are returned immediately after starting the [Workflow](/workflows). +const StartWorkflowUsageText = `The `+"`"+`temporal workflow start`+"`"+` command starts a new [Workflow Execution](/concepts/what-is-a-workflow-execution). +When invoked successfully, the Workflow and Run ID are returned immediately after starting the [Workflow](/concepts/what-is-a-workflow). Use the command options listed below to change how the Workflow Execution behaves upon starting. Make sure to write the command in this format: `+"`"+`temporal workflow start [command options] [arguments]`+"`"+` -## OPTIONS ` -const ExecuteWorkflowUsageText = `The `+"`"+`temporal workflow execute`+"`"+` command starts a new [Workflow Execution](/workflows#workflow-execution) and prints its progress. -The command doesn't finish until the [Workflow](/workflows) completes. +const ExecuteWorkflowUsageText = `The `+"`"+`temporal workflow execute`+"`"+` command starts a new [Workflow Execution](/concepts/what-is-a-workflow-execution) and prints its progress. +The command doesn't finish until the [Workflow](/concepts/what-is-a-workflow) completes. Single quotes('') are used to wrap input as JSON. @@ -140,130 +134,117 @@ Use the command options listed below to change how the Workflow Execution behave Make sure to write the command in this format: `+"`"+`temporal workflow execute [command options] [arguments]`+"`"+` -## OPTIONS ` -const DescribeWorkflowUsageText = `The `+"`"+`temporal workflow describe`+"`"+` command shows information about a given [Workflow Execution](/workflows#workflow-execution). +const DescribeWorkflowUsageText = `The `+"`"+`temporal workflow describe`+"`"+` command shows information about a given [Workflow Execution](/concepts/what-is-a-workflow-execution). This information can be used to locate Workflow Executions that weren't able to run successfully. Use the command options listed below to change the information returned by this command. Make sure to write the command in this format: `+"`"+`temporal workflow describe [command options] [arguments]`+"`"+` -## OPTIONS ` -const ListWorkflowUsageText = `The `+"`"+`temporal workflow list`+"`"+` command provides a list of [Workflow Executions](/workflows#workflow-execution) that meet the criteria of a given [Query](/workflows#query). +const ListWorkflowUsageText = `The `+"`"+`temporal workflow list`+"`"+` command provides a list of [Workflow Executions](/concepts/what-is-a-workflow-execution) that meet the criteria of a given [Query](/concepts/what-is-a-query). By default, this command returns a list of up to 10 closed Workflow Executions. Use the command options listed below to change the information returned by this command. Make sure to write the command as follows: `+"`"+`temporal workflow list [command options] [arguments]`+"`"+` -## OPTIONS ` -const QueryWorkflowUsageText = `The `+"`"+`temporal workflow query`+"`"+` command sends a [Query](/workflows#query) to a [Workflow Execution](/workflows#workflow-execution). +const QueryWorkflowUsageText = `The `+"`"+`temporal workflow query`+"`"+` command sends a [Query](/concepts/what-is-a-query) to a [Workflow Execution](/concepts/what-is-a-workflow-execution). Queries can retrieve all or part of the Workflow state within given parameters. -Queries can also be used on completed [Workflows](/workflows#workflow-execution). +Queries can also be used on completed [Workflows](/concepts/what-is-a-workflow-execution). Use the command options listed below to change the information returned by this command. Make sure to write the command as follows: `+"`"+`temporal workflow query [command options] [arguments]`+"`"+` -## OPTIONS ` -const CancelWorkflowUsageText = `The `+"`"+`temporal workflow cancel`+"`"+` command cancels a [Workflow Execution](/workflows#workflow-execution). +const CancelWorkflowUsageText = `The `+"`"+`temporal workflow cancel`+"`"+` command cancels a [Workflow Execution](/concepts/what-is-a-workflow-execution). -Canceling a running Workflow Execution records a [`+"`"+`WorkflowExecutionCancelRequested`+"`"+` event](/events#workflowexecutioncancelrequested) in the [Event History](/workflows#event-history). -A new [Command](/workflows#command) Task will be scheduled, and the Workflow Execution performs cleanup work. +Canceling a running Workflow Execution records a [`+"`"+`WorkflowExecutionCancelRequested`+"`"+` event](/references/events#workflow-execution-cancel-requested) in the [Event History](/concepts/what-is-an-event-history). +A new [Command](/concepts/what-is-a-command) Task will be scheduled, and the Workflow Execution performs cleanup work. Use the options listed below to change the behavior of this command. Make sure to write the command as follows: `+"`"+`temporal workflow cancel [command options] [arguments]`+"`"+` -## OPTIONS ` -const TerminateWorkflowUsageText = `The `+"`"+`temporal workflow terminate`+"`"+` command terminates a [Workflow Execution](/workflows#workflow-execution) +const TerminateWorkflowUsageText = `The `+"`"+`temporal workflow terminate`+"`"+` command terminates a [Workflow Execution](/concepts/what-is-a-workflow-execution) -Terminating a running Workflow Execution records a [`+"`"+`WorkflowExecutionTerminated`+"`"+` event](/events#workflowexecutionterminated) as the closing Event in the [Event History](/workflows#event-history). -Any further [Command](/workflows#command) Tasks cannot be scheduled after running this command. +Terminating a running Workflow Execution records a [`+"`"+`WorkflowExecutionTerminated`+"`"+` event](/references/events#workflowexecutionterminated) as the closing Event in the [Event History](/concepts/what-is-an-event-history). +Any further [Command](/concepts/what-is-a-command) Tasks cannot be scheduled after running this command. Use the options listed below to change termination behavior. Make sure to write the command as follows: `+"`"+`temporal workflow terminate [command options] [arguments]`+"`"+` -## OPTIONS ` -const ResetWorkflowUsageText = `The `+"`"+`temporal workflow reset`+"`"+` command resets a [Workflow Execution](/workflows#workflow-execution). -A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](/workflows#event-history). +const ResetWorkflowUsageText = `The `+"`"+`temporal workflow reset`+"`"+` command resets a [Workflow Execution](/concepts/what-is-a-workflow-execution). +A reset allows the Workflow to be resumed from a certain point without losing your parameters or [Event History](/concepts/what-is-an-event-history). Use the options listed below to change reset behavior. Make sure to write the command as follows: `+"`"+`temporal workflow reset [command options] [arguments]`+"`"+` -## OPTIONS ` -const ResetBatchUsageText = `The `+"`"+`temporal workflow reset-batch`+"`"+` command resets a batch of [Workflow Executions](/workflows#workflow-execution) by `+"`"+`resetType`+"`"+`. -Resetting a [Workflow](/workflows) allows the process to resume from a certain point without losing your parameters or [Event History](/workflows#event-history). +const ResetBatchUsageText = `The `+"`"+`temporal workflow reset-batch`+"`"+` command resets a batch of [Workflow Executions](/concepts/what-is-a-workflow-execution) by `+"`"+`resetType`+"`"+`. +Resetting a [Workflow](/concepts/what-is-a-workflow) allows the process to resume from a certain point without losing your parameters or [Event History](/concepts/what-is-an-event-history). Use the options listed below to change reset behavior. Make sure to write the command as follows: `+"`"+`temporal workflow reset-batch [command options] [arguments]`+"`"+` -## OPTIONS ` -const DescribeTaskQueueUsageText = `The `+"`"+`temporal task-queue describe`+"`"+` command provides [poller](/applcation-development/worker-performance#poller-count) information for a given [Task Queue](/tasks#task-queue). +const DescribeTaskQueueUsageText = `The `+"`"+`temporal task-queue describe`+"`"+` command provides [poller](/application-development/worker-performance#poller-count) information for a given [Task Queue](/concepts/what-is-a-task-queue). -The [Server](/clusters#temporal-server) records the last time of each poll request. +The [Server](/concepts/what-is-the-temporal-server) records the last time of each poll request. Should `+"`"+`LastAccessTime`+"`"+` exceeds one minute, it's likely that the Worker is at capacity (all Workflow and Activity slots are full) or that the Worker has shut down. -[Workers](/workers) are removed if 5 minutes have passed since the last poll request. +[Workers](/concepts/what-is-a-worker) are removed if 5 minutes have passed since the last poll request. Use the options listed below to modify what this command returns. Make sure to write the command as follows: `+"`"+`temporal task-queue describe [command options] [arguments]`+"`"+` -## OPTIONS ` -const ScheduleUsageText = `Schedule commands allow the user to create, use, and update [Schedules](/workflows#schedule). +const ScheduleUsageText = `Schedule commands allow the user to create, use, and update [Schedules](/concepts/what-is-a-schedule). Schedules control when certain Actions for a Workflow Execution are performed, making it a useful tool for automation. To run a Schedule command, run `+"`"+`temporal schedule [command] [command options] [arguments]`+"`"+`. ` -const OperatorUsageText = `Operator commands enable actions on [Namespaces](/namespaces), [Search Attributes](/visibility#search-attribute), and [Temporal Clusters](/clusters). +const OperatorUsageText = `Operator commands enable actions on [Namespaces](/concepts/what-is-a-namespace), [Search Attributes](/concepts/what-is-a-search-attribute), and [Temporal Clusters](/concepts/what-is-a-temporal-cluster). These actions are performed through subcommands for each Operator area. To run an Operator command, run `+"`"+`temporal operator [command] [subcommand] [command options] [arguments]`+"`"+`. ` -const CompleteActivityUsageText = `The `+"`"+`temporal activity complete`+"`"+` command completes an [Activity Execution](/activities#activity-execution). +const CompleteActivityUsageText = `The `+"`"+`temporal activity complete`+"`"+` command completes an [Activity Execution](/concepts/what-is-an-activity-execution). Use the options listed below to change the behavior of this command. Make sure to write the command as follows: `+"`"+`temporal activity complete [command options] [arguments]`+"`"+` -## OPTIONS ` -const FailActivityUsageText = `The `+"`"+`temporal activity fail`+"`"+` command fails an [Activity Execution](/activities#activity-execution). +const FailActivityUsageText = `The `+"`"+`temporal activity fail`+"`"+` command fails an [Activity Execution](/concepts/what-is-an-activity-execution). Use the options listed below to change the behavior of this command. Make sure to write the command as follows: `+"`"+`temporal activity fail [command options] [arguments]`+"`"+` -## OPTIONS ` -const HealthUsageText = `The `+"`"+`temporal operator cluster health`+"`"+` command checks the health of the [Frontend Service](/clusters#frontend-service). +const HealthUsageText = `The `+"`"+`temporal operator cluster health`+"`"+` command checks the health of the [Frontend Service](/concepts/what-is-a-frontend-service). Use the options listed below to change the behavior and output of this command. Make sure to write the command as follows: `+"`"+`temporal operator cluster health [command options] [arguments]`+"`"+` -## OPTIONS ` -const ClusterDescribeUsageText = `The `+"`"+`temporal operator cluster describe`+"`"+` command shows information about the [Cluster](/clusters). +const ClusterDescribeUsageText = `The `+"`"+`temporal operator cluster describe`+"`"+` command shows information about the [Cluster](/concepts/what-is-a-temporal-cluster). Use the options listed below to change the output of this command. Make sure to write the command as follows: `+"`"+`temporal operator cluster describe [command options] [arguments]`+"`"+` -## OPTIONS ` const ClusterSystemUsageText = `The `+"`"+`temporal operator cluster system`+"`"+` command provides information about the system the Cluster is running on. @@ -271,32 +252,28 @@ Use the options listed below to change this command's output. Make sure to write the command as follows: `+"`"+`temporal operator cluster system [command options] [arguments]`+"`"+` -## OPTIONS ` -const ClusterUpsertUsageText = `The `+"`"+`temporal operator cluster upsert`+"`"+` command allows the user to add or update a remote [Cluster](/clusters). +const ClusterUpsertUsageText = `The `+"`"+`temporal operator cluster upsert`+"`"+` command allows the user to add or update a remote [Cluster](/concepts/what-is-a-temporal-cluster). Use the options listed below to change the behavior of this command. Make sure to write the command as follows: `+"`"+`temporal operator cluster upsert [command options] [arguments]`+"`"+` -## OPTIONS ` -const ClusterListUsageText = `The `+"`"+`temporal operator cluster list`+"`"+` command prints a list of all remote [Clusters](/clusters) on the system. +const ClusterListUsageText = `The `+"`"+`temporal operator cluster list`+"`"+` command prints a list of all remote [Clusters](/concepts/what-is-a-temporal-cluster) on the system. Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal operator cluster list [command options] [arguments]`+"`"+` -## OPTIONS ` -const ClusterRemoveUsageText = `The `+"`"+`temporal operator cluster remove`+"`"+` command removes a remote [Cluster](/clusters) from the system. +const ClusterRemoveUsageText = `The `+"`"+`temporal operator cluster remove`+"`"+` command removes a remote [Cluster](/concepts/what-is-a-temporal-cluster) from the system. Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal operator cluster remove [command options] [arguments]`+"`"+` -## OPTIONS ` const EnvGetUsageText = `The `+"`"+`temporal env get`+"`"+` command prints the environmental properties for the environment in use. @@ -304,7 +281,6 @@ Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal env get [command options] [arguments]`+"`"+` -## OPTIONS ` const EnvSetUsageText = `The `+"`"+`temporal env set`+"`"+` command sets the value for an environmental property. @@ -312,7 +288,6 @@ Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal env set [command options] [arguments]`+"`"+` -## OPTIONS ` const EnvDeleteUsageText = `The `+"`"+`temporal env delete`+"`"+` command deletes a given environment or environmental property. @@ -320,50 +295,44 @@ Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal env delete [command options] [arguments]`+"`"+` -## OPTIONS ` -const NamespaceDescribeUsageText = `The `+"`"+`temporal operator namespace describe`+"`"+` command provides a description of a [Namespace](/namespaces). +const NamespaceDescribeUsageText = `The `+"`"+`temporal operator namespace describe`+"`"+` command provides a description of a [Namespace](/concepts/what-is-a-namespace). Namespaces can be identified by name or Namespace ID. Use the options listed below to change the command's output. Make sure to write the command as follows: `+"`"+`temporal operator namespace describe [command options] [arguments]`+"`"+` -## OPTIONS ` -const NamespaceListUsageText = `The `+"`"+`temporal operator namespace list`+"`"+` command lists all [Namespaces](/namespaces) on the [Server](/clusters#frontend-server). +const NamespaceListUsageText = `The `+"`"+`temporal operator namespace list`+"`"+` command lists all [Namespaces](/namespaces) on the [Server](/concepts/what-is-a-frontend-server). Use the options listed below to change the command's output. Make sure to write the command as follows: `+"`"+`temporal operator namespace list [command options] [arguments]`+"`"+` -## OPTIONS ` -const NamespaceCreateUsageText = `The `+"`"+`temporal operator namespace create`+"`"+` command creates a new [Namespace](/namespaces). +const NamespaceCreateUsageText = `The `+"`"+`temporal operator namespace create`+"`"+` command creates a new [Namespace](/concepts-what-is-a-namespace). Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal operator namespace create [command options] [arguments]`+"`"+` -## OPTIONS ` -const NamespaceUpdateUsageText = `The `+"`"+`temporal operator namespace update`+"`"+` command updates a given [Namespace](/namespaces). +const NamespaceUpdateUsageText = `The `+"`"+`temporal operator namespace update`+"`"+` command updates a given [Namespace](/concepts-what-is-a-namespace). Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal operator namespace update [command options] [arguments]`+"`"+` -## OPTIONS ` -const NamespaceDeleteUsageText = `The `+"`"+`temporal operator namespace delete`+"`"+` command deletes a given [Namespace](/namespaces) from the system. +const NamespaceDeleteUsageText = `The `+"`"+`temporal operator namespace delete`+"`"+` command deletes a given [Namespace](/concepts-what-is-a-namespace) from the system. Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal operator namespace delete [command options] [arguments]`+"`"+` -## OPTIONS ` -const ScheduleCreateUsageText = `The `+"`"+`temporal schedule create`+"`"+` command creates a new [Schedule](/workflows#schedule). +const ScheduleCreateUsageText = `The `+"`"+`temporal schedule create`+"`"+` command creates a new [Schedule](/concepts/what-is-a-schedule). Newly created Schedules return a Schedule ID to be used in other Schedule commands. Schedules need to follow a format like the example shown here: @@ -381,9 +350,8 @@ Actions will be executed at any time specified in the Schedule. Use the options provided below to change the command's behavior. -## OPTIONS ` -const ScheduleUpdateUsageText = `The `+"`"+`temporal schedule update`+"`"+` command updates an existing [Schedule](/workflows#schedule). +const ScheduleUpdateUsageText = `The `+"`"+`temporal schedule update`+"`"+` command updates an existing [Schedule](/concepts/what-is-a-schedule). Like `+"`"+`temporal schedule create`+"`"+`, updated Schedules need to follow a certain format: `+"`"+``+"`"+``+"`"+` @@ -400,10 +368,9 @@ If you only change one value of the Schedule, be sure to provide the other uncha Use the options provided below to change the command's behavior. -## OPTIONS ` -const ScheduleToggleUsageText = `The `+"`"+`temporal schedule toggle`+"`"+` command can pause and unpause a [Schedule](/workflows#schedule). +const ScheduleToggleUsageText = `The `+"`"+`temporal schedule toggle`+"`"+` command can pause and unpause a [Schedule](/concepts/what-is-a-schedule). Toggling a Schedule requires a reason to be entered on the command line. Use `+"`"+`--reason`+"`"+` to note the issue leading to the pause or unpause. @@ -414,10 +381,9 @@ Schedule toggles are passed in this format: Use the options provided below to change this command's behavior. -## OPTIONS ` -const ScheduleTriggerUsageText = `The `+"`"+`temporal schedule trigger`+"`"+` command triggers an immediate action with a given [Schedule](/workflows#schedule). +const ScheduleTriggerUsageText = `The `+"`"+`temporal schedule trigger`+"`"+` command triggers an immediate action with a given [Schedule](/concepts/what-is-a-schedule). By default, this action is subject to the Overlap Policy of the Schedule. `+"`"+`temporal schedule trigger`+"`"+` can be used to start a Workflow Run immediately. @@ -428,11 +394,10 @@ The Overlap Policy of the Schedule can be overridden as well. Use the options provided below to change this command's behavior. -## OPTIONS ` const ScheduleBackfillUsageText = `The `+"`"+`temporal schedule backfill`+"`"+` command executes Actions ahead of their specified time range. -Backfilling can be used to fill in [Workflow Runs](/workflows#run-id) from a time period when the Schedule was paused, or from before the Schedule was created. +Backfilling can be used to fill in [Workflow Runs](/concepts/what-is-a-run-id) from a time period when the Schedule was paused, or from before the Schedule was created. `+"`"+``+"`"+``+"`"+` temporal schedule backfill --sid 'your-schedule-id' \ @@ -443,56 +408,50 @@ temporal schedule backfill --sid 'your-schedule-id' \ Use the options provided below to change this command's behavior. -## OPTIONS ` -const ScheduleDescribeUsageText = `The `+"`"+`temporal schedule describe`+"`"+` command shows the current [Schedule](#workflows#schedule) configuration. -This command also provides information about past, current, and future [Workflow Runs](/workflows#run-id). +const ScheduleDescribeUsageText = `The `+"`"+`temporal schedule describe`+"`"+` command shows the current [Schedule](/concepts/what-is-a-schedule) configuration. +This command also provides information about past, current, and future [Workflow Runs](/concepts/what-is-a-run-id). `+"`"+`temporal schedule describe --sid 'your-schedule-id' [command options] [arguments]`+"`"+` Use the options below to change this command's output. -## OPTIONS ` -const ScheduleDeleteUsageText = `The `+"`"+`temporal schedule delete`+"`"+` command deletes a [Schedule](/workflows#schedule). -Deleting a Schedule does not affect any [Workflows](/workflows) started by the Schedule. +const ScheduleDeleteUsageText = `The `+"`"+`temporal schedule delete`+"`"+` command deletes a [Schedule](/concepts/what-is-a-schedule). +Deleting a Schedule does not affect any [Workflows](/concepts/what-is-a-workflow) started by the Schedule. -[Workflow Executions](/workflows#workflow-execution) started by Schedules can be cancelled or terminated like other Workflow Executions. -However, Workflow Executions started by a Schedule can be identified by their [Search Attributes](/visibility#search-attribute), making them targetable by batch command for termination. +[Workflow Executions](/concepts/what-is-a-workflow-execution) started by Schedules can be cancelled or terminated like other Workflow Executions. +However, Workflow Executions started by a Schedule can be identified by their [Search Attributes](/concepts/what-is-a-search-attribute), making them targetable by batch command for termination. `+"`"+`temporal schedule delete --sid 'your-schedule-id' [command options] [arguments]`+"`"+` Use the options below to change the behavior of this command. -## OPTIONS ` -const ScheduleListUsageText = `The `+"`"+`temporal schedule list`+"`"+` command lists all [Schedule](/workflows#schedule) configurations. -Listing Schedules in [Standard Visibility](/visibility#standard-visibility) will only provide Schedule IDs. +const ScheduleListUsageText = `The `+"`"+`temporal schedule list`+"`"+` command lists all [Schedule](/concepts/what-is-a-schedule) configurations. +Listing Schedules in [Standard Visibility](/concepts/what-is-standard-visibility) will only provide Schedule IDs. `+"`"+`temporal schedule list [command options] [arguments]`+"`"+` Use the options below to change the behavior of this command. -## OPTIONS ` -const SearchAttributeCreateUsageText = `The `+"`"+`temporal operator search-attribute create`+"`"+` command adds one or more custom [Search Attributes](/visibility#search-attribute). -These Search Attributes can be used to [filter a list](/visibility#list-filter) of [Workflow Executions](/workflows#workflow-execution) that contain the given Search Attributes in their metadata. +const SearchAttributeCreateUsageText = `The `+"`"+`temporal operator search-attribute create`+"`"+` command adds one or more custom [Search Attributes](/concepts/what-is-a-search-attribute). +These Search Attributes can be used to [filter a list](/concepts/whaat-is-a-list-filter) of [Workflow Executions](/concepts/what-is-a-workflow-execution) that contain the given Search Attributes in their metadata. Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal operator search-attribute create [command options] [arguments]`+"`"+` -## OPTIONS ` -const SearchAttributeListUsageText = `The `+"`"+`temporal operator search-attrbute list`+"`"+` command displays a list of all [Search Attributes](/visibility#search-attribute) that can be used in `+"`"+` temporal workflow list --query`+"`"+`. +const SearchAttributeListUsageText = `The `+"`"+`temporal operator search-attrbute list`+"`"+` command displays a list of all [Search Attributes](/concepts/what-is-a-search-attribute) that can be used in `+"`"+` temporal workflow list --query`+"`"+`. Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal operator search-attribute list [command options] [arguments]`+"`"+` -## OPTIONS ` -const SearchAttributeRemoveUsageText = `The `+"`"+`temporal operator search-attribute remove`+"`"+` command removes custom [Search Attribute](/visibility#search-attribute) metadata. +const SearchAttributeRemoveUsageText = `The `+"`"+`temporal operator search-attribute remove`+"`"+` command removes custom [Search Attribute](/concepts/what-is-a-search-attribute) metadata. This command does not remove custom Search Attributes from Elasticsearch. The index schema is not modified. @@ -500,64 +459,56 @@ Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal operator search-attribute remove [command options] [arguments]`+"`"+` -## OPTIONS ` -const TaskQueueListPartitionUsageText = `The `+"`"+`temporal task-queue list-partition`+"`"+` command displays the partitions of a [Task Queue](/tasks#task-queue), along with the matching node they are assigned to. +const TaskQueueListPartitionUsageText = `The `+"`"+`temporal task-queue list-partition`+"`"+` command displays the partitions of a [Task Queue](/concepts/what-is-a-task-queue), along with the matching node they are assigned to. Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal task-queue list-partition [command options] [arguments]`+"`"+` -## OPTIONS ` -const WorkflowShowUsageText = `The `+"`"+`temporal workflow show`+"`"+` command provides the [Event History](/workflows#event-history) for a specified [Workflow Execution](/workflows#workflow-execution). +const WorkflowShowUsageText = `The `+"`"+`temporal workflow show`+"`"+` command provides the [Event History](/concepts/what-is-an-event-history) for a specified [Workflow Execution](/concepts/what-is-a-workflow-execution). Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal workflow show [command options] [arguments]`+"`"+` -## OPTIONS ` -const WorkflowStackUsageText = `The `+"`"+`temporal workflow stack`+"`"+` command queries a [Workflow Execution](/workflows#workflow-execution) with `+"`"+`--stack-trace`+"`"+` as the [Query](/workflows#stack-trace-query) type. +const WorkflowStackUsageText = `The `+"`"+`temporal workflow stack`+"`"+` command queries a [Workflow Execution](/concepts/what-is-a-workflow-execution) with `+"`"+`--stack-trace`+"`"+` as the [Query](/concepts/what-is-a-query#stack-trace-query) type. Returning the stack trace of all the threads owned by a Workflow Execution can be great for troubleshooting in production. Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal workflow stack [command options] [arguments]`+"`"+` -## OPTIONS ` -const WorkflowSignalUsageText = `The `+"`"+`temporal workflow signal`+"`"+` command is used to [Signal](/workflows#signal) a [Workflow Execution](/workflows#workflow-execution) by ID or [List Filter](/visibility#list-filter). +const WorkflowSignalUsageText = `The `+"`"+`temporal workflow signal`+"`"+` command is used to [Signal](/concepts/what-is-a-signal) a [Workflow Execution](/concepts/what-is-a-workflow-execution) by ID or [List Filter](/concepts/what-is-a-list-filter). Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal workflow signal [command options] [arguments]`+"`"+` -## OPTIONS ` -const WorkflowCountUsageText = `The `+"`"+`temporal workflow count`+"`"+` command returns a count of [Workflow Executions](/workflows#workflow-execution). +const WorkflowCountUsageText = `The `+"`"+`temporal workflow count`+"`"+` command returns a count of [Workflow Executions](/concepts/what-is-a-workflow-execution). This command requires Elasticsearch to be enabled. Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal workflow count [command options] [arguments]`+"`"+` -## OPTIONS ` -const WorkflowDeleteUsageText = `The `+"`"+`temporal workflow delete`+"`"+` command deletes the specified [Workflow Execution](/workflows#workflow-execution). +const WorkflowDeleteUsageText = `The `+"`"+`temporal workflow delete`+"`"+` command deletes the specified [Workflow Execution](/concepts/what-is-a-workflow-execution). Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal workflow delete [command options] [arguments]`+"`"+` -## OPTIONS ` -const WorkflowTraceUsageText = `The `+"`"+`temporal workflow trace`+"`"+` command tracks the progress of a [Workflow Execution](/workflows#workflow-execution) and any [Child Workflows](/workflows#child-workflow) it generates. +const WorkflowTraceUsageText = `The `+"`"+`temporal workflow trace`+"`"+` command tracks the progress of a [Workflow Execution](/concepts/what-is-a-workflow-execution) and any [Child Workflows](/concepts/what-is-a-child-workflow) it generates. Use the options listed below to change the command's behavior. Make sure to write the command as follows: `+"`"+`temporal workflow trace [command options] [arguments]`+"`"+` -## OPTIONS ` \ No newline at end of file