Terraform-docs

Jul 20, 2023

Generate documentation from Terraform modules

A utility to generate documentation from Terraform modules in various output formats.

terraform-docs asciidoc ./my-terraform-module # asciidoc table terraform-docs asciidoc table ./my-terraform-module # asciidoc table terraform-docs asciidoc document ./my-terraform-module # asciidoc document terraform-docs json ./my-terraform-module # json terraform-docs markdown ./my-terraform-module # markdown table terraform-docs markdown table ./my-terraform-module # markdown table terraform-docs markdown document ./my-terraform-module # markdown document terraform-docs pretty ./my-terraform-module # colorized pretty terraform-docs tfvars hcl ./my-terraform-module # hcl format of terraform.tfvars terraform-docs tfvars json ./my-terraform-module # json format of terraform.tfvars terraform-docs toml ./my-terraform-module # toml terraform-docs xml ./my-terraform-module # xml terraform-docs yaml ./my-terraform-module # yaml



Checkout these related ports:
  • Zxfer - Easily and reliably transfer ZFS filesystems
  • Ztop - Display ZFS dataset I/O in real time
  • Zsm - ZFS Snapshot Manager
  • Zsd - Destroys ZFS snapshots
  • Zrepl - ZFS dataset replication tool
  • Zrep - ZFS based replication and failover solution
  • Zpool-iostat-viz - ZFS pool I/O latency statistics
  • Zoxide - Fast cd alternative that learns your habits
  • Zogftw - Creates redundant backups on encrypted ZFS pools
  • Znapzend - ZFS-centric backup tool
  • Zisofs-tools - User utilities for zisofs
  • Zidrav - File corruption detection and repair program
  • Zfstools - OpenSolaris-compatible auto snapshotting for ZFS
  • Zfsnap2 - Portable performant script to make rolling ZFS snapshots easy
  • Zfsnap - Simple sh script to make zfs rolling snaphosts with cron