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' Namespace 🔗

x

Link preview

What is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

term explanation

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.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

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.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

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 Namespace 🔗

x

Link preview

What is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

term explanation

name.

temporal env delete local

Use the options listed below to change the command's behavior.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time