Get terraform-docs on Windows, macOS or Linux Now!
Get terraform-docs with one command
Pick your system, reveal the step-by-step guide, copy the command, paste it into your terminal and press Enter. This command was taken from the project's own documentation and checked against it.
Not available for Windows yet.
terraform-docs doesn't publish an install command for Windows anywhere we can verify, so there's nothing for us to show you. We won't invent one. It does document one for macOS and Linux — switch to that tab.
Installs terraform-docs into your user directory on Windows and puts it on your PATH, so you
can run terraform-docs straight away. Runs as your normal user account, and needs no administrator rights.
Not available for macOS yet.
terraform-docs doesn't publish an install command for macOS or Linux anywhere we can verify, so there's nothing for us to show you. We won't invent one. It does document one for Windows — switch to that tab.
Installs terraform-docs on your macOS or Linux machine and links it into your PATH — after this,
terraform-docs just works from any directory. Runs as your normal user account, and needs no administrator rights.
How to set up terraform-docs, step by step
On Windows, open PowerShell (press Win, type PowerShell, hit Enter) and paste the command. On macOS or Linux, open Terminal — on a Mac it's in Applications ▸ Utilities, or press Cmd+Space and type Terminal — and paste the command there.
Run terraform-docs --help to see the available commands, and
terraform-docs --version to confirm the install worked. If your shell complains about
permissions, that project usually documents a corrected command on its own site.
This asks Scoop to download terraform-docs and place it where your shell can find it.
What terraform-docs does
- you can only use plugin thorough file and it cannot be used
- Read the [User Guide] to learn how to use terraform-docs
- Read the [Formats Guide] to learn about different output formats of terraform-docs
- Refer to [Config File Reference] for all the available configuration options
- folder at root of module directory
- make sure the plugin file name is
Summarised from terraform-docs's own README.
About terraform-docs
terraform-docs is an open-source developer tool.
| Category | Developer tool |
|---|---|
| Install method | scoop |
| Windows | documented install command available |
| macOS / Linux | documented install command available |
| Price | Free and open source |
| Command verified | Yes — checked against the project README |
| Popularity | 4.8k stars on the project's public repository |
On mobile
terraform-docs is a command-line tool, so there is no phone app for it — a phone has no shell to run it in. You'll need a desktop, or a remote shell into a machine that has one.
terraform-docs is developed by its own authors. This page is an independent reference; we are not affiliated with or sponsored by the project. The command shown here was reproduced from the project's public documentation — always check the project's own documentation before running anything.