2021-06-18 15:17:40 -07:00
|
|
|
# Terraform plugin
|
2015-08-04 11:42:28 -07:00
|
|
|
|
2023-08-16 04:46:28 -07:00
|
|
|
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.
|
2015-08-04 11:42:28 -07:00
|
|
|
|
2019-06-26 06:20:41 -07:00
|
|
|
To use it, add `terraform` to the plugins array of your `~/.zshrc` file:
|
|
|
|
|
|
|
|
```shell
|
|
|
|
plugins=(... terraform)
|
|
|
|
```
|
|
|
|
|
2021-06-18 15:17:40 -07:00
|
|
|
## Requirements
|
2017-11-07 08:45:25 -07:00
|
|
|
|
2023-08-16 04:46:28 -07:00
|
|
|
- [Terraform](https://terraform.io/)
|
2017-11-07 08:45:25 -07:00
|
|
|
|
2021-06-18 15:17:40 -07:00
|
|
|
## Aliases
|
2017-11-07 08:45:25 -07:00
|
|
|
|
2021-06-18 15:17:40 -07:00
|
|
|
| Alias | Command |
|
|
|
|
| ----- | -------------------- |
|
|
|
|
| `tf` | `terraform` |
|
|
|
|
| `tfa` | `terraform apply` |
|
2023-02-21 03:23:04 -07:00
|
|
|
| `tfc` | `terraform console` |
|
2021-06-18 15:17:40 -07:00
|
|
|
| `tfd` | `terraform destroy` |
|
|
|
|
| `tff` | `terraform fmt` |
|
|
|
|
| `tfi` | `terraform init` |
|
2022-03-18 05:09:05 -07:00
|
|
|
| `tfo` | `terraform output` |
|
2021-06-18 15:17:40 -07:00
|
|
|
| `tfp` | `terraform plan` |
|
|
|
|
| `tfv` | `terraform validate` |
|
|
|
|
|
|
|
|
## Prompt function
|
|
|
|
|
2023-08-16 04:46:28 -07:00
|
|
|
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.
|
2021-06-18 15:17:40 -07:00
|
|
|
|
|
|
|
```sh
|
|
|
|
RPROMPT='$(tf_prompt_info)'
|
2023-08-16 04:46:28 -07:00
|
|
|
RPROMPT='$(tf_version_prompt_info)'
|
2021-06-18 15:17:40 -07:00
|
|
|
```
|
|
|
|
|
|
|
|
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%}"
|
2023-08-16 04:46:28 -07:00
|
|
|
ZSH_THEME_TF_VERSION_PROMPT_PREFIX="%{$fg[white]%}"
|
|
|
|
ZSH_THEME_TF_VERSION_PROMPT_SUFFIX="%{$reset_color%}"
|
2017-11-07 08:45:25 -07:00
|
|
|
```
|