@@ -4,12 +4,13 @@ description:
4
4
Learn how to connect your favorite editors and IDEs to your remote workspace.
5
5
---
6
6
7
- There are four primary ways you can connect an IDE to your Coder workspace:
7
+ There are five primary ways you can connect an IDE to your Coder workspace:
8
8
9
- 1 . [ VS Code remote SSH] ( #vs-code-remote-ssh ) with local VS Code
10
- 1 . [ VS Code in the browser] ( #vs-code-in-the-browser ) with code-server
11
- 1 . [ JetBrains in the browser] ( # #jetbrains-ides-in-the-browser) with JetBrains
9
+ 1 . [ VS Code remote SSH] ( editors.md #vs-code-remote-ssh) with local VS Code
10
+ 1 . [ VS Code in the browser] ( editors.md #vs-code-in-the-browser) with code-server
11
+ 1 . [ JetBrains in the browser] ( editors.md #jetbrains-ides-in-the-browser) with JetBrains
12
12
Projector
13
+ 1 . [ JetBrains' Code With Me] ( editors.md#code-with-me )
13
14
1 . _ Any_ local editor with
14
15
[ 1-way file synchronization] ( ../cli/file-sync.md#one-way-file-sync ) or
15
16
[ 2-way file synchronization over SSH] ( ../cli/file-sync.md#two-way-file-sync )
@@ -83,3 +84,97 @@ workspace with the following resources at a minimum:
83
84
- Popup windows are missing titles and window controls
84
85
- Some theme-based plugins can cause the IDE to render incorrectly
85
86
- Some minor rendering artifacts occur during regular usage
87
+
88
+ ## Code With Me
89
+
90
+ [ JetBrains' Code With Me] ( https://www.jetbrains.com/code-with-me/ ) allows you to
91
+ collaborate with others in real-time on your project and enables pair
92
+ programming.
93
+
94
+ > You must have a [ JetBrains IDE
95
+ installed] ( ../admin/workspace-management/installing-jetbrains.md ) onto your
96
+ [ image] ( ../images/index.md ) to use Code With Me.
97
+
98
+ ### Getting started
99
+
100
+ To set up a Code With Me session:
101
+
102
+ 1 . The host creates a session and shares the information needed to join the
103
+ session with other participants.
104
+ 1 . The participants use the information provided by the host to join the session
105
+ and request access.
106
+ 1 . The host accepts the participants' request to join the session created
107
+ by the host.
108
+
109
+ #### Step 1: Start and host a session
110
+
111
+ To create and host a Code With Me session:
112
+
113
+ 1 . Log in to Coder.
114
+
115
+ 1 . Under ** Applications** , launch the JetBrains IDE (e.g., GoLand) of your
116
+ choice.
117
+
118
+ ![ Launch IDE] ( ../assets/workspaces/code-with-me-1.png )
119
+
120
+ 1 . Click the ** Code With Me** icon at the top of your IDE.
121
+
122
+ ![ Code With Me icon] ( ../assets/workspaces/code-with-me-2.png )
123
+
124
+ 1 . Select ** Enable Access and Copy Invitation Link...** .
125
+
126
+ ![ Enable access and copy link] ( ../assets/workspaces/code-with-me-3.png )
127
+
128
+ 1 . Confirm and accept the Terms of Use.
129
+
130
+ 1 . Set the permissions for new guests to ** Full access** and uncheck the
131
+ ** Automatically start voice call** feature. Click ** Enable Access** .
132
+
133
+ ![ Set permissions] ( ../assets/workspaces/code-with-me-4.png )
134
+
135
+ 1 . Once you've enabled access, JetBrains copies the link you must share with
136
+ participants to your clipboard. Send this link to those with whom you'd like
137
+ to collaborate.
138
+
139
+ You can recopy this link at any time by clicking the ** Code With Me icon**
140
+ and choosing ** Copy Invitation Link...** .
141
+
142
+ ![ Link confirmation] ( ../assets/workspaces/code-with-me-5.png )
143
+
144
+ #### Step 2: Request to join the session
145
+
146
+ If you've received a link to join a Code With Me session as a participant:
147
+
148
+ 1 . Copy the Code With Me session link that you were provided, and paste it into
149
+ your web browser. You'll be directed to a webpage with further instructions.
150
+
151
+ 1 . On the instructions page to which you were directed, copy the code snippet
152
+ and run it in the terminal.
153
+
154
+ ![ Run join command in terminal] ( ../assets/workspaces/code-with-me-6.png )
155
+
156
+ 1 . Confirm and accept the User Agreement.
157
+
158
+ 1 . You'll be shown a ** security code** . Verify with the host of your session
159
+ that they see the same code.
160
+
161
+ ![ Security code verification] ( ../assets/workspaces/code-with-me-7.png )
162
+
163
+ 1 . Wait for your host to accept your request to join; when they do, your
164
+ JetBrains IDE will launch automatically.
165
+
166
+ ![ New JetBrains IDE] ( ../assets/workspaces/code-with-me-8.png )
167
+
168
+ #### Step 3: Accept the request to the join
169
+
170
+ If you're the host of the session, you'll see a request that the other
171
+ participant wants to join your project, the permissions you've
172
+ granted to the other user, and a security code.
173
+
174
+ ![ Security code verification for host] ( ../assets/workspaces/code-with-me-9.png )
175
+
176
+ Verify that the security code you see matches the one shown to your
177
+ participants. If they do, click ** Accept** to proceed.
178
+
179
+ At this point, you'll be able to share your project and work with your partner
180
+ in real-time.
0 commit comments