Wondering how to use Live Share?

User guide

Learn how to use Live Share

Get your team started with collaborative editing and debugging in just a few simple steps:

Share

Click the Live Share button in the upper right hand corner, which will share your project, and copy a unique session URL to your clipboard.

You'll be asked to sign in the first time you share (using a GitHub or Microsoft account), which allows others to identify you when collaborating.

On Windows, you may be asked to allow Live Share to open a firewall port, in order to enable peer-to-peer connections.

Edit

Now that you are in a collaboration session, you can move your cursor around, edit, and highlight text. You can see other participants doing the same.

You can access all Live Share functionality by clicking on the "Joined" drop down menu or the participant icons on the top right.

From here, you can see participants in the session as well as servers and terminals that have been shared.

  • Move to other files in the code. You are able to navigate around the project.

  • Focus a participant, and call attention to a part of the code that you are looking at.

  • Follow any participant in a session by clicking their name on the top right.

Debug

Work through an issue/question/task with your team in real-time using the many collaborative debugging features.

  • 🐞 Debug together, when in a debugging session, set breakpoints and step together in real time.

  • ☁️ View shared servers, by clicking on the "Joined" drop down menu to view the host’s locally running web app, databases, etc.

  • 💻 Show shared terminals, by clicking on the "Joined" drop down menu to view or run commands in the host’s terminal.

Invite

Send the session URL to the developers you'd like to collaborate with (up to 5!), using e-mail, Skype, Slack, etc. View security info to understand more about secure sharing.

Collaboration session URL:

${this.joinUri}

Want to evaluate VS Live Share but don't have anyone to collaborate with? No problem! You can actually share with yourself from another instance of VS. Click here to try it out.

Collaborate

That's it! Once an invited "guest" joins, you'll get a notification, and will see their cursor appear in your currently opened file. All guests will start out following you, which means that as you scroll or navigate between files, they will track those actions as well. This makes it easy to orient them with the issue/question/task you're about to start collaborating on.

Additionally, to get the most out of Live Share, here are a few things to try out:

  • Move your cursor, edit and highlight text, and watch guests do the same
  • Follow a guest, and have them scroll and/or navigate to other files
  • Share a debugging session, by pressing F5, and then stepping together in real time
  • Share a server, so guests can view a locally running web app, database, etc.
  • Share a terminal and run commands collaboratively

If you run into any problems, see our troubleshooting documentation for potential workarounds. Additionally, if you have any questions and/or feedback, please don't hesitate to reach out to the team using the Send Feedback options in the Help menu.