Working collaboratively in a codespace

You can work collaboratively with other people in a codespace by using Visual Studio Live Share.

In this article

Visual Studio Live Share lets you collaboratively edit and debug with others in real time, within a codespace. You can securely share your current codespace, or access a codespace created by someone else.

You can start a Live Share session either within the VS Code web client in your browser, or within the VS Code desktop application.

For more information about Live Share, see "What is Visual Studio Live Share?" in the Visual Studio documentation.

Sharing your codespace with someone else

  1. In the Activity Bar, click the Extensions icon.

  2. In the search box, type Live Share.

    Screenshot of the "Extensions: Marketplace" side bar with "live share" entered in the search box. "Live Share" is the first in the list of extensions.

  3. If the Install button is displayed beside the extension, click it to install the extension in the codespace.

  4. If the extension is shown grayed out in the list, right-click it and click Enable.

    Screenshot of the "Enable" right-click menu option.

  5. In the Activity Bar, click the Live Share icon.

    Screenshot of the Activity Bar. The Live Share icon (an arrow above a circle) is highlighted with a dark orange outline.

  6. Click Share.

    A "toast" notification message is displayed at the bottom right corner of VS Code, telling you that a link to your codespace has been copied to the clipboard. You can click Make read-only if you want to prevent guests from making changes to the files you share with them.

    Screenshot of a popup message: "Invitation link copied to clipboard!" There are three buttons: "Make read-only," "More info," and "Copy again."

  7. Send the link in your clipboard to anyone you want to join you in your Live Share session.

    Important

    Given the level of access Live Share sessions can provide to guests, you should only share with people you trust, and you should think through the implications of what you are sharing. For more information, see "Security features of Live Share" in the Visual Studio documentation.

Stopping a Live Share session

To stop sharing your codespace, click the stop icon in the Live Share panel.

Screenshot of the stop icon to the right of "Session Details" in the "Live Share" side bar. The icon is a circle with a diagonal line through it.

If you, as the person who started the Live Share session, close the codespace the sharing session ends, even if the codespace remains active on the remote host.

The idle timeout, which automatically stops a codespace after a period of inactivity, only applies to the person who started the codespace. It does not apply to people who are working on the codespace via Live Share. The codespace may therefore time out while collaborators are using the codespace if the person who started the codespace remains inactive for the configured period of time. For more information, see "Setting your timeout period for GitHub Codespaces."

Working collaboratively in someone else's codespace

If you want to work with someone within a codespace they've created, ask them to set up a Live Share session and send you a link, as described above.