https://github.com/mineiros-io/terradoc

Terradoc is a lean helper tool that creates human readable documentation from HCL syntax.
https://github.com/mineiros-io/terradoc

iac mineiros terraform terraform-modules

Last synced: 28 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/mineiros-io/terradoc
• Owner: mineiros-io
• License: apache-2.0
• Created: 2020-05-26T05:55:39.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-02-23T16:16:18.000Z (over 1 year ago)
• Last Synced: 2024-09-27T19:21:35.423Z (about 1 month ago)
• Topics: iac, mineiros, terraform, terraform-modules
• Language: Go
• Homepage:
• Size: 178 KB
• Stars: 11
• Watchers: 6
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Table of Contents

- [terradoc](#terradoc)

    - [Installing](#installing)

        - [Go/Git configuration for private Repositories](#gogit-configuration-for-private-repositories)

# 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@

```

Where **** is any terradoc [version tag](https://github.com/mineiros-io/terradock/tags),

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.