Skip to content

Commit ab99da5

Browse files
author
Katie Horne
authored
chore: add instructions for using Code With Me (#429)
1 parent 4d33344 commit ab99da5

11 files changed

+102
-0
lines changed

assets/workspaces/code-with-me-1.png

46.4 KB
Loading

assets/workspaces/code-with-me-2.png

110 KB
Loading

assets/workspaces/code-with-me-3.png

56.9 KB
Loading

assets/workspaces/code-with-me-4.png

62 KB
Loading

assets/workspaces/code-with-me-5.png

37.1 KB
Loading

assets/workspaces/code-with-me-6.png

119 KB
Loading

assets/workspaces/code-with-me-7.png

48 KB
Loading

assets/workspaces/code-with-me-8.png

47.3 KB
Loading

assets/workspaces/code-with-me-9.png

69.7 KB
Loading

manifest.json

+3
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@
3030
{
3131
"path": "./workspaces/autostart.md"
3232
},
33+
{
34+
"path": "./workspaces/code-with-me.md"
35+
},
3336
{
3437
"path": "./workspaces/devurls.md"
3538
},

workspaces/code-with-me.md

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: Code With Me
3+
description: Learn how to use JetBrains' Code With Me feature in Coder.
4+
---
5+
6+
This article will show you how to set up a Code With Me session when running a
7+
JetBrains IDE in Coder. JetBrains' [Code With
8+
Me](https://www.jetbrains.com/code-with-me/) allows you to collaborate with
9+
others in real-time on your project and enables pair programming.
10+
11+
## Prerequisites
12+
13+
You must have a [JetBrains IDE
14+
installed](../admin/workspace-management/installing-jetbrains.md) onto your
15+
[image](../images/index.md).
16+
17+
## Getting started
18+
19+
To set up a Code With Me session:
20+
21+
1. The host creates a session and shares the information needed to join the
22+
session with other participants.
23+
1. The participants use the information provided by the host to join the session
24+
and request access.
25+
1. The host accepts the participants' request to join the session created
26+
by the host.
27+
28+
### Step 1: Start and host a session
29+
30+
To create and host a Code With Me session:
31+
32+
1. Log in to Coder.
33+
34+
1. Under **Applications**, launch the JetBrains IDE (e.g., GoLand) of your
35+
choice.
36+
37+
![Launch IDE](../assets/workspaces/code-with-me-1.png)
38+
39+
1. Click the **Code With Me** icon at the top of your IDE.
40+
41+
![Code With Me icon](../assets/workspaces/code-with-me-2.png)
42+
43+
1. Select **Enable Access and Copy Invitation Link...**.
44+
45+
![Enable access and copy link](../assets/workspaces/code-with-me-3.png)
46+
47+
1. Confirm and accept the Terms of Use.
48+
49+
1. Set the permissions for new guests to **Full access** and uncheck the
50+
**Automatically start voice call** feature. Click **Enable Access**.
51+
52+
![Set permissions](../assets/workspaces/code-with-me-4.png)
53+
54+
1. Once you've enabled access, JetBrains copies the link you must share with
55+
participants to your clipboard. Send this link to those with whom you'd like
56+
to collaborate.
57+
58+
You can recopy this link at any time by clicking the **Code With Me icon**
59+
and choosing **Copy Invitation Link...**.
60+
61+
![Link confirmation](../assets/workspaces/code-with-me-5.png)
62+
63+
### Step 2: Request to join the session
64+
65+
If you've received a link to join a Code With Me session as a participant:
66+
67+
1. Copy the Code With Me session link that you were provided, and paste it into
68+
your web browser. You'll be directed to a webpage with further instructions.
69+
70+
1. On the instructions page to which you were directed, copy the code snippet
71+
and run it in the terminal.
72+
73+
![Run join command in terminal](../assets/workspaces/code-with-me-6.png)
74+
75+
1. Confirm and accept the User Agreement.
76+
77+
1. You'll be shown a **security code**. Verify with the host of your session
78+
that they see the same code.
79+
80+
![Security code verification](../assets/workspaces/code-with-me-7.png)
81+
82+
1. Wait for your host to accept your request to join; when they do, your
83+
JetBrains IDE will launch automatically.
84+
85+
![New JetBrains IDE](../assets/workspaces/code-with-me-8.png)
86+
87+
### Step 3: Accept the request to the join
88+
89+
If you're the host of the session, you'll see a request that the other
90+
participant wants to join your project, the permissions you've
91+
granted to the other user, and a security code.
92+
93+
![Security code verification for host](../assets/workspaces/code-with-me-9.png)
94+
95+
Verify that the security code you see matches the one shown to your
96+
participants. If they do, click **Accept** to proceed.
97+
98+
At this point, you'll be able to share your project and work with your partner
99+
in real-time.

0 commit comments

Comments
 (0)