VS Extensions

Official Marketplace

According to the VSCode Marketplace Terms of Use, you may only install and use Marketplace Offerings with Visual Studio Products and Services.

Marketplace Offerings are intended for use only with Visual Studio Products and Services, and you may only install and use Marketplace Offerings with Visual Studio Products and Services.

For this reason, we use Open-VSX, an open source registry for VS Code extensions.

ℹ️ INFO

Please note that some Visual Studio Code extensions have licenses that restrict their use to the official Visual Studio Code builds and therefore do not work with our workspace.

Installing User-Defined Extensions

Recognizing your individual preferences for VSCode extensions, we provide two methods for ensuring your workspace retains custom installed extensions across restarts.

💡 TIP

Kloud Workspace is always evolving. To gain the most from all the new features and upgrades, we suggest using the "Install at Boot" method.

Install at Boot

Upon startup, Kloud Workspace evaluates several environment variables to automate the installation of additional user-defined VSCode extensions. Both options below can be used in unison:

• WS_EDITOR_ADDITIONAL_VS_EXTENSIONS: Installs these Marketplace extension IDs at startup.
• WS_EDITOR_ADDITIONAL_VS_EXTENSIONS_DIR: Installs .vsix file found in this directory.

list

docker run \
  -e WS_EDITOR_ADDITIONAL_VS_EXTENSIONS="dbaeumer.vscode-eslint esbenp.prettier-vscode" \
  ghcr.io/kloudkit/workspace:v0.0.21

directory

docker run \
  -e WS_EDITOR_ADDITIONAL_VS_EXTENSIONS_DIR=/additional-extensions \
  -v /path/to/my-additional-extensions:/additional-extensions \
  ghcr.io/kloudkit/workspace:v0.0.21

Persistent Extensions

You can take full control of the workspace extensions by using a persistent volume to the /extensions directory. When using a named volume, the initial content of /extensions from the deployed image is copied over to the volume.

NOTICE

It is important to note that by mounting a volume for the extensions directory, you opt-out of receiving future updates, installs, and changes to the prepackaged extensions that come with the workspace.

# Optional: the volume name is explicitly defined
# below, so the following can be skipped
docker volume create my-extensions

docker run \
  -v my-extensions:/extensions \
  ghcr.io/kloudkit/workspace:v0.0.21

Privately Hosted Gallery

If you own a marketplace that implements the VSCode Extension Gallery API, you can point the workspace to it by setting $EXTENSIONS_GALLERY. For example:

docker run \
  -e EXTENSIONS_GALLERY='{"serviceUrl": "https://my-extensions/api"}' \
  ghcr.io/kloudkit/workspace:v0.0.21

⚠️ WARNING

We strongly discourage you from setting this for the official VSCode Marketplace, since it infringes on the terms of use.

Prepackaged Extensions

The table below describes the preinstalled extensions (some also have customized settings) and their respective license.

👏 Many thanks to the amazing developers of these extensions.

Name	License
Catppuccin.catppuccin-vsc	MIT
charliermarsh.ruff	MIT
DavidAnson.vscode-markdownlint	MIT
EditorConfig.EditorConfig	MIT
exiasr.hadolint	MIT
golang.go	MIT, Apache 2, BSD, Other
humao.rest-client	MIT
ludwhe.vscode-uuid	ISC
mikestead.dotenv	MIT
ms-azuretools.vscode-docker	MIT
ms-kubernetes-tools.vscode-kubernetes-tools	Apache 2
ms-python.python	MIT
ms-vscode.hexeditor	MIT
PKief.material-icon-theme	MIT
redhat.ansible	MIT
redhat.vscode-xml	EPL 2
redhat.vscode-yaml	MIT
samuelcolvin.jinjahtml	MIT
streetsidesoftware.code-spell-checker	GPL 3
tamasfe.even-better-toml	MIT
timonwong.shellcheck	MIT
wayou.vscode-todo-highlight	MIT
yzhang.markdown-all-in-one	MIT