Extension Setup

This page explains how to install and configure the Sigasi Studio extension for VS Code.

Requirements

VS Code Version

The extension requires VS Code or VS Codium version 1.77.0 or higher.

Java Runtime (Optional)

The path to use the Java Runtime (JRE) can optionally be configured in the settings. If empty, the extension will extract the included JRE in the user’s home folder.

  • Linux: ~/.config/Code/User/globalStorage/sigasi.sigasi-vscode
  • Windows: %AppData%\Code\User\globalStorage\sigasi.sigasi-vscode

If you wish to provide the JRE:

  • The extension requires a Java Runtime
  • The Java runtime must be 64-bit. Make sure to use JRE 11 or JRE 17
  • You can check your Java version with java -version
  • Java can be downloaded from several sources, a.o. Adoptium 
  • Make sure the java executable is available in the PATH environment variable

Installation

You can install the extension from the VS Code marketplace .

To install the extension, open the Extensions pane using Ctrl+Shift+X. In the Search field on top, type Sigasi. Click the Sigasi extension and click Install.

If you’re working on a remote host for your HDL development, the extension only needs to be installed on the remote.

Updating

VS Code supports automatic extension updates. Since VS Code version 1.85, fine-grained control about which extensions to auto-update is available.

If your Extensions: Auto Update setting is set to _Selected Extensions, you can right-click the Sigasi extension in the Extensions pane and select the Auto Update option. Doing so ensures that your Sigasi extension will be updated even when other extensions are not auto-updating.

Settings

You can reach the settings for the Sigasi extension as follows.

VS Code Sigasi license setting
  • Open the Command Palette using Ctrl+Shift+P
  • Start typing and select Preferences: Open Settings (UI)
  • In the Search field on top, type Sigasi.
  • First, configure the Path To License. It can be a local node-locked license file or a floating license server, e.g., 27000@myserver.example.com. The setting for the license path is similar to the one in Sigasi Studio on Eclipse.
  • Optionally, configure the JRE location in Sigasi > Java: Path. Make sure to add the java executable name to the configured value.

Alternatively, you can access the Sigasi extension settings through the Manage icon () in the extensions overview.

Talkback and Telemetry

You can help improve the Sigasi extension for VS Code by enabling the automatic submission of usage statistics and error stack traces through Talkback and telemetry. More information about these features is available on the Talkback manual page.

Talkback is disabled by default. To enable Talkback in the VS Code extension, open the settings and enable the Sigasi: Enable Talkback option.

The messages sent to Sigasi are logged locally. You can view these messages using the Sigasi: Open Talkback Log Folder command.

On Disk Caching

Disk caching is enabled by default in the Sigasi extension for VS Code. We recommend leaving it enabled as the cache will significantly speed up the plugin by preserving the state from an earlier moment.

However, if you’d like to disable it, you can turn off the setting Sigasi > Server > Caching: Enable On-Disk Caching.