Getting started with Code With Me
With PyCharm, you can use the Code With Me plugin that enables you to share your locally running project with anyone.
You can use Code With Me for real time collaboration, editing code, sharing a server, and running a debugging session.
A Code With Me shared session involves the interaction between a host and one or more guests.
You can start a session with one of the following basic scenarios:
You can do pair-programming, in this case you share your IDE with a single participant and either use the Full sync mode, or follow each other and collaborate on different parts of code. Unlike classic pair-programming where developers share a single screen and a keyboard, you can work independently and achieve the goal faster.
You can have a teacher-students scenario where you have many participants who follow you. Let's say you need to explain a problem and show your team members different parts of your project. You can achieve that with the Force Others to Follow You mode.
You can do simultaneous multi editing of your code with other participants. In this case, participants can quickly change the code and even work on other files of the project at the same time. However, there is a limitation on how many participants can actively type together. The limit is 5, and if it's reached, PyCharm will display a popup suggesting to wait. Additionally, it might slow down the performance.
You can watch a short video tutorial on how to start working with Code With Me.
Get started as a host
You can create a link to invite other participants to collaborate on your code using your computer as the host. You can also start a debugging session, share its state and actions.
Create a session
Install and enable the Code With Me plugin.
On the main toolbar, click
.Alternatively, from the main menu, select .
In the list that opens, click Enable Access and Copy Invitation Link.
In the Code With Me: Enable Access and Start Session dialog, configure the access permissions for your guests and click Enable Access.
PyCharm creates a link that you can send to guests you want to invite to collaborate.
Send the link to guests. When a guest clicks the link, PyCharm displays a popup suggesting either to accept or decline the guest.
Click Accept. The guest joins your session and you can start collaborating. You will see an additional caret at your editor and an icon on the main toolbar indicating the active guest.
Terminate an active session
On the main toolbar, click the Code With Me icon (
).From the list that opens, select Turn Access Off and Disconnect All.
PyCharm terminates the session and disables all the guests. The link also gets disabled, and you need to create a new one to start another session.
Join another IDE as a participant
On the main toolbar, click
and choose Join Another IDE as Participant.
In the dialog that opens, add the received link and click OK. After you are accepted, you can join the shared session on another IDE.
Permissions
You as a host can configure what new guests may or may not access on you machine. For example, specify whether the guests can edit files, use the terminal, and execute code. You can also enable or disable the voice call option. The permissions can be configured for the whole session or for specific guests in the session.
Add permissions
On the main toolbar, click
and select Permissions and Security.When you create a session, the dialog with permissions options is opened automatically.
In the Code With Me: Enable Access and Start Session dialog, specify the following options:
Read-only: select this permission for guests to have a view-only access for files, terminal, and run actions.
Edit files: select this permission if you want your guests to only edit files, but not to access the terminal, or execute code.
You can exclude some files from accessing.
Click Manage hidden files under the Files field and in the Excluded Files dialog add files that you want to exclude from access and click OK.
Full access: select this permission to give your guests full access to all files, terminal, and run actions on your machine.
Custom: select this permission to customize access for guests to files, terminal, and run actions.
The Automatically start voice call option is enabled by default, disable it to deactivate voice calls in the session.
After you configured permissions, click Enable Access if you are in a process of creating a session. If you edit the permissions, click Apply.
Audio and video calls
When you collaborate with your peers, you can chat, use audio and video calls in the session.
Voice calls are available automatically when your create a session. However, you can disable them in the Edit Permissions dialog.
During the session, you can manage the voice calls.
Manage voice calls
On the main toolbar, control the camera and microphone by clicking the appropriate icons next to the Call option.
Click
to select the following options when you handle the calls:Leave call: use this option to disable the active call.
Enable camera: use this option to enable the camera.
Sound Settings: use this option to open the Code With Me tool window to manage your sound settings.
Open Call tool window: use this option to open the Code With Me tool window where you can manage the calls, sound, and use the session chat.
You can access the Code With Me tool window from the right side toolbar and use it to manage the call session as an alternative to the main toolbar. You can use chat, mute or unmute the microphone for your audio, manage the camera, and so on.
Get started as a guest
As a guest, you can follow a host during the created session and edit the code on which the host is working. You can also follow other session participants and get access to other parts of the project. Moreover, you can run and debug code on the host's machine, and work in the terminal tool window.
Accept an invitation
Click the received link.
The PyCharm lightweight client application will be downloaded at the run time.
You don't need to have PyCharm installed for the lightweight version to work.
Once it is installed, PyCharm displays a notification suggesting that you wait until the host accepts your request to join the session. When you are accepted, you are able to join the session. When the host’s project gets opened, you will see the active file in the editor.
At this point, you can customize the guest IDE to make your working process more convenient. You can change themes, view modes, and so on. The changes you make will only affect your guest IDE.
Leave a session
On the main toolbar, click
.From the list that opens, select Disconnect and Close Project.
The session is terminated and the Code With Me welcome screen is displayed. You can quickly return to the same session without any accepting process from the host using the same link.
Guest Code With Me setup locations
After you set up your work with Code With Me as a guest, you can check the following locations to see where the Code With Me distribution, logs, settings, and caches are located in your file system:
The Code With Me logs
~/Library/Logs/JetBrains/CodeWithMeGuest<plugin_version>%LOCALAPPDATA%\Logs\JetBrains\CodeWithMeGuest<plugin_version>~/.local/share/Logs/JetBrains/CodeWithMeGuest<plugin_version>The Code With Me caches
~/Library/Caches/JetBrains/CodeWithMeGuest<plugin_version>%LOCALAPPDATA%\Caches\JetBrains\CodeWithMeGuest<plugin_version>~/.local/share/Caches/JetBrains/CodeWithMeGuest<plugin_version>The Code With Me settings
~/Library/Application Support/JetBrains/CodeWithMeGuest<plugin_version>%LOCALAPPDATA%\Application Support\JetBrains\CodeWithMeGuest<plugin_version>~/.local/share/Application Support/JetBrains/CodeWithMeGuest<plugin_version>The Code With Me distributions and JetBrains runtime
~/Library/Caches/JetBrains/CodeWithMeClientDist%LOCALAPPDATA%\Caches\JetBrains\CodeWithMeGuestClientDist~/.local/share/Caches/JetBrains/CodeWithMeGuestClientDist
Work in a shared session
Once a shared session is created and all invited participants are accepted, the editor will contain the additional carets, the main toolbar will display the guests' icons, and the Code With Me tool window with the voice calls and the chat support becomes available.
In a shared session you can try different things such as move around the host's project independently, follow other participants, use the terminal tool window, make code edits, and so on.
Follow a participant
On the main toolbar, click
.From the list that opens, select the name of the participant you want to follow and select Follow.
Alternatively, on the main toolbar, click the needed participant's icon.
PyCharm places your caret at top of the participant's caret and places a frame around the editor with a small label displaying the name of the participant you are following.
Click Stop next to the name to unfollow the participant.
You can have more than one participant following other participants. When one of the followers decides to switch focus, it will not affect the main host. This is helpful in the teacher-students use case.
Force all others to follow you
On the main toolbar, click
.From the list that opens, select Force All to Follow You.
In this case, all the guest carets are placed on top of the host, and the focus will switch if the main caret is placed in the other files of the project.
At any time, a participant can stop following the main caret.
Jump to other participant
On the main toolbar, click
.From the list that opens, click a name of the participant and select Jump To.
Alternatively, on the main toolbar, right-click the participant's icon and select the same option.
The caret is placed on the line where the selected guest's caret is located. This might be helpful if you want to quickly locate a certain participant's caret.
Use the full sync mode
On the main toolbar, click
.From the list that opens, choose the name of a participant and select Full sync mode.
Alternatively, on the main toolbar, right-click the participant's icon and select the same option.
The caret is placed on top of the host's caret. PyCharm places a frame around both the host's editor and the guest's editor indicating that the full sync mode is on. The focus stays within the host caret even if the caret is placed in other parts of the project. This mode is usually used in the pair-programming scenario.
Terminate a shared session for a specific user
On the main toolbar, click
.From the list that opens, click a name of the participant for whom you want to terminate the session and select Kick user.
Alternatively, on the main toolbar right-click the participant's icon and select the same option.
PyCharm terminates the session for the selected participant and displays a notification on the guest's side. PyCharm closes the guest project and returns the guest to the Code With Me welcome screen.
If the guest wants to return to the shared session, they need to wait for the host permission to join.
Collect logs for the current guest
On the Code With Me welcome screen, click
next to Settings/Preferences.From the list that opens, select Collect Logs and Diagnostic Data.
PyCharm creates a log file on your local machine. The log file contains the current project's filenames, parts of code, and detailed information on guest's activity such as caret movements, typed symbols, invoked actions, files opened, file paths, and so on.
Collect all logs in the session
On the main toolbar, click
.In the list that opens, click
and select Submit Feedback Collect Logs and Submit an _Issue. 
In the dialog that opens, click OK to approve the data collection.
Once the log details are collected, they are automatically attached to the newly created issue in the YouTrack system.
Change the session name or URL of the session server
You can change the default name of the created session using the Code With Me settings.
You can also change the URL of a lobby server used for a session. It might be useful to switch to your own company's server for security purposes.
Access the Code With Me settings
Press Ctrl+Alt+S to open IDE settings and select Tools | Code With Me.
In the User name field enter a new name for your session. The session name will be changed on the restart. Clicking Use System Name will reset the session name to the default one.
You can change the default server URL, in the Lobby server URL field.
Click OK to save the changes.
How can I disable Code With Me?
Press Ctrl+Alt+S to open IDE settings and select Plugins.
Switch to the Installed tab and locate the Code With Me plugin in the list of the installed plugins.
Click
in the plugin description area and select Disable for All Projects, then click OK and restart PyCharm.