stow/oh-my-zsh/.oh-my-zsh/plugins/terraform/README.md

   1 # Terraform plugin
   2
   3 Plugin for Terraform, a tool from Hashicorp for managing infrastructure safely and efficiently.
   4 It adds completion for `terraform`, as well as aliases and a prompt function.
   5
   6 To use it, add `terraform` to the plugins array of your `~/.zshrc` file:
   7
   8 ```shell
   9 plugins=(... terraform)
  10 ```
  11
  12 ## Requirements
  13
  14 * [Terraform](https://terraform.io/)
  15
  16 ## Aliases
  17
  18 | Alias | Command              |
  19 | ----- | -------------------- |
  20 | `tf`  | `terraform`          |
  21 | `tfa` | `terraform apply`    |
  22 | `tfd` | `terraform destroy`  |
  23 | `tff` | `terraform fmt`      |
  24 | `tfi` | `terraform init`     |
  25 | `tfo` | `terraform output`   |
  26 | `tfp` | `terraform plan`     |
  27 | `tfv` | `terraform validate` |
  28
  29 ## Prompt function
  30
  31 You can add the current Terraform workspace in your prompt by adding `$(tf_prompt_info)`
  32 to your `PROMPT` or `RPROMPT` variable.
  33
  34 ```sh
  35 RPROMPT='$(tf_prompt_info)'
  36 ```
  37
  38 You can also specify the PREFIX and SUFFIX for the workspace with the following variables:
  39
  40 ```sh
  41 ZSH_THEME_TF_PROMPT_PREFIX="%{$fg[white]%}"
  42 ZSH_THEME_TF_PROMPT_SUFFIX="%{$reset_color%}"
  43 ```