cli

564 notes in this subject, read out of this brain and free to use. This is page 1 of 10.

Log in to Temporal Cloud with CLI

Use `temporal cloud login` to authenticate to Temporal Cloud. After login, run commands against Temporal Cloud by providing the address and Namespace with flags like `--address <namespace>.<account>.tmprl.cloud:7233` and `--namespace <namespace>.<account>`.

Create and manage Schedules with CLI

Use `temporal schedule create --schedule-id <id> --interval <duration> --task-queue <queue> --type <WorkflowType>` to create a Schedule that starts a Workflow on an interval. Use `temporal schedule list` to list all Schedules. Use `temporal schedule toggle --schedule-id <id> --pause --reason '<reason>'` to pause a Schedule and `--unpause --reason '<reason>'` to unpause it.

Cancel or Terminate a Workflow Execution with CLI

Use `temporal workflow cancel --workflow-id <id>` to cancel a Workflow Execution, which allows cleanup logic to run before completion. Use `temporal workflow terminate --workflow-id <id>` to terminate a Workflow Execution immediately with no cleanup.

List and describe Workflow Executions with CLI

Use `temporal workflow list` to list running Workflows. Use `temporal workflow describe --workflow-id <id>` to get details about a specific Workflow Execution. Use `temporal workflow show --workflow-id <id>` to view the Event History for a Workflow Execution.

Format and filter CLI output

Use `--output json` flag with any CLI command to get machine-readable JSON output. Combine with jq for filtering, such as `temporal workflow list --output json | jq '.[].type.name'`.

Manage Namespaces with CLI

Use `temporal operator namespace list` to list available Namespaces. Use `temporal operator namespace create --namespace <name>` to create a new Namespace. To manage Namespaces on Temporal Cloud, use the Temporal Cloud extension and `temporal cloud namespace` commands instead.

Start a Workflow Execution with CLI

Use `temporal workflow start --task-queue <queue> --type <WorkflowType> --workflow-id <id> --input '<input>'` to start a Workflow. To start a Workflow and wait for the result, use `temporal workflow execute` with the same parameters instead.

Start a development Temporal Server with CLI

Run a local Temporal Service for development using `temporal server start-dev`. The Temporal Service is available on localhost:7233 and the Web UI at http://localhost:8233. To persist workflow data between restarts, use `temporal server start-dev --db-filename temporal.db`.

Send Signals and Queries to Workflows with CLI

Use `temporal workflow signal --workflow-id <id> --name <signal-name> --input '<value>'` to send a Signal to a running Workflow. Use `temporal workflow query --workflow-id <id> --name <query-name>` to Query a running Workflow for its current state.

Global CLI flags for batch commands

The temporal CLI batch commands support these global flags: `--address` (string, default localhost:7233) for Temporal Service gRPC endpoint, `--api-key` (string) for API key, `--client-authority` (string) for gRPC client :authority pseudoheader, `--client-connect-timeout` (duration) for client connection timeout, `--codec-auth` (string) for Codec Server authorization header, `--codec-endpoint` (string) for remote Codec Server endpoint, `--codec-header` (string[], KEY=VALUE format) for Codec Server HTTP headers, `--color` (string-enum: always/never/auto, default auto) for output coloring, `--command-timeout` (duration) for command execution timeout, `--config-file` (string) for TOML config file path, `--disable-config-env` (bool) to disable environment config loading, `--disable-config-file` (bool) to disable config file loading, `--env` (string, default default) for active environment name, `--env-file` (string) for environment settings file path, `--grpc-meta` (string[], KEY=VALUE format) for HTTP request headers, `--identity` (string, defaults to temporal-cli:$USER@$HOST) for request identity, `--log-format` (string-enum: text/json, default text) for log format, `--log-level` (string-enum: debug/info/warn/error/never, default never) for log level, `--namespace` or `-n` (string, default default) for Temporal Service Namespace, `--no-json-shorthand-payloads` (bool) for raw payload output, `--output` or `-o` (string-enum: text/json/jsonl/none, default text) for output format, `--profile` (string) for config file profile, `--time-format` (string-enum: relative/iso/raw, default relative) for time format, and `--tls` (bool, defaulted to true if api-key or other TLS options are present) to enable base TLS encryption.

