Devsy
Developing in a Workspace

Connect to a Workspace

After a workspace is created, it accepts SSH connections at WORKSPACE_NAME.devsy. If you chose an IDE, Devsy opens it after the workspace starts.

Set the IDE with --ide when you start a workspace, or set a default for all workspaces:

devsy workspace up my-workspace --ide vscode
devsy ide use vscode

Run devsy ide list to see every supported IDE.

VS Code in the browser

Devsy installs openvscode-server in the workspace and tunnels to it from localhost.

devsy workspace up my-workspace --ide openvscode

VS Code

Install the Remote - SSH extension and the code CLI, then:

devsy workspace up my-workspace --ide vscode

If that fails, connect VS Code to WORKSPACE_NAME.devsy over SSH.

For a slow SSH connection, set the Remote - SSH connection timeout in seconds:

devsy workspace up my-workspace --ide vscode --ide-option SSH_CONNECT_TIMEOUT=60

To set the option for all VS Code workspaces, run devsy ide set vscode -o SSH_CONNECT_TIMEOUT=60. The value must be a positive whole number of seconds, up to 999999999. Devsy writes remote.SSH.connectTimeout to the host user settings for the selected editor. The setting applies to all Remote - SSH hosts in that editor, including hosts Devsy does not manage. Without the option, Devsy leaves the existing timeout unchanged. For other VS Code-based editors, use their IDE name in place of vscode.

On Linux, Devsy uses XDG_CONFIG_HOME for editor settings when it is set. Otherwise, it uses ~/.config.

JetBrains IDEs

Install JetBrains Gateway. You need a license for the IDE you use. Start the workspace with the IDE name:

devsy workspace up my-workspace --ide goland

Devsy installs the IDE server in the workspace and opens Gateway. Click Check Connection and Continue in the prefilled SSH dialog. If that fails, connect Gateway to WORKSPACE_NAME.devsy over SSH.

Fleet works only through a manually added SSH connection to WORKSPACE_NAME.devsy.

SSH

When SSH configuration is enabled, Devsy adds a WORKSPACE_NAME.devsy entry to ~/.ssh/config on the machine that runs Devsy when it creates a workspace.

ssh WORKSPACE_NAME.devsy

Any IDE with remote SSH support can use this host. Without an ssh client, use the CLI:

devsy workspace ssh my-workspace
devsy workspace ssh my-workspace --command "echo Hello World"

SFTP uses the SSH username for file operations inside the workspace. Files you upload belong to that user, and access follows that user's permissions:

sftp USER@WORKSPACE_NAME.devsy

To get the host and remote user for a manually configured IDE connection, run this in the container terminal:

devsy container info
devsy container info --result-format json

Run devsy container info inside the workspace container, not on your local machine. The printed ssh command works only from a client with the matching Devsy SSH configuration and a reachable transport. The .devsy suffix is an SSH alias that Devsy writes to the SSH config, not a network name.

When Devsy runs on a remote VM, a separate laptop or IDE client needs its own working SSH transport or host configuration. devsy container info does not configure it.

Docker Compose workspaces created before Devsy set DEVSY_WORKSPACE_ID in the service lack that variable, and devsy container info fails in them. Recreate the workspace to fix this.

IDE options

Each IDE has options, such as the version. Read and set them with:

devsy ide get openvscode
devsy ide set openvscode -o VERSION=v1.76.2

You can also set an option for a single workspace with --ide-option VERSION=... on devsy workspace up.

Desktop shortcuts

  • Cmd/Ctrl + K opens the command palette.
  • Cmd/Ctrl + N starts the New Workspace wizard.
  • Cmd/Ctrl + 1 to 8 jumps between the main sections.
  • Esc closes the open sheet, dialog, or palette.

On this page