Open VSX Extension (vscode)

An Open VSX feed in ProGet stores Open VSX compatible extensions, typically used with Visual Studio Code and compatible IDEs. Extensions stored in this feed can be installed directly from compatible IDEs/code editors like VSCodium.

Note that this feed type is for VS Code style extensions only, not for Visual Studio extensions. See Visual Studio Extension feeds if you need a feed for Visual Studio extensions.

Prerequisite Configuration

Using With Visual Studio Code

The official Microsoft-produced build of Visual Studio code is not currently supported by this feed type. While it is technically possible to configure it to install extensions from an Open VSX feed, this requires hand-editing a file that is part of its distribution and gets overwritten on upgrades. Further, changing the URL to a non-Microsoft private extension repository in this way may violate Microsoft's license.

Adding the Feed to VSCodium

These instructions are specifically for VSCodium, but should also apply to other open source forks of Visual Studio Code.

To use an Open VSX feed in VSCodium, you need to create or edit a product.json file with the following content:

{
    "extensionsGallery": {
        "serviceUrl": "https://proget.example.com/endpoints/FeedName/vscode/gallery",
        "itemUrl": "https://proget.example.com/endpoints/FeedName/vscode/item",
        "extensionUrlTemplate": "https://proget.example.com/endpoints/FeedName/gallery/{publisher}/{name}/latest",
        "resourceUrlTemplate": "https://proget.example.com/endpoints/FeedName/unpkg/{publisher}/{name}/{version}/{path}",
        "cacheUrl": "",
        "controlUrl": ""
    }
}

The product.json file location will vary based on your operating system. Normally, the location is:

• Windows: %APPDATA%\VSCodium or %USERPROFILE%\AppData\Roaming\VSCodium
• macOS: ~/Library/Application Support/VSCodium
• Linux: $XDG_CONFIG_HOME/VSCodium or ~/.config/VSCodium

After updating the file, restart VSCodium and the Extensions tab should now show the contents of your feed.

Uploading Extensions

To upload a .vsix extension, you can use Inedo's pgutil and run this command:

pgutil packages upload --feed=«vsix-feed-name» --input-file=«path-to-extension»

You can also use the UI or bulk upload.

Installing Extensions

Navigate to the Extensions tab and search for the desired extension, then click Install.

Limitations

• Not supported in official builds of VS Code (see above)
• Connectors to the official Visual Studio Marketplace are not permitted due to licensing. However, connectors to open-vsx.org are permitted.