From 2811663bed855a31a0c83d76fd53ac4a5eeeb4ee Mon Sep 17 00:00:00 2001 From: Spencer Judge Date: Thu, 14 Aug 2025 20:29:53 +0000 Subject: [PATCH] Update CLI docs for release v1.4.1-cloud-v1-29-0-139-2.0 --- docs/cli/activity.mdx | 297 +++++++++++++++++++++++++--------------- docs/cli/batch.mdx | 23 +++- docs/cli/config.mdx | 35 ++++- docs/cli/env.mdx | 29 +++- docs/cli/operator.mdx | 121 +++++++++++++--- docs/cli/schedule.mdx | 98 +++++++++---- docs/cli/server.mdx | 21 +-- docs/cli/task-queue.mdx | 140 ++++++++++++++----- docs/cli/worker.mdx | 114 ++++++++------- docs/cli/workflow.mdx | 177 +++++++++++++++++++----- 10 files changed, 745 insertions(+), 310 deletions(-) diff --git a/docs/cli/activity.mdx b/docs/cli/activity.mdx index cdb256ae19..aceb373793 100644 --- a/docs/cli/activity.mdx +++ b/docs/cli/activity.mdx @@ -1,3 +1,5 @@ +{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. +This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} --- id: activity title: Temporal CLI activity command reference @@ -42,19 +44,23 @@ Use the following options to change the behavior of this command. Activity ID to complete. Required. -**--identity** _string_ - -Identity of the user submitting this request. - **--result** _string_ Result `JSON` to return. Required. +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + **Global Flags:** **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -122,6 +128,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -215,19 +225,23 @@ Activity ID to fail. Required. Reason for failing the Activity (JSON). -**--identity** _string_ - -Identity of the user submitting this request. - **--reason** _string_ Reason for failing the Activity. +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + **Global Flags:** **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -295,6 +309,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -367,25 +385,13 @@ Override target TLS server name. ## pause -:::tip Stability - -In [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -Available in Temporal Cloud. - -Supported Open Source Versions: - -- [Temporal Server version 1.28](https://github.com/temporalio/temporal/releases/tag/v1.28.0) and higher. -- [CLI version v1.4](https://github.com/temporalio/cli/releases/tag/v1.4.0) and higher. - -::: - Pause an Activity. If the Activity is not currently running (e.g. because it previously failed), it will not be run again until it is unpaused. -However, if the Activity is currently running, it will run until the next time it fails, completes, or times out, at which point the pause will kick in. +However, if the Activity is currently running, it will run until the next +time it fails, completes, or times out, at which point the pause will kick in. If the Activity is on its last retry attempt and fails, the failure will be returned to the caller, just as if the Activity had not been paused. @@ -400,7 +406,8 @@ temporal activity pause \ --workflow-id YourWorkflowId ``` -To later unpause the activity, see [unpause](#unpause). You may also want to [reset](#reset) the activity to unpause it while also starting it from the beginning. +To later unpause the activity, see [unpause](#unpause). You may also want to +[reset](#reset) the activity to unpause it while also starting it from the beginning. Use the following options to change the behavior of this command. @@ -410,7 +417,7 @@ Use the following options to change the behavior of this command. The Activity ID to pause. Either `activity-id` or `activity-type` must be provided, but not both. -**--activity-type**, **-g** _string_ +**--activity-type** _string_ All activities of the Activity Type will be paused. Either `activity-id` or `activity-type` must be provided, but not both. @@ -418,19 +425,19 @@ All activities of the Activity Type will be paused. Either `activity-id` or `act The identity of the user or client submitting this request. -**--run-id** _string_ +**--run-id**, **-r** _string_ Run ID. -**--workflow-id** _string_ +**--workflow-id**, **-w** _string_ -Workflow ID to Pause. Required. +Workflow ID. Required. **Global Flags:** **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -498,6 +505,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -570,38 +581,32 @@ Override target TLS server name. ## reset -:::tip Stability - -In [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -Available in Temporal Cloud. - -Supported Open Source Versions: - -- [Temporal Server version 1.28](https://github.com/temporalio/temporal/releases/tag/v1.28.0) and higher. -- [CLI version v1.4](https://github.com/temporalio/cli/releases/tag/v1.4.0) and higher. +Reset an activity. This restarts the activity as if it were first being +scheduled. That is, it will reset both the number of attempts and the +activity timeout, as well as, optionally, the +[heartbeat details](#reset-heartbeats). -::: - -Resetting an activity restarts the activity as if it were first being scheduled. That is, it will reset both the number of attempts and the activity timeout, as well as, optionally, the [heartbeat details](#reset-heartbeats). - -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 is waiting for a retry (i.e. has failed or timed out), the reset will apply immediately. +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 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. You can specify `keep_paused` to prevent this. +If the activity is already paused, it will be unpaused by default. +You can specify `keep_paused` to prevent this. -If the activity is paused and the `keep_paused` flag is not provided, it will be -unpaused. -If the activity is paused and `keep_paused` flag is provided - it will stay -paused. +If the activity is paused and the `keep_paused` flag is not provided, +it will be unpaused. If the activity is paused and `keep_paused` flag +is provided - it will stay paused. Activities can be specified by their Activity ID or Activity Type. ### Resetting activities that heartbeat {#reset-heartbeats} -Activities that heartbeat will receive a [Canceled failure](/references/failures#cancelled-failure) the next time they heartbeat after a reset. +Activities that heartbeat will receive a [Canceled failure](/references/failures#cancelled-failure) +the next time they heartbeat after a reset. -If, in your Activity, you need to do any cleanup when an Activity is reset, handle this error and then re-throw it when you've cleaned up. +If, in your Activity, you need to do any cleanup when an Activity is +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. @@ -615,6 +620,16 @@ temporal activity reset \ --reset-heartbeats ``` +Either `activity-id`, `activity-type`, or `--match-all` must be specified. + +Activities can be reset in bulk with a visibility query list filter. +For example, if you want to reset activities of type Foo: + +``` +temporal activity reset \ + --query 'TemporalResetInfo="property:activityType=Foo"' +``` + Use the following options to change the behavior of this command. **Flags:** @@ -623,35 +638,67 @@ Use the following options to change the behavior of this command. The Activity ID to reset. Either `activity-id` or `activity-type` must be provided, but not both. -**--activity-type**, **-g** _string_ +**--activity-type** _string_ -to reset. Either `activity-id` or `activity-type` must be provided, but not both. +The Activity Type to reset. Either `activity-id` or `activity-type` must be provided, but not both. **--identity** _string_ The identity of the user or client submitting this request. +**--jitter** _duration_ + +The activity will reset at random a time within the specified duration. Can only be used with --query. + **--keep-paused** _bool_ If the activity was paused, it will stay paused. +**--match-all** _bool_ + +Every activity should be reset. Every activity should be updated. Mutually exclusive with `--activity-id` and `--activity-type`. + +**--query**, **-q** _string_ + +Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. + +**--reason** _string_ + +Reason for batch operation. Only use with --query. Defaults to user name. + +**--reset-attempts** _bool_ + +Reset the activity attempts. + **--reset-heartbeats** _bool_ Clear the Activity's heartbeat details. -**--run-id** _string_ +**--restore-original-options** _bool_ + +Restore the original options of the activity. + +**--rps** _float_ + +Limit batch's requests per second. Only allowed if query is present. + +**--run-id**, **-r** _string_ + +Run ID. Only use with --workflow-id. Cannot use with --query. + +**--workflow-id**, **-w** _string_ -Run ID to reset. +Workflow ID. You must set either --workflow-id or --query. -**--workflow-id** _string_ +**--yes**, **-y** _bool_ -Workflow ID to reset. Required. +Don't prompt to confirm signaling. Only allowed when --query is present. **Global Flags:** **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -719,6 +766,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -791,19 +842,6 @@ Override target TLS server name. ## unpause -:::tip Stability - -In [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -Available in Temporal Cloud. - -Supported Open Source Versions: - -- [Temporal Server version 1.28](https://github.com/temporalio/temporal/releases/tag/v1.28.0) and higher. -- [CLI version v1.4](https://github.com/temporalio/cli/releases/tag/v1.4.0) and higher. - -::: - Re-schedule a previously-paused Activity for execution. If the Activity is not running and is past its retry timeout, it will be @@ -830,7 +868,9 @@ temporal activity unpause \ --reset-heartbeats ``` -Activities can be unpaused in bulk via a visibility Query list filter. For example, if you want to unpause activities of type Foo that you previously paused, do: +Activities can be unpaused in bulk via a visibility Query list filter. +For example, if you want to unpause activities of type Foo that you +previously paused, do: ``` temporal activity unpause \ @@ -853,13 +893,13 @@ Activities of this Type will unpause. Can only be used without --match-all. Eith The identity of the user or client submitting this request. -**--jitter**, **-j** _duration_ +**--jitter** _duration_ The activity will start at random a time within the specified duration. Can only be used with --query. **--match-all** _bool_ -Every paused activity should be unpaused. This flag is ignored if activity-type is provided. Can only be used with --query. +Every paused activity should be unpaused. This flag is ignored if activity-type is provided. **--query**, **-q** _string_ @@ -871,7 +911,7 @@ Reason for batch operation. Only use with --query. Defaults to user name. **--reset-attempts** _bool_ -Also reset the activity attempts. +Reset the activity attempts. **--reset-heartbeats** _bool_ @@ -897,7 +937,7 @@ Don't prompt to confirm signaling. Only allowed when --query is present. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -965,6 +1005,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1037,21 +1081,9 @@ Override target TLS server name. ## update-options -:::tip Stability - -In [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -Available in Temporal Cloud. - -Supported Open Source Versions: - -- [Temporal Server version 1.28](https://github.com/temporalio/temporal/releases/tag/v1.28.0) and higher. -- [CLI version v1.4](https://github.com/temporalio/cli/releases/tag/v1.4.0) and higher. - -::: - -Updates the options of a running Activity that were passed into it from a Workflow. -Updates are incremental, only changing the specified options. +Update the options of a running Activity that were passed into it from + a Workflow. Updates are incremental, only changing the specified +options. For example: @@ -1072,60 +1104,104 @@ temporal activity update-options \ You may follow this command with `temporal activity reset`, and the new values will apply after the reset. -Use the following options: +Either `activity-id`, `activity-type`, or `--match-all` must be specified. + +Activity options can be updated in bulk with a visibility query list filter. +For example, if you want to reset for activities of type Foo, do: + +``` +temporal activity update-options \ + --query 'TemporalPauseInfo="property:activityType=Foo"' + ... +``` + +You may follow this command with `temporal activity reset`, and the new values will apply after the reset. + +Use the following options to change the behavior of this command. **Flags:** -**--activity-id** _string_ +**--activity-id**, **-a** _string_ + +The Activity ID to update options. Mutually exclusive with `--query`, `--match-all`, and `--activity-type`. Requires `--workflow-id` to be specified. -Activity ID. Required. +**--activity-type** _string_ + +Activities of this Type will be updated. Mutually exclusive with `--match-all` and `activity-id`. **--heartbeat-timeout** _duration_ -Modifies the Activity's [Heartbeat Timeout](/encyclopedia/detecting-activity-failures#heartbeat-timeout). +Maximum permitted time between successful worker heartbeats. -**--identity** _string_ +**--match-all** _bool_ -The identity of the user or client submitting this request. +Every activity should be updated. Mutually exclusive with `--activity-id` and `--activity-type`. + +**--query**, **-q** _string_ + +Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. + +**--reason** _string_ + +Reason for batch operation. Only use with --query. Defaults to user name. + +**--restore-original-options** _bool_ + +Restore the original options of the activity. **--retry-backoff-coefficient** _float_ -Modifies the [Backoff Coefficient](/encyclopedia/retry-policies#backoff-coefficient) +Coefficient used to calculate the next retry interval. The next retry interval is previous interval multiplied by the backoff coefficient. Must be 1 or larger. **--retry-initial-interval** _duration_ -Modifies the [Initial Retry Interval](/encyclopedia/retry-policies#initial-interval) in the activity's Retry Policy. -If your activity has already retried, this is only useful in conjunction with activity reset. +Interval of the first retry. If retryBackoffCoefficient is 1.0 then it is used for all retries. **--retry-maximum-attempts** _int_ -Modifies the [Maximum Attempts](/encyclopedia/retry-policies#maximum-attempts) in the activity's Retry Policy. +Maximum number of attempts. When exceeded the retries stop even if not expired yet. Setting this value to 1 disables retries. Setting this value to 0 means unlimited attempts(up to the timeouts). **--retry-maximum-interval** _duration_ -Modifies the [Maximum Interval](/encyclopedia/retry-policies#maximum-interval) in the activity's Retry Policy. +Maximum interval between retries. Exponential backoff leads to interval increase. This value is the cap of the increase. + +**--rps** _float_ + +Limit batch's requests per second. Only allowed if query is present. + +**--run-id**, **-r** _string_ + +Run ID. Only use with --workflow-id. Cannot use with --query. **--schedule-to-close-timeout** _duration_ -Modifies the activity's [Schedule-to-Close Timeout](/encyclopedia/detecting-activity-failures#schedule-to-close-timeout). +Indicates how long the caller is willing to wait for an activity completion. Limits how long retries will be attempted. **--schedule-to-start-timeout** _duration_ -Modifies the activity's [Schedule-to-Start Timeout](/encyclopedia/detecting-activity-failures#schedule-to-start-timeout). +Limits time an activity task can stay in a task queue before a worker picks it up. This timeout is always non retryable, as all a retry would achieve is to put it back into the same queue. Defaults to the schedule-to-close timeout or workflow execution timeout if not specified. **--start-to-close-timeout** _duration_ -Modifies the activity's [Start-to-Close Timeout](/encyclopedia/detecting-activity-failures#start-to-close-timeout). +Maximum time an activity is allowed to execute after being picked up by a worker. This timeout is always retryable. **--task-queue** _string_ Name of the task queue for the Activity. +**--workflow-id**, **-w** _string_ + +Workflow ID. You must set either --workflow-id or --query. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm signaling. Only allowed when --query is present. + **Global Flags:** **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1193,6 +1269,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1262,3 +1342,4 @@ Path to x509 private key. Can't be used with --tls-key-data. **--tls-server-name** _string_ Override target TLS server name. + diff --git a/docs/cli/batch.mdx b/docs/cli/batch.mdx index 9ea8343db0..664775e7d0 100644 --- a/docs/cli/batch.mdx +++ b/docs/cli/batch.mdx @@ -1,3 +1,5 @@ +{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. +This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} --- id: batch title: Temporal CLI batch command reference @@ -16,8 +18,6 @@ keywords: tags: - Temporal CLI --- -{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. -This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} ## describe @@ -41,7 +41,7 @@ Batch job ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -109,6 +109,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -201,7 +205,7 @@ Maximum number of batch jobs to display. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -269,6 +273,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -367,7 +375,7 @@ Reason for terminating the batch job. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -435,6 +443,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -504,3 +516,4 @@ Path to x509 private key. Can't be used with --tls-key-data. **--tls-server-name** _string_ Override target TLS server name. + diff --git a/docs/cli/config.mdx b/docs/cli/config.mdx index d675181ba1..d34f0d1903 100644 --- a/docs/cli/config.mdx +++ b/docs/cli/config.mdx @@ -1,3 +1,5 @@ +{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. +This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} --- id: config title: Temporal CLI config command reference @@ -18,8 +20,6 @@ keywords: tags: - Temporal CLI --- -{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. -This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} ## delete @@ -42,7 +42,7 @@ Specific property to delete. If unset, deletes entire profile. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -110,6 +110,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -195,7 +199,7 @@ Use the following options to change the behavior of this command. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -263,6 +267,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -360,7 +368,7 @@ Specific property to get. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -428,6 +436,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -512,7 +524,7 @@ Use the following options to change the behavior of this command. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -580,6 +592,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -676,7 +692,7 @@ Property value. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -744,6 +760,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -813,3 +833,4 @@ Path to x509 private key. Can't be used with --tls-key-data. **--tls-server-name** _string_ Override target TLS server name. + diff --git a/docs/cli/env.mdx b/docs/cli/env.mdx index e4b33e5ac9..32fff4cccb 100644 --- a/docs/cli/env.mdx +++ b/docs/cli/env.mdx @@ -1,3 +1,5 @@ +{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. +This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} --- id: env title: Temporal CLI env command reference @@ -18,8 +20,6 @@ keywords: tags: - Temporal CLI --- -{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. -This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} ## delete @@ -52,7 +52,7 @@ Property name. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -120,6 +120,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -223,7 +227,7 @@ Property name. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -291,6 +295,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -372,7 +380,7 @@ Use the following options to change the behavior of this command. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -440,6 +448,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -545,7 +557,7 @@ Property value (required). **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -613,6 +625,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -682,3 +698,4 @@ Path to x509 private key. Can't be used with --tls-key-data. **--tls-server-name** _string_ Override target TLS server name. + diff --git a/docs/cli/operator.mdx b/docs/cli/operator.mdx index 69b715143d..1fb289ad92 100644 --- a/docs/cli/operator.mdx +++ b/docs/cli/operator.mdx @@ -1,3 +1,5 @@ +{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. +This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} --- id: operator title: Temporal CLI operator command reference @@ -36,8 +38,6 @@ keywords: tags: - Temporal CLI --- -{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. -This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} ## cluster @@ -74,7 +74,7 @@ Show history shard count and Cluster/Service version information. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -142,6 +142,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -226,7 +230,7 @@ Use the following options to change the behavior of this command. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -294,6 +298,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -386,7 +394,7 @@ Maximum number of Clusters to display. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -454,6 +462,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -545,7 +557,7 @@ Cluster/Service name. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -613,6 +625,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -703,7 +719,7 @@ Use the following options to change the behavior of this command. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -771,6 +787,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -873,7 +893,7 @@ Remote endpoint. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -941,6 +961,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1034,7 +1058,7 @@ Create a new Namespace on the Temporal Service: temporal operator namespace create \ --namespace YourNewNamespaceName \ [options] -``` +```` Create a Namespace with multi-region data replication: @@ -1109,7 +1133,7 @@ Archive visibility data to this `URI`. Once enabled, can't be changed. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1177,6 +1201,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1274,7 +1302,7 @@ Request confirmation before deletion. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1342,6 +1370,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1440,7 +1472,7 @@ Namespace ID. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1508,6 +1540,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1592,7 +1628,7 @@ Use the following options to change the behavior of this command. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1660,6 +1696,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1816,7 +1856,7 @@ Archive visibility data to this `URI`. Once enabled, can't be changed. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1884,6 +1924,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2032,7 +2076,7 @@ Option is experimental. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2100,6 +2144,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2190,7 +2238,7 @@ Endpoint name. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2258,6 +2306,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2348,7 +2400,7 @@ Endpoint name. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2416,6 +2468,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2500,7 +2556,7 @@ Use the following options to change the behavior of this command. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2568,6 +2624,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2708,7 +2768,7 @@ Unset the description. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2776,6 +2836,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2889,7 +2953,7 @@ Search Attribute type. Required. Accepted values: Text, Keyword, Int, Double, Bo **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2957,6 +3021,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -3042,7 +3110,7 @@ Use the following options to change the behavior of this command. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -3110,6 +3178,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -3214,7 +3286,7 @@ Don't prompt to confirm removal. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -3282,6 +3354,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -3351,3 +3427,4 @@ Path to x509 private key. Can't be used with --tls-key-data. **--tls-server-name** _string_ Override target TLS server name. + diff --git a/docs/cli/schedule.mdx b/docs/cli/schedule.mdx index 38ff1fa919..8e03d7fff3 100644 --- a/docs/cli/schedule.mdx +++ b/docs/cli/schedule.mdx @@ -1,3 +1,5 @@ +{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. +This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} --- id: schedule title: Temporal CLI schedule command reference @@ -23,8 +25,6 @@ tags: - Temporal CLI - Schedules --- -{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. -This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} ## backfill @@ -49,20 +49,20 @@ temporal schedule backfill \ The policies include: -- **AllowAll**: Allow unlimited concurrent Workflow Executions. This +* **AllowAll**: Allow unlimited concurrent Workflow Executions. This significantly speeds up the backfilling process on systems that support concurrency. You must ensure running Workflow Executions do not interfere with each other. -- **BufferAll**: Buffer all incoming Workflow Executions while waiting for +* **BufferAll**: Buffer all incoming Workflow Executions while waiting for the running Workflow Execution to complete. -- **Skip**: If a previous Workflow Execution is still running, discard new +* **Skip**: If a previous Workflow Execution is still running, discard new Workflow Executions. -- **BufferOne**: Same as 'Skip' but buffer a single Workflow Execution to be +* **BufferOne**: Same as 'Skip' but buffer a single Workflow Execution to be run after the previous Execution completes. Discard other Workflow Executions. -- **CancelOther**: Cancel the running Workflow Execution and replace it with +* **CancelOther**: Cancel the running Workflow Execution and replace it with the incoming new Workflow Execution. -- **TerminateOther**: Terminate the running Workflow Execution and replace +* **TerminateOther**: Terminate the running Workflow Execution and replace it with the incoming new Workflow Execution. Use the following options to change the behavior of this command. @@ -73,6 +73,14 @@ Use the following options to change the behavior of this command. Backfill end time. Required. +**--overlap-policy** _string-enum_ + +Policy for handling overlapping Workflow Executions. Accepted values: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. (default "Skip") + +**--schedule-id**, **-s** _string_ + +Schedule ID. Required. + **--start-time** _timestamp_ Backfill start time. Required. @@ -81,7 +89,7 @@ Backfill start time. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -149,6 +157,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -227,21 +239,21 @@ new Workflow Executions at the times you specify. For example: ``` -temporal schedule create \ - --schedule-id "YourScheduleId" \ - --calendar '{"dayOfWeek":"Fri","hour":"3","minute":"30"}' \ - --workflow-id YourBaseWorkflowIdName \ - --task-queue YourTaskQueue \ - --type YourWorkflowType + temporal schedule create \ + --schedule-id "YourScheduleId" \ + --calendar '{"dayOfWeek":"Fri","hour":"3","minute":"30"}' \ + --workflow-id YourBaseWorkflowIdName \ + --task-queue YourTaskQueue \ + --type YourWorkflowType ``` Schedules support any combination of `--calendar`, `--interval`, and `--cron`: -- Shorthand `--interval` strings. +* Shorthand `--interval` strings. For example: 45m (every 45 minutes) or 6h/5h (every 6 hours, at the top of the 5th hour). -- JSON `--calendar`, as in the preceding example. -- Unix-style `--cron` strings and robfig declarations +* JSON `--calendar`, as in the preceding example. +* Unix-style `--cron` strings and robfig declarations (@daily/@weekly/@every X/etc). For example, every Friday at 12:30 PM: `30 12 * * Fri`. @@ -283,7 +295,7 @@ A path or paths for input file(s). Use JSON content or set --input-meta to overr **--input-meta** _string[]_ -Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. **--interval** _string[]_ @@ -385,7 +397,7 @@ Workflow ID. If not supplied, the Service generates a unique ID. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -453,6 +465,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -533,7 +549,8 @@ temporal schedule delete \ ``` Removing a Schedule won't affect the Workflow Executions it started that are -still running. To cancel or terminate these Workflow Executions, use `temporal workflow delete` with the `TemporalScheduledById` Search Attribute instead. +still running. To cancel or terminate these Workflow Executions, use `temporal +workflow delete` with the `TemporalScheduledById` Search Attribute instead. Use the following options to change the behavior of this command. @@ -547,7 +564,7 @@ Schedule ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -615,6 +632,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -707,7 +728,7 @@ Schedule ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -775,6 +796,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -874,7 +899,7 @@ Show extensive information in non-table form. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -942,6 +967,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1060,7 +1089,7 @@ Unpause the Schedule. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1128,6 +1157,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1223,7 +1256,7 @@ Schedule ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1291,6 +1324,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1410,7 +1447,7 @@ A path or paths for input file(s). Use JSON content or set --input-meta to overr **--input-meta** _string[]_ -Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. **--interval** _string[]_ @@ -1512,7 +1549,7 @@ Workflow ID. If not supplied, the Service generates a unique ID. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1580,6 +1617,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1649,3 +1690,4 @@ Path to x509 private key. Can't be used with --tls-key-data. **--tls-server-name** _string_ Override target TLS server name. + diff --git a/docs/cli/server.mdx b/docs/cli/server.mdx index 9af19fef5c..eee483156c 100644 --- a/docs/cli/server.mdx +++ b/docs/cli/server.mdx @@ -1,3 +1,5 @@ +{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. +This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} --- id: server title: Temporal CLI server command reference @@ -14,19 +16,17 @@ tags: - Temporal CLI - Development Server --- -{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. -This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} ## start-dev Run a development Temporal Server on your local system. +------------------------------------------------------------------------+ -| WARNING: The development server is not intended for production use. | -| It skips certain HTTP security checks to make local use simpler. | -| | -| For production use, see: | -| https://docs.temporal.io/production-deployment | +| WARNING: The development server is not intended for production use. | +| It skips certain HTTP security checks to make local use simpler. | +| | +| For production use, see: | +| https://docs.temporal.io/production-deployment | +------------------------------------------------------------------------+ View the Web UI for the default configuration at: http://localhost:8233 @@ -129,7 +129,7 @@ The public base path for the Web UI. Default is `/`. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -197,6 +197,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -266,3 +270,4 @@ Path to x509 private key. Can't be used with --tls-key-data. **--tls-server-name** _string_ Override target TLS server name. + diff --git a/docs/cli/task-queue.mdx b/docs/cli/task-queue.mdx index 71ef70b95e..d70f4860b4 100644 --- a/docs/cli/task-queue.mdx +++ b/docs/cli/task-queue.mdx @@ -1,3 +1,5 @@ +{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. +This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} --- id: task-queue title: Temporal CLI task-queue command reference @@ -14,8 +16,6 @@ keywords: tags: - Temporal CLI --- -{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. -This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} ## describe @@ -39,7 +39,6 @@ temporal task-queue describe \ ``` This command provides the following task queue statistics: - - `ApproximateBacklogCount`: The approximate number of tasks backlogged in this task queue. May count expired tasks but eventually converges to the right value. @@ -51,11 +50,11 @@ This command provides the following task queue statistics: (sync-matched tasks), as well as tasks added to the backlog. (See note below.) - `TasksDispatchRate`: Approximate rate at which tasks are being dispatched from the task queue, measured in tasks per second, averaged over the last 30 - seconds. Includes tasks dispatched immediately without going to the backlog + seconds. Includes tasks dispatched immediately without going to the backlog (sync-matched tasks), as well as tasks added to the backlog. (See note below.) - `BacklogIncreaseRate`: Approximate rate at which the backlog size is increasing (if positive) or decreasing (if negative), measured in tasks per - second, averaged over the last 30 seconds. This is roughly equivalent to: + second, averaged over the last 30 seconds. This is roughly equivalent to: `TasksAddRate` - `TasksDispatchRate`. NOTE: The `TasksAddRate` and `TasksDispatchRate` metrics may differ from the @@ -148,7 +147,7 @@ Task Queue type (legacy mode only). Accepted values: workflow, activity. (defaul **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -216,6 +215,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -325,7 +328,7 @@ Search only the specified task queue(s). Can be passed multiple times. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -393,6 +396,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -495,7 +502,7 @@ Task Queue name. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -563,6 +570,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -654,7 +665,7 @@ Task Queue name. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -722,6 +733,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -847,7 +862,7 @@ Task Queue name. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -915,6 +930,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1002,9 +1021,9 @@ temporal task-queue update-build-ids add-new-default \ ``` +------------------------------------------------------------------------+ -| NOTICE: This command is limited to Namespaces that support Worker | +| NOTICE: This command is limited to Namespaces that support Worker | | versioning. Worker versioning is experimental. Versioning commands are | -| subject to change. | +| subject to change. | +------------------------------------------------------------------------+ Use the following options to change the behavior of this command. @@ -1023,7 +1042,7 @@ Task Queue name. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1091,6 +1110,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1177,9 +1200,9 @@ temporal task-queue update-build-ids promote-id-in-set \ ``` +------------------------------------------------------------------------+ -| NOTICE: This command is limited to Namespaces that support Worker | +| NOTICE: This command is limited to Namespaces that support Worker | | versioning. Worker versioning is experimental. Versioning commands are | -| subject to change. | +| subject to change. | +------------------------------------------------------------------------+ Use the following options to change the behavior of this command. @@ -1198,7 +1221,7 @@ Task Queue name. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1266,6 +1289,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1353,9 +1380,9 @@ temporal task-queue update-build-ids promote-set \ ``` +------------------------------------------------------------------------+ -| NOTICE: This command is limited to Namespaces that support Worker | +| NOTICE: This command is limited to Namespaces that support Worker | | versioning. Worker versioning is experimental. Versioning commands are | -| subject to change. | +| subject to change. | +------------------------------------------------------------------------+ Use the following options to change the behavior of this command. @@ -1374,7 +1401,7 @@ Task Queue name. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1442,6 +1469,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1515,7 +1546,7 @@ Override target TLS server name. ## versioning +---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | +| CAUTION: This API has been deprecated by Worker Deployment. | +---------------------------------------------------------------------+ Provides commands to add, list, remove, or replace Worker Build ID assignment @@ -1550,7 +1581,7 @@ temporal task-queue versioning add-redirect-rule \ ``` +---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | +| CAUTION: This API has been deprecated by Worker Deployment. | +---------------------------------------------------------------------+ Use the following options to change the behavior of this command. @@ -1573,7 +1604,7 @@ Don't prompt to confirm. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1641,6 +1672,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1735,7 +1770,7 @@ This prevents committing invalid Build IDs. Use the `--force` option to override this validation. +---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | +| CAUTION: This API has been deprecated by Worker Deployment. | +---------------------------------------------------------------------+ Use the following options to change the behavior of this command. @@ -1758,7 +1793,7 @@ Don't prompt to confirm. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1826,6 +1861,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1912,7 +1951,7 @@ hint filter" or "percentage". Otherwise, the delete operation is rejected. Use the `--force` option to override this validation. +---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | +| CAUTION: This API has been deprecated by Worker Deployment. | +---------------------------------------------------------------------+ Use the following options to change the behavior of this command. @@ -1935,7 +1974,7 @@ Don't prompt to confirm. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2003,6 +2042,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2084,7 +2127,7 @@ temporal task-queue versioning delete-redirect-rule \ ``` +---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | +| CAUTION: This API has been deprecated by Worker Deployment. | +---------------------------------------------------------------------+ Use the following options to change the behavior of this command. @@ -2103,7 +2146,7 @@ Don't prompt to confirm. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2171,6 +2214,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2261,9 +2308,9 @@ Task Queues support the following versioning rules: Build ID. You may add at most one redirect rule for each source Build ID. Redirect rules require that a target Build ID is fully compatible with the source Build ID. - +---------------------------------------------------------------------+ - | CAUTION: This API has been deprecated by Worker Deployment. | - +---------------------------------------------------------------------+ ++---------------------------------------------------------------------+ +| CAUTION: This API has been deprecated by Worker Deployment. | ++---------------------------------------------------------------------+ Use the following options to change the behavior of this command. @@ -2271,7 +2318,7 @@ Use the following options to change the behavior of this command. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2339,6 +2386,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2424,7 +2475,7 @@ temporal task-queue versioning insert-assignment-rule \ If you do not specify a `--rule-index`, this command inserts at index 0. +---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | +| CAUTION: This API has been deprecated by Worker Deployment. | +---------------------------------------------------------------------+ Use the following options to change the behavior of this command. @@ -2451,7 +2502,7 @@ Don't prompt to confirm. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2519,6 +2570,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2618,7 +2673,7 @@ temporal task-queue versioning replace-assignment-rule \ Percent may vary between 0 and 100 (default). +---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | +| CAUTION: This API has been deprecated by Worker Deployment. | +---------------------------------------------------------------------+ Use the following options to change the behavior of this command. @@ -2649,7 +2704,7 @@ Don't prompt to confirm. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2717,6 +2772,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2800,7 +2859,7 @@ temporal task-queue versioning replace-redirect-rule \ ``` +---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | +| CAUTION: This API has been deprecated by Worker Deployment. | +---------------------------------------------------------------------+ Use the following options to change the behavior of this command. @@ -2823,7 +2882,7 @@ Don't prompt to confirm. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2891,6 +2950,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2960,3 +3023,4 @@ Path to x509 private key. Can't be used with --tls-key-data. **--tls-server-name** _string_ Override target TLS server name. + diff --git a/docs/cli/worker.mdx b/docs/cli/worker.mdx index b2e637c927..92006a021e 100644 --- a/docs/cli/worker.mdx +++ b/docs/cli/worker.mdx @@ -1,3 +1,5 @@ +{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. +This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} --- id: worker title: Temporal CLI worker command reference @@ -10,14 +12,12 @@ keywords: tags: - Temporal CLI --- -{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. -This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} ## deployment +---------------------------------------------------------------------+ | CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | +| subject to change. | +---------------------------------------------------------------------+ Deployment commands perform operations on Worker Deployments: @@ -50,7 +50,7 @@ Sets the current Deployment Version for a given Deployment. +---------------------------------------------------------------------+ | CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | +| subject to change. | +---------------------------------------------------------------------+ Remove a Worker Deployment given its Deployment Name. @@ -66,16 +66,13 @@ For example, setting the user identity that removed the deployment: temporal worker deployment delete \ --name YourDeploymentName \ --identity YourIdentity + ``` Use the following options to change the behavior of this command. **Flags:** -**--identity** _string_ - -Identity of the user submitting this request. - **--name**, **-d** _string_ Name for a Worker Deployment. Required. @@ -84,7 +81,7 @@ Name for a Worker Deployment. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -152,6 +149,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -226,7 +227,7 @@ Override target TLS server name. +---------------------------------------------------------------------+ | CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | +| subject to change. | +---------------------------------------------------------------------+ Remove a Worker Deployment Version given its fully-qualified identifier. @@ -234,13 +235,11 @@ This is rarely needed during normal operation since unused Versions are eventually garbage collected. The client can delete a Version only when all of the following conditions are met: - -- It is not the Current or Ramping Version for this Deployment. -- It has no active pollers, i.e., none of the task queues in the + - It is not the Current or Ramping Version for this Deployment. + - It has no active pollers, i.e., none of the task queues in the Version have pollers. -- It is not draining. This requirement can be ignored with the option - `--skip-drainage`. - + - It is not draining. This requirement can be ignored with the option +`--skip-drainage`. ``` temporal worker deployment delete-version [options] ``` @@ -265,10 +264,6 @@ Build ID of the Worker Deployment Version. Required. Name of the Worker Deployment. Required. -**--identity** _string_ - -Identity of the user submitting this request. - **--skip-drainage** _bool_ Ignore the deletion requirement of not draining. @@ -277,7 +272,7 @@ Ignore the deletion requirement of not draining. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -345,6 +340,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -419,7 +418,7 @@ Override target TLS server name. +---------------------------------------------------------------------+ | CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | +| subject to change. | +---------------------------------------------------------------------+ Describe properties of a Worker Deployment, such as the versions @@ -450,7 +449,7 @@ Name for a Worker Deployment. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -518,6 +517,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -592,7 +595,7 @@ Override target TLS server name. +---------------------------------------------------------------------+ | CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | +| subject to change. | +---------------------------------------------------------------------+ Describe properties of a Worker Deployment Version, such as the task @@ -604,7 +607,7 @@ metadata, or its creation/modification time. temporal worker deployment describe-version [options] ``` -For example, to describe a deployment version in a deployment +For example, to describe a deployment version in a deployment `YourDeploymentName`, with Build ID `YourBuildID`, and in the default namespace: @@ -629,7 +632,7 @@ Name of the Worker Deployment. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -697,6 +700,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -771,7 +778,7 @@ Override target TLS server name. +---------------------------------------------------------------------+ | CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | +| subject to change. | +---------------------------------------------------------------------+ List existing Worker Deployments in the client's namespace. @@ -793,7 +800,7 @@ Use the following options to change the behavior of this command. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -861,6 +868,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -935,7 +946,7 @@ Override target TLS server name. +---------------------------------------------------------------------+ | CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | +| subject to change. | +---------------------------------------------------------------------+ Set the Current Version for a Deployment. @@ -981,10 +992,6 @@ Build ID of the Worker Deployment Version. Required unless --unversioned is spec Name of the Worker Deployment. Required. -**--identity** _string_ - -Identity of the user submitting this request. - **--ignore-missing-task-queues** _bool_ Override protection to accidentally remove task queues. @@ -1001,7 +1008,7 @@ Don't prompt to confirm set Current Version. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1069,6 +1076,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1143,7 +1154,7 @@ Override target TLS server name. +---------------------------------------------------------------------+ | CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | +| subject to change. | +---------------------------------------------------------------------+ Set the Ramping Version and Percentage for a Deployment. @@ -1179,7 +1190,6 @@ temporal worker deployment set-ramping-version \ ``` And to remove that ramping: - ``` temporal worker deployment set-ramping-version \ --deployment-name YourDeploymentName --build-id YourBuildID \ @@ -1202,10 +1212,6 @@ Delete the Ramping Version. Name of the Worker Deployment. Required. -**--identity** _string_ - -Identity of the user submitting this request. - **--ignore-missing-task-queues** _bool_ Override protection to accidentally remove task queues. @@ -1226,7 +1232,7 @@ Don't prompt to confirm set Ramping Version. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1294,6 +1300,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1368,24 +1378,23 @@ Override target TLS server name. +---------------------------------------------------------------------+ | CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | +| subject to change. | +---------------------------------------------------------------------+ Update metadata associated with a Worker Deployment Version. For example: ``` -temporal worker deployment update-metadata-version \ - --deployment-name YourDeploymentName --build-id YourBuildID \ - --metadata bar=1 \ - --metadata foo=true + temporal worker deployment update-metadata-version \ + --deployment-name YourDeploymentName --build-id YourBuildID \ + --metadata bar=1 \ + --metadata foo=true ``` The current metadata is also returned with `describe-version`: - ``` -temporal worker deployment describe-version \ - --deployment-name YourDeploymentName --build-id YourBuildID \ + temporal worker deployment describe-version \ + --deployment-name YourDeploymentName --build-id YourBuildID \ ``` Use the following options to change the behavior of this command. @@ -1412,7 +1421,7 @@ Keys of entries to be deleted from metadata. Can be passed multiple times. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1480,6 +1489,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1549,3 +1562,4 @@ Path to x509 private key. Can't be used with --tls-key-data. **--tls-server-name** _string_ Override target TLS server name. + diff --git a/docs/cli/workflow.mdx b/docs/cli/workflow.mdx index 8892e30b19..b10f695b3b 100644 --- a/docs/cli/workflow.mdx +++ b/docs/cli/workflow.mdx @@ -1,3 +1,5 @@ +{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. +This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} --- id: workflow title: Temporal CLI workflow command reference @@ -41,8 +43,6 @@ tags: - Temporal CLI - Workflows --- -{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. -This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */} ## cancel @@ -101,7 +101,7 @@ Don't prompt to confirm signaling. Only allowed when --query is present. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -169,6 +169,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -264,7 +268,7 @@ Content for an SQL-like `QUERY` List Filter. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -332,6 +336,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -449,7 +457,7 @@ Don't prompt to confirm signaling. Only allowed when --query is present. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -517,6 +525,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -628,7 +640,7 @@ Workflow ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -696,6 +708,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -826,7 +842,7 @@ A path or paths for input file(s). Use JSON content or set --input-meta to overr **--input-meta** _string[]_ -Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. **--memo** _string[]_ @@ -884,7 +900,7 @@ Workflow ID. If not supplied, the Service generates a unique ID. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -952,6 +968,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1079,7 +1099,7 @@ A path or paths for input file(s). Use JSON content or set --input-meta to overr **--input-meta** _string[]_ -Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. **--memo** _string[]_ @@ -1169,7 +1189,7 @@ Workflow ID. If not supplied, the Service generates a unique ID. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1237,6 +1257,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1333,7 +1357,7 @@ Path to the results file. When omitted, output is sent to stdout. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1401,6 +1425,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1521,7 +1549,7 @@ Content for an SQL-like `QUERY` List Filter. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1589,6 +1617,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1689,7 +1721,7 @@ Workflow ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1757,6 +1789,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -1859,7 +1895,7 @@ A path or paths for input file(s). Use JSON content or set --input-meta to overr **--input-meta** _string[]_ -Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. **--name** _string_ @@ -1881,7 +1917,7 @@ Workflow ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -1949,6 +1985,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2069,7 +2109,7 @@ When overriding to a `pinned` behavior, specifies the Deployment Name of the ver **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2137,6 +2177,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2232,7 +2276,7 @@ Workflow ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2300,6 +2344,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2406,7 +2454,7 @@ Workflow ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2474,6 +2522,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2578,7 +2630,7 @@ A path or paths for input file(s). Use JSON content or set --input-meta to overr **--input-meta** _string[]_ -Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. **--name** _string_ @@ -2612,7 +2664,7 @@ Don't prompt to confirm signaling. Only allowed when --query is present. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2680,6 +2732,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -2804,7 +2860,7 @@ A path or paths for input file(s). Use JSON content or set --input-meta to overr **--input-meta** _string[]_ -Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. **--memo** _string[]_ @@ -2882,7 +2938,7 @@ Workflow ID. If not supplied, the Service generates a unique ID. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -2950,6 +3006,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -3051,7 +3111,7 @@ Workflow ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -3119,6 +3179,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -3239,7 +3303,7 @@ A path or paths for input file(s). Use JSON content or set --input-meta to overr **--input-meta** _string[]_ -Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. **--memo** _string[]_ @@ -3297,7 +3361,7 @@ Workflow ID. If not supplied, the Service generates a unique ID. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -3365,6 +3429,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -3493,7 +3561,7 @@ A path or paths for input file(s). Use JSON content or set --input-meta to overr **--input-meta** _string[]_ -Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. **--memo** _string[]_ @@ -3587,7 +3655,7 @@ Workflow ID. If not supplied, the Service generates a unique ID. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -3655,6 +3723,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -3785,7 +3857,7 @@ Don't prompt to confirm termination. Can only be used with --query. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -3853,6 +3925,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -3965,7 +4041,7 @@ Workflow ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -4033,6 +4109,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -4139,7 +4219,7 @@ Workflow ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -4207,6 +4287,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -4312,7 +4396,7 @@ A path or paths for input file(s). Use JSON content or set --input-meta to overr **--input-meta** _string[]_ -Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. **--name** _string_ @@ -4334,7 +4418,7 @@ Workflow ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -4402,6 +4486,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -4503,7 +4591,7 @@ Workflow ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -4571,6 +4659,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -4677,7 +4769,7 @@ A path or paths for input file(s). Use JSON content or set --input-meta to overr **--input-meta** _string[]_ -Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. +Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. **--name** _string_ @@ -4693,7 +4785,7 @@ Update ID. If unset, defaults to a UUID. **--wait-for-stage** _string-enum_ -Update stage to wait for. The only option is `accepted`, but this option is required. This is to allow a future version of the CLI to choose a default value. Required. Accepted values: accepted. +Update stage to wait for. The only option is `accepted`, but this option is required. This is to allow a future version of the CLI to choose a default value. Required. Accepted values: accepted. **--workflow-id**, **-w** _string_ @@ -4703,7 +4795,7 @@ Workflow ID. Required. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -4771,6 +4863,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -4845,7 +4941,7 @@ Override target TLS server name. +---------------------------------------------------------------------+ | CAUTION: Worflow update-options is experimental. Workflow Execution | -| properties are subject to change. | +| properties are subject to change. | +---------------------------------------------------------------------+ Modify properties of Workflow Executions: @@ -4932,7 +5028,7 @@ Don't prompt to confirm signaling. Only allowed when --query is present. **--address** _string_ -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") +Temporal Service gRPC endpoint. (default "localhost:7233") **--api-key** _string_ @@ -5000,6 +5096,10 @@ Path to environment settings file. Defaults to `$HOME/.config/temporalio/tempora 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** _string_ + +The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". + **--log-format** _string-enum_ Log format. Accepted values: text, json. (default "text") @@ -5069,3 +5169,4 @@ Path to x509 private key. Can't be used with --tls-key-data. **--tls-server-name** _string_ Override target TLS server name. +