The following desktop IDEs have been tested with Coder, though any IDE with SSH support should work:
- Visual Studio Code
- JetBrains with Gateway
- IntelliJ IDEA
- CLion
- GoLand
- PyCharm
- Rider
- RubyMine
- WebStorm
- Web IDEs (code-server, JupyterLab, JetBrains Projector)
- Note: These are configured in the template
- Emacs
Click VS Code Desktop
in the dashboard to one-click enter a workspace. This automatically installs the Coder Remote extension, authenticates with Coder, and connects to the workspace.
You can set the default directory in which VS Code opens via the dir
argument on
the coder_agent
resource in your workspace template. See the Terraform documentation
for more details.
The
VS Code Desktop
button can be hidden by enabling Browser-only connections.
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
ext install coder.coder-remote
Alternatively, manually install the VSIX from the latest release.
Before proceeding, run
coder login <accessURL>
if you haven't already to authenticate the CLI with the web UI and your workspaces.
To access Coder via SSH, run the following in the terminal:
coder config-ssh
Run
coder config-ssh --dry-run
if you'd like to see the changes that will be made before proceeding.
Confirm that you want to continue by typing yes and pressing enter. If successful, you'll see the following message:
You should now be able to ssh into your workspace.
For example, try running:
$ ssh coder.<workspaceName>
Your workspace is now accessible via ssh coder.<workspace_name>
(e.g.,
ssh coder.myEnv
if your workspace is named myEnv
).
Gateway operates in a client-server model, using an SSH connection to the remote host to install and start the server.
Setting up Gateway also involves picking a project directory, so if you have not already done so, you may wish to open a terminal on your Coder workspace and check out a copy of the project you intend to work on.
After installing Gateway on your local system, follow these steps to create a Connection and connect to your Coder workspace.
Version | Status | Notes |
---|---|---|
2021.3.2 | Working | |
2022.1.4 | Working | Windows clients are unable to connect to Linux workspace |
2022.2 RC | Working | Version >= 222.3345.108 |
Web IDEs (code-server, JetBrains Projector, VNC, etc.) are defined in the template. See IDEs.
- Learn about Port Forwarding