TLS certificate and key CLI flags

The temporal CLI supports these TLS-specific flags: `--tls-ca-data` (string, cannot be used with --tls-ca-path) for server CA certificate data, `--tls-ca-path` (string, cannot be used with --tls-ca-data) for server CA certificate path, `--tls-cert-data` (string, cannot be used with --tls-cert-path) for x509 certificate data, `--tls-cert-path` (string, cannot be used with --tls-cert-data) for x509 certificate path, `--tls-disable-host-verification` (bool) to disable TLS host-name verification, `--tls-key-data` (string, cannot be used with --tls-key-path) for private certificate key data, `--tls-key-path` (string, cannot be used with --tls-key-data) for x509 private key path, and `--tls-server-name` (string) to override target TLS server name.

batch describe command usage

Use `temporal batch describe --job-id YourJobId` to show the progress of an ongoing batch job. The `--job-id` flag is required and accepts a string value specifying the Batch job ID.

batch list command usage

Use `temporal batch list --namespace YourNamespace` to return a list of batch jobs on the Service or within a single Namespace. The `--limit` flag is optional and accepts an integer value to set the maximum number of batch jobs to display.

batch terminate command usage

Use `temporal batch terminate --job-id YourJobId --reason YourTerminationReason` to terminate a batch job. Both `--job-id` (string, required) and `--reason` (string, required) flags are required. The Service stores the reason as metadata for the termination event for later reference.

temporal activity fail command

Fail an Activity marking it as encountered an error using `temporal activity fail --activity-id <id> --workflow-id <id>`. Required flags: `--activity-id` or `-a` (string) for Activity ID (may be ID invoked by Workflow or Standalone Activity). Optional flags: `--detail` (string JSON) for failure details payload, `--reason` (string) for failure message, `--run-id` or `-r` (string) for Run ID (Workflow Run ID if workflow-id provided, Activity Run ID for Standalone), `--workflow-id` or `-w` (string) required for workflow Activities, omit for Standalone Activities.

temporal activity list command

List Standalone Activities using `temporal activity list`. Optional flags: `--limit` (int) for maximum number of Activity Executions to display, `--page-size` (int) for maximum fetched at a time from server, `--query` or `-q` (string) to filter Activity Executions. Visit https://docs.temporal.io/visibility for more about Search Attributes and queries.

temporal activity count command

Return a count of Standalone Activities using `temporal activity count`. Optional flag: `--query` or `-q` (string) to filter activities to be counted using Search Attribute queries. Visit https://docs.temporal.io/visibility for more about Search Attributes and queries.

temporal activity update-options command

Update options of a running Activity passed from Workflow using `temporal activity update-options --activity-id <id> --workflow-id <id>`. Updates are incremental, only changing specified options. Not supported for Standalone Activities. Either `--activity-id` or `--query` must be specified. Optional flags: `--activity-id` or `-a` (string, mutually exclusive with --query, requires --workflow-id), `--headers` (string[] KEY=VALUE), `--heartbeat-timeout` (duration), `--query` or `-q` (string), `--reason` (string, --query only), `--restore-original-options` (bool), `--retry-backoff-coefficient` (float >=1), `--retry-initial-interval` (duration), `--retry-maximum-attempts` (int, 1=disables retries, 0=unlimited), `--retry-maximum-interval` (duration), `--rps` (float, --query only), `--run-id` or `-r` (string, --workflow-id only), `--schedule-to-close-timeout` (duration), `--schedule-to-start-timeout` (duration), `--start-to-close-timeout` (duration), `--task-queue` (string), `--workflow-id` or `-w` (string), `--yes` or `-y` (bool, --query only).

temporal activity describe command

Display information about a Standalone Activity using `temporal activity describe --activity-id <id>`. Required flag: `--activity-id` or `-a` (string). Optional flags: `--raw` (bool) to print properties without changing their format, `--run-id` or `-r` (string) for Activity Run ID, defaults to latest if not set.

