Skip to main content

Use with Temporal Cloud

The Temporal CLI works with Temporal Cloud. The same commands you use for local development, such as temporal workflow start and temporal workflow list, work with Temporal Cloud once you provide an address and credentials.

For administrative tasks, install the Temporal Cloud extension. The extension adds temporal cloud commands for managing your Temporal Cloud account, including Namespaces, users, API keys, and Nexus endpoints.

Connect to Temporal Cloud​

To run commands against a Temporal Cloud Namespace, provide the Namespace address and authentication credentials. You can pass these as flags, environment variables, or configuration profiles.

Using flags:

temporal workflow list \
  --address <namespace>.<account>.tmprl.cloud:7233 \
  --namespace <namespace>.<account> \
  --api-key <your-api-key>

Using environment variables:

export TEMPORAL_ADDRESS=<namespace>.<account>.tmprl.cloud:7233
export TEMPORAL_NAMESPACE=<namespace>.<account>
export TEMPORAL_API_KEY=<your-api-key>

temporal workflow list

Using a configuration profile:

temporal --profile prod workflow list

For details on setting up configuration profiles, see Environment configuration.

Authentication methods​

Temporal Cloud supports three authentication methods. The method you choose determines which CLI commands are available.

temporal cloud login (interactive)​

The temporal cloud login command opens a browser to authenticate with Temporal Cloud using OAuth. This grants access to both service-level commands (temporal workflow, temporal schedule, etc.) and administrative commands (temporal cloud namespace, temporal cloud apikey, etc.).

temporal cloud login --profile prod

After login, credentials are stored in the specified configuration profile. If no profile is specified, credentials are stored in the default profile.

This is the simplest way to get started and the only authentication method that grants access to temporal cloud administrative commands.

API keys​

API keys authenticate to a specific Namespace and grant service-level access. API keys are a good fit for CI pipelines, scripts, and non-interactive environments.

Pass an API key using the --api-key flag, the TEMPORAL_API_KEY environment variable, or the api_key field in a configuration profile.

API keys do not grant access to temporal cloud administrative commands.

mTLS certificates​

mTLS certificates authenticate to a specific Namespace and grant service-level access. Pass certificate and key paths using the --tls-cert-path and --tls-key-path flags, the corresponding environment variables, or the tls section in a configuration profile.

mTLS certificates do not grant access to temporal cloud administrative commands.

Cloud administration​

The Temporal Cloud extension requires authentication through temporal cloud login.

Install the extension:

brew install temporal-cloud

For the full list of temporal cloud commands, see the cloud command reference.

Next steps​