mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-25 09:13:35 +01:00

History

chenzj fd8f72b276 feat(opentofu): add plugin for OpenTofu (#12285 ) - Adds aliases - Sets up autocompletion - Adds promp functions to show workspace and `tofu` version Co-authored-by: Marc Cornellà <marc@mcornella.com>		2024-07-13 19:31:32 +02:00
..
opentofu.plugin.zsh
README.md

README.md

OpenTofu plugin

Plugin for OpenTofu, a fork of Terraform that is open-source, community-driven, and managed by the Linux Foundation. It adds completion for tofu command, as well as aliases and a prompt function.

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

plugins=(... opentofu)

Requirements

OpenTofu

Aliases

Alias	Command
`tt`	`tofu`
`tta`	`tofu apply`
`ttc`	`tofu console`
`ttd`	`tofu destroy`
`ttf`	`tofu fmt`
`tti`	`tofu init`
`tto`	`tofu output`
`ttp`	`tofu plan`
`ttv`	`tofu validate`
`tts`	`tofu state`
`ttsh`	`tofu show`
`ttr`	`tofu refresh`
`ttt`	`tofu test`
`ttws`	`tofu workspace`

Prompt functions

tofu_prompt_info: shows the current workspace when in an OpenTofu project directory.
tofu_version_prompt_info: shows the current version of the tofu commmand.

To use them, add them to a PROMPT variable in your theme or .zshrc file:

PROMPT='$(tofu_prompt_info)'
RPROMPT='$(tofu_version_prompt_info)'

You can also specify the PREFIX and SUFFIX strings for both functions, with the following variables:

# for tofu_prompt_info
ZSH_THEME_TOFU_PROMPT_PREFIX="%{$fg[white]%}"
ZSH_THEME_TOFU_PROMPT_SUFFIX="%{$reset_color%}"
# for tofu_version_prompt_info
ZSH_THEME_TOFU_VERSION_PROMPT_PREFIX="%{$fg[white]%}"
ZSH_THEME_TOFU_VERSION_PROMPT_SUFFIX="%{$reset_color%}"