OpenTofu Extension for Visual Studio Code
OpenTofu Extension for Visual Studio Code (VS Code) with the Terraform Language Server adds editing features for OpenTofu files such as syntax highlighting, IntelliSense, code navigation, code formatting, module explorer and much more!
We apologize for any inconvenience this may cause, and we appreciate your understanding.
Get started writing OpenTofu configurations with VS Code in three steps:
New to OpenTofu? Read the OpenTofu Introduction
See Usage for more detailed getting started information.
Read the Troubleshooting Guide for answers to common questions.
IntelliSense and Autocomplete
IntelliSense is a general term for a variety of code editing features including: code completion, parameter info, quick info, and member lists. IntelliSense features are sometimes called by other names such as autocomplete, code completion, and code hinting.
For OpenTofu constructs like resource and data, labels, blocks and attributes are auto completed both at the root of the document and inside other blocks. This also works for OpenTofu modules that are installed in the workspace, attributes and other constructs are autocompleted.
Invoking intellisense is performed through the keyboard combination for your platform and the results depend on where the cursor is placed.
If the cursor is at the beginning of a line and no other characters are present, then a list of constructs like
If inside a set of quotes or inside a block, the extension provides context specific completions appropriate for the location. For example, inside a
Completing the snippet allows you to tab complete through each attribute and block.
OpenTofu configuration files are validated when opened and on change, and invalid code is marked with diagnostics.
HCL syntax is checked for e.g. missing control characters like
Enhanced validation of selected OpenTofu language constructs in both
The enhanced validation feature is enabled by default but can be disabled using the following setting:
The extension also provides validation through
OpenTofu syntax highlighting recognizes language constructs of OpenTofu version 1.X. OpenTofu providers, modules, variables and other high-level constructs are recognized, as well as more complex code statements like
While editing, you can right-click different identifiers to take advantage of several convenient commands
This extension utilizes
See the Formatting Configuration section for information on how to configure this feature.
The extension provides several snippets to accelerate adding OpenTofu code to your configuration files:
OpenTofu Module and Provider Explorer
List OpenTofu modules used in the current open document in the Explorer Pane, or drag to the Side Bar pane for an expanded view.
Each item shows an icon indicating where the module comes from (local filesystem, git repository, or OpenTofu Registry).
If the module comes from the OpenTofu Registry, a link to open the documentation in a browser is provided.
List OpenTofu providers used in the current open document in the Explorer Pane, or drag to the Side Bar pane for an expanded view.
The extension provides access to several OpenTofu commands through the Command Palette:
The OpenTofu VS Code extension bundles the Terraform Language Server and is a self-contained install.
The extension does require the following to be installed before use:
The extension should work anywhere VS Code itself and OpenTofu 1.0 or higher is supported. Our test matrix includes the following:
Intellisense, error checking and other language features are supported for OpenTofu v1.0 and greater.
Syntax highlighting targets OpenTofu v1.0 and greater.
VS Code Workspace support
It is a common pattern to have separate folders containing related OpenTofu configuration that are not contained under one root folder. For example, you have a main OpenTofu folder containing the configuration for a single application and several module folders containing encapsulated code for configuring different parts of component pieces. You could open each folder in a separate VS Code window, and bounce between each window to author your changes.
A better approach is to use VS Code Workspaces. Using our example above, open the main OpenTofu folder first, then use Add Folder to workspace to add the dependent module folders. A single VS Code window is used and all OpenTofu files are available to author your changes. This uses a single terraform-ls process that has an understanding of your entire project, allowing you to use features like
Single file support
Opening a single OpenTofu configuration file inside VS Code is currently not supported. We see this approach most commonly attempted by users of terminal editors like vim, where it is common to edit a single file at a time.
The OpenTofu VS Code extension works best when it has the full context of a OpenTofu project where it can parse the referenced files and provide the expected advanced language features.
The recommended workflow is to instead open the containing folder for the desired OpenTofu file inside a single VS Code editor window, then navigate to the desired file. This seems counter-intuitive when you only want to edit a single file, but this allows the extension to understand the OpenTofu setup you are using and provide accurate and helpful intellisense, error checking, and other language features.
The extension will pick up new schema for OpenTofu providers you reference in your configuration files automatically whenever anything changes inside
To provide the extension with an up-to-date schema for the OpenTofu providers used in your configuration:
Remote Extension support
The Visual Studio Code Remote - WSL extension lets you use the Windows Subsystem for Linux (WSL) as your full-time development environment right from VS Code. You can author OpenTofu configuration files in a Linux-based environment, use Linux-specific toolchains and utilities from the comfort of Windows.
The Remote WSL extension runs the OpenTofu Extension and other extensions directly in WSL so you can edit files located in WSL or the mounted Windows filesystem (for example /mnt/c) without worrying about pathing issues, binary compatibility, or other cross-OS challenges.
For a detailed walkthrough for how to get started using WSL and VS Code, see https://code.visualstudio.com/docs/remote/wsl-tutorial.
The extension does not require any initial configuration and should work out of the box. To take advantage of additional VS Code features or experimental extension features you can configure settings to customize behavior.
This extension offers several configuration options. To modify these open the VS Code Settings Editor in the UI or JSON view for user and workspace level settings, scope your settings by language, or alternatively modify the
An experimental option can be enabled to prefill required fields when completing OpenTofu blocks with the following setting:
For example, choosing
Combine this with
Completing the snippet allows you to tab complete through each attribute and block.
Display reference counts above top level blocks and attributes
To enable automatic formatting, it is recommended that the following be added to the extension settings for the OpenTofu extension:
When using the
If you want to use
This will keep the global
An experimental validate-on-save option can be enabled with the following setting:
This will create diagnostics for any elements that fail validation. You can also run
If you have multiple root modules in your workspace, you can configure the language server settings to identify them. Edit this through the VSCode Settings UI or add a
If you want to automatically search root modules in your workspace and exclude some folders, you can configure the language server settings to identify them.
If you want to automatically ignore certain directories when terraform-ls indexes files, add the folder names to this setting:
OpenTofu command options
You can configure the path to the tofu binary used by terraform-ls to perform operations inside the editor by configuring this setting:
You can override the opentofu execution timeout by configuring this setting:
You can set the path OpenTofu logs (
Supports variables (e.g. timestamp, pid, ppid) via Go template syntax
Generate a bug report
Experience a problem? You can have VS Code open a Github issue in our repo with all the information filled out for you. Open the Command Palette and invoke
Reload the extension
If you haven't seen the Problems Pane update in awhile, or hover and intellisense doesn't seem to showing up, you might not know what to do. Sometimes the OpenTofu extension can experience problems which cause the editor to not respond. The extension has a way of reporting the problem, but there is something you can do to get right back to working after reporting the problem: reload the OpenTofu extension.
You can reload the OpenTofu extension by opening the command palette and starting to type
Pin to a specific version of the extension
If you wish to install a specific version of the extension, you can choose 'Install Another version' option in the Extensions pane. This will bring up a list of prior versions for the selected extension. Choose the version you want to install from the list.
We are an open source project on GitHub and would enjoy your contributions! Consult our development guide for steps on how to get started. Please open a new issue before working on a PR that requires significant effort. This will allow us to make sure the work is in line with the project's goals.
This project mentions the following registered trademarks: