www.jetbrains.com Open in urlscan Pro
18.66.97.27  Public Scan

Form analysis
0 forms found in the DOM

Text Content

IntelliJ IDEA
 
2023.1

Shortcuts: Windows
Get IntelliJ IDEA
Upcoming webinar
Remote Development in JetBrains IDEs With Google Cloud
Wednesday, March 29, 2023, 15:00-16:00 UTC

 * Getting started
 * IDE configuration
 * Project configuration
 * Write and edit source code
 * Compilation and building
 * Running
 * Debugging
 * Deployment
 * Testing
 * Analysis
 * Version control
 * Remote development
 * Integrated tools
 * Code With Me
 * FAQ about Code With Me
 * FAQ about Code With Me security
 * Code With Me security overview
 * JetBrains Client UI overview
 * Space
 * Database tools and SQL
 * Docker
 * Kubernetes
 * WSL
 * HTTP Client
 * Big Data Tools
 * Scientific tools
 * Vagrant
 * TextMate
 * Terminal
 * JShell Console
 * IDE scripting console
 * File Watchers
 * External tools
 * Manage tasks and contexts
 * Command-line interface
 * Swing.Designing GUI
 * Kotlin
 * Scala
 * Groovy
 * Android
 * JVM frameworks
 * Non-JVM technologies
 * Reference

 1. Integrated tools
 2. Code With Me


GETTING STARTED WITH CODE WITH ME

Last modified: 16 March 2023

Required for a Host: the latest IntelliJ IDEA version, the Code With Me enabled
plugin.

In IntelliJ IDEA 2021.1 and later, the Code With Me plugin is enabled by default
and doesn't require manual installation. In earlier versions, starting from
IntelliJ IDEA 2020.2.1, the Code With Me plugin downloaded and enabled.

Required for a Guest: an invitation link created by a host.

For the isolated on-premises server setup, refer to the Code With Me Enterprise
help.

With IntelliJ IDEA, 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. Check the following video for a quick
look at the 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, IntelliJ IDEA will display a popup suggesting to wait. Additionally,
   it might slow down the performance.

We prepared a short video tutorial on how to start working with Code With Me:




CODE WITH ME LICENSE

Code With Me offers different types of subscriptions that you can choose at the
JetBrains website.

If you have an active IntelliJ IDEA subscription or other IDE subscription
(except for DataGrip and Rider), you don't need a separate Code With Me license
as it's already included in the IDE's license.

If you have the IntelliJ IDEA Community edition, you have also Community version
of Code With Me license included in it.

Community and Ultimate editions of Code With Me license differ with the number
of guests that is allowed and time limits of the Code With Me session.


> NOTE
> 
> In case you have a Community edition, but want to add more guests to your
> session or make it longer, or your IntelliJ IDEA license is outdated, then you
> can purchase a separate Premium Code With Me license.

There are several scenarios in which you might need to activate the Code With Me
license manually:

 * You have an active IDE or an offline activation code and your license should
   be automatically applied to the Code With Me plugin. However, you if continue
   facing problems with the activation, activate the license explicitly.

 * You have a commercial Code With Me license, and your company uses the
   JetBrains floating license server (FLS). In this case, you can activate the
   license the same way you would activate the IntelliJ IDEA license.

 * Your company has commercial Code With Me licenses placed on internal lobby
   server. In this case, you activate the license manually additionally
   specifying the lobby server address.


ACTIVATE A PERSONAL LICENSE

 1. Get a license from the JetBrains website.

 2. From the main menu, select Help | Register.

 3. In the Licenses dialog, select Code With Me.

 4. From the options on the right, select Activate New License.

 5. Depending on what IDE you have, select JB Account.
    
    
    > NOTE
    > 
    > If you have an active IntelliJ IDEA license, you can use Activation code
    > for activation.

 6. Enter the needed information and click Activate.


ACTIVATE A COMMERCIAL LICENSE WITH FLOATING LICENSE SERVER

 1. Get a license server URL from an responsible person in your company.

 2. From the main menu, select Help | Register.

 3. In the Licenses dialog, select Code With Me.

 4. From the options on the right, select Activate New License.

 5. From the options on the right, select License server.

 6. Add the server address and click Activate.
    
    
    > NOTE
    > 
    > If you have a corporate license server with an IntelliJ IDEA license and
    > you are experiencing timeout problems during the Code With Me session,
    > your license server might be outdated (no plugins support). Contact your
    > system administrator in order to update the license server or contact the
    > JetBrains support (support-int@jetbrains.com).


