summaryrefslogtreecommitdiff
path: root/plugins/terraform/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2023-11-04 18:38:46 -0700
committerTuowen Zhao <ztuowen@gmail.com>2023-11-04 18:38:46 -0700
commit4d908094fdc2a0c0e9a0a072eba213fab7adef43 (patch)
tree7c17e70bcdeebbe96c84d849bdf17882007480d8 /plugins/terraform/README.md
parent4b0bbc0b263a150eb9a9b59f196914629be06a9b (diff)
parent632ed413a9ce62747ded83d7736491b081be4b49 (diff)
downloadzsh-master.tar.gz
zsh-master.tar.bz2
zsh-master.zip
Merge remote-tracking branch 'github/master'HEADmaster
Diffstat (limited to 'plugins/terraform/README.md')
-rw-r--r--plugins/terraform/README.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/plugins/terraform/README.md b/plugins/terraform/README.md
index c19f2ad1c..fc9a9f005 100644
--- a/plugins/terraform/README.md
+++ b/plugins/terraform/README.md
@@ -1,7 +1,7 @@
# 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.
+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:
@@ -11,7 +11,7 @@ plugins=(... terraform)
## Requirements
-* [Terraform](https://terraform.io/)
+- [Terraform](https://terraform.io/)
## Aliases
@@ -29,11 +29,12 @@ plugins=(... terraform)
## Prompt function
-You can add the current Terraform workspace in your prompt by adding `$(tf_prompt_info)`
-to your `PROMPT` or `RPROMPT` variable.
+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:
@@ -41,4 +42,6 @@ You can also specify the PREFIX and SUFFIX for the workspace with the following
```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%}"
```