temporal activity unpause command

Re-schedule a previously-paused Activity for execution using `temporal activity unpause --activity-id <id> --workflow-id <id>`. Not supported for Standalone Activities. If Activity not running and past retry timeout, scheduled immediately. Otherwise scheduled after retry timeout expires. Optional flags: `--reset-attempts` (bool) to reset number of previous run attempts to zero, `--reset-heartbeats` (bool) to reset Activity's heartbeats. Either `--activity-id` (with `--workflow-id`) or `--query` must be specified. Optional flags: `--activity-id` or `-a` (string, mutually exclusive with --query), `--headers` (string[] KEY=VALUE), `--jitter` (duration, --query only), `--query` or `-q` (string), `--reason` (string, --query only), `--reset-attempts` (bool), `--reset-heartbeats` (bool), `--rps` (float, --query only), `--run-id` or `-r` (string, --workflow-id only), `--workflow-id` or `-w` (string), `--yes` or `-y` (bool, --query only).

temporal activity complete command

Complete an Activity marking it as successfully finished using `temporal activity complete --activity-id <id> --result '<json>'`. Required flags: `--activity-id` or `-a` (string) for Activity ID (may be ID of Activity invoked by Workflow or Standalone Activity), `--result` (string) for JSON result to return. Optional flags: `--run-id` or `-r` (string) for Run ID (Workflow Run ID if workflow-id provided, Activity Run ID for Standalone), `--workflow-id` or `-w` (string) required for workflow Activities, omit for Standalone Activities.

temporal activity terminate command

Terminate a Standalone Activity using `temporal activity terminate --activity-id <id>`. Activity code cannot see or respond to terminations. Required flag: `--activity-id` or `-a` (string). Optional flags: `--reason` (string) for termination reason, defaults to message with current user name, `--run-id` or `-r` (string) for Activity Run ID, defaults to latest if not set.

temporal activity cancel command

Request cancellation of a Standalone Activity using `temporal activity cancel --activity-id <id>`. Required flags: `--activity-id` or `-a` (string). Optional flags: `--reason` (string) for cancellation reason, `--run-id` or `-r` (string) to target specific run, defaults to latest. Requesting cancellation transitions the Activity's run state to CancelRequested. If the Activity is heartbeating, a cancellation error will be raised when the next heartbeat response is received; if the Activity allows this error to propagate, the Activity transitions to canceled status.

temporal activity start command

Start a new Standalone Activity using `temporal activity start --activity-id <id> --type <type> --task-queue <queue> --start-to-close-timeout <duration> --input '<json>'`. Outputs Activity ID and Run ID. Required flags: `--activity-id` or `-a` (string), `--type` (string) for Activity Type name, `--task-queue` or `-t` (string). Either `--start-to-close-timeout` or `--schedule-to-close-timeout` required. Optional flags: `--fairness-key` (string, max 64 bytes), `--fairness-weight` (float 0.001-1000), `--headers` (string[] KEY=VALUE), `--heartbeat-timeout` (duration), `--id-conflict-policy` (Fail|UseExisting), `--id-reuse-policy` (AllowDuplicate|AllowDuplicateFailedOnly|RejectDuplicate), `--input` or `-i` (string[] JSON), `--input-base64` (bool), `--input-file` (string[] paths), `--input-meta` (string[] KEY=VALUE), `--priority-key` (int 1-5, default 3), `--retry-backoff-coefficient` (float >=1), `--retry-initial-interval` (duration), `--retry-maximum-attempts` (int, 0=unlimited), `--retry-maximum-interval` (duration), `--schedule-to-close-timeout` (duration), `--schedule-to-start-timeout` (duration), `--search-attribute` (string[] KEY=VALUE), `--start-to-close-timeout` (duration), `--static-details` (string, Markdown), `--static-summary` (string, Markdown).

temporal activity result command

