Generate a module README from its variables and outputs, in the layout terraform-docs produces. A sensitive default is written as (sensitive), not its value.
Waiting for a module
The README is built from the variables and outputs the module declares.
The README appears here
Inputs, outputs, resources and a usage example built from the required variables, in the layout terraform-docs produces.
A sensitive variable’s default is written as (sensitive) rather than its value. A generated README is the document most likely to end up committed, and a default that happens to be a real token would be published by the act of documenting it — the variable is still listed with its type and description, only the value is held back. Descriptions come from the description arguments you wrote; a variable without one gets an empty cell rather than an invented sentence.
Terraform Module README Generator runs entirely on your device — sensitive defaults are withheld from the output, and no Terraform command is run.
You’re on the Free plan. Compare plans
The output is Markdown because it goes in a repository, and the tables follow the layout terraform-docs produces — because that is what people's eyes and their CI checks already expect. A README in a different shape is a README nobody reads carefully.
A sensitive variable's default is never printed. It appears as *(sensitive)* in the defaults column instead. A generated README is the document most likely to be committed, and a default that happens to be a real token would be published by the act of documenting it. The variable is still listed with its type and description; only the value is held back.
The usage example is built from the required variables only, which is what makes it useful. A module call setting every variable including the ones with sensible defaults is longer than the module and teaches nothing. The required ones are exactly the set a caller has to think about.
Variables with no description are listed on the page before you generate, because that gap is worth seeing. The table leaves the cell empty rather than inventing a sentence — a description is the one piece of documentation a caller cannot derive from the type, and a made-up one is worse than a visible hole.
Nothing is run. No Terraform, no state, no provider, no cloud account.
No. It writes *(sensitive)* in place of the value. A generated README is the file most likely to be committed, so a sensitive default printed there is a secret published by the act of documenting it.
It sets the required ones, which is the set a caller actually has to decide about. An example that also sets every variable with a sensible default is longer than the module and buries the two lines that matter.
No, but it produces the same table layout, so the output drops into a repository that already uses it. terraform-docs runs in CI against the real files; this is useful for a quick README or when you do not have it installed.