Still, you may wish to customize Gitpod, or to extend it with new features. You can do this by installing VS Code extensions.
To install a VS Code extension in Gitpod, simply go to the left vertical menu, and open the Extensions view. There you can search for an extension and install it with one click.
If the extension is helpful to anyone who works on the project, you can add it to the
.gitpod.yml configuration file so that it gets installed for anyone who works on the project. To do that:
- Visit the extension page (where you installed it from)
- Click the settings icon
- Select “Add to .gitpod.yml” from the menu
.gitpod.yml is updated automatically and lists the given extension. You can also directly edit this file to install or remove extensions manually.
Here is an example of what a
.gitpod.yml with installed extensions may look like:
vscode: extensions: - svelte.svelte-vscode - firstname.lastname@example.org - https://example.com/abc/releases/extension-0.26.0.vsix
You can share the installed extensions with your team by committing the
.gitpod.yml change and pushing it to your Git repository.
You have two options to install extensions for yourself only:
- For the current workspace only
- For all your workspaces
The second use case can be useful for extensions that you want to have in all your projects (for example a custom theme), and this doesn’t require changing every project’s
To do this, open the Extensions view, search for the extension you want to install and click Install.
Gitpod already comes with a number of commonly used VS Code extensions pre-installed by default.
You can view all pre-installed extensions by navigating to VS Code’s Extensions section on the left-hand side. In the “Search Extensions in Marketplace” input field, type
@builtin to see the built-in extensions.
If you cannot find an extension by searching in Gitpod, it probably means that the extension hasn’t been added to the Open VSX registry yet.
In that case, you can run the official CI script for publishing existing open-source VS Code extensions to open-vsx.org by following the steps described in https://github.com/open-vsx/publish-extensions#how-to-add-an-extension.
The CI script automates the manual way of installing a
*.vsix file. To manually install an extension:
- Drag a
.vsixfile into your editor’s Explorer view where you see your project’s files (you can delete that file after you installed the extension).
- Open the VS Code Extensions view on the left-side of the editor.
- Click the ”…” menu at the top right of the view
- Select Install from VSIX…
- Enter the path to the
.vsixfile you uploaded in step 1 above and press Enter.
Please note that
.vsixfiles downloaded from the Visual Studio Marketplace should not be installed in Gitpod, because Microsoft prohibits the direct use of their marketplace by any non-Microsoft software, even though most extensions are actually open source and not developed or maintained by Microsoft.
You can of course also develop and install your own extensions. Note that installing a
.vsixfile in Gitpod will not list that extension anywhere publicly except in your own
.gitpod.yml, so you can also install private extensions that way.