Command: console
The terraform console
command provides an interactive console for
evaluating expressions.
Usage
Usage: terraform console [options]
This command provides an interactive command-line console for evaluating and experimenting with expressions. You can use it to test interpolations before using them in configurations and to interact with any values currently saved in state. If the current state is empty or has not yet been created, you can use the console to experiment with the expression syntax and built-in functions. The console holds a lock on the state, and you will not be able to use the console while performing other actions that modify state.
To close the console, enter the exit
command or press Control-C
or Control-D.
For configurations using
the local
backend only,
terraform console
accepts the legacy command line option
-state
.
Scripting
The terraform console
command can be used in non-interactive scripts
by piping newline-separated commands to it. Only the output from the
final command is printed unless an error occurs earlier.
For example:
Remote State
If remote state is used by the current backend, Terraform will read the state for the current workspace from the backend before evaluating any expressions.
Examples
The terraform console
command will read the Terraform configuration in the
current working directory and the Terraform state file from the configured
backend so that interpolations can be tested against both the values in the
configuration and the state file.
With the following main.tf
:
Executing terraform console
will drop you into an interactive shell where you
can test interpolations to:
Print a value from a map:
Filter a map based on a specific value:
Check if certain values may not be known until apply:
Test various functions: