Use with Temporal Cloud
If you install the Temporal Cloud extension for the Temporal CLI, you can use the extension to interact with Temporal Cloud.
Authentication
You can authenticate with Temporal Cloud interactively or programmatically. Both approaches use environment configuration files to store the authentication credentials.
Interactive authentication
Use the temporal cloud login command to authenticate with Temporal Cloud. Provide a environment configuration profile
name to output the authentication credentials to. For more information about environment configuration profiles, see
Environment Configuration.
temporal cloud login --profile <profile-name>
The command will open a browser window to authenticate with Temporal Cloud. Once authenticated, the command will output
the authentication credentials to the specified profile. If you do not provide a profile name, the command will output
the authentication credentials to the default profile.
A successful login will allow you to run temporal cloud command to perform operational and administrative tasks on
Temporal Cloud. It will also allow you to use the base temporal CLI to interact with a Temporal Service on Temporal
Cloud.
Programmatic authentication
You can authenticate with Temporal Cloud using environment configuration files or setting environment variables. For more information about environment configuration files, see Environment Configuration.
Common operations
The following cheat sheet groups common Temporal Cloud commands by object. Commands and subcommands are listed in alphabetical order.
This isn't a comprehensive list of all commands. For the full list of commands, see the command reference.
Namespace
| Operation | Command |
|---|---|
| Apply Namespace spec | temporal cloud namespace apply --namespace-id <id> --spec @spec-file.yaml |
| Create Namespace | temporal cloud namespace create |
| Create Namespace with spec | temporal cloud namespace create --namespace-id <id> --spec @spec-file.yaml |
| Delete Namespace | temporal cloud namespace delete |
| Describe Namespace | temporal cloud namespace describe |
| Export Namespace | temporal cloud namespace export |
| List Namespaces | temporal cloud namespace list |
API key
| Operation | Command |
|---|---|
| Create API key | temporal cloud apikey create |
| Delete API key | temporal cloud apikey delete <key-id> |
| Describe API key | temporal cloud apikey describe <key-id> |
| Turn off API key | temporal cloud apikey disable <key-id> |
| Turn on API key | temporal cloud apikey enable <key-id> |
| List API keys | temporal cloud apikey list |
Nexus endpoint
| Operation | Command |
|---|---|
| Create endpoint | temporal cloud nexus endpoint create |
| Delete endpoint | temporal cloud nexus endpoint delete |
| Get endpoint | temporal cloud nexus endpoint get |
| List endpoints | temporal cloud nexus endpoint list |
| Update endpoint | temporal cloud nexus endpoint update |
Service account
| Operation | Command |
|---|---|
| Create service account | temporal cloud service-account create |
| Delete service account | temporal cloud service-account delete |
| Get service account | temporal cloud service-account get |
| List service accounts | temporal cloud service-account list |
| Update service account | temporal cloud service-account update |
User
| Operation | Command |
|---|---|
| Delete user | temporal cloud user delete |
| Describe user | temporal cloud user describe |
| Get user | temporal cloud user get |
| Invite user | temporal cloud user invite |
| List users | temporal cloud user list |
| Resend invite for user | temporal cloud user resend-invite |
| Set account role for user | temporal cloud user set-account-role |
| Set Namespace permissions for user | temporal cloud user set-namespace-permissions |