がじぇ

お金と家電とプログラミングのブログ

Terraform docsコマンドの出力をsortしないで表示する

こんにちわ

がじぇったー (@hackmylife7) | Twitter

です。

Terraform docsコマンド便利ですよね。 Terraformモジュールから様々な出力フォーマットでドキュメントを生成するユーティリティです。

GitHub - segmentio/terraform-docs: Generate documentation from Terraform modules in various output formats

使い方に関しては以下の方がわかりやすく説明してくださっているので参考ください。

qiita.com

面倒なinputとoutputのドキュメンテーションを自動でやってくれます。

ただ、普通に使用するとsortされて出力されてしまうので、ちょっと見にくいです。

variablesを書いた順番に出力したいときのオプションを紹介します。

TL;DR(要約)

  • --no-sort オプションをつける

markdownを出力したい場合は以下のようにコマンドを実行するとsortしないで出力されます

|| terraform-docs markdown ./ --no-sort ||<

短いですが以上です。