@@ -175,13 +175,13 @@ Create markdown output and sent to stdout:
175175docker run --rm \
176176 -v $( pwd) :/data \
177177 cytopia/terraform-docs \
178- terraform-docs --sort-inputs- by-required --with-aggregate-type-defaults md .
178+ terraform-docs --sort-by-required md .
179179
180180# [Terraform >= 0.12]
181181docker run --rm \
182182 -v $( pwd) :/data \
183183 cytopia/terraform-docs \
184- terraform-docs-012 --sort-inputs- by-required --with-aggregate-type-defaults md .
184+ terraform-docs-012 --sort-by-required md .
185185` ` `
186186
187187# ## Store in file
@@ -191,13 +191,13 @@ Create README.md with `terraform-docs` output:
191191docker run --rm \
192192 -v $( pwd) :/data \
193193 cytopia/terraform-docs \
194- terraform-docs --sort-inputs- by-required --with-aggregate-type-defaults md . > README.md
194+ terraform-docs --sort-by-required md . > README.md
195195
196196# [Terraform >= 0.12]
197197docker run --rm \
198198 -v $( pwd) :/data \
199199 cytopia/terraform-docs \
200- terraform-docs-012 --sort-inputs- by-required --with-aggregate-type-defaults md . > README.md
200+ terraform-docs-012 --sort-by-required md . > README.md
201201` ` `
202202
203203# ## Replace in README.md
@@ -220,15 +220,15 @@ following delimiter by default:
220220docker run --rm \
221221 -v $( pwd) :/data \
222222 cytopia/terraform-docs \
223- terraform-docs-replace --sort-inputs- by-required --with-aggregate-type-defaults md README.md
223+ terraform-docs-replace --sort-by-required md README.md
224224
225225# [Terraform >= 0.12]
226226# Path to README.md must be specified as last command.
227227# Note that the command changes from terraform-docs to terraform-docs-replace
228228docker run --rm \
229229 -v $( pwd) :/data \
230230 cytopia/terraform-docs \
231- terraform-docs-replace-012 --sort-inputs- by-required --with-aggregate-type-defaults md README.md
231+ terraform-docs-replace-012 --sort-by-required md README.md
232232` ` `
233233
234234# ## Replace in INFO.md with different delimiter
@@ -251,7 +251,7 @@ docker run --rm \
251251 -e DELIM_START=' < ! -- TFDOC_START --> ' \
252252 -e DELIM_CLOSE=' < ! -- TFDOC_END --> ' \
253253 cytopia/terraform-docs \
254- terraform-docs-replace --sort-inputs- by-required --with-aggregate-type-defaults md INFO.md
254+ terraform-docs-replace --sort-by-required md INFO.md
255255
256256# [Terraform >= 0.12]
257257# Path to INFO.md must be specified as last command.
@@ -261,7 +261,7 @@ docker run --rm \
261261 -e DELIM_START=' < ! -- TFDOC_START --> ' \
262262 -e DELIM_CLOSE=' < ! -- TFDOC_END --> ' \
263263 cytopia/terraform-docs \
264- terraform-docs-replace-012 --sort-inputs- by-required --with-aggregate-type-defaults md INFO.md
264+ terraform-docs-replace-012 --sort-by-required md INFO.md
265265```
266266
267267### Example Makefile
@@ -301,7 +301,7 @@ _gen-main:
301301 -e DELIM_START=' $( DELIM_START) ' \
302302 -e DELIM_CLOSE=' $( DELIM_CLOSE) ' \
303303 cytopia/terraform-docs:$(TF_DOCS_VERSION) \
304- terraform-docs-replace --sort-inputs- by-required --with-aggregate-type-defaults md README.md; then \
304+ terraform-docs-replace --sort-by-required md README.md; then \
305305 echo "OK"; \
306306 else \
307307 echo "Failed"; \
@@ -320,7 +320,7 @@ _gen-examples:
320320 -e DELIM_START=' $( DELIM_START) ' \
321321 -e DELIM_CLOSE=' $( DELIM_CLOSE) ' \
322322 cytopia/terraform-docs:$(TF_DOCS_VERSION) \
323- terraform-docs-replace --sort-inputs- by-required --with-aggregate-type-defaults md $${DOCKER_PATH}/README.md; then \
323+ terraform-docs-replace --sort-by-required md $${DOCKER_PATH}/README.md; then \
324324 echo "OK"; \
325325 else \
326326 echo "Failed"; \
@@ -340,7 +340,7 @@ _gen-modules:
340340 -e DELIM_START=' $( DELIM_START) ' \
341341 -e DELIM_CLOSE=' $( DELIM_CLOSE) ' \
342342 cytopia/terraform-docs:$(TF_DOCS_VERSION) \
343- terraform-docs-replace --sort-inputs- by-required --with-aggregate-type-defaults md $${DOCKER_PATH}/README.md; then \
343+ terraform-docs-replace --sort-by-required md $${DOCKER_PATH}/README.md; then \
344344 echo "OK"; \
345345 else \
346346 echo "Failed"; \
0 commit comments