Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,13 @@ tags:
- account
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Manage the Temporal Cloud account.

This page provides a reference for the `temporal cloud account` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand.
Expand Down
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/apikey.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ tags:
- apikeys
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Commands for creating, listing, and managing Temporal Cloud API keys.

API keys authenticate requests to the Temporal Cloud API.
Expand Down
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/async-operation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ tags:
- async-operations
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Commands for working with Temporal Cloud async operations.

This page provides a reference for the `temporal cloud async-operation` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand.
Expand Down
6 changes: 5 additions & 1 deletion docs/cli/command-reference/cloud/connectivity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,13 @@ tags:
- connectivity
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Commands for managing connectivity rules for Temporal Cloud.

This page provides a reference for the `temporal cloud connectivity` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand.
Expand Down Expand Up @@ -108,7 +112,7 @@ Use the following options to change the behavior of this command. You can also u
| `--api-key` | No | **string** API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. |
| `--async` | No | **bool** Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later. |
| `--async-operation-id` | No | **string** Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically. |
| `--azure-pe-resource-id` | No | **string** The ARM resource ID of the Azure Private Endpoint (only for Azure private connectivity). Example: `/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Network/privateEndpoints/{name}`. |
| `--azure-pe-resource-id` | No | **string** The ARM resource ID of the Azure Private Endpoint (only for Azure private connectivity). Example: /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Network/privateEndpoints/{name}. |
| `--connection-id` | No | **string** The connection ID for private connectivity (AWS VPC endpoint ID or GCP PSC connection ID). |
| `--gcp-project-id` | No | **string** The GCP project ID (only for GCP private connectivity). |
| `--idempotent` | No | **bool** Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed. |
Expand Down
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/custom-role.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ tags:
- custom-roles
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Commands for managing Temporal Cloud custom roles.

Custom roles enable fine-grained authorization by binding sets of
Expand Down
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ tags:
- login
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Authenticate with Temporal Cloud using browser-based OAuth login.

This command opens your default browser to complete authentication. Once
Expand Down
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/logout.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ tags:
- login
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Log out from Temporal Cloud by clearing stored authentication tokens
and credentials from the local configuration.

Expand Down
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/namespace.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,13 @@ tags:
- namespaces
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Commands for creating, updating, and managing Temporal Cloud namespaces.

Namespaces provide isolation for workflows and activities. Each namespace
Expand Down
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/nexus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,13 @@ tags:
- nexus
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Commands for managing Nexus Operations in Temporal Cloud.

This page provides a reference for the `temporal cloud nexus` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand.
Expand Down
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/region.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,13 @@ tags:
- region
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Commands for listing Temporal Cloud regions.

This page provides a reference for the `temporal cloud region` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand.
Expand Down
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/service-account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,13 @@ tags:
- service-accounts
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Commands for managing Temporal Cloud service accounts.

This page provides a reference for the `temporal cloud service-account` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand.
Expand Down
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/user-group.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,13 @@ tags:
- user-groups
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Commands for managing Temporal Cloud user groups.

This page provides a reference for the `temporal cloud user-group` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand.
Expand Down
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,13 @@ tags:
- users
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Commands for managing Temporal Cloud users.

This page provides a reference for the `temporal cloud user` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand.
Expand Down
4 changes: 4 additions & 0 deletions docs/cli/command-reference/cloud/whoami.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ tags:
- authentication
---

import { ReleaseNoteHeader } from '@site/src/components';

{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
This file is generated from the CLI command definitions via cmd/gen-docs. */}

<ReleaseNoteHeader featureName="cloudCli" />

Display information about the currently authenticated identity.

Shows whether you are authenticated as a user or service account, along
Expand Down
1 change: 1 addition & 0 deletions docs/cli/command-reference/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ This section includes the complete command reference for the `temporal` CLI, inc
- [cloud](/cli/command-reference/cloud)
- [config](/cli/command-reference/config)
- [env](/cli/command-reference/env)
- [nexus](/cli/command-reference/nexus)
- [operator](/cli/command-reference/operator)
- [schedule](/cli/command-reference/schedule)
- [server](/cli/command-reference/server)
Expand Down
Loading