Wait for a Standalone Activity to complete and output result using `temporal activity result --activity-id <id>`. Required flag: `--activity-id` or `-a` (string). Optional flag: `--run-id` or `-r` (string) for Activity Run ID, defaults to latest if not set.

temporal activity reset command

Reset an Activity using `temporal activity reset --activity-id <id> --workflow-id <id>`. Not supported for Standalone Activities. Restarts activity as if first being scheduled, resetting number of attempts and activity timeout, and optionally heartbeat details. If activity may be executing, reset takes effect on next failure, heartbeat, or timeout. If waiting for retry, reset applies immediately. If paused, unpause by default unless `--keep-paused` specified. Either `--activity-id` (with `--workflow-id`) or `--query` must be specified. Activities that heartbeat receive Canceled failure on next heartbeat after reset. Optional flags: `--activity-id` or `-a` (string, mutually exclusive with --query), `--headers` (string[] KEY=VALUE), `--jitter` (duration, --query only), `--keep-paused` (bool), `--query` or `-q` (string), `--reason` (string, --query only), `--reset-attempts` (bool), `--reset-heartbeats` (bool), `--restore-original-options` (bool), `--rps` (float, --query only), `--run-id` or `-r` (string, --workflow-id only), `--workflow-id` or `-w` (string), `--yes` or `-y` (bool, --query only).

temporal activity pause command

Pause an Activity using `temporal activity pause --activity-id <id> --workflow-id <id>`. Not supported for Standalone Activities. If Activity not currently running, it will not run again until unpaused. If currently running, it will run until next failure, completion, or timeout, then pause kicks in. Pause does not stop or extend Activity's Schedule-To-Close Timeout; paused Activity can still time out. If on last retry attempt and fails, failure returned to caller. Required flag: `--workflow-id` or `-w` (string). Optional flags: `--activity-id` or `-a` (string) required, `--identity` (string), `--reason` (string), `--run-id` or `-r` (string).

temporal cloud account audit-log sink kinesis update command flags

The `temporal cloud account audit-log sink kinesis update` command updates an existing Kinesis audit log sink; omitted string flags retain their current values. Flags: `--api-key` (string, optional) for authentication; `--async` (bool, optional) returns immediately instead of waiting for completion; `--async-operation-id` (string, optional) custom identifier for tracking async operation, auto-generated if not provided; `--destination-uri` (string, optional) ARN of Kinesis stream, current value kept if omitted; `--idempotent` (bool, optional) succeeds silently if resource already exists or matches specification; `--name` (string, required) name of the audit log sink to update; `--poll-interval` (duration, optional, cannot exceed 10 minutes, supports m and s) time to wait between status checks; `--region` (string, optional) AWS region, current value kept if omitted; `--resource-version` or `-v` (string, optional) for optimistic concurrency control, auto-fetched if not provided; `--role-name` (string, optional) name of IAM role, current value kept if omitted; `--server` (string, optional) overrides API server address.

temporal cloud account audit-log list command flags

The `temporal cloud account audit-log list` command retrieves a paginated list of audit logs for the account, optionally filtered by time range. Flags: `--api-key` (string, optional) for authentication; `--end-time` (timestamp, optional, RFC3339 format e.g. 2024-02-01T00:00:00Z, defaults to current time) filters logs before this UTC time; `--page-size` (int, optional, cannot exceed 1000, defaults to 100) specifies logs per page; `--page-token` (string, optional) for pagination; `--server` (string, optional) overrides the API server address; `--start-time` (timestamp, optional, RFC3339 format, defaults to 30 days ago) filters logs at or after this UTC time.

temporal cloud account metrics cert-ca create command flags

The `temporal cloud account metrics cert-ca create` command adds a CA certificate to the list of accepted client CA certificates for the Temporal Cloud account metrics endpoint. Flags: `--api-key` (string, optional) for authentication; `--async` (bool, optional) returns immediately instead of waiting for completion; `--async-operation-id` (string, optional) custom identifier for tracking async operation, auto-generated if not provided; `--ca-certificate` (string, optional) base64-encoded CA certificate, mutually exclusive with --ca-certificate-file; `--ca-certificate-file` (string, optional) path to CA certificate PEM file, mutually exclusive with --ca-certificate; `--idempotent` (bool, optional) succeeds silently if resource already exists or matches specification; `--poll-interval` (duration, optional, cannot exceed 10 minutes, supports m and s) time to wait between status checks; `--resource-version` or `-v` (string, optional) for optimistic concurrency control, auto-fetched if not provided; `--server` (string, optional) overrides API server address.

