Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paololazzari/terraform-repl
A terraform console wrapper for a better REPL experience
https://github.com/paololazzari/terraform-repl
repl terraform
Last synced: about 1 month ago
JSON representation
A terraform console wrapper for a better REPL experience
- Host: GitHub
- URL: https://github.com/paololazzari/terraform-repl
- Owner: paololazzari
- License: apache-2.0
- Created: 2022-12-20T14:27:49.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-30T16:35:34.000Z (about 1 year ago)
- Last Synced: 2024-08-02T00:26:38.575Z (4 months ago)
- Topics: repl, terraform
- Language: Shell
- Homepage:
- Size: 79.1 KB
- Stars: 113
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-tf - terraform-repl - A terraform console wrapper for a better interactive console experience. (Tools / Community providers)
README
# terraform-repl
terraform-repl is a terraform console wrapper that aims at providing a better interactive console for evaluating Terraform language expressions.
## Motivation
The standard terraform console has several limitations, including:
- No tab completion
- No ability to view all objects
- No ability to define variables
- No ability to view command history
- No ability to clear screen
- No ability to run system commands
terraform-repl provides a solution to these problems.
## How it works
By default, terraform-repl evaluates each expression against a new terraform console process.
You can, however, choose to use a hashicorp/terraform docker container as a single background process to evaluate the expressions entered. This can be faster if working with terraform projects of a certain size. You can enable the container backend by using the `-docker-container-backend` option.
## Usage
### Starting the REPL
To start the REPL:
```bash
$ terraform-repl
>
```
or with the container backend:
```bash
$ terraform-repl -docker-container-backend
Starting terraform console docker container...
```
or starting the terraform-repl docker container:
```bash
$ docker run --rm -it -v "$(pwd)":/data plazzari/terraform-repl
>
```
### Using the REPL
Given the following `main.tf` file:
```terraform
locals {
a = "foo"
b = {"nums": [
1,
2
]}
}
```
To inspect the `locals`:
```bash
> local
[
{
"a": "foo",
"b": {
"nums": [
1,
2
]
}
}
]
```
To inspect one value:
```bash
> local.b.nums[0]
1
```
To create new variables:
```bash
> local.c="example"
> local.c
"example"
> local.d={"nums": \
[ 3, 4 ] \
}
> local.d
{
"nums" = [
3,
4,
]
}
```
To view the command history:
```bash
> history
1 local
2 local.b.nums[0]
3 local.c="example"
4 local.c
5 local.d={"nums": [ 3, 4 ] }
6 local.d
7 history
```
All terraform functions can be run as usual:
```bash
> element(local.d.nums,0)
3
```
To run an external command, prepend the command with `!`:
```bash
> !grep "locals" main.tf
locals {
```
To clear the screen:
```bash
> clear
```
To exit:
```bash
> exit
```
### Tab completion
You can use the TAB key to get autocompletion for terraform functions:
```bash
> e
endswith element
> el
> element
```
as well as for `local` variables:
```bash
> local.
local.a local.b.nums[0] local.b.nums[1]
```
this can be useful when you are working with many `local` variables.
### Transcript
When you start the REPL you may also specify the `-transcript` option. This will generate a transcript of all inputs and outputs of the session.
For the commands demonstrated above, the transcript file would be as follows:
Sample transcript
> local
[
{
"a": "foo",
"b": {
"nums": [
1,
2
]
}
}
]
> local.b.nums[0]
1
> local.c="example"
> local.c
"example"
> local.d={"nums": [ 3, 4 ] }
> local.d
{
"nums" = [
3,
4,
]
}
> element(local.d.nums,0)
3
## Prerequisites
- [jq](https://github.com/stedolan/jq)
- [hcl2json](https://github.com/tmccombs/hcl2json)
- [docker*](https://docs.docker.com/desktop/install/linux-install/)
- socat*
\* optional, although highly recommended
## Installation
```bash
$ curl -O https://raw.githubusercontent.com/paololazzari/terraform-repl/master/terraform-repl
$ cp terraform-repl /usr/local/bin/
$ chmod +x /usr/local/bin/terraform-repl
```