tcb env

Manages the lifecycle of CloudBase environments, their login policies, and environment-level API keys.

Command index

Environment operations

Command	Purpose
tcb env list	List environments
tcb env create	Create an environment
tcb env use	Set the global default environment
tcb env detail	Show the resource configuration
tcb env modify	Change the package or platform edition resource states
tcb env rename	Rename an environment alias
tcb env renew	Renew an environment
tcb env usage	Show resource usage
tcb env info	Show resource metric details
tcb env delete	Destroy an environment

Login policy

The login policy defines which login methods an environment supports (email, phone number, anonymous login, and so on) and is managed by tcb env login. To log in to a Tencent Cloud account to authorize CLI operations, see Authentication.

Command	Purpose
tcb env login get	Show the login policy
tcb env login set	Update the login policy

API Key

API keys let server-side or client-side code access CloudBase resources by key. Available since v3.1.0.

Type	Description	Use case	Limit
api_key	Server-side admin credential	Server-side API calls (not yet available)	Up to 5 per environment
publish_key	Frontend anonymous access credential	Frontend anonymous access to CloudBase resources	1 per environment

Command	Purpose
tcb env apikey list	List API keys
tcb env apikey create	Create an API key
tcb env apikey delete	Delete an API key

Region is not a separate command. Set it with the global -r/--region flag or the region field of cloudbaserc.json, see Region.

Deprecated

Command	Behavior	Replacement
tcb env login list	Lists the login methods configured for the environment	tcb env login get
tcb env login create	Interactively adds login methods, supporting WeChat Official Account, WeChat Open Platform, and anonymous login	tcb env login set
tcb env login update	Interactively modifies existing login methods	tcb env login set
tcb env domain list		tcb cors list
tcb env domain create		tcb cors add
tcb env domain delete		tcb cors rm