This page explains how to install and configure the VS Code extension.
The extension requires VS Code
1.61.0 or higher.
0.3.6 of this extension, the path to use the Java Runtime (JRE) can optionally be configured in the settings.
If the setting is empty, the extension will download a JRE and extract it in the local
If you wish to provide the JRE:
- The extension requires a Java Runtime
- The Java runtime must be 64-bit. Make sure to use at least JRE 11
- You can check your Java version with
- Java can be downloaded from several sources, a.o. Adoptium
- Choose the OpenJDK 11 x64 JRE for your OS
- Make sure the
javaexecutable is available in the
The extension can be installed from the VS Code marketplace.
To install the extension in VS Code, 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.
The settings for the Sigasi extension can be reached trough:
- Open the Command Palette using Ctrl+Shift+P
- Start typing and select Preferences: Open Settings (UI)
- In Search settings type
- First, configure the Path To License. This can be a local node locked license file or a floating license server (e.g.
- Optionally, configure the JRE location in Sigasi > Java: Path. Make sure to add the
javaexecutable name in the path.
Alternatively, the Sigasi extension settings can be accessed through the Manage icon () in the extensions overview.
The following features need setup before they are active.
For Verilog code, it is possible to configure an external formatter, Verible.
To enable and configure the formatter, open the settings and search for
Sigasi › Verilog › Formatting.
Here you have the choice between using the Sigasi formatter or the Verible formatter by setting the
verible, arguments for Verible can be set in
Verible: Format Arguments.
verible, by default the Verible formatter that comes with the extension will be used.
It’s also possible to use an external executable by configuring its installation path in the
Verible: Installation Path setting and enabling the
Verible: Use External option.
You can help improving the Sigasi extension for VS Code by enabling the automatic submission of usage statistics and error stack traces. More information about this feature is available in the Talkback manual page.
To enable talkback in the VS Code extension, open the settings and enable the
Sigasi: Enable Talkback option.
The messages sent to Sigasi can also be logged locally. Then you can view these messages using the Sigasi: Open talkback log command. In order to log the messages locally, a data storage needs to be configured.
You can specify a directory to be used by the Sigasi Language Server to write the cache and talkback logs to.
Open the settings and search for
Sigasi › Server: Data Location.
The directory needs to exist already.