MANAGE A COMMERCIAL LICENSE WITH A LOBBY SERVER

 1. Get a lobby server URL from a responsible person in your company.

 2. Press Ctrl+Alt+S to open the IDE settings and select Tools | Code With Me.

 3. In the Lobby server URL field specify the address of the lobby server you
    got from your system administrator and click OK to save the changes.


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

 1. Make sure that the Code With Me plugin is enabled.

 2. On the main toolbar, click .
    
    Alternatively, from the main menu, select Tools | Code With Me.

 3. In the list that opens, click Start Code With Me Session.

 4. In the Code With Me: Start Session dialog, configure the access permissions
    for your guests and click Start Session.
    
    IntelliJ IDEA creates a link that you can send to the guests you want to
    invite to collaborate. To copy the invitation link, click the Code With Me
    icon, and select Copy Session Link.

 5. Send the link to guests. When a guest clicks the link, IntelliJ IDEA
    displays a popup suggesting either to accept or decline the guest. On this
    step, you should verify the codes are equal for your guest and you.

 6. 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

 1. On the main toolbar, click the Code With Me icon ().

 2. From the list that opens, select End Session.
    
    IntelliJ IDEA 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.
    
    
    > NOTE
    > 
    > If you exit IntelliJ IDEA without terminating the session, the shared link
    > will be disabled.


JOIN ANOTHER IDE AS A PARTICIPANT

 1. On the main toolbar, click and choose Join Session….

 2. In the dialog that opens, add the received link and click OK. After you are
    accepted by the Host, you can join the shared session on the other IDE.


ACCESS THE HOST SETTINGS

 1. On the main toolbar, click Code With Me icon ().

 2. Click and from the list that opens, select Settings.


PERMISSIONS

You as a host can configure what new guests may or may not access on your
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.

At any time during the session, guests can request additonal permissions from
the host.


ADD PERMISSIONS

 1. On the main toolbar, click and select Permissions.
    
    When you create a session, the dialog with permissions options is opened
    automatically.

 2. In the Code With Me: 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. However, guests can still copy and
      paste code from the editor.
    
    * 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 Hidden 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.
      
      
      > NOTE
      > 
      > Even though full access is granted, some of the actions are not
      > implemented for guests.
    
    * Custom: select this permission to customize access for guests to files,
      terminal, and run actions. When you switch to Custom permissions, the
      options associated with them will repeat choices from the previously
      selected permissions. You can change them accordingly.

 3. The Start call option is enabled by default, disable it to deactivate voice
    calls in the session.

 4. After you configured permissions, click Start Session 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, video calls in
the session, enable screen sharing, and forward your port.

Voice calls, camera, and screen sharing become available automatically when you
create a session. However, you can disable them in the Edit Permissions dialog.
If later, during a session, you want to initiate a call, use the Start Call
option in the main toolbar under .

During the session, you can manage the voice calls.


MANAGE VOICE CALLS

 * On the main toolbar, control the camera, microphone, and your screen sharing
   by clicking the appropriate icons next to the Call option.

 * Click to select additional options when you handle the calls:
   
   * Leave Call: use this option to disable the active call.
   
   * End Call for Everyone: use this option to disable the active call for all
     participants at once.
     
     This option is available for the host of the session.
   
   * Show Call 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, share
your screen, and so on.


SHARE YOUR SCREEN WITH GUESTS

 1. Open the Code With Me tool window.

 2. On the bottom toolbar, click .
    
    Your screen gets shared with other participants in the session. If you want
    to stop the screen sharing, click the same icon again.

If you work on a web or database project, you can give access to a port on your
local machine to guests during a session.


> NOTE
> 
> Make sure you trust the guests with whom you share your port since guests
> might have access to system resources during port sharing.
> 
> If you need to disable the port forwarding, refer to the Disable port
> forwarding section.


FORWARD A PORT

 1. Click Code With Me to open the Code With Me tool window.

 2. In the Code With Me tool window, click the Port Forwarding tab.

 3. Click to add a port.

 4. In the Port Forwarding dialog add your port, select the protocol and click
    OK.
    
    On the guest side, the port is added to the Port Forwarding tab in the Code
    With Me tool window and guests can access it.


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 if you have
permissions to do so.


ACCEPT AN INVITATION

 1. Click the received link.

 2. The IntelliJ IDEA lightweight client application will be downloaded at the
    run time.
    
    You don't need to have IntelliJ IDEA installed for the lightweight version
    to work.

 3. Once it is installed, IntelliJ IDEA 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.
    
    For the detailed information about JetBrains Client UI, refer to JetBrains
    Client UI overview.


