Skip to main content

Connect to a Workspace

Connect to a Workspace​

Once a workspace is created, it is reachable through the SSH host WORKSPACE_NAME.devsy. If you chose an IDE, Devsy opens it after the workspace starts.

info

Change the default IDE globally with devsy ide use vscode, or per workspace with devsy workspace up my-workspace --ide vscode.

VS Code Browser​

Devsy can open VS Code in a browser tab. It installs openvscode-server inside the workspace and tunnels a connection to it from localhost. Open the workspace in VS Code browser with:

devsy workspace up my-workspace --ide openvscode

To pick a different openvscode version:

devsy workspace up my-workspace --ide openvscode --ide-option VERSION=v1.76.2

VS Code​

Install the remote ssh extension and the code CLI. Then start the workspace in VS Code with:

devsy workspace up my-workspace --ide vscode
SSH Fallback

If this doesn't work, use the regular SSH connection WORKSPACE_NAME.devsy to connect VS Code.

JetBrains Suite (Goland, PyCharm, Intellij etc.)​

Install JetBrains Gateway and have a valid JetBrains subscription for your local IDE. Supported JetBrains IDEs:

  • CLion (clion)
  • Goland (goland)
  • PyCharm (pycharm)
  • Intellij (intellij)
  • PhpStorm (phpstorm)
  • WebStorm (webstorm)
  • Rider (rider)
  • RubyMine (rubymine)

Start your workspace with:

devsy workspace up my-workspace --ide goland

Devsy installs the GoLand server binary into the workspace and opens JetBrains Gateway. After installation, the Gateway SSH dialog appears pre-filled — click Check Connection and Continue to start the IDE inside the workspace.

To pick a different IDE version:

devsy workspace up my-workspace --ide goland --ide-option VERSION=2022.3.3
SSH Fallback

If this doesn't work, use the SSH host WORKSPACE_NAME.devsy to connect your JetBrains IDE.

Fleet Support

Fleet only works by manually adding an SSH connection to WORKSPACE_NAME.devsy.

SSH​

When a workspace is created, Devsy adds an entry for WORKSPACE_NAME.devsy to ~/.ssh/config. Connect with:

ssh WORKSPACE_NAME.devsy

Any IDE that supports remote development over SSH can also use this host.

Devsy CLI​

If you don't have ssh installed or can't connect through an IDE, use the Devsy CLI:

devsy workspace ssh my-workspace

Run a command non-interactively:

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

IDE Commands​

Configure how Devsy opens workspaces with these commands.

Configure IDE Options​

Each IDE supports options like version and download path. List them with:

devsy ide get openvscode

Change an option with:

devsy ide set openvscode -o VERSION=v1.76.2

Change Default IDE​

Set the default IDE Devsy uses to open workspaces:

devsy ide use vscode

List supported IDEs​

List every IDE Devsy supports:

devsy ide list

Desktop shortcuts​

Devsy Desktop ships a command palette and section shortcuts for fast navigation:

  • Cmd/Ctrl + K — open the command palette (search workspaces, providers, machines, and pages).
  • Cmd/Ctrl + N — start the New Workspace wizard.
  • Cmd/Ctrl + 1 through Cmd/Ctrl + 8 — jump to Dashboard, Workspaces, Providers, Machines, Contexts, Terminals, SSH Keys, and Settings.
  • Esc — close the active sheet, dialog, or palette (where supported).