/terraform-docs-zsh-plugin

ZSH plugin to easier work with terraform-docs

Primary LanguageShellMIT LicenseMIT

terraform-docs-zsh-plugin

Plugin for terraform-docs adds

  • autocomplete for commands
  • autocomplete for global flags
  • autocomplete for command flags
  • alias

Requirements

Installation

Oh My Zsh

  1. Clone repository into ${ZSH_CUSTOM}/plugins (by default $ZSH_CUSTOM points to ~/.oh-my-zsh/custom)
git clone https://github.com/jsporna/terraform-docs-zsh-plugin \
    ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/terraform-docs
  1. Add te plugin to the list of plugins in ~/.zshrc for Oh My Zsh to load:
plugins=(... terraform-docs)
  1. Start new terminal session.

Usage

  • Type terraform-docs or tfdocs into your prompt and hit TAB to see available completion options