Skip to content

Commit 47c3d72

Browse files
authored
docs: add support for the coder remote extension (#5764)
1 parent 537b9df commit 47c3d72

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

docs/ides.md

+19-15
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The following desktop IDEs have been tested with Coder, though any IDE with SSH
44
support should work:
55

6-
- [VS Code Remote SSH](#vs-code-remote)
6+
- [Visual Studio Code](#visual-studio-code)
77
- [JetBrains with Gateway](./ides/gateway.md)
88
- IntelliJ IDEA
99
- CLion
@@ -16,6 +16,24 @@ support should work:
1616
- Note: These are [configured in the template](./ides/web-ides.md)
1717
- [Emacs](./ides/emacs-tramp.md)
1818

19+
## Visual Studio Code
20+
21+
Click `VS Code Desktop` in the dashboard to one-click enter a workspace. This automatically installs the [Coder Remote](https://github.com/coder/vscode-coder) extension, authenticates with Coder, and connects to the workspace.
22+
23+
![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true)
24+
25+
> The `VS Code Desktop` button can be hidden by enabling [Browser-only connections](./networking.md#browser-only-connections-enterprise).
26+
27+
### Manual Installation
28+
29+
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
30+
31+
```text
32+
ext install coder.coder-remote
33+
```
34+
35+
Alternatively, manually install the VSIX from the [latest release](https://github.com/coder/vscode-coder/releases/latest).
36+
1937
## SSH configuration
2038

2139
> Before proceeding, run `coder login <accessURL>` if you haven't already to
@@ -43,20 +61,6 @@ $ ssh coder.<workspaceName>
4361
Your workspace is now accessible via `ssh coder.<workspace_name>` (e.g.,
4462
`ssh coder.myEnv` if your workspace is named `myEnv`).
4563

46-
## VS Code Remote
47-
48-
Once you've configured SSH, you can work on projects from your local copy of VS
49-
Code, connected to your Coder workspace for compute, etc.
50-
51-
1. Open VS Code locally.
52-
53-
1. Install the [Remote -
54-
SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
55-
extension.
56-
57-
1. In VS Code's left-hand nav bar, click **Remote Explorer** and right-click on
58-
a workspace to connect.
59-
6064
## JetBrains Gateway
6165

6266
Gateway operates in a client-server model, using an SSH connection to the remote

0 commit comments

Comments
 (0)