From 903132c54e3b42eaaf678d3766e9e7baedec03f5 Mon Sep 17 00:00:00 2001 From: Alex Stanfield Date: Tue, 3 Mar 2026 01:04:51 +0000 Subject: [PATCH] Update CLI docs for release v1.6.1 --- docs/cli/activity.mdx | 6 +++--- docs/cli/batch.mdx | 2 +- docs/cli/config.mdx | 2 +- docs/cli/env.mdx | 2 +- docs/cli/operator.mdx | 2 +- docs/cli/schedule.mdx | 14 +++++++++++--- docs/cli/server.mdx | 2 +- docs/cli/task-queue.mdx | 2 +- docs/cli/worker.mdx | 2 +- docs/cli/workflow.mdx | 4 ++-- 10 files changed, 23 insertions(+), 15 deletions(-) diff --git a/docs/cli/activity.mdx b/docs/cli/activity.mdx index 0a530f9c80..324b36daf5 100644 --- a/docs/cli/activity.mdx +++ b/docs/cli/activity.mdx @@ -114,7 +114,7 @@ activity timeout, as well as, optionally, the If the activity may be executing (i.e. it has not yet timed out), the reset will take effect the next time it fails, heartbeats, or times out. -If it is waiting for a retry (i.e. has failed or timed out), the reset +If is waiting for a retry (i.e. has failed or timed out), the reset will apply immediately. If the activity is already paused, it will be unpaused by default. @@ -136,7 +136,7 @@ reset, handle this error and then re-throw it when you've cleaned up. If the `reset_heartbeats` flag is set, the heartbeat details will also be cleared. -Specify the Activity Type or ID and Workflow IDs: +Specify the Activity Type of ID and Workflow IDs: ``` temporal activity reset \ @@ -314,7 +314,7 @@ The following options can be used with any command. | `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | | | `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | | | `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` | -| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. | `info` | +| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` | | `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` | | `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | | | `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` | diff --git a/docs/cli/batch.mdx b/docs/cli/batch.mdx index a9e76204f0..c79731441a 100644 --- a/docs/cli/batch.mdx +++ b/docs/cli/batch.mdx @@ -96,7 +96,7 @@ The following options can be used with any command. | `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | | | `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | | | `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` | -| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. | `info` | +| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` | | `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` | | `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | | | `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` | diff --git a/docs/cli/config.mdx b/docs/cli/config.mdx index 96663123c5..eaeff2dd98 100644 --- a/docs/cli/config.mdx +++ b/docs/cli/config.mdx @@ -121,7 +121,7 @@ The following options can be used with any command. | `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | | | `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | | | `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` | -| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. | `info` | +| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` | | `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` | | `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | | | `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` | diff --git a/docs/cli/env.mdx b/docs/cli/env.mdx index 9b64f74df7..a019b6fb23 100644 --- a/docs/cli/env.mdx +++ b/docs/cli/env.mdx @@ -132,7 +132,7 @@ The following options can be used with any command. | `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | | | `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | | | `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` | -| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. | `info` | +| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` | | `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` | | `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | | | `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` | diff --git a/docs/cli/operator.mdx b/docs/cli/operator.mdx index c7a7b9666f..74727387bf 100644 --- a/docs/cli/operator.mdx +++ b/docs/cli/operator.mdx @@ -540,7 +540,7 @@ The following options can be used with any command. | `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | | | `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | | | `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` | -| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. | `info` | +| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` | | `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` | | `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | | | `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` | diff --git a/docs/cli/schedule.mdx b/docs/cli/schedule.mdx index d1dc5baa30..d1b1a1f9c2 100644 --- a/docs/cli/schedule.mdx +++ b/docs/cli/schedule.mdx @@ -254,6 +254,16 @@ temporal schedule update \ --workflow-type "NewWorkflowType" ``` +This command performs a full replacement of the Schedule +configuration. Any options not provided will be reset to their default +values. You must re-specify all options, not just the ones you want to +change. To view the current configuration of a Schedule, use +`temporal schedule describe` before updating. + +Schedule memo and search attributes cannot be updated with this +command. They are set only during Schedule creation and are not affected +by updates. + Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. | Flag | Required | Description | @@ -281,8 +291,6 @@ Use the following options to change the behavior of this command. You can also u | `--remaining-actions` | No | **int** Total allowed actions. Default is zero (unlimited). | | `--run-timeout` | No | **duration** Fail a Workflow Run if it lasts longer than `DURATION`. | | `--schedule-id`, `-s` | Yes | **string** Schedule ID. | -| `--schedule-memo` | No | **string[]** Set schedule memo using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. | -| `--schedule-search-attribute` | No | **string[]** Set schedule Search Attributes using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. | | `--search-attribute` | No | **string[]** Search Attribute in `KEY=VALUE` format. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. | | `--start-time` | No | **timestamp** Schedule start time. | | `--static-details` | No | **string** Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. _(Experimental)_ | @@ -316,7 +324,7 @@ The following options can be used with any command. | `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | | | `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | | | `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` | -| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. | `info` | +| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` | | `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` | | `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | | | `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` | diff --git a/docs/cli/server.mdx b/docs/cli/server.mdx index 7adde4500b..2524e7c052 100644 --- a/docs/cli/server.mdx +++ b/docs/cli/server.mdx @@ -106,7 +106,7 @@ The following options can be used with any command. | `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | | | `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | | | `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` | -| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. | `info` | +| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` | | `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` | | `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | | | `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` | diff --git a/docs/cli/task-queue.mdx b/docs/cli/task-queue.mdx index 689d85e626..02b603fd13 100644 --- a/docs/cli/task-queue.mdx +++ b/docs/cli/task-queue.mdx @@ -693,7 +693,7 @@ The following options can be used with any command. | `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | | | `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | | | `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` | -| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. | `info` | +| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` | | `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` | | `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | | | `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` | diff --git a/docs/cli/worker.mdx b/docs/cli/worker.mdx index 1f34d72445..72804d7940 100644 --- a/docs/cli/worker.mdx +++ b/docs/cli/worker.mdx @@ -456,7 +456,7 @@ The following options can be used with any command. | `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | | | `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | | | `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` | -| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. | `info` | +| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` | | `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` | | `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | | | `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` | diff --git a/docs/cli/workflow.mdx b/docs/cli/workflow.mdx index a1adb3365b..f722ca6286 100644 --- a/docs/cli/workflow.mdx +++ b/docs/cli/workflow.mdx @@ -105,7 +105,7 @@ Use the following options to change the behavior of this command. You can also u ## delete -Delete a Workflow Execution and its Event History: +Delete a Workflow Executions and its Event History: ``` temporal workflow delete \ @@ -891,7 +891,7 @@ The following options can be used with any command. | `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | | | `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | | | `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` | -| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. | `info` | +| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` | | `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` | | `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | | | `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` |