The default Workspaces environment supports remote connection with VSCode, Cursor, and CodeBuddy clients.

Custom Environment Configuration

For custom development environments, additional configuration is required:

Install SSH Server

Pre-install openssh-server in the Dockerfile. Note: installation methods may vary depending on the base image.

The following specifies a custom image through the vscode event and pre-installs openssh-server in the Dockerfile. Using a Debian-based image (node:22) as an example:

.cnb.yml

$:
  vscode:
    - docker:
        build:
          dockerfile: .ide/Dockerfile
      services:
        - vscode

.ide/Dockerfile

FROM node:22

# Install the SSH server to support remote connection via VSCode / Cursor / CodeBuddy clients
RUN apt-get update && apt-get install -y openssh-server

Tips

If you use other base images such as alpine, install it with the matching package manager (e.g. apk add openssh-server).

Install Client

Download the VSCode/Cursor/CodeBuddy client and install the Remote-SSH extension.

Resolving Window Overlap Issue

Clicking the VSCode client button may overlap existing windows. Set Open Folders In New Window to on to fix this:

• Manage → Settings → User → Window → New Window → Open Folders in New Window

Previous pagePreview Mode Only

Next pageJetBrains Client