temporal cloud account metrics cert-ca delete command flags

The `temporal cloud account metrics cert-ca delete` command removes a CA certificate from the list of accepted client CA certificates for the Temporal Cloud account metrics endpoint. Flags: `--api-key` (string, optional) for authentication; `--async` (bool, optional) returns immediately instead of waiting for completion; `--async-operation-id` (string, optional) custom identifier for tracking async operation, auto-generated if not provided; `--ca-certificate` (string, optional) base64-encoded CA certificate, mutually exclusive with --ca-certificate-file; `--ca-certificate-file` (string, optional) path to CA certificate PEM file, mutually exclusive with --ca-certificate; `--idempotent` (bool, optional) succeeds silently if resource already exists or matches specification; `--poll-interval` (duration, optional, cannot exceed 10 minutes, supports m and s) time to wait between status checks; `--resource-version` or `-v` (string, optional) for optimistic concurrency control, auto-fetched if not provided; `--server` (string, optional) overrides API server address.

temporal cloud account metrics cert-ca list command flags

The `temporal cloud account metrics cert-ca list` command lists the CA certificates accepted for authenticating clients accessing the Temporal Cloud account metrics endpoint. Flags: `--api-key` (string, optional) for authentication; `--server` (string, optional) overrides API server address.

temporal cloud account audit-log sink pubsub create command flags

The `temporal cloud account audit-log sink pubsub create` command creates a new PubSub audit log sink for the account using Google Cloud Pub/Sub. Flags: `--api-key` (string, optional) for authentication; `--async` (bool, optional) returns immediately instead of waiting for completion; `--async-operation-id` (string, optional) custom identifier for tracking async operation, auto-generated if not provided; `--idempotent` (bool, optional) succeeds silently if resource already exists or matches specification; `--name` (string, required) name of the audit log sink; `--poll-interval` (duration, optional, cannot exceed 10 minutes, supports m and s) time to wait between status checks; `--server` (string, optional) overrides API server address; `--service-account-email` (string, required) email of GCP service account that Temporal Cloud impersonates (format: my-sa@my-project.iam.gserviceaccount.com); `--topic-name` (string, required) destination PubSub topic name where audit logs will be sent.

temporal cloud account audit-log sink kinesis validate command flags

The `temporal cloud account audit-log sink kinesis validate` command validates an audit log sink configuration against Amazon Kinesis without creating it. Use to verify that the IAM role and Kinesis stream are correctly configured before creating or updating the sink. Flags: `--api-key` (string, optional) for authentication; `--destination-uri` (string, required) ARN of the Kinesis stream; `--region` (string, required) AWS region where Kinesis stream is located (e.g. us-east-1); `--role-name` (string, required) name of IAM role Temporal Cloud assumes; `--server` (string, optional) overrides API server address.

temporal cloud account audit-log sink enable command flags

The `temporal cloud account audit-log sink enable` command enables an audit log sink for the account. Flags: `--api-key` (string, optional) for authentication; `--async` (bool, optional) returns immediately instead of waiting for completion; `--async-operation-id` (string, optional) custom identifier for tracking async operation, auto-generated if not provided; `--idempotent` (bool, optional) succeeds silently if resource already exists or matches specification; `--name` (string, required) name of the audit log sink to enable; `--poll-interval` (duration, optional, cannot exceed 10 minutes, supports m and s) time to wait between status checks; `--resource-version` or `-v` (string, optional) for optimistic concurrency control, auto-fetched if not provided; `--server` (string, optional) overrides API server address.

temporal cloud account audit-log sink kinesis create command flags

