https://github.com/jsporna/terraform-docs-zsh-plugin

ZSH plugin to easier work with terraform-docs
https://github.com/jsporna/terraform-docs-zsh-plugin

devops terraform terraform-docs zsh zsh-plugin

Last synced: about 2 months ago
JSON representation

ZSH plugin to easier work with terraform-docs

• Host: GitHub
• URL: https://github.com/jsporna/terraform-docs-zsh-plugin
• Owner: jsporna
• License: mit
• Created: 2020-10-23T13:00:16.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2020-10-24T22:47:13.000Z (over 4 years ago)
• Last Synced: 2024-05-02T05:11:22.704Z (9 months ago)
• Topics: devops, terraform, terraform-docs, zsh, zsh-plugin
• Language: Shell
• Homepage:
• Size: 2.93 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
terraform-docs-zsh-plugin

=========================

Plugin for terraform-docs adds

- autocomplete for commands 

- autocomplete for global flags

- autocomplete for command flags

- alias

# Requirements

* [terraform-docs](https://github.com/terraform-docs/terraform-docs)

# Installation

* [Oh My Zsh](#oh-my-zsh)

  

## Oh My Zsh

1. Clone repository into `${ZSH_CUSTOM}/plugins` (by default `$ZSH_CUSTOM` points to `~/.oh-my-zsh/custom`)

```sh

git clone https://github.com/jsporna/terraform-docs-zsh-plugin \

    ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/terraform-docs

```

2. Add te plugin to the list of plugins in `~/.zshrc` for Oh My Zsh to load:

```sh

plugins=(... terraform-docs)

```

3. Start new terminal session.

# Usage

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