For the complete documentation index, see /llms.txt. This page is also available as raw Markdown at /cloud/tcld.md. Append .md to any page URL to fetch its Markdown.

tcld command reference

View Markdown

The Temporal Cloud CLI (tcld) is a command-line tool that you can use to interact with Temporal Cloud.

tip

The Temporal CLI also manages Temporal Cloud through its Temporal Cloud extension, which adds temporal cloud commands for Namespaces, users, API keys, and Nexus Endpoints. See the temporal cloud command reference for the equivalent commands.

• How to install tcld

tcld commands

• tcld account
• tcld apikey
• tcld connectivity-rule
• tcld feature
• tcld generate-certificates
• tcld login
• tcld logout
• tcld migration
• tcld namespace
• tcld nexus
• tcld request
• tcld service-account
• tcld user
• tcld user-group
• tcld version

Global modifiers

--auto_confirm

Automatically confirm all prompts.

You can specify the value for this modifier by setting the AUTO_CONFIRM environment variable. The default value is false.

How to install tcld

You can install tcld in two ways.

Install tcld by using Homebrew

brew install temporalio/brew/tcld

Build tcld from source

1. Verify that you have Go 1.18 or later installed.

   go version

   If Go 1.18 or later is not installed, follow the Download and install instructions on the Go website.

2. Clone the tcld repository and run make.

   git clone https://github.com/temporalio/tcld.git
   cd tcld
   make

3. Copy the tcld executable to any directory that appears in the PATH environment variable, such as /usr/local/bin.

   cp tcld /usr/local/bin/tcld

4. Verify that tcld is installed.

   tcld version