The `temporal cloud account audit-log sink kinesis create` command creates an account audit log sink that streams audit events to Amazon Kinesis. Temporal Cloud assumes the specified IAM role to write events to the Kinesis stream. Flags: `--api-key` (string, optional) for authentication; `--async` (bool, optional) returns immediately instead of waiting for completion; `--async-operation-id` (string, optional) custom identifier for tracking async operation, auto-generated if not provided; `--destination-uri` (string, required) ARN of the Kinesis stream; `--idempotent` (bool, optional) succeeds silently if resource already exists or matches specification; `--name` (string, required) name of the audit log sink; `--poll-interval` (duration, optional, cannot exceed 10 minutes, supports m and s) time to wait between status checks; `--region` (string, required) AWS region where Kinesis stream is located (e.g. us-east-1); `--role-name` (string, required) name of IAM role Temporal Cloud assumes; `--server` (string, optional) overrides API server address.

temporal cloud account audit-log sink get command flags

The `temporal cloud account audit-log sink get` command returns the details of an audit log sink for the account. Flags: `--api-key` (string, optional) for authentication; `--name` (string, required) name of the audit log sink to get; `--server` (string, optional) overrides API server address.

temporal cloud account audit-log sink pubsub update command flags

The `temporal cloud account audit-log sink pubsub update` command updates an existing PubSub audit log sink for the account. Flags: `--api-key` (string, optional) for authentication; `--async` (bool, optional) returns immediately instead of waiting for completion; `--async-operation-id` (string, optional) custom identifier for tracking async operation, auto-generated if not provided; `--idempotent` (bool, optional) succeeds silently if resource already exists or matches specification; `--name` (string, required) name of the audit log sink to update; `--poll-interval` (duration, optional, cannot exceed 10 minutes, supports m and s) time to wait between status checks; `--resource-version` or `-v` (string, optional) for optimistic concurrency control, auto-fetched if not provided; `--server` (string, optional) overrides API server address; `--service-account-email` (string, optional) email of GCP service account (format: my-sa@my-project.iam.gserviceaccount.com); `--topic-name` (string, optional) destination PubSub topic name where audit logs will be sent.

temporal cloud account audit-log sink list command flags

The `temporal cloud account audit-log sink list` command returns a paginated list of audit log sinks for the account. Flags: `--api-key` (string, optional) for authentication; `--page-size` (int, optional, cannot exceed 1000, defaults to 100) specifies sinks per page; `--page-token` (string, optional) for pagination; `--server` (string, optional) overrides API server address.

temporal cloud account audit-log sink pubsub validate command flags

The `temporal cloud account audit-log sink pubsub validate` command validates a PubSub audit log sink specification without creating or modifying any resources. Flags: `--api-key` (string, optional) for authentication; `--server` (string, optional) overrides API server address; `--service-account-email` (string, required) email of GCP service account (format: my-sa@my-project.iam.gserviceaccount.com); `--topic-name` (string, required) destination PubSub topic name where audit logs will be sent.

temporal cloud async-operation get command

The 'temporal cloud async-operation get' command retrieves the status and details of a Temporal Cloud async operation. Example usage: 'temporal cloud async-operation get --async-operation-id my-op-id'.

temporal cloud async-operation await flags

The 'temporal cloud async-operation await' command accepts the following flags: --api-key (optional, string) for API key authentication; --async-operation-id (required, string) specifying the ID of the async operation to wait for; --poll-interval (optional, duration) specifying time between status checks with max 10 minutes, supporting minutes (m) and seconds (s), default 1s; --server (optional, string) to override the Temporal Cloud API server address for non-production environments.

temporal cloud async-operation await command

The 'temporal cloud async-operation await' command waits for a Temporal Cloud async operation to reach a terminal state. It polls the operation status until it completes, fails, or is cancelled. Example usage: 'temporal cloud async-operation await --async-operation-id my-op-id'.

temporal cloud async-operation get flags

The 'temporal cloud async-operation get' command accepts the following flags: --api-key (optional, string) for API key authentication; --async-operation-id (required, string) specifying the ID of the async operation to retrieve; --server (optional, string) to override the Temporal Cloud API server address for non-production environments.

