cloud-cli

README

Temporal Cloud CLI (Public Preview)

Extension for the Temporal command-line interface to work with Temporal Cloud.

Public preview: This extension is offered as a public preview. APIs and configuration may change before the stable release. Please reach out to Temporal Support if you have questions.

Prerequisites

• A Temporal Cloud account.
• The temporal CLI installed and on your PATH. The Cloud CLI runs as an extension to it.

Quick install

Install via Homebrew

brew install temporalio/brew/temporal-cloud

Install via download

1. Download the latest version for your OS and architecture.
2. Extract the downloaded archive.
3. Add the temporal-cloud binary to your PATH (temporal-cloud.exe for Windows).

Build

1. Install Go (check go.mod for the version).
2. Clone this repository.
3. From the cloned directory, run make build.

The executable will be at temporal-cloud (temporal-cloud.exe for Windows). Add it to your PATH so the temporal CLI can discover it.

Usage

Once installed, invoke the plugin via temporal cloud.

Authenticate

temporal cloud login     # browser-based OAuth login
temporal cloud whoami    # confirm the authenticated identity

Alternatively, pass an API key directly to any command with --api-key.

Run Workflow commands against Temporal Cloud

The temporal cloud commands manage Temporal Cloud resources. To operate Workflow Executions in a Cloud Namespace, use the regular temporal workflow commands with the same CLI profile and the Cloud Namespace endpoint.

temporal cloud login --profile prod

temporal workflow list \
  --profile prod \
  --address <namespace>.<account>.tmprl.cloud:7233 \
  --namespace <namespace>.<account>

temporal workflow start \
  --profile prod \
  --address <namespace>.<account>.tmprl.cloud:7233 \
  --namespace <namespace>.<account> \
  --task-queue <task-queue> \
  --type <workflow-type> \
  --workflow-id <workflow-id>

Make sure a compatible Worker is polling the target Task Queue before starting a Workflow.

Examples

temporal cloud namespace list
temporal cloud namespace get --namespace <namespace>
temporal cloud namespace retention get --namespace <namespace>

Run temporal cloud --help (or temporal cloud <command> --help) to see all available commands and flags.