1. Project Overview & Quickstart (microsoft/vcpkg)
🌐 Read in a different language
vcpkg overview
vcpkg is a free and open-source C/C++ package manager maintained by Microsoft
and the C++ community.
Initially launched in 2016 as a tool for assisting developers in migrating their
projects to newer versions of Visual Studio, vcpkg has evolved into a
cross-platform tool used by developers on Windows, macOS, and Linux. vcpkg has a
large collection of open-source libraries and enterprise-ready features designed to
facilitate your development process with support for any build and project
systems. vcpkg is a C++ tool at heart and is written in C++ with scripts in
CMake. It is designed from the ground up to address the unique pain points C/C++
developers experience.
This tool and ecosystem are constantly evolving, and we always appreciate
contributions! Learn how to start contributing with our packaging
tutorial and maintainer
guide.
Get started
First, follow one of our quick start guides.
Whether you're using CMake, MSBuild, or any other build system, vcpkg has you covered:
You can also use any editor:
If a library you need is not present in the vcpkg registry, open an issue on
the GitHub repository or contribute the package
yourself.
After you've gotten vcpkg installed and working, you may wish to add
tab completion to your terminal.
Use vcpkg
Create a manifest for your project's dependencies:
vcpkg new --application
vcpkg add port fmtOr install packages through the command line:
vcpkg install fmtThen use one of our available integrations for
CMake,
MSBuild or
other build
systems.
For a short description of all available commands, run vcpkg help.
Run vcpkg help [topic] for details on a specific topic.
Key features
vcpkg offers powerful features for your package management needs:
- easily integrate with your build system
- control the versions of your dependencies
- package and publish your own packages
- reuse your binary artifacts
- enable offline scenarios with asset caching
Contribute
vcpkg is an open source project, and is thus built with your contributions. Here
are some ways you can contribute:
- Submit issues in vcpkg or existing packages
- Submit fixes and new packages
Please refer to our maintainer guide and
packaging tutorial for more details.
This project has adopted the Microsoft Open Source Code of
Conduct. For more information see the Code of Conduct
FAQ or email
[email protected] with any additional
questions or comments.
Resources
- Ports: Microsoft/vcpkg
- Source code: Microsoft/vcpkg-tool
- Docs: Microsoft Learn | vcpkg
- Website: vcpkg.io
- Email: [email protected]
- Discord: #include <C++>'s Discord server, in the #🌏vcpkg channel
- Slack: C++ Alliance's Slack server, in the #vcpkg channel
License
The code in this repository is licensed under the MIT License. The libraries
provided by ports are licensed under the terms of their original authors. Where
available, vcpkg places the associated license(s) in the locationinstalled//share//copyright.
Security
Most ports in vcpkg build the libraries in question using the original build
system preferred by the original developers of those libraries, and download
source code and build tools from their official distribution locations. For use
behind a firewall, the specific access needed will depend on which ports are
being installed. If you must install it in an "air gapped" environment, consider
installing once in a non-"air gapped" environment, populating an asset
cache shared with the otherwise "air gapped"
environment.
Telemetry
vcpkg collects usage data in order to help us improve your experience. The data
collected by Microsoft is anonymous. You can opt-out of telemetry by:
- running the bootstrap-vcpkg script with
-disableMetrics - passing
--disable-metricsto vcpkg on the command line - setting the
VCPKG_DISABLE_METRICSenvironment variable
Read more about vcpkg telemetry at https://learn.microsoft.com/vcpkg/about/privacy.
2. Official Technical Reference & Guides (microsoft/microsoft.github.io)
[microsoft.github.io](https://microsoft.github.io)
Many open source projects released by Microsoft products, services and teams also have
deployments powered by GitHub Pages on this domain.
To discover Microsoft-released open source projects, learn about Microsoft's open source
approach and other information, check us out online at opensource.microsoft.com.
If we can help answer questions about the open source program at Microsoft, you can
contact opensource at microsoft com - although we are not able to provide support
for projects through this mechanism.
Microsoft GitHub resources
- Default repo templates including
SECURITY.MDand code of conduct files: microsoft/repo-templates - Code of Conduct (FAQ)
Microsoft open source resources
Resources for Microsoft employees
How to identify an official Microsoft organization on GitHub
- Official Microsoft GitHub orgs have a professional avatar and include a web address at Microsoft.com or an associated official domain
- Official Microsoft orgs are Verified on GitHub - look for the domain verification indicator on GitHub