summaryrefslogtreecommitdiff
path: root/plugins/terraform/README.md
blob: 48fdae28279de9db48ae068f1acad3a35cbca409 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# Terraform plugin

Plugin for Terraform, a tool from Hashicorp for managing infrastructure safely and efficiently. It adds
completion for `terraform`, as well as aliases and a prompt function.

To use it, add `terraform` to the plugins array of your `~/.zshrc` file:

```shell
plugins=(... terraform)
```

## Requirements

- [Terraform](https://terraform.io/)

## Aliases

| Alias   | Command                                |
| ------- | -------------------------------------- |
| `tf`    | `terraform`                            |
| `tfa`   | `terraform apply`                      |
| `tfaa`  | `terraform apply -auto-approve`        |
| `tfc`   | `terraform console`                    |
| `tfd`   | `terraform destroy`                    |
| `tfd!`  | `terraform destroy -auto-approve`      |
| `tff`   | `terraform fmt`                        |
| `tffr`  | `terraform fmt -recursive`             |
| `tfi`   | `terraform init`                       |
| `tfir`  | `terraform init -reconfigure`          |
| `tfiu`  | `terraform init -upgrade`              |
| `tfiur` | `terraform init -upgrade -reconfigure` |
| `tfo`   | `terraform output`                     |
| `tfp`   | `terraform plan`                       |
| `tfv`   | `terraform validate`                   |
| `tfs`   | `terraform state`                      |
| `tft`   | `terraform test`                       |
| `tfsh`  | `terraform show`                       |
| `tfw`   | `terraform workspace`                  |
| `tfwl`  | `terraform workspace list`             |
| `tfws`  | `terraform workspace select`           |

## Prompt function

You can add the current Terraform workspace in your prompt by adding `$(tf_prompt_info)`,
`$(tf_version_prompt_info)` to your `PROMPT` or `RPROMPT` variable.

```sh
RPROMPT='$(tf_prompt_info)'
RPROMPT='$(tf_version_prompt_info)'
```

You can also specify the PREFIX and SUFFIX for the workspace with the following variables:

```sh
ZSH_THEME_TF_PROMPT_PREFIX="%{$fg[white]%}"
ZSH_THEME_TF_PROMPT_SUFFIX="%{$reset_color%}"
ZSH_THEME_TF_VERSION_PROMPT_PREFIX="%{$fg[white]%}"
ZSH_THEME_TF_VERSION_PROMPT_SUFFIX="%{$reset_color%}"
```