Skip to content

terramate-io/vscode-terramate

Repository files navigation

Terramate VSCode Extension

CI Status Join Discord

This is the official Terramate extension for Visual Studio Code editor.

If you are new to Terramate, this article provides an overview of the project and how it improves the Terraform workflow.

Getting started

If you have installed the terramate-ls in an arbitrary path (not in PATH env) you can configure where the extension should look up for the binary using the setting terramate.languageServer.binPath in settings.json.

  • Step 3: To activate the extension, open any folder or VS Code workspace containing Terramate files. Any .tm or .tm.hcl file open will have the "Language mode" set to Terramate.

If you have *.hcl associated with other extension (eg.: terraform) you can add a specific file association for terramate in the Settings -> Text Editor -> Files -> Associations or directly updating/adding the files.associations in the settings.json:

"files.associations": {
	"*.tm.hcl": "terramate"
}

Contributing

In order to contribute to this project, first have a look in the Terramate Contributing Guide as the same workflow applies here.

For a technical contributing guide specific to this extension, check the CONTRIBUTING.md documentation.