Prerequisites
Before connecting, make sure you have completed Getting Started — the Devbox CLI must be installed and authenticated. You’ll also need a running Devbox.Terminal Access
Direct SSH
The fastest way to get a shell in your Devbox:-A flag to forward your local SSH agent:
Configure SSH
To use the standardssh command (and enable any tool that relies on SSH config), run:
~/.ssh/config with an Include directive pointing to ~/.namespace/ssh/, writes the SSH key and a host config for your Devbox. After running this, you can connect with:
scp, rsync, and any program that reads your SSH config.
Port Forwarding
Forward ports from your Devbox to localhost:local:remote syntax:
devbox port-forward main without --ports will forward all of them automatically.
IDEs
All IDE integrations connect over SSH. There are three ways to get started:- Dashboard: Open VS Code or Cursor directly from the Devbox dashboard.
- Automatic:
devbox open-ideconfigures SSH and opens your IDE in one step. Available for VS Code, Cursor, Zed, and others. - Manual: Run
devbox configure-sshfirst (see Configure SSH), then connect from your IDE using the SSH host. You may need to specify a working directory. Use/workspaces/{repo-name}if you created your Devbox with--checkout.
VS Code / Cursor
Open from the dashboard
- In the Devbox dashboard, click Open VSCode and choose VS Code (desktop) or Cursor (desktop)
Open from the CLI
Open your Devbox directly in VS Code or Cursor:- Configure local SSH access to your Devbox
- Ensure the Remote - SSH extension is installed (see the VS Code Remote-SSH documentation for more details)
- Open a new window connected to your Devbox
--flavor vscode-insiders, --flavor codium, --flavor positron, --flavor windsurf, or --flavor zed.
JetBrains
JetBrains IDEs support remote development through JetBrains Gateway or the built-in remote development features in IDEs like IntelliJ IDEA, GoLand, PyCharm, and WebStorm. See the JetBrains remote development documentation for more details.- Configure SSH access. This writes the SSH key and proxy config so Gateway can connect without manual setup:
- Open JetBrains Gateway and select SSH Connection
- Create a new connection with the host
main.devbox.namespaceand usernamedevbox - Select the IDE and project directory on the remote host