Skip to content

Update CLI docs for release v1.4.1-cloud-v1-29-0-139-2.0 #3769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update CLI docs for release v1.4.1-cloud-v1-29-0-139-2.0 #3769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
297 changes: 189 additions & 108 deletions docs/cli/activity.mdx
View file
Open in desktop

Large diffs are not rendered by default.

23 changes: 18 additions & 5 deletions docs/cli/batch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand All @@ -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_

Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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_

Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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_

Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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.

35 changes: 28 additions & 7 deletions docs/cli/config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand All @@ -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_

Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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_

Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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_

Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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_

Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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_

Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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.

29 changes: 23 additions & 6 deletions docs/cli/env.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down Expand Up @@ -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_

Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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_

Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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_

Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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_

Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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.

Loading