vcpkg integrate

Synopsis

• Build system integration

vcpkg integrate [options] install
vcpkg integrate [options] remove
vcpkg integrate [options] project

• Shell integration

vcpkg integrate [options] powershell
vcpkg integrate [options] bash
vcpkg integrate [options] zsh
vcpkg integrate [options] x-fish

Description

Integrate vcpkg with shells and buildsystems.

vcpkg integrate install

Integrates with Visual Studio (Windows-only), sets the user-wide vcpkg instance, and displays CMake integration help.

To set the user-wide vcpkg instance, vcpkg creates a few short files containing the absolute path to the vcpkg instance inside the user's user-wide configuration location:

• %LOCALAPPDATA%\vcpkg or %APPDATA%\Local\vcpkg on Windows
• $HOME/.vcpkg or /var/.vcpkg on non-Windows

Displays the full path to the CMake toolchain file. Running this command is not required to use the toolchain file.

vcpkg integrate remove

Removes the user-wide vcpkg instance setting.

This command deletes the linking files from the user-wide configuration location created by vcpkg integrate install.

vcpkg integrate project

Creates a linked NuGet package for MSBuild integration.

See MSBuild Per-Project Integration for more information.

vcpkg integrate powershell

• Windows only

Adds vcpkg tab-completion support to the current user's Powershell profile.

vcpkg integrate bash

• Non-Windows only

Adds vcpkg tab-completion support to the current user's .bashrc (.bash_profile on MacOS).

vcpkg integrate zsh

• Non-Windows only

Adds vcpkg tab-completion support to the current user's .zshrc.

vcpkg integrate x-fish

• Non-Windows only

Adds vcpkg tab-completion support to the current user's fish shell completions directory.

Example

$ vcpkg integrate install
Applied user-wide integration for this vcpkg root.

CMake projects should use: "-DCMAKE_TOOLCHAIN_FILE=/workspaces/vcpkg/scripts/buildsystems/vcpkg.cmake"

Options

All vcpkg commands support a set of common options.