How to connect your local VS Code to a workshop

Use workshopsJetBrains Gateway →

A local VS Code instance can connect to a remote workshop environment via the vscode-remote SDK, giving you the full VS Code experience against Workshop.

Prerequisites

Before starting, ensure you have these requirements satisfied:

Configure SSH access

Workshop generates an OpenSSH configuration for connecting to launched workshops. When using the Workshop snap, include that generated configuration in your host user’s ~/.ssh/config file. Replace <UID> with your host user ID, which you can find with id -u:

~/.ssh/config
Include /var/snap/workshop/current/ssh/<UID>/config

Add the SDK

Add the vscode-remote SDK to your workshop definition:

workshop.yaml
name: dev
base: ubuntu@24.04
sdks:
  - name: vscode-remote

Launch the workshop

Launch the workshop if it isn’t already running:

$ workshop launch

Then find the workshop hostname:

$ workshop info

name:      dev
base:      ubuntu@24.04
project:   ~/my-project
hostname:  dev.my-project.wp
...

Use the hostname from the workshop info output when configuring VS Code.

Connect with VS Code

In VS Code, press F1 to open the command palette, start typing Connect to Host, then choose the Remote-SSH option. Enter workshop@dev.my-project.wp, replacing dev.my-project.wp with the hostname from workshop info. In the terminal prompt, you’ll see that the IDE is running inside your workshop.

Note

If you’re having trouble finding the Remote-SSH option, mind that it’s enabled by the Remote - SSH extension from the extension pack mentioned above.

See also

Explanation:

Reference: