Codesleuth/terraform-docs_with_docker.md

Last active September 7, 2021 10:21

Star () You must be signed in to star a gist
Fork () You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/Codesleuth/79aee1487e81aca7a8814a4ca9c12f23.js"></script>
Save Codesleuth/79aee1487e81aca7a8814a4ca9c12f23 to your computer and use it in GitHub Desktop.

Download ZIP

Create terraform-docs using docker command

Raw

terraform-docs_with_docker.md

Given a structure like:

/
  /terraform
    /environment
    /infra
  /other

For x86/64 machines:

docker run --rm \
  -v $(pwd):/data \
  -w /data/terraform/infra \
  quay.io/terraform-docs/terraform-docs:0.15.0 \
  markdown table . > README.md

For M1 Apple Silicon Mac, specify the platform:

docker run --rm \
  --platform linux/amd64 \
  -v $(pwd):/data \
  -w /data/terraform/infra \
  quay.io/terraform-docs/terraform-docs:0.15.0 \
  markdown table . > README.md