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

Temporal CLI cloud project command reference

View Markdown

Currently in: Public Preview

APIs and configuration may change before the stable release.

Commands for managing Temporal Cloud projects.

Projects provide an account-level grouping for Temporal Cloud resources.

This page provides a reference for the temporal cloud project commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to Global Flags for flags that you can use with every subcommand.

apply

Apply a project configuration to Temporal Cloud. An existing project with the specification's display_name is updated if found; if no matching project exists, a new project is created.

The specification can be provided as inline JSON or loaded from a file by prefixing the path with '@'.

Example:

temporal cloud project apply --spec '{"display_name": "Engineering", "description": "Engineering workloads"}'

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

Flag	Required	Description
--api-key	No	string API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--async	No	bool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-id	No	string Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotent	No	bool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--poll-interval	No	duration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s).
--resource-version, -v	No	string Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--server	No	string Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--spec	Yes	string Project configuration in JSON format. Provide inline JSON directly, or use '@path/to/file.json' to load from a file.
--verbose-diff	No	bool Show detailed differences between the current and desired namespace configurations when changes are detected.

create

Create a new Temporal Cloud project.

Example:

temporal cloud project create --display-name "Engineering" --description "Engineering workloads"

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

Flag	Required	Description
--api-key	No	string API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--async	No	bool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-id	No	string Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--description	No	string A description of the project.
--display-name	Yes	string The display name of the project.
--enable-delete-protection	No	bool Prevent the project from being deleted while enabled.
--idempotent	No	bool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--poll-interval	No	duration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s).
--server	No	string Override the Temporal Cloud API server address. Used for connecting to non-production environments.

delete

Delete a Temporal Cloud project.

Example:

temporal cloud project delete --project-id my-project-id

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

Flag	Required	Description
--api-key	No	string API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--async	No	bool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-id	No	string Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotent	No	bool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--poll-interval	No	duration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s).
--project-id	Yes	string The ID of the project.
--resource-version, -v	No	string Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--server	No	string Override the Temporal Cloud API server address. Used for connecting to non-production environments.

edit

Open an existing project specification in your default editor and apply the edited configuration.

Example:

temporal cloud project edit --project-id my-project-id

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

Flag	Required	Description
--api-key	No	string API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--async	No	bool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-id	No	string Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotent	No	bool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--poll-interval	No	duration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s).
--project-id	Yes	string The ID of the project.
--resource-version, -v	No	string Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--server	No	string Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--verbose-diff	No	bool Show detailed differences between the current and desired namespace configurations when changes are detected.

get

Retrieve the configuration and status of a Temporal Cloud project.

Example:

temporal cloud project get --project-id my-project-id

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

Flag	Required	Description
--api-key	No	string API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--project-id	Yes	string The ID of the project.
--server	No	string Override the Temporal Cloud API server address. Used for connecting to non-production environments.

list

List Temporal Cloud projects in the current account.

Example:

temporal cloud project list --page-size 50

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

Flag	Required	Description
--api-key	No	string API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--page-size	No	int Maximum number of projects to return.
--page-token	No	string Token for retrieving the next page of results.
--project-id	No	string[] Filter by project ID. Can be specified multiple times.
--server	No	string Override the Temporal Cloud API server address. Used for connecting to non-production environments.

service-account

Commands for inspecting the service accounts that have access to a Temporal Cloud project.

service-account list

List the service accounts that have access to a Temporal Cloud project, including both directly-assigned and inherited access.

Example:

temporal cloud project service-account list --project-id my-project-id

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

Flag	Required	Description
--api-key	No	string API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--page-size	No	int Number of service accounts to return per page. Use for paginated results.
--page-token	No	string Token for retrieving the next page of results in a paginated list.
--project-id	Yes	string The ID of the project.
--server	No	string Override the Temporal Cloud API server address. Used for connecting to non-production environments.

update

Update an existing Temporal Cloud project. Only explicitly provided flags are changed.

Example:

temporal cloud project update --project-id my-project-id --display-name "Platform"

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

Flag	Required	Description
--api-key	No	string API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--async	No	bool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-id	No	string Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--description	No	string A description of the project.
--display-name	No	string The display name of the project.
--enable-delete-protection	No	bool Prevent the project from being deleted while enabled.
--idempotent	No	bool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--poll-interval	No	duration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s).
--project-id	Yes	string The ID of the project.
--resource-version, -v	No	string Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--server	No	string Override the Temporal Cloud API server address. Used for connecting to non-production environments.

user

Commands for inspecting the users that have access to a Temporal Cloud project.

user list

List the users that have access to a Temporal Cloud project, including both directly-assigned and inherited access.

Example:

temporal cloud project user list --project-id my-project-id

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

Flag	Required	Description
--api-key	No	string API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--page-size	No	int Number of users to return per page. Use for paginated results.
--page-token	No	string Token for retrieving the next page of results in a paginated list.
--project-id	Yes	string The ID of the project.
--server	No	string Override the Temporal Cloud API server address. Used for connecting to non-production environments.

user-group

Commands for inspecting the user groups that have access to a Temporal Cloud project.

user-group list

List the user groups that have access to a Temporal Cloud project, including both directly-assigned and inherited access.

Example:

temporal cloud project user-group list --project-id my-project-id

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

Flag	Required	Description
--api-key	No	string API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--page-size	No	int Number of user groups to return per page. Use for paginated results.
--page-token	No	string Token for retrieving the next page of results in a paginated list.
--project-id	Yes	string The ID of the project.
--server	No	string Override the Temporal Cloud API server address. Used for connecting to non-production environments.

Global Flags

The following options can be used with any command.

Flag	Required	Description	Default
--api-key	No	string API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--auto-confirm	No	bool Automatically confirm prompts and actions that require user confirmation. Useful for scripting and automation.
--config-dir	No	string Directory path where CLI configuration files are stored, including authentication tokens and settings.
--disable-pop-up	No	bool Prevent the CLI from opening a browser window during authentication. Useful for headless environments or when using alternative auth methods.
--server	No	string Override the Temporal Cloud API server address. Used for connecting to non-production environments.	saas-api.tmprl.cloud:443