Installing VS Code Extensions in Theia

You can install VS Code extensions into Theia-based products via the Open VSX Registry, aka “Theia Marketplace” or “Theia Extension Registry”.

Note: To be able to install extensions, the creator of your Theia-based tool needs to have enabled this option. The following documentation is based on Theia Blueprint, a standard product based on Theia. This might slightly differ from the Theia-based product you are using, please contact the provider of your tool if there are uncertainties and also see here. For tool creators, please see the end of this document.

To install new extensions into Theia Blueprint, please open the Extensions View via the Menu "View => Extensions" or via the command “Toggle Extensions View”.

In the opened Extension View you can browse for available VS Code extensions using the search field on top (see screenshot below). In the list of matching extensions, you can review the details about an extension and directly install it by clicking on the “Install” button.

The Extension View also presents recommendations to be installed, if any, as well as extensions that are already installed. Here, you can uninstall extensions by clicking “Uninstall”.

Theia Marketplace / Theia Registry

The last section, “Built-In” shows VS Code extensions that are a fix part of your Theia-based product. This means the creator of your tool has installed them already for you and you can also not uninstall them.

Compatibility

Every Theia version supports a specific VS Code extension API version, i.e. the extension API is fully provided by Theia until and including this VS Code version. In Theia Blueprint, you can find the supported version in the about dialog (Menu "Help" => "About"). The Open VSX Registry will automatically show compatible VS Code extensions only.

Extensions not listed as compatible might still work in Theia, as newer API versions are usually already partially implemented. In this case, you can manually install the extension via a VSIX file and test if it works (Use the command "Extensions: Install from VSIX...").

Please note that a few parts of the VS Code extension API are only stubbed in Theia. Extensions will be installable, but some features might not work as expected.

For details about the compatibility of Theia for VS Code extensions can be found in this report. This includes unsupported as well as stubbed parts of the API for all recent Theia versions.

If you are missing a specific VS Code extension or if you have issues with using a VS Code extension in Theia, please report this to the creator of your Theia-based Tool. If you are using Theia Blueprint or a variant of it, please report your issues here.

For adopters: If you are building a Theia-based product, please have a look at our overview about extensions and plugins as well as at the documentation on authoring VS Code extensions in Theia.

Go to previous Page : Getting StartedGo to next page : Build your own IDE/Tool