tfdoc

A VS Code extension to open Terraform Provider documentation in your browser.

Features

• Open the documentation of the Terraform resource or data source at the cursor position.

Usage

By default this extension does not have a keyboard shortcut. To bind it to a key you like, add an entry to your keybindings.json. In this example the command is bound to the cmd+; cmd+t:

[
  {
    "key": "cmd+; cmd+t",
    "command": "tfdoc.openDocs",
    "when": "editorTextFocus && editorLangId == 'terraform'"
  }
]

Requirements

• Visual Studio Code 1.106.1 or later.

Install

code --install-extension mi-wada.tfdoc

ToDo

• [ ] Write tests.
• [ ] Setup CI/CD.
• [ ] Open documentation for parameters with fragment identifiers like a https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/instance#region-1.
• [ ] Detect provider version from required_providers block in Terraform configuration.