powerline-go VS terraform-docs

https://github.com/justjanne/powerline-go https://formulae.brew.sh/formula/powerline-go

It's amazing how slow shell prompts can be when you enable just a few addons. It can easily take a few seconds to show a prompt.

I've had good results with https://github.com/justjanne/powerline-go in the past.

This is my goto: https://github.com/justjanne/powerline-go

Extraction. For each repo it shallow-clones and runs terraform-docs to pull out providers, modules, resources, and variables, plus a small HCL parser to recover the bits terraform-docs drops (like provider source in JSON output).

terraform-docs - Automated documentation generation

Link: https://terraform-docs.io

terraform-docs: tool for generating module documentation

# Para MacOS brew install terraform-docs # Para Linux curl -Lo ./terraform-docs.tar.gz https://github.com/terraform-docs/terraform-docs/releases/latest/download/terraform-docs-v0.16.0-linux-amd64.tar.gz tar -xzf terraform-docs.tar.gz chmod +x ./terraform-docs mv ./terraform-docs /usr/local/bin/

Documentation is really important, so having a README.md file inside your Terraform repository that explains how to use the automation (including descriptions of variables and outputs) really help in understanding what has been implemented. To easily generate the description of variables and outputs, you can leverage tfdocs.

‍Terraform-docs is a tool that automatically generates documentation from Terraform modules in various output formats, including markdown, JSON, and others. It's particularly useful for maintaining up-to-date documentation of your Terraform modules' inputs, outputs, providers, and resources.

Earlier this year I wrote about the challenges I faced creating a Terraform module. I mentioned then that I was leveraging terraform-docs and GitHub Actions to automate documentation, but a full workflow walkthrough was out of that post's scope.

I'm going to have to figure out how to run terraform-docs.io against each module. I have zero terraform experience.