Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/microsoft/vscode-cmake-tools

CMake Tools provides a robust, convenient workflow for CMake projects in VS Code. It simplifies configurations with CMake presets, supports IntelliSense and built-in debugging for CMake scripts, and offers configurable tasks. Its customizable interface allows for efficient project control, while also simplifying test execution and monitoring.
https://github.com/microsoft/vscode-cmake-tools

c cmake cpp ctest debugging intellisense microsoft tasks visual-studio-code

Last synced: 11 days ago
JSON representation

CMake Tools provides a robust, convenient workflow for CMake projects in VS Code. It simplifies configurations with CMake presets, supports IntelliSense and built-in debugging for CMake scripts, and offers configurable tasks. Its customizable interface allows for efficient project control, while also simplifying test execution and monitoring.

Awesome Lists containing this project

README 

        
 CMake Logo CMake Tools 



Enhancing CMake development in VS Code.





    VS Code

    CMake

    C

    C++






    VS Code Marketplace Downloads

    VS Code Marketplace Version

    Closed Issues







CMake Tools Banner



## Introduction

[CMake Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools) provides the native developer a full-featured, convenient, and powerful workflow for CMake-based projects in Visual Studio Code. It simplifies advanced configurations with support for CMake presets and enhances the development experience by supporting rich IntelliSense features, a built-in debugger for CMake scripts, and configurable CMake tasks. Its customizable interface allows for efficient tailored control of projects, while CTest integration ensures straightforward test execution and monitoring.



 Features







    Presets Support

 

    Built-In CMake Language Services





    CMake Debugging

 

    Project Status





    CMake Commands

 

    Project Outline





    Tasks  

 

    Test Integration

  



## Setup and Installation

Ensure CMake is available on your system. A couple of options are:

- [Download CMake](https://cmake.org/download/).

- Utilize the CMake that is bundled with a Visual Studio installation.



Install the CMake Tools extension from the Extensions pane within VS Code or from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools).



Ensure that either you've added your CMake executable to your PATH, or you've adjusted the `cmake.cmakePath` setting to point to your CMake executable. 



## Resources

- [Docs](docs/README.md) for comprehensive documentation.

- [Quick Start](https://code.visualstudio.com/docs/cpp/CMake-linux) to get up and running fast.

- [Github](https://github.com/microsoft/vscode-cmake-tools) for source code, issues, and contributing.



## Contributing

We encourage an open and collaborative development environment and welcome all contributions. Whether you're fixing bugs, proposing new features, or improving our documentation - we invite you to join the CMake Tools community. Please review our [contribution guidelines](CONTRIBUTING.md) and adhere to our [code of conduct](https://opensource.microsoft.com/codeofconduct/).



You can file issues with us using one of our templates:



[Bug Report](https://github.com/microsoft/vscode-cmake-tools/issues/new?template=bugreport.yml): If you see an error message or encounter an issue while using the CMake Tools extension.



[Feature Request](https://github.com/microsoft/vscode-cmake-tools/issues/new?template=featurerequest.yml): If you have a suggestion or need a feature that would enhance development.



[Documentation Request](https://github.com/microsoft/vscode-cmake-tools/issues/new?template=docrequest.yml): Requesting changes or additions to the [CMake Tools documentation](docs/README.md).



##



### Microsoft Open Source Code of Conduct



This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [email protected] with any additional questions or comments.



### Data/Telemetry



This extension collects usage data and sends it to Microsoft to help improve our products and services. Collection of telemetry is controlled via the same setting provided by Visual Studio Code: `"telemetry.enableTelemetry"`. Read our [privacy statement](https://privacy.microsoft.com/en-us/privacystatement) to learn more.



### Credits



This project was started by [@vector-of-bool](https://github.com/vector-of-bool) and is now currently maintained by Microsoft.



### Contributors





  Contributors