Temporal CLI env command reference
Environment (or 'env') commands allow the user to configure the properties for the environment in use.
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 options listed below to change the command's behavior.
- --fieldstemporal fields
Customize fields to print.
Learn more - --limittemporal limit
Number of items to print.
Learn more - --no-pagertemporal no-pager
Disables the interactive pager.
Learn more - --outputtemporal output
Output format.
Learn more - --pagertemporal pager
Sets the pager for Temporal CLI to use.
Learn more - --time-formattemporal time-format
Format time as either relative, iso, raw.
Learn more
set
The temporal env set
command sets the value for an environmental property.
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 options listed below to change the command's behavior.
- --fieldstemporal fields
Customize fields to print.
Learn more - --limittemporal limit
Number of items to print.
Learn more - --no-pagertemporal no-pager
Disables the interactive pager.
Learn more - --outputtemporal output
Output format.
Learn more - --pagertemporal pager
Sets the pager for Temporal CLI to use.
Learn more - --time-formattemporal time-format
Format time as either relative, iso, raw.
Learn more
delete
The temporal env delete
command deletes a given environment or environmental property.
Deleting a given environment (such as 'local') and its saved values is achieved by passing a valid NamespaceWhat is a Namespace?
A Namespace is a unit of isolation within the Temporal Platform
Learn more name.
temporal env delete local
Use the options listed below to change the command's behavior.
- --fieldstemporal fields
Customize fields to print.
Learn more - --limittemporal limit
Number of items to print.
Learn more - --no-pagertemporal no-pager
Disables the interactive pager.
Learn more - --outputtemporal output
Output format.
Learn more - --pagertemporal pager
Sets the pager for Temporal CLI to use.
Learn more - --time-formattemporal time-format
Format time as either relative, iso, raw.
Learn more