Skip to content

Terradoc is a lean helper tool that creates human readable documentation from HCL syntax.

License

Notifications You must be signed in to change notification settings

mineiros-io/terradoc

Repository files navigation

Table of Contents

terradoc

Terradoc is a lean helper tool that creates human readable documentation from HCL syntax.

Installing

To install terradoc using Go just run:

go install github.com/mineiros-io/terradoc/cmd/terradoc@<version>

Where is any terradoc version tag, or if you are feeling adventurous you can just install latest:

go install github.com/mineiros-io/terradoc/cmd/terradoc@latest

We put great effort into keeping the main branch stable, so it should be safe to use latest to play around, but not recommended for long term automation since you won't get the same build result each time you run the install command.