Skip to content

Commit cbea160

Browse files
github-actions[bot]VegetarianOrcbrianmacdonald-temporal
authored
Update CLI docs for release v1.7.1-standalone-nexus-operations (#4510)
* Update CLI docs for release v1.7.1-standalone-nexus-operations * Update task-queue.mdx Adding escape character --------- Co-authored-by: Alex Mazzeo <VegetarianOrc@users.noreply.github.com> Co-authored-by: Brian MacDonald <brian.macdonald@temporal.io>
1 parent 91cb65c commit cbea160

10 files changed

Lines changed: 147 additions & 89 deletions

File tree

docs/cli/activity.mdx

Lines changed: 25 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,6 @@ Use the following options to change the behavior of this command. You can also u
5757
| `--reason` | No | **string** Reason for cancellation. |
5858
| `--run-id`, `-r` | No | **string** Activity Run ID. If not set, targets the latest run. |
5959

60-
To use the CLI with Standalone Activities, see the CLI commands in the [Go](/docs/develop/go/activities/standalone-activities.mdx) and [Python](/docs/develop/python/activities/standalone-activities.mdx) Standalone Activity guides.
61-
6260
## complete
6361

6462
Complete an Activity, marking it as successfully finished. Specify the
@@ -212,9 +210,7 @@ time it fails, completes, or times out, at which point the pause will kick in.
212210
If the Activity is on its last retry attempt and fails, the failure will
213211
be returned to the caller, just as if the Activity had not been paused.
214212

215-
Activities should be specified either by their Activity ID or Activity Type.
216-
217-
For example, specify the Activity and Workflow IDs like this:
213+
Specify the Activity and Workflow IDs:
218214

219215
```
220216
temporal activity pause \
@@ -229,9 +225,9 @@ Use the following options to change the behavior of this command. You can also u
229225

230226
| Flag | Required | Description |
231227
|------|----------|-------------|
232-
| `--activity-id`, `-a` | No | **string** The Activity ID to pause. Either `activity-id` or `activity-type` must be provided, but not both. |
233-
| `--activity-type` | No | **string** All activities of the Activity Type will be paused. Either `activity-id` or `activity-type` must be provided, but not both. Note: Pausing Activity by Type is an experimental feature and may change in the future. |
228+
| `--activity-id`, `-a` | No | **string** The Activity ID to pause. Required. |
234229
| `--identity` | No | **string** The identity of the user or client submitting this request. |
230+
| `--reason` | No | **string** Reason for pausing the Activity. |
235231
| `--run-id`, `-r` | No | **string** Run ID. |
236232
| `--workflow-id`, `-w` | Yes | **string** Workflow ID. |
237233

@@ -255,7 +251,7 @@ If the activity is paused and the `keep_paused` flag is not provided,
255251
it will be unpaused. If the activity is paused and `keep_paused` flag
256252
is provided - it will stay paused.
257253

258-
Activities can be specified by their Activity ID or Activity Type.
254+
Either `--activity-id` (with `--workflow-id`) or `--query` must be specified.
259255

260256
### Resetting activities that heartbeat {#reset-heartbeats}
261257

@@ -267,7 +263,7 @@ reset, handle this error and then re-throw it when you've cleaned up.
267263

268264
If the `reset_heartbeats` flag is set, the heartbeat details will also be cleared.
269265

270-
Specify the Activity Type of ID and Workflow IDs:
266+
Specify the Activity and Workflow IDs:
271267

272268
```
273269
temporal activity reset \
@@ -277,30 +273,25 @@ temporal activity reset \
277273
--reset-heartbeats
278274
```
279275

280-
Either `activity-id`, `activity-type`, or `--match-all` must be specified.
281-
282-
Activities can be reset in bulk with a visibility query list filter.
283-
For example, if you want to reset activities of type Foo:
276+
Activities can be reset in bulk with a visibility query list filter:
284277

285278
```
286279
temporal activity reset \
287-
--query 'TemporalResetInfo="property:activityType=Foo"'
280+
--query 'WorkflowType="YourWorkflow"'
288281
```
289282

290283
Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands.
291284

292285
| Flag | Required | Description |
293286
|------|----------|-------------|
294-
| `--activity-id`, `-a` | No | **string** The Activity ID to reset. Mutually exclusive with `--query`, `--match-all`, and `--activity-type`. Requires `--workflow-id` to be specified. |
295-
| `--activity-type` | No | **string** Activities of this Type will be reset. Mutually exclusive with `--match-all` and `activity-id`. Note: Resetting Activity by Type is an experimental feature and may change in the future. |
287+
| `--activity-id`, `-a` | No | **string** The Activity ID to reset. Mutually exclusive with `--query`. Requires `--workflow-id` to be specified. |
296288
| `--headers` | No | **string[]** Temporal workflow headers in 'KEY=VALUE' format. Keys must be identifiers, and values must be JSON values. May be passed multiple times to set multiple Temporal headers. Note: These are workflow headers, not gRPC headers. |
297289
| `--jitter` | No | **duration** The activity will reset at random a time within the specified duration. Can only be used with --query. |
298290
| `--keep-paused` | No | **bool** If the activity was paused, it will stay paused. |
299-
| `--match-all` | No | **bool** Every activity should be reset. Every activity should be updated. Mutually exclusive with `--activity-id` and `--activity-type`. Note: This is an experimental feature and may change in the future. |
300291
| `--query`, `-q` | No | **string** Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. Note: Using --query for batch activity operations is an experimental feature and may change in the future. |
301292
| `--reason` | No | **string** Reason for batch operation. Only use with --query. Defaults to user name. |
302293
| `--reset-attempts` | No | **bool** Reset the activity attempts. |
303-
| `--reset-heartbeats` | No | **bool** Reset the Activity's heartbeats. Only works with --reset-attempts. |
294+
| `--reset-heartbeats` | No | **bool** Reset the Activity's heartbeats. |
304295
| `--restore-original-options` | No | **bool** Restore the original options of the activity. |
305296
| `--rps` | No | **float** Limit batch's requests per second. Only allowed if query is present. |
306297
| `--run-id`, `-r` | No | **string** Run ID. Only use with --workflow-id. Cannot use with --query. |
@@ -403,10 +394,9 @@ Activity to be retried another N times after unpausing.
403394

404395
Use `--reset-heartbeat` to reset the Activity's heartbeats.
405396

406-
Activities can be specified by their Activity ID or Activity Type.
407-
One of those parameters must be provided.
397+
Either `--activity-id` (with `--workflow-id`) or `--query` must be specified.
408398

409-
Specify the Activity ID or Type and Workflow IDs:
399+
Specify the Activity and Workflow IDs:
410400

411401
```
412402
temporal activity unpause \
@@ -416,28 +406,24 @@ temporal activity unpause \
416406
--reset-heartbeats
417407
```
418408

419-
Activities can be unpaused in bulk via a visibility Query list filter.
420-
For example, if you want to unpause activities of type Foo that you
421-
previously paused, do:
409+
Activities can be unpaused in bulk via a visibility Query list filter:
422410

423411
```
424412
temporal activity unpause \
425-
--query 'TemporalPauseInfo="property:activityType=Foo"'
413+
--query 'TemporalPauseInfo IS NOT NULL'
426414
```
427415

428416
Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands.
429417

430418
| Flag | Required | Description |
431419
|------|----------|-------------|
432-
| `--activity-id`, `-a` | No | **string** The Activity ID to unpause. Mutually exclusive with `--query`, `--match-all`, and `--activity-type`. Requires `--workflow-id` to be specified. |
433-
| `--activity-type` | No | **string** Activities of this Type will unpause. Can only be used without --match-all. Either `activity-id` or `activity-type` must be provided, but not both. Note: Unpausing Activity by Type is an experimental feature and may change in the future. |
420+
| `--activity-id`, `-a` | No | **string** The Activity ID to unpause. Mutually exclusive with `--query`. Requires `--workflow-id` to be specified. |
434421
| `--headers` | No | **string[]** Temporal workflow headers in 'KEY=VALUE' format. Keys must be identifiers, and values must be JSON values. May be passed multiple times to set multiple Temporal headers. Note: These are workflow headers, not gRPC headers. |
435422
| `--jitter` | No | **duration** The activity will start at random a time within the specified duration. Can only be used with --query. |
436-
| `--match-all` | No | **bool** Every paused activity should be unpaused. This flag is ignored if activity-type is provided. Note: This is an experimental feature and may change in the future. |
437423
| `--query`, `-q` | No | **string** Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. Note: Using --query for batch activity operations is an experimental feature and may change in the future. |
438424
| `--reason` | No | **string** Reason for batch operation. Only use with --query. Defaults to user name. |
439425
| `--reset-attempts` | No | **bool** Reset the activity attempts. |
440-
| `--reset-heartbeats` | No | **bool** Reset the Activity's heartbeats. Only works with --reset-attempts. |
426+
| `--reset-heartbeats` | No | **bool** Reset the Activity's heartbeats. |
441427
| `--rps` | No | **float** Limit batch's requests per second. Only allowed if query is present. |
442428
| `--run-id`, `-r` | No | **string** Run ID. Only use with --workflow-id. Cannot use with --query. |
443429
| `--workflow-id`, `-w` | No | **string** Workflow ID. You must set either --workflow-id or --query. |
@@ -468,26 +454,23 @@ temporal activity update-options \
468454

469455
You may follow this command with `temporal activity reset`, and the new values will apply after the reset.
470456

471-
Either `activity-id`, `activity-type`, or `--match-all` must be specified.
457+
Either `--activity-id` or `--query` must be specified.
472458

473-
Activity options can be updated in bulk with a visibility query list filter.
474-
For example, if you want to reset for activities of type Foo, do:
459+
Activity options can be updated in bulk with a visibility query list filter:
475460

476461
```
477462
temporal activity update-options \
478-
--query 'TemporalPauseInfo="property:activityType=Foo"'
479-
...
463+
--query 'WorkflowType="YourWorkflow"' \
464+
--task-queue NewTaskQueueName
480465
```
481466

482467
Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands.
483468

484469
| Flag | Required | Description |
485470
|------|----------|-------------|
486-
| `--activity-id`, `-a` | No | **string** The Activity ID to update options. Mutually exclusive with `--query`, `--match-all`, and `--activity-type`. Requires `--workflow-id` to be specified. |
487-
| `--activity-type` | No | **string** Activities of this Type will be updated. Mutually exclusive with `--match-all` and `activity-id`. Note: Updating Activity options by Type is an experimental feature and may change in the future. |
471+
| `--activity-id`, `-a` | No | **string** The Activity ID to update options. Mutually exclusive with `--query`. Requires `--workflow-id` to be specified. |
488472
| `--headers` | No | **string[]** Temporal workflow headers in 'KEY=VALUE' format. Keys must be identifiers, and values must be JSON values. May be passed multiple times to set multiple Temporal headers. Note: These are workflow headers, not gRPC headers. |
489473
| `--heartbeat-timeout` | No | **duration** Maximum permitted time between successful worker heartbeats. |
490-
| `--match-all` | No | **bool** Every activity should be updated. Mutually exclusive with `--activity-id` and `--activity-type`. Note: This is an experimental feature and may change in the future. |
491474
| `--query`, `-q` | No | **string** Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. Note: Using --query for batch activity operations is an experimental feature and may change in the future. |
492475
| `--reason` | No | **string** Reason for batch operation. Only use with --query. Defaults to user name. |
493476
| `--restore-original-options` | No | **bool** Restore the original options of the activity. |
@@ -519,19 +502,19 @@ The following options can be used with any command.
519502
| `--codec-header` | No | **string[]** HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. | |
520503
| `--color` | No | **string-enum** Output coloring. Accepted values: always, never, auto. | `auto` |
521504
| `--command-timeout` | No | **duration** The command execution timeout. 0s means no timeout. | |
522-
| `--config-file` | No | **string** File path to read TOML config from, defaults to `$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, `$HOME/Library/Application Support` on macOS, and `%AppData%` on Windows. _(Experimental)_ | |
523-
| `--disable-config-env` | No | **bool** If set, disables loading environment config from environment variables. _(Experimental)_ | |
524-
| `--disable-config-file` | No | **bool** If set, disables loading environment config from config file. _(Experimental)_ | |
505+
| `--config-file` | No | **string** File path to read TOML config from, defaults to `$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, `$HOME/Library/Application Support` on macOS, and `%AppData%` on Windows. | |
506+
| `--disable-config-env` | No | **bool** If set, disables loading environment config from environment variables. | |
507+
| `--disable-config-file` | No | **bool** If set, disables loading environment config from config file. | |
525508
| `--env` | No | **string** Active environment name (`ENV`). | `default` |
526509
| `--env-file` | No | **string** Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. | |
527510
| `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | |
528511
| `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | |
529512
| `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` |
530-
| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` |
513+
| `--log-level` | No | **string-enum** Log level. Default is "never" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `never` |
531514
| `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` |
532515
| `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | |
533516
| `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` |
534-
| `--profile` | No | **string** Profile to use for config file. _(Experimental)_ | |
517+
| `--profile` | No | **string** Profile to use for config file. | |
535518
| `--time-format` | No | **string-enum** Time format. Accepted values: relative, iso, raw. | `relative` |
536519
| `--tls` | No | **bool** Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. | |
537520
| `--tls-ca-data` | No | **string** Data for server CA certificate. Can't be used with --tls-ca-path. | |

docs/cli/batch.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,19 +88,19 @@ The following options can be used with any command.
8888
| `--codec-header` | No | **string[]** HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. | |
8989
| `--color` | No | **string-enum** Output coloring. Accepted values: always, never, auto. | `auto` |
9090
| `--command-timeout` | No | **duration** The command execution timeout. 0s means no timeout. | |
91-
| `--config-file` | No | **string** File path to read TOML config from, defaults to `$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, `$HOME/Library/Application Support` on macOS, and `%AppData%` on Windows. _(Experimental)_ | |
92-
| `--disable-config-env` | No | **bool** If set, disables loading environment config from environment variables. _(Experimental)_ | |
93-
| `--disable-config-file` | No | **bool** If set, disables loading environment config from config file. _(Experimental)_ | |
91+
| `--config-file` | No | **string** File path to read TOML config from, defaults to `$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, `$HOME/Library/Application Support` on macOS, and `%AppData%` on Windows. | |
92+
| `--disable-config-env` | No | **bool** If set, disables loading environment config from environment variables. | |
93+
| `--disable-config-file` | No | **bool** If set, disables loading environment config from config file. | |
9494
| `--env` | No | **string** Active environment name (`ENV`). | `default` |
9595
| `--env-file` | No | **string** Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. | |
9696
| `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | |
9797
| `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | |
9898
| `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` |
99-
| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` |
99+
| `--log-level` | No | **string-enum** Log level. Default is "never" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `never` |
100100
| `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` |
101101
| `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | |
102102
| `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` |
103-
| `--profile` | No | **string** Profile to use for config file. _(Experimental)_ | |
103+
| `--profile` | No | **string** Profile to use for config file. | |
104104
| `--time-format` | No | **string-enum** Time format. Accepted values: relative, iso, raw. | `relative` |
105105
| `--tls` | No | **bool** Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. | |
106106
| `--tls-ca-data` | No | **string** Data for server CA certificate. Can't be used with --tls-ca-path. | |

0 commit comments

Comments
 (0)