Temporal CLI env command reference
Environment (or 'env') commands let the user configure the properties for the environment in use.
Use env <env name>
alongside other commands to point the CLI at a different Temporal Server instance.
get
The temporal env get
command prints the environmental properties for the environment in use.
For example, passing the 'local' NamespaceWhat is a Namespace?
A Namespace is a unit of isolation within the Temporal Platform
Learn more returns the name, address, and certificate paths for the local environment.
temporal env get local
Output: tls-cert-path /home/my-user/certs/cluster.cert tls-key-path /home/my-user/certs/cluster.key address 127.0.0.1:7233 namespace accounting
Output can be narrowed down to a specific option.
temporal env get local.tls-key-path
tls-key-path /home/my-user/certs/cluster.key
Use the following options to change the command's behavior.
- --address
temporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-auth
temporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpoint
temporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --color
temporal color
Color options for the CLI.
Learn more - --context-timeout
temporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --env
temporal env
Name of the environment to read environmental variables from.
Learn more - --grpc-meta
temporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --namespace
temporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --tls
temporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-path
temporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-path
temporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verification
temporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-path
temporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-name
temporal tls-server-name
Overrides the target TLS server name.
Learn more
set
The temporal env set
command sets the value for an environmental property.
Property names match CLI option names.
temporal env set prod.tls-cert-path /home/my-user/certs/cluster.cert
Properties can be set for the entire system, such as the frontend address:
temporal env set local.address 127.0.0.1:7233
Use the following options to change the command's behavior.
- --address
temporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-auth
temporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpoint
temporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --color
temporal color
Color options for the CLI.
Learn more - --context-timeout
temporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --env
temporal env
Name of the environment to read environmental variables from.
Learn more - --grpc-meta
temporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --namespace
temporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --tls
temporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-path
temporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-path
temporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verification
temporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-path
temporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-name
temporal tls-server-name
Overrides the target TLS server name.
Learn more
delete
The temporal env delete
command deletes a given environment or environmental property.
temporal env delete [environment or property]
Pass a valid NamespaceWhat is a Namespace?
A Namespace is a unit of isolation within the Temporal Platform
Learn more into the command to delete an environment and its saved values.
temporal env delete local
Use the following options to change the command's behavior.
- --address
temporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-auth
temporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpoint
temporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --color
temporal color
Color options for the CLI.
Learn more - --context-timeout
temporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --env
temporal env
Name of the environment to read environmental variables from.
Learn more - --grpc-meta
temporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --namespace
temporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --tls
temporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-path
temporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-path
temporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verification
temporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-path
temporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-name
temporal tls-server-name
Overrides the target TLS server name.
Learn more
list
List all environments.
- --address
temporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-auth
temporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpoint
temporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --color
temporal color
Color options for the CLI.
Learn more - --context-timeout
temporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --env
temporal env
Name of the environment to read environmental variables from.
Learn more - --grpc-meta
temporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --namespace
temporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --output
temporal output
Output format.
Learn more - --tls
temporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-path
temporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-path
temporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verification
temporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-path
temporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-name
temporal tls-server-name
Overrides the target TLS server name.
Learn more