How to connect your local VS Code to a workshop¶

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.

First, you’ll need to have the remote development extension pack installed.

After that, add the vscode-remote SDK to your workshop definition:

workshop.yaml¶

name: dev
base: ubuntu@24.04
sdks:
  - name: vscode-remote

Launch the workshop. Then find the workshop hostname:

$ workshop info dev

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

In VS Code, choose Open Remote Window, then Connect to host, and type workshop@dev.my-project.wp using the hostname from the workshop info output. In the terminal prompt, you’ll see that the IDE is running inside your workshop.

Note

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

How to connect your local VS Code to a workshop¶

See also¶