temporal cloud apikey edit command

Opens an API key configuration in the default editor for interactive modification. After saving and closing the editor, changes are applied to Temporal Cloud. The editor is determined by the EDITOR environment variable, falling back to 'vi' if not set. Example: `temporal cloud apikey edit --key-id my-key-id`. Flags: --api-key (string, no), --async (bool, no), --async-operation-id (string, no), --idempotent (bool, no), --key-id (string, yes), --poll-interval (duration, no, max 10 minutes, supports m and s), --resource-version/-v (string, no - for optimistic concurrency control, fetched automatically if not provided), --server (string, no), --verbose-diff (bool, no - shows detailed differences between current and desired configurations).

temporal cloud apikey get command

Retrieves the configuration and status of a Temporal Cloud API key. Example: `temporal cloud apikey get --key-id my-key-id`. Flags: --api-key (string, no), --key-id (string, yes), --server (string, no).

temporal cloud apikey update command

Updates an API key's display name, description, or disabled status. Only flags that are explicitly provided are changed. Examples: `temporal cloud apikey update --key-id my-key-id --display-name "New Name"`, `temporal cloud apikey update --key-id my-key-id --disabled=true`. Flags: --api-key (string, no), --async (bool, no), --async-operation-id (string, no), --description (string, no), --disabled (bool, no - set to true to disable or false to enable), --display-name (string, no), --idempotent (bool, no), --key-id (string, yes), --poll-interval (duration, no, max 10 minutes, supports m and s), --resource-version/-v (string, no - for optimistic concurrency control, fetched automatically if not provided), --server (string, no).

temporal cloud apikey disable command

Disables a Temporal Cloud API key. Disabled keys cannot be used for authentication. Example: `temporal cloud apikey disable --key-id my-key-id`. Flags: --api-key (string, no), --async (bool, no), --async-operation-id (string, no), --idempotent (bool, no), --key-id (string, yes), --poll-interval (duration, no, max 10 minutes, supports m and s), --resource-version/-v (string, no - for optimistic concurrency control, fetched automatically if not provided), --server (string, no).

temporal cloud apikey create-for-service-account command

Creates a new API key owned by the specified service account. The token is printed once on creation and cannot be retrieved again. Example: `temporal cloud apikey create-for-service-account --service-account-id my-sa-id --display-name "My Key"`. Flags: --api-key (string, no), --async (bool, no), --async-operation-id (string, no), --description (string, no), --display-name (string, yes), --expiry-duration (duration, no - supports days (d), hours (h), minutes (m), seconds (s), mutually exclusive with --expiry-time), --expiry-time (timestamp RFC3339, no, mutually exclusive with --expiry-duration), --idempotent (bool, no), --poll-interval (duration, no, max 10 minutes, supports m and s), --server (string, no), --service-account-id (string, yes).

temporal cloud apikey delete command

Deletes a Temporal Cloud API key. This action is irreversible. Example: `temporal cloud apikey delete --key-id my-key-id`. Flags: --api-key (string, no), --async (bool, no), --async-operation-id (string, no), --idempotent (bool, no), --key-id (string, yes), --poll-interval (duration, no, max 10 minutes, supports m and s), --resource-version/-v (string, no - for optimistic concurrency control, fetched automatically if not provided), --server (string, no).

temporal cloud apikey global flags

Global flags that can be used with any apikey command: --api-key (string, no - for automation and CI/CD), --auto-confirm (bool, no - automatically confirm prompts), --config-dir (string, no - directory where CLI configuration files are stored), --disable-pop-up (bool, no - prevent browser window opening during authentication), --server (string, no, default: saas-api.tmprl.cloud:443 - override Temporal Cloud API server address).

temporal cloud apikey enable command

Enables a previously disabled Temporal Cloud API key. Example: `temporal cloud apikey enable --key-id my-key-id`. Flags: --api-key (string, no), --async (bool, no), --async-operation-id (string, no), --idempotent (bool, no), --key-id (string, yes), --poll-interval (duration, no, max 10 minutes, supports m and s), --resource-version/-v (string, no - for optimistic concurrency control, fetched automatically if not provided), --server (string, no).

temporal cloud apikey list command

Lists API keys with optional filtering by user ID, user email, or service account ID. At most one filter may be specified. Examples: `temporal cloud apikey list`, `temporal cloud apikey list --user-id my-user-id`, `temporal cloud apikey list --service-account-id my-sa-id`. Flags: --api-key (string, no), --page-size (int, no), --page-token (string, no), --server (string, no), --service-account-id (string, no - mutually exclusive with --user-id and --user-email), --user-email (string, no - mutually exclusive with --user-id and --service-account-id), --user-id (string, no - mutually exclusive with --user-email and --service-account-id).

temporal cloud connectivity delete command

The temporal cloud connectivity delete command deletes a connectivity rule by its ID. Required flag: --id (string, the ID of the connectivity rule). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately after initiating operation), --async-operation-id (string, custom identifier for tracking async operation), --idempotent (bool, succeed silently if no changes needed), --poll-interval (duration, time to wait between status checks, max 10 minutes), --resource-version/-v (string, resource version for optimistic concurrency control), --server (string, override Temporal Cloud API server address). Example: temporal cloud connectivity delete --id <connectivity-rule-id>

temporal cloud connectivity private create command

The temporal cloud connectivity private create command creates a new private connectivity rule for AWS, GCP, or Azure. Required flag: --region (string, the region for private connectivity). For AWS, also provide --connection-id (VPC endpoint ID). For GCP, also provide --connection-id (PSC connection ID), --gcp-project-id. For Azure, provide --azure-pe-resource-id (ARM resource ID, format: /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Network/privateEndpoints/{name}). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately after initiating operation), --async-operation-id (string, custom identifier for async tracking), --idempotent (bool, succeed silently if resource matches specification), --poll-interval (duration, time to wait between status checks, max 10 minutes), --server (string, override Temporal Cloud API server address). Examples: temporal cloud connectivity private create --connection-id vpce-12345 --region aws-us-west-2 and temporal cloud connectivity private create --azure-pe-resource-id /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Network/privateEndpoints/{name} --region azure-eastus

temporal cloud connectivity public create command

The temporal cloud connectivity public create command creates a new public internet connectivity rule. Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately after initiating operation), --async-operation-id (string, custom identifier for async tracking), --enable-stable-ips (bool, connect the namespace via a predictable set of IPs on the public internet), --idempotent (bool, succeed silently if resource matches specification), --poll-interval (duration, time to wait between status checks, max 10 minutes), --server (string, override Temporal Cloud API server address). Example: temporal cloud connectivity public create

temporal cloud connectivity list command

The temporal cloud connectivity list command lists connectivity rules, optionally filtered by namespace. Optional flags: --api-key (string, API key for authentication), --namespace/-n (string, filter rules by namespace, e.g., 'my-namespace.my-account'), --page-size (int, number of rules to return per page), --page-token (string, page token for pagination), --server (string, override Temporal Cloud API server address). Example: temporal cloud connectivity list --namespace my-namespace.my-account

temporal cloud connectivity get command

The temporal cloud connectivity get command retrieves details of a specific connectivity rule by its ID. Required flag: --id (string, the ID of the connectivity rule). Optional flags: --api-key (string, API key for authentication), --server (string, override Temporal Cloud API server address). Example: temporal cloud connectivity get --id <connectivity-rule-id>

Temporal cloud CLI commands list

The temporal cloud CLI extension includes the following commands: account, apikey, async-operation, connectivity, custom-role, login, logout, namespace, nexus, region, service-account, user, user-group, whoami. Each command manages a specific aspect of Temporal Cloud resources and operations.

temporal cloud login command

The temporal cloud login command authenticates with Temporal Cloud using browser-based OAuth login. This command opens the default browser to complete authentication. Once logged in, credentials are stored locally for subsequent commands.

Give your agent this brain