When the required VS Code extension is added into a Che plug-in registry, the user can add it into the workspace through the Che Plugins panel or through the workspace configuration.

Adding the VS Code extension using the Che Plugins panel

Prerequisites
  • A running instance of Eclipse Che. To install an instance of Eclipse Che, see Che quick-starts

Procedure

To add the VS Code extension using the Che Plugins panel:

  1. Open the Che Plugin panel.

  2. Change the current registry to the registry in which the VS Code extension was added.

  3. In the search bar, click the Menu button and then click Change Registry to choose the registry from the list. If the required registry is not in the list, add it using the Add Registry menu option. The registry link should point to the plugins segment of the registry. For example: https://my-registry.com/v3/plugins/index.json.

    vs code extension change registry
  4. Search for the required plug-in using the filter, and then click the Install button.

  5. Restart the workspace for the changes to take effect.

Adding the VS Code extension using the workspace configuration

Prerequisites
Procedure

To add the VS Code extension using the workspace configuration:

  1. Click the Workspaces tab on the Dashboard and select the workspace in which you want to add the plug-in. The Workspace <workspace-name> window is opened showing the details of the workspace.

  2. Click the devfile tab.

  3. Locate the components section, and add a new entry with the following structure:

     - type: chePlugin
       id:              (1)
    1 Link to the meta.yaml file in your registry, for example, https://my-plugin-registry/v3/plugins/<publisher>/<plug-inName>/<plug-inVersion>/meta.yaml

    Che automatically adds the other fields to the new component.

  4. Restart the workspace for the changes to take effect.