How-to: Install & Configure Conan

Conan Overview

Conan is a dependency manager for C and C++. It simplifies the process of retrieving, configuring and managing external libraries for your projects. It is also our primary distribution channel for SDKs and, since 2023, for sample applications.

Like most powerful tools, Conan offers many commands and configuration options. This guide provides the essentials to help you understand the basics and set up Conan correctly in order to access our packages.

Installation

Conan is implemented in Python 3. The recommended installation method is to use Python’s package manager pip.

Support for Conan 2 was added in November 2025, and this is now the recommended method. If you encounter any issues that are not covered in this documentation, please let us know so we can update it accordingly.

Open a terminal a type :

BASH

pip install conan

If you want to target Conan 1 specifically, do this instead.

BASH

pip install -U "conan<2.0"

Make sure the installation was successful with a version check.

BASH

conan --version

Check that the operation is successful with conan --version.

Configuration

The commands differ between Conan 1 and Conan 2 but the process remains the same.

Package immutability

The following command is necessary with Conan 1 to ensure package immutability. Conan 2 does it by default so you don’t have to do anything.

CODE

conan config set general.revisions_enabled=1

Adding the Vivoka customer remote repository

Access to Vivoka’s package repository is required in order access the various resources, including samples.

BASH

conan remote add vivoka-customer https://conan-customer.vivoka.com/artifactory/api/conan/vivoka-customer

Login access to the repository

Now you should be able to login using your VDK credentials.

Conan 1

CODE

conan user <username> -r vivoka-customer -p <password>

Conan 2

CODE

conan remote login vivoka-customer <username> -p <password>

Environments variables

You can set the following environments variables if you want to avoid inputting your credentials regularly.

CONAN_LOGIN_USERNAME_VIVOKA_CUSTOMER
CONAN_PASSWORD_VIVOKA_CUSTOMER

Setting up Conan profile

Conan works with profiles. It can automatically detect your environment and generate a default profile by identifying your compiler and other relevant settings.

Conan 1

CODE

conan profile new --detect default

Conan 2

CODE

conan profile detect

For Windows users

Only MSVC 15 and 16 (which maps to Visual Studio 2017 and 2019) are supported.

Check generated Conan profile

If you’re unsure Conan detected a compatible version, print it:

POWERSHELL

conan profile get settings.compiler.version default # Conan 1
conan profile show -pr default # Conan 2

You can modify the auto-generated profile directly in ~/.conan2/profiles/ (Conan 2) or ~/.conan/profiles/ (Conan 1).