Terrarium - VS Code Extension

Terrarium-VSCode is an extension that enhances your Terraform development experience by providing intelligent autocompletion for indexed Terraform modules.

Key Features

• Module Autocompletion: Easily access autocompletion suggestions for Terraform modules.
• Dependency Autocompletion: Receive autocompletion suggestions for linked dependencies.
• Value Autocompletion: Get autocompletion suggestions for values related to linked dependencies.

Installation

Before you can start benefiting from the Terrarium-VSCode extension, make sure to complete the following prerequisites:

1. Install Terrarium CLI: Ensure that you have the Terrarium CLI installed on your machine. You can follow the installation process in the CLI Installation Guide.

   • Verify installation: Confirm that the Terrarium CLI is correctly installed by executing terrarium version in your terminal.

2. Terrarium - VS Code Extension: You can install the Terrarium-VSCode extension in two ways: directly from this webpage or from within Visual Studio Code (VS Code).

   • Option 1: Install from the Terrarium-VSCode extension

     1. Download Terrarium-VSCode extension.
     2. Open Visual Studio Code.
     3. Go to Extensions (Ctrl+Shift+X or Cmd+Shift+X).
     4. Click the three dots (ellipsis) and choose Install from VSIX
     5. Locate and select the downloaded .vsix extension package.
     6. Click Install

   • Option 2: Install from Within VS Code

     1. Open Visual Studio Code.
     2. Go to Extensions (Ctrl+Shift+X or Cmd+Shift+X).
     3. Search for the extension "Terrarium"
     4. Click "Install" on the extension.

3. Restart VS Code: Restart your Visual Studio Code editor to apply any necessary changes.

4. Open or Create Terraform Workspace: To begin using the Terrarium-VSCode extension, you should either open a workspace containing Terraform files or create a new Terraform file within your project.

5. Trigger Autocompletion: While editing Terraform files in VS Code, you can prompt autocompletion suggestions by pressing ctrl + space.

Developing

Run Terrarium CLI

1. follow the installation process at setup.md run the latest version of terrarium CLI binary.

Local development environment

1. Clone this repo with git.
2. Install npm
3. Install dependencies by running npm i within the directory that you cloned.
4. Start the development mode with npm watch.
5. open the cloned repo in vscode and open "Run and Debug" cmd+shift+D.
6. Click on "Run Extension" it will open a new vscode session with the plugin activated in it.
7. In the 'Development Mode' vscode create a new file with extension .tf.

Enjoy!