Skip to content

Commit e72e289

Browse files
author
Katie Horne
committed
chore: add IDEs page
1 parent d48ab96 commit e72e289

File tree

2 files changed

+62
-30
lines changed

2 files changed

+62
-30
lines changed

docs/ides.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# IDEs
2+
3+
The following desktop IDEs have been tested with Coder, though any IDE with SSH
4+
support should work:
5+
6+
- VS Code (with [Remote -
7+
SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
8+
extension)
9+
- JetBrains (with
10+
[Gateway](https://www.jetbrains.com/help/idea/remote-development-a.html#launch_gateway)
11+
installed)
12+
- IntelliJ IDEA
13+
- CLion
14+
- GoLand
15+
- PyCharm
16+
- Rider
17+
- RubyMine
18+
- WebStorm
19+
20+
## SSH configuration
21+
22+
To access Coder via SSH, run the following in the terminal:
23+
24+
```console
25+
coder config-ssh
26+
```
27+
28+
> Run `coder config-ssh --diff` if you'd like to see the changes that will be
29+
> made before proceeding.
30+
31+
Confirm that you would like to continue by typing **yes** and pressing enter. If
32+
successful, you'll see the following message:
33+
34+
```console
35+
You should now be able to ssh into your workspace.
36+
For example, try running:
37+
38+
$ ssh coder.<workspaceName>
39+
```
40+
41+
Your workspace is now accessible via `ssh coder.<workspace_name>` (e.g.,
42+
`ssh coder.myEnv` if your workspace is named `myEnv`).
43+
44+
## VS Code
45+
46+
Once you've configured SSH, you can work on projects from your local copy of VS
47+
Code, connected to your Coder workspace for compute, etc.
48+
49+
1. Open VS Code locally.
50+
51+
1. Install the [Remote - SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
52+
extension.
53+
54+
1. In VS Code's left-hand nav bar, click **Remote Explorer** and right-click on
55+
a workspace to connect.

docs/workspaces.md

Lines changed: 7 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -10,40 +10,15 @@ templates](./templates.md):
1010

1111
```sh
1212
# create a workspace from the template; specify any variables
13-
coder create <workspace-name>
13+
create --template="<templateName>" <workspaceName>
1414

1515
# show the resources behind the workspace and how to connect
1616
coder show <workspace-name>
1717
```
1818

19-
## Connect with SSH
19+
## IDEs
2020

21-
Once you've added your workspaces to your SSH hosts, you can connect from any
22-
IDE with remote development support:
23-
24-
```sh
25-
coder config-ssh
26-
coder ssh <workspaceName>
27-
```
28-
29-
## Editors and IDEs
30-
31-
The following desktop IDEs have been tested with Coder, though any IDE with SSH
32-
support should work!
33-
34-
- VS Code (with [Remote -
35-
SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
36-
extension)
37-
- JetBrains (with
38-
[Gateway](https://www.jetbrains.com/help/idea/remote-development-a.html#launch_gateway)
39-
installed)
40-
- IntelliJ IDEA
41-
- CLion
42-
- GoLand
43-
- PyCharm
44-
- Rider
45-
- RubyMine
46-
- WebStorm
21+
Coder [supports multiple IDEs](ides.md) for use with your workspaces.
4722

4823
## Workspace lifecycle
4924

@@ -67,8 +42,10 @@ When a workspace is deleted, all of the workspace's resources are deleted.
6742

6843
## Dotfiles
6944

70-
Users can install configuration from a personal [dotfiles repository](https://dotfiles.github.io) with the `coder dotfiles <repo>`
71-
command in their workspace. Templates can also prompt users for their dotfiles repo [(example)](../examples/templates/docker-with-dotfiles/README.md#how-it-works).
45+
Users can install configuration from a personal [dotfiles
46+
repository](https://dotfiles.github.io) with the `coder dotfiles <repo>` command
47+
in their workspace. Templates can also prompt users for their dotfiles repo
48+
[(example)](../examples/templates/docker-with-dotfiles/README.md#how-it-works).
7249

7350
## Updating workspaces
7451

0 commit comments

Comments
 (0)