summaryrefslogtreecommitdiff
path: root/plugins/terraform/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/terraform/README.md')
-rw-r--r--plugins/terraform/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/plugins/terraform/README.md b/plugins/terraform/README.md
new file mode 100644
index 000000000..471aef24e
--- /dev/null
+++ b/plugins/terraform/README.md
@@ -0,0 +1,28 @@
+## Terraform oh-my-zsh plugin
+
+Plugin for Terraform, a tool from Hashicorp for managing infrastructure safely and efficiently.
+
+Current as of Terraform v0.11.7
+
+### Requirements
+
+ * [Terraform](https://terraform.io/)
+
+### Usage
+
+To use it, add `terraform` to the plugins array of your `~/.zshrc` file:
+
+```shell
+plugins=(... terraform)
+```
+
+ * Type `terraform` into your prompt and hit `TAB` to see available completion options
+
+### Expanding ZSH prompt with current Terraform workspace name
+
+If you want to get current Terraform workspace name in your ZSH prompt open
+your .zsh-theme file and in a chosen place insert:
+
+```shell
+PROMPT=$'%{$fg[white]%}$(tf_prompt_info)%{$reset_color%} '
+```