CMake Tools for Visual Studio Code documentation
\nCMake Tools is an extension designed to make it easy to work with CMake-based projects.
\nIf you are new, try the CMake Tools quick start and see the frequently asked questions.
\n\n- \n
- Create a new project \n
- Configure a project \n
- Build a project \n
- Debug a project \n
- Pass command-line arguments to the debugger \n
- Set up include paths for C++ IntelliSense \n
- \n
- CMake configuration process overview \n
- The CMake tools configure step \n
- The configure step outside of CMake Tools \n
- Clean configure \n
- \n
- Variant YAML example \n
- Variant schema \n
- Variant settings \n
- Variant options \n
- How variants are applied \n
- Large variant file example \n
- \n
- Build the default target \n
- Build a single target \n
- How CMake tools builds your project \n
- Clean build \n
- \n
- Select a launch target \n
- Quick debugging \n
- Debug using a launch.json file \n
- Run without debugging \n
- Debugging CMake \n
Configure CMake Tools settings
\n\n\n- \n
- Configure and build with CMake Presets \n
- Supported CMake and CMakePresets.json versions \n
- Enable CMakePresets.json in the CMake Tools extension \n
- Configure and build \n
- CMake: Configure \n
- CMake: Select Build Preset \n
- CMake: Build \n
- Test \n
- CMake: Select Test Preset \n
- CMake: Run Tests \n
- Add new presets \n
- Add new Configure Presets \n
- Add new Build Presets \n
- Edit presets \n
- Select your generator \n
- Set and reference environment variables \n
- Vcpkg integration \n
- Command substitution in launch.json and settings.json \n
- Ignored settings \n
- Unsupported commands \n
- Troubleshooting \n
- Run CMake from the command line or a Continuous Integration (CI) pipeline \n
- Sourcing the environment when building with command line generators on Windows \n
- Example CMakePresets.json file \n
- \n
- Common issues and resolutions \n
- CMake Tools is unable to provide IntelliSense configuration \n
- Green squiggles beneath #include directives \n
- Debugging ignores launch.json \n
- Reset CMake Tools extension state \n
- Increase the logging level \n
- Check the log file \n
- Get help \n