LEAVE A SESSION

 1. On the main toolbar, click .

 2. From the list that opens, select Leave Session.
    
    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:
   
   macOS
   Windows
   Linux
   
   
   ~/Library/Logs/JetBrains/JetBrainsClient<plugin_version>
   
   %LOCALAPPDATA%\JetBrains\JetBrainsClient<plugin_version>\log
   
   ~/.cache/JetBrains/JetBrainsClient<plugin_version>/log

 * The Code With Me caches:
   
   macOS
   Windows
   Linux
   
   
   ~/Library/Caches/JetBrains/JetBrainsClient<plugin_version>
   
   %LOCALAPPDATA%\JetBrains\JetBrainsClient<plugin_version>
   
   ~/.cache/JetBrains/JetBrainsClient<plugin_version>

 * The Code With Me settings:
   
   macOS
   Windows
   Linux
   
   
   ~/Library/Application\ Support/JetBrains/JetBrainsClient<plugin_version>
   
   %APPDATA%\Roaming\JetBrains\JetBrainsClient<plugin_version>
   
   ~/.config/JetBrains/JetBrainsClient<plugin_version>

 * The Code With Me distributions and JetBrains runtime:
   
   
   > NOTE
   > 
   > There are several scenarios, in which the distributions and runtime are
   > downloaded into 2 different folders: JetBrainsClientDist (downloads
   > JetBrains Client from JetBrains Gateway or IntelliJ IDEA) and
   > CodeWithMeClientDist (downloads JetBrains Client from a browser)
   
   macOS
   Windows
   Linux
   
   
   ~/Library/Caches/JetBrains/JetBrainsClientDist
   
   ~/Library/Caches/JetBrains/CodeWithMeClientDist
   
   %LOCALAPPDATA%\JetBrains\JetBrainsClientDist
   
   %LOCALAPPDATA%\JetBrains\CodeWithMeClientDist
   
   ~/.cache/JetBrains/JetBrainsClientDist
   
   ~/.cache/JetBrains/CodeWithMeClientDist


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, request additional permissions from a host and so on.


FOLLOW A PARTICIPANT

 1. On the main toolbar, click .

 2. 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.
    
    IntelliJ IDEA 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 always
    click Resume to follow the same participant once again.
    
    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

 1. On the main toolbar, click .

 2. From the list that opens, select Make Everyone 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

 1. On the main toolbar, click .

 2. 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 PAIR CODING MODE

 1. On the main toolbar, click .

 2. From the list that opens, choose the name of a participant and select Pair
    Coding 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. IntelliJ IDEA places a frame
    around both the host's editor and the guest's editor indicating that the
    pair-coding 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

 1. On the main toolbar, click .

 2. From the list that opens, click a name of the participant for whom you want
    to terminate the session and select Remove Guest.
    
    Alternatively, on the main toolbar right-click the participant's icon and
    select the same option.
    
    
    
    
    
    IntelliJ IDEA terminates the session for the selected participant and
    displays a notification on the guest's side. IntelliJ IDEA 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

 1. On the Code With Me welcome screen, click next to Settings.

 2. From the list that opens, select Collect Logs and Diagnostic Data.
    
    IntelliJ IDEA 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

 1. On the main toolbar, click .

 2. In the list that opens, click and select Submit an Issue.

 3. 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.


REQUEST PERMISSIONS

By default, you, as a guest, are given the Read-only permissions. That means you
can't edit files, add the code, or work in the terminal during the session.
IntelliJ IDEA displays a proper notification every time you try to something for
which you don't have permissions. You can click the link in the notification to
request additional permissions from the host.


REQUEST EDIT FILES PERMISSIONS

 1. Start editing a file. When a notification appears, click the Request to edit
    files link.
    
    As a result, the host receives a notification and can either grant the
    permissions or decline them.

 2. If the permissions are granted, a guest can edit files and the guest
    permissions are updated on the host side. The host can change permissions at
    any time during the session. From the host main menu, select a name of the
    guest and Permissions from the list of options and in the Edit Permissions
    dialog, update permissions accordingly.

In order to work with the terminal, run the application, or debug code, you
would need the full access permissions.


REQUEST FULL ACCESS PERMISSIONS

 1. When you try to access actions that require the full access permissions, the
    appropriate notification will appear. For example, the terminal access
    permission.
    
    Click the Request full access link.
    
    As a result, the host receives a notification and can either grant the
    permissions or decline them.

 2. If permissions are granted, a tab with the shared terminal is opened and a
    guest can use it. A host in this case has two terminal tabs: one private and
    the other one shared.
    
    The host can change permissions at any time during the session. From the
    host main menu, select a name of the guest and Permissions from the list of
    options and in the Edit Permissions dialog, update permissions accordingly.


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

 1. In the main menu, open Settings - Tools - Code With Me

 2. 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.
    
    For more information, refer to the Code With Me help.

 3. Click OK to save the changes.



Thanks for your feedback!

Was this page helpful?
YesNo
 * Getting started with Code With Me
 * Code With Me license
 * Get started as a host
 * Permissions
 * Audio and video calls
 * Get started as a guest
 * Work in a shared session
 * Change the session name or URL of the session server

Security modelFAQ about Code With Me
 * What's new
 * Issue tracker
 * Submit support request

Copyright © 2000–2023  JetBrains s.r.o.



Our website uses some cookies and records your IP address for the purposes of
accessibility, security, and managing your access to the telecommunication
network. You can disable data collection and cookies by changing your browser
settings, but it may affect how this website functions. Learn more.

With your consent, JetBrains may also use cookies and your IP address to collect
individual statistics and provide you with personalized offers and ads subject
to the Privacy Policy and the Terms of Use. JetBrains may use third-party
services for this purpose. You can adjust or withdraw your consent at any time
by visiting the Opt-Out page.

[A]ccept All[M]anage Settings