Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

README.md

Terraform module example

Generate a reusable Terraform module skeleton with standard files and documentation placeholders.

Use case

Use this when starting an infrastructure module that should have consistent variables, outputs, provider constraints, and README structure.

Command

structkit generate --vars "module_name=terraform-example-module,description=A reusable Terraform module generated by StructKit.,terraform_version=1.6.0,provider_source=hashicorp/null,provider_version=>= 3.2.0" examples/terraform-module/.struct.yaml ./demo-terraform-module

Expected output

  • README.md
  • main.tf
  • variables.tf
  • outputs.tf
  • versions.tf
  • examples/basic/main.tf

Customization notes

  • Override module_name, provider_source, and provider_version to match your platform standard.
  • Replace the placeholder null_resource with real infrastructure resources.