Quickstart: Share your first project
Welcome to Visual Studio Live Share! Live Share enables you to collaboratively edit and debug with others in real time, regardless what programming languages you're using or app types you're building. It allows you to instantly and securely share your current project, and then as needed, share debugging sessions, terminal instances, localhost web apps, voice calls, and more!
Ready to get going? Team collaboration should be so quick and natural, that it becomes harder not to do it! For this reason, Visual Studio Live Share makes it simple to get started, so that you can seamlessly begin sharing your work and ideas.
Did you know you can join your own collaboration session? This allows you to try Live Share on your own or to spin up an instance of Visual Studio or VS Code and connect to it remotely! You can even use the same identity in both instances. Check it out!
Just follow these steps to start sharing.
1. Install the extension
Installing the extension is easy. Just follow these steps:
Visual Studio Code (1.22.0+)
1. Install Visual Studio Code for Windows (7, 8.1, or 10), macOS (Sierra+), 64-bit Linux (details)
2. Download and install the Visual Studio Live Share extension from the marketplace.
3. Reload and wait for dependencies to download and install (see status bar).
4. Linux: If prompted to install libraries, click install, enter password, restart VS Code when done.
Visual Studio 2019
1. Install Visual Studio 2019.
2. Install a supported workload. (e.g. ASP.NET, .NET Core, C++, Python, and/or Node.js)
3. Visual Studio Live Share is installed by default with these workloads.
Visual Studio 2017 15.6 or higher
1. Install the latest version of Visual Studio 2017 (15.6+) on Windows (7, 8.1, or 10).
2. Install a supported workload. (e.g. ASP.NET, .NET Core, C++, and/or Node.js)
3. Download and install the Visual Studio Live Share extension from the marketplace.
2. Sign in
After installing the Live Share extension, restarting, and waiting for dependencies to finish installing (VS Code), you'll want to sign in to let other participants know who you are. Simply click the "Live Share" status bar item (VS Code) / "Sign in" button (VS) to get started.
In VS Code, your browser will launch while a notification will appear launch asking you to sign in. Complete the sign in process in your browser, then simply close the browser when done.
Linux users: You may be prompted to enter a user code if you are using an older version of Live Share (v0.3.295 or below). Update to the latest version of the extension or click the "Having trouble?" link after sign in to see the code. See here for details.
In Visual Studio, Live Share automatically uses your personalization account. As a result, you can simply sign in as you would normally. However, if you prefer to use a different sign-in than your Visual Studio personalization account, go to Tools > Options > Live Share > User account and select different credentials.
See troubleshooting if you are still hitting problems.
3. Open a folder, project, or solution
Use your normal workflow to open a folder, project, or solution that you would like to share in Visual Studio or Visual Studio Code.
4. [Optional] Update hidden or excluded files
By default, Live Share hides any files/folders referenced in .gitignore files in your shared folders from guests. Hiding a file prevents it from appearing in the guest's file tree. Excluding a file applies a stricter rule that prevents Live Share from opening it for the guest in situations like go to definition or if you step into the file while debugging or being "followed". If you want to hide/exclude different files, a .vsls.json file can be added to your project with these settings. See controlling file access and visibility for details.
5. Start a collaboration session
Next, simply click "Live Share" within your tool and an invite link is automatically copied to your clipboard.
You may be asked by your desktop firewall software to allow the Live Share agent to open a port the first time you share. Accepting this is entirely optional but enables a secured "direct mode" to improve performance when the person you are working with is on the same network as you are. See change the connection mode for details.
6. [Optional] Enable read-only mode
Once you start your collaboration session, you can set the session to be read-only to prevent guests from making edits to the code being shared.
After sharing, you will get a notification that the invite link has been copied to your clipboard. You can then select the option to make the session read-only.
In VS Code, you can also start a read-only session from the Live Share viewlet tab.
7. Send someone the invite link
Send the link over e-mail, Slack, Skype, etc. to those you want to invite. Opening the link in a browser allows them to join the collaboration session that is sharing the contents of the folder, project, or solution that you opened. Note that, given the level of access Live Share sessions can provide to guests, you should only share with people you trust and think through the implications of what you are sharing.
Security Tip: Want to understand the security implications of some of Live Share's features? Check out the security article.
If the guest you invited has questions, the Quickstart: Join your first session article provides some more information on getting up and running as a guest.
8. [Optional] Approve the guest
By default, guests automatically join your collaboration session and you are notified when they're ready to work with you.
You can opt to require an explicit "approval" for anyone joining instead. If you have this setting turned on, a notification prompts you to approve the guest when they try to join your session.
See requiring guest approval for details on how to turn this feature on.
That's it! Here are a few things to try out once a guest has joined you:
- Move around to different files in the project independently and make some edits
- Follow the guest and observe as they scroll, make edits, and navigate to different files
- Start up a co-debugging session with them
- Share a server so you can check out something like a web app running on their machine
- Share a terminal and run some commands
Check out these additional articles for more information.
- Quickstart: Join your first collaboration session
- How-to: Collaborate using Visual Studio Code
- How-to: Collaborate using Visual Studio