Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
99 commits
Select commit Hold shift + click to select a range
580bfa7
Updating docs to match updated sample code
Evanthx Apr 29, 2026
8260bc8
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
2474676
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
b833fd7
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
e3dceb9
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
a649754
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
b4b99d9
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
d6042d7
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
ee58de1
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
78329f8
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
935a6ac
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
309c7b1
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
fdc1f13
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
a950509
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
b695749
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
9661834
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
b16a3a5
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
08f527a
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
fb1c43b
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
3e47a6d
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
ec06c4c
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
b29a4bb
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
442a285
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
d1ff332
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
67b824b
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
01cafe9
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
f816637
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
f87dca4
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
26c8eac
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
3fd0b2f
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
df2e145
Update docs/develop/python/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
ce4545b
Update docs/develop/python/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
0b6fb2e
Update docs/develop/python/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
ef00075
Update docs/develop/python/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
7f38957
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
7bc3035
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
6e9d6fe
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
763fa6a
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
68731a7
Fixed links to dotnet and go
Evanthx Apr 30, 2026
b89f3a8
docs: add tags column to ai integrations (#4509)
lennessyy Apr 30, 2026
2755a75
docs: update blob size limit error troubleshooting page (#4379)
lennessyy Apr 30, 2026
a2fe787
Java Standalone Activities guide (#4491)
GregoryTravis May 1, 2026
e939190
Replace Priority and Fairness diagrams with poller-flow flowcharts (#…
jpvotta May 1, 2026
8e43d01
Add Tenuo to Python AI integrations (#4496)
DABH May 1, 2026
2b631ad
Update .NET standalone activity examples to use IDs and task queue na…
fretz12 May 1, 2026
1f0cce4
Document Java Worker Heartbeating (#4520)
dustin-temporal May 1, 2026
269ad52
Renaming the docs MCP server to be a more accurate representation of …
MasonEgger May 1, 2026
ade0863
Update docs to refine explanations for non-determinism (#4448)
flippedcoder May 1, 2026
ed7aaef
docs: clarify upgrade path to require highest patch before minor bump…
chaptersix May 1, 2026
2fb9959
Java SAA is at pre-release. (#4522)
GregoryTravis May 1, 2026
14e6125
PrivateLink docs improvements + GA of Private Connectivity (#4492)
lukeknep May 1, 2026
8edbb66
docs: refresh codec server page (#4483)
lennessyy May 1, 2026
07299e4
docs: relax host resource reporting requirement; refresh audit log fi…
dustin-temporal May 4, 2026
c808782
add rust to quickstarts (#4524)
Splutonics May 4, 2026
bcf0ee7
chore(rust): added link to Develop page (#4527)
flippedcoder May 4, 2026
91cb65c
docs: add Mastra to Python integrations table (#4528)
DABH May 4, 2026
cbea160
Update CLI docs for release v1.7.1-standalone-nexus-operations (#4510)
github-actions[bot] May 4, 2026
bdc8b6e
docs: move Mastra integration from Python to TypeScript table (#4529)
DABH May 4, 2026
2797426
Updating docs to match updated sample code
Evanthx Apr 29, 2026
5503aa3
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
6a9fe3c
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
938d4d1
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
560f789
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
757fbf9
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
b23fe2d
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
6585456
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
3bbf256
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
d6fc852
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
2fd228d
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
70f645c
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
5351e6b
Update docs/develop/dotnet/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
125e533
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
2c076b7
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
576a045
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
c23b90c
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
ba63171
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
52ccab8
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
5f255fe
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
017eabe
Update docs/develop/go/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
d45a993
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
55b3d6c
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
7c0cc21
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
f086154
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
0151386
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
5e344e9
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
f33696b
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
732edf9
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
9d2a254
Update docs/develop/java/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
39b2681
Update docs/develop/python/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
053b3c3
Update docs/develop/python/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
f040e2d
Update docs/develop/python/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
311209b
Update docs/develop/python/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
3e022b6
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
dd94e01
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
4499203
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
bc899f6
Update docs/develop/typescript/nexus/feature-guide.mdx
flippedcoder Apr 30, 2026
4a0ede4
Fixed links to dotnet and go
Evanthx Apr 30, 2026
b4d2f8c
Merge remote-tracking branch 'refs/remotes/origin/nexus-sample-messag…
Evanthx May 4, 2026
69bfbb9
Fixed a Java link
Evanthx May 4, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/best-practices/cost-optimization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ See [Spooky Stories: Chilling Temporal Anti-Patterns](https://temporal.io/blog/s
### Large payloads in Workflow History

Passing multi-megabyte payloads through Workflows when external storage (S3, blob storage) is more appropriate.
Use [compression](/troubleshooting/blob-size-limit-error#why-does-this-error-occur) or the [claim check pattern](https://dataengineering.wiki/Concepts/Software+Engineering/Claim+Check+Pattern) for large data.
Use [compression](/troubleshooting/blob-size-limit-error#payload-size-limit) or the [claim check pattern](https://dataengineering.wiki/Concepts/Software+Engineering/Claim+Check+Pattern) for large data.

### Over-optimization at the expense of observability

Expand Down
67 changes: 25 additions & 42 deletions docs/cli/activity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,6 @@ Use the following options to change the behavior of this command. You can also u
| `--reason` | No | **string** Reason for cancellation. |
| `--run-id`, `-r` | No | **string** Activity Run ID. If not set, targets the latest run. |

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.

## complete

Complete an Activity, marking it as successfully finished. Specify the
Expand Down Expand Up @@ -212,9 +210,7 @@ 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.

Activities should be specified either by their Activity ID or Activity Type.

For example, specify the Activity and Workflow IDs like this:
Specify the Activity and Workflow IDs:

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

| Flag | Required | Description |
|------|----------|-------------|
| `--activity-id`, `-a` | No | **string** The Activity ID to pause. Either `activity-id` or `activity-type` must be provided, but not both. |
| `--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. |
| `--activity-id`, `-a` | No | **string** The Activity ID to pause. Required. |
| `--identity` | No | **string** The identity of the user or client submitting this request. |
| `--reason` | No | **string** Reason for pausing the Activity. |
| `--run-id`, `-r` | No | **string** Run ID. |
| `--workflow-id`, `-w` | Yes | **string** Workflow ID. |

Expand All @@ -255,7 +251,7 @@ 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.
Either `--activity-id` (with `--workflow-id`) or `--query` must be specified.

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

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

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

Specify the Activity Type of ID and Workflow IDs:
Specify the Activity and Workflow IDs:

```
temporal activity reset \
Expand All @@ -277,30 +273,25 @@ 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:
Activities can be reset in bulk with a visibility query list filter:

```
temporal activity reset \
--query 'TemporalResetInfo="property:activityType=Foo"'
--query 'WorkflowType="YourWorkflow"'
```

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

| Flag | Required | Description |
|------|----------|-------------|
| `--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. |
| `--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. |
| `--activity-id`, `-a` | No | **string** The Activity ID to reset. Mutually exclusive with `--query`. Requires `--workflow-id` to be specified. |
| `--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. |
| `--jitter` | No | **duration** The activity will reset at random a time within the specified duration. Can only be used with --query. |
| `--keep-paused` | No | **bool** If the activity was paused, it will stay paused. |
| `--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. |
| `--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. |
| `--reason` | No | **string** Reason for batch operation. Only use with --query. Defaults to user name. |
| `--reset-attempts` | No | **bool** Reset the activity attempts. |
| `--reset-heartbeats` | No | **bool** Reset the Activity's heartbeats. Only works with --reset-attempts. |
| `--reset-heartbeats` | No | **bool** Reset the Activity's heartbeats. |
| `--restore-original-options` | No | **bool** Restore the original options of the activity. |
| `--rps` | No | **float** Limit batch's requests per second. Only allowed if query is present. |
| `--run-id`, `-r` | No | **string** Run ID. Only use with --workflow-id. Cannot use with --query. |
Expand Down Expand Up @@ -403,10 +394,9 @@ Activity to be retried another N times after unpausing.

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

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

Specify the Activity ID or Type and Workflow IDs:
Specify the Activity and Workflow IDs:

```
temporal activity unpause \
Expand All @@ -416,28 +406,24 @@ 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:

```
temporal activity unpause \
--query 'TemporalPauseInfo="property:activityType=Foo"'
--query 'TemporalPauseInfo IS NOT NULL'
```

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

| Flag | Required | Description |
|------|----------|-------------|
| `--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. |
| `--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. |
| `--activity-id`, `-a` | No | **string** The Activity ID to unpause. Mutually exclusive with `--query`. Requires `--workflow-id` to be specified. |
| `--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. |
| `--jitter` | No | **duration** The activity will start at random a time within the specified duration. Can only be used with --query. |
| `--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. |
| `--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. |
| `--reason` | No | **string** Reason for batch operation. Only use with --query. Defaults to user name. |
| `--reset-attempts` | No | **bool** Reset the activity attempts. |
| `--reset-heartbeats` | No | **bool** Reset the Activity's heartbeats. Only works with --reset-attempts. |
| `--reset-heartbeats` | No | **bool** Reset the Activity's heartbeats. |
| `--rps` | No | **float** Limit batch's requests per second. Only allowed if query is present. |
| `--run-id`, `-r` | No | **string** Run ID. Only use with --workflow-id. Cannot use with --query. |
| `--workflow-id`, `-w` | No | **string** Workflow ID. You must set either --workflow-id or --query. |
Expand Down Expand Up @@ -468,26 +454,23 @@ temporal activity update-options \

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

Either `activity-id`, `activity-type`, or `--match-all` must be specified.
Either `--activity-id` or `--query` 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:
Activity options can be updated in bulk with a visibility query list filter:

```
temporal activity update-options \
--query 'TemporalPauseInfo="property:activityType=Foo"'
...
--query 'WorkflowType="YourWorkflow"' \
--task-queue NewTaskQueueName
```

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

| Flag | Required | Description |
|------|----------|-------------|
| `--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. |
| `--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. |
| `--activity-id`, `-a` | No | **string** The Activity ID to update options. Mutually exclusive with `--query`. Requires `--workflow-id` to be specified. |
| `--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. |
| `--heartbeat-timeout` | No | **duration** Maximum permitted time between successful worker heartbeats. |
| `--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. |
| `--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. |
| `--reason` | No | **string** Reason for batch operation. Only use with --query. Defaults to user name. |
| `--restore-original-options` | No | **bool** Restore the original options of the activity. |
Expand Down Expand Up @@ -519,19 +502,19 @@ The following options can be used with any command.
| `--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. | |
| `--color` | No | **string-enum** Output coloring. Accepted values: always, never, auto. | `auto` |
| `--command-timeout` | No | **duration** The command execution timeout. 0s means no timeout. | |
| `--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)_ | |
| `--disable-config-env` | No | **bool** If set, disables loading environment config from environment variables. _(Experimental)_ | |
| `--disable-config-file` | No | **bool** If set, disables loading environment config from config file. _(Experimental)_ | |
| `--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. | |
| `--disable-config-env` | No | **bool** If set, disables loading environment config from environment variables. | |
| `--disable-config-file` | No | **bool** If set, disables loading environment config from config file. | |
| `--env` | No | **string** Active environment name (`ENV`). | `default` |
| `--env-file` | No | **string** Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. | |
| `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | |
| `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | |
| `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` |
| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` |
| `--log-level` | No | **string-enum** Log level. Default is "never" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `never` |
| `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` |
| `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | |
| `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` |
| `--profile` | No | **string** Profile to use for config file. _(Experimental)_ | |
| `--profile` | No | **string** Profile to use for config file. | |
| `--time-format` | No | **string-enum** Time format. Accepted values: relative, iso, raw. | `relative` |
| `--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. | |
| `--tls-ca-data` | No | **string** Data for server CA certificate. Can't be used with --tls-ca-path. | |
Expand Down
10 changes: 5 additions & 5 deletions docs/cli/batch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,19 +88,19 @@ The following options can be used with any command.
| `--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. | |
| `--color` | No | **string-enum** Output coloring. Accepted values: always, never, auto. | `auto` |
| `--command-timeout` | No | **duration** The command execution timeout. 0s means no timeout. | |
| `--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)_ | |
| `--disable-config-env` | No | **bool** If set, disables loading environment config from environment variables. _(Experimental)_ | |
| `--disable-config-file` | No | **bool** If set, disables loading environment config from config file. _(Experimental)_ | |
| `--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. | |
| `--disable-config-env` | No | **bool** If set, disables loading environment config from environment variables. | |
| `--disable-config-file` | No | **bool** If set, disables loading environment config from config file. | |
| `--env` | No | **string** Active environment name (`ENV`). | `default` |
| `--env-file` | No | **string** Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. | |
| `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | |
| `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | |
| `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` |
| `--log-level` | No | **string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `info` |
| `--log-level` | No | **string-enum** Log level. Default is "never" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `never` |
| `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` |
| `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | |
| `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` |
| `--profile` | No | **string** Profile to use for config file. _(Experimental)_ | |
| `--profile` | No | **string** Profile to use for config file. | |
| `--time-format` | No | **string-enum** Time format. Accepted values: relative, iso, raw. | `relative` |
| `--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. | |
| `--tls-ca-data` | No | **string** Data for server CA certificate. Can't be used with --tls-ca-path. | |
Expand Down
Loading
Loading