Using C++ and WSL in VS Code
AI agents: See llms.txt for documentation discovery and navigation. Documentation articles are also available as Markdown by appending .md to the article URL. Join VS Code at Microsoft Ignite or catch the sessions online. A year of VS Code, wrapped. Explore the highlights. Using C++ and WSL in VS Code View as Markdown Ask in VS Code Ask in VS Code Insiders In this tutorial, you will configure Visual Studio Code to use the GCC C++ compiler (g++) and GDB debugger on Ubuntu in the Windows Subsystem for Linux (WSL).
GCC stands for GNU Compiler Collection; GDB is the GNU debugger. WSL is a Linux environment within Windows that runs directly on the machine hardware, not in a virtual machine. Note : Much of this tutorial is applicable to working with C++ and VS Code directly on a Linux machine. Visual Studio Code has support for working directly in WSL with the WSL extension . We recommend this mode of WSL development , where all your source code files, in addition to the compiler, are hosted on the Linux distro.
For more background, see VS Code Remote Development . After completing this tutorial, you will be ready to create and configure your own C++ project, and to explore the VS Code documentation for further information about its many features. This tutorial does not teach you about GCC or Linux or the C++ language. For those subjects, there are many good resources available on the Web. If you have any problems, feel free to file an issue for this tutorial in the VS Code documentation repository .
Prerequisites To successfully complete this tutorial, you must do the following steps: Install Visual Studio Code . Install the WSL extension . Install Windows Subsystem for Linux and then use the links on that same page to install your Linux distribution of choice. This tutorial uses Ubuntu. During installation, remember your Linux user password because you'll need it to install additional software. Set up your Linux environment Open the Bash shell for WSL.
If you installed an Ubuntu distro, type "Ubuntu" in the Windows search box and then click on it in the result list. For Debian, type "Debian", and so on. The shell appears with a command prompt that by default consists of your user name and computer name, and puts you in your home directory. For Ubuntu it looks like this: Make a directory called projects and then subdirectory under that called helloworld : mkdir projects cd projects mkdir helloworld Although you will be using VS Code to edit your source code, you'll be compiling the source code on Linux using the g++ compiler.
You'll also debug on Linux using GDB. These tools are not installed by default on Ubuntu, so you have to install them. Fortunately, that task is quite easy! From the WSL command prompt, first run apt-get update to update the Ubuntu package lists. An out-of-date distro can sometimes interfere with attempts to install new packages. sudo apt-get update If you like, you can run sudo apt-get update && sudo apt-get dist-upgrade to also download the latest versions of the system packages, but this can take significantly longer depending on your connection speed.
From the command prompt, install the GNU compiler tools and the GDB debugger by typing: sudo apt-get install build-essential gdb Verify that the install succeeded by locating g++ and gdb. If the filenames are not returned from the whereis command, try running the update command again. whereis g++ whereis gdb Note : The setup steps for installing the g++ compiler and GDB debugger apply if you are working directly on a Linux machine rather than in WSL.
Running VS Code in your helloworld project, as well as the editing, building, and debugging steps are the same. Run VS Code in WSL Navigate to your helloworld project folder and launch VS Code from the WSL terminal with code . : cd $HOME /projects/helloworld code . You'll see a message about "Installing VS Code Server". VS Code is downloading and installing a small server on the Linux side that the desktop VS Code will then talk to.
VS Code will then start and open the helloWorld folder. The File Explorer shows that VS Code is now running in the context of WSL with the title bar WSL: Ubuntu . You can also tell the remote context from the Status bar. If you click on the Remote Status bar item, you will see a dropdown of Remote commands appropriate for the session. For example, if you want to end your session running in WSL, you can select the Close Remote Connection command from the dropdown.
Running code . from your WSL command prompt will restart VS Code running in WSL. The code . command opened VS Code in the current working folder, which becomes your "workspace". As you go through the tutorial, you will see three files created in a .vscode folder in the workspace: c_cpp_properties.json (compiler path and IntelliSense settings) tasks.json (build instructions) launch.json (debugger settings) Add a source code file In the File Explorer title bar, select the New File button and name the file helloworld.cpp .
Install the C/C++ extension Once you create the file and VS Code detects it is a C++ language file, you may be prompted to install the Microsoft C/C++ extension if you don't already have it installed. Choose Install and then Reload Required when the button is displayed in the Extensions view to complete installing the C/C++ extension. If you already have C/C++ language extensions installed locally in VS Code, you'll need to go to the Extensions view ( ⇧⌘X (Windows, Linux Ctrl+Shift+X ) ) and install those extensions into WSL.
Locally installed extensions can be installed into WSL by selecting the Install in WSL button and then Reload Required . Add hello world source code Now paste in this source code: #include <iostream> #include <vector> #include <string> using namespace std ; int main () { vector<string> msg { "Hello" , "C++" , "World" , "from" , "VS Code" , "and the C++ extension!" }; for ( const string& word : msg) { cout << word << " " ; } cout << endl; } Now press ⌘S (Windows, Linux Ctrl+S ) to save the file.
Notice how the file you just added appears in the File Explorer view ( ⇧⌘E (Windows, Linux Ctrl+Shift+E ) ) in the side bar of VS Code: You can also enable Auto Save to automatically save your file changes, by checking Auto Save in the main File menu. The Activity Bar on the far left lets you open different views such as Search , Source Control , and Run . You'll look at the Run view later in this tutorial. You can find out more about the other views in the VS Code User Interface documentation .
Explore IntelliSense In your new helloworld.cpp file, hover over vector or string to see type information. After the declaration of the msg variable, start typing msg. as you would when calling a member function. You should immediately see a completion list that shows all the member functions, and a window that shows the type information for the msg object: You can press the Tab key to insert the selected member; then, when you add the opening parenthesis, you will see information about any arguments that the function requires.
Run helloworld.cpp Remember, the C++ extension uses the C++ compiler you have installed on your machine to build your program. Make sure you have a C++ compiler installed before attempting to run and debug helloworld.cpp in VS Code. Open helloworld.cpp so that it is the active file. Press the play button in the top right corner of the editor. Choose g++ build and debug active file from the list of detected compilers on your system.
You'll only be asked to choose a compiler the first time you run helloworld.cpp . This compiler will be set as the "default" compiler in tasks.json file. After the build succeeds, your program's output will appear in the integrated Terminal . The first time you run your program, the C++ extension creates tasks.json , which you'll find in your project's .vscode folder. tasks.json stores build configurations. Your new tasks.json file should look similar to the JSON belo
The rest of this page is on the live site.