Environment variables

These are the environment variables used to customize Conan.

Most of them can be set in the conan.conf configuration file (inside your <userhome>/.conan folder). However, this environment variables will take precedence over the conan.conf configuration.

CONAN_BASH_PATH

Defaulted to: Not defined

Used only in windows to help the tools.run_in_windows_bash() function to locate our Cygwin/MSYS2 bash. Set it with the bash executable path if it’s not in the PATH or you want to use a different one.

CONAN_CACHE_NO_LOCKS

Defaulted to: False/0

Set it to True/1 to disable locking mechanism of local cache. Set it to False/0 to enable locking mechanism of local cache. Use it with caution, and only for debugging purposes. Disabling locks may easily lead to corrupted packages. Not recommended for production environments, and in general should be used for conan development and contributions only.

CONAN_CMAKE_GENERATOR

Conan CMake helper class is just a convenience to help to translate Conan settings and options into CMake parameters, but you can easily do it yourself, or adapt it.

For some compiler configurations, as gcc it will use by default the Unix Makefiles CMake generator. Note that this is not a package settings, building it with makefiles or other build system, as Ninja, should lead to the same binary if using appropriately the same underlying compiler settings. So it doesn’t make sense to provide a setting or option for this.

So it can be set with the environment variable CONAN_CMAKE_GENERATOR. Just set its value to your desired CMake generator (as Ninja).

CONAN_CMAKE_GENERATOR_PLATFORM

Defines generator platform to be used by particular CMake generator (see CMAKE_GENERATOR_PLATFORM documentation <https://cmake.org/cmake/help/latest/variable/CMAKE_GENERATOR_PLATFORM.html>). Resulting value is passed to the cmake command line (-A argument) by the Conan CMake helper class during the configuration step. Passing None causes auto-detection, which currently only happens for the Visual Studio 16 2019 generator. The detection is according to the following table:

settings.arch

generator platform

x86

Win32

x86_64

x64

armv7

ARM

armv8

ARM64

other

(none)

For any other generators besides the Visual Studio 16 2019 generator, detection results in no generator platform applied (and no -A argument passed to the CMake command line).

CLICOLOR

Defaulted to: Not defined

Set it to 0 to disable console output colors, overriding tty detection. Set it to any value other than 0 to enable console output colors if a tty is detected. If this is left undefined, Conan will use the CONAN_COLOR_DISPLAY logic to determine whether colors should be enabled.

CLICOLOR_FORCE

Defaulted to: Not defined

Set it to any value other than 0 to force the generation of console output colors, overriding tty detection and CLICOLOR.

NO_COLOR

Defaulted to: Not defined

Set it to any value to force disable console output colors, overriding tty detection and any other color output controls.

CONAN_COLOR_DARK

Defaulted to: False/0

Set it to True/1 to use dark colors in the terminal output, instead of light ones. Useful for terminal or consoles with light colors as white, so text is rendered in Blue, Black, Magenta, instead of Yellow, Cyan, White.

CONAN_COLOR_DISPLAY

Defaulted to: Not defined

By default if undefined Conan output will use color if a tty is detected.

Set it to False/0 to remove console output colors. Set it to True/1 to force console output colors.

CONAN_COMPRESSION_LEVEL

Defaulted to: 9

Conan uses .tgz compression for archives before uploading them to remotes. The default compression level is good and fast enough for most cases, but users with huge packages might want to change it and set CONAN_COMPRESSION_LEVEL environment variable to a lower number, which is able to get slightly bigger archives but much better compression speed.

CONAN_CPU_COUNT

Defaulted to: Number of available cores in your machine.

Set the number of cores that the tools.cpu_count() will return. Conan recipes can use the cpu_count() tool to build the library using more than one core.

CONAN_DEFAULT_PROFILE_PATH

Defaulted to: Not defined

This variable can be used to define a path to an existing profile file that Conan will use as default. If relative, the path will be resolved from the profiles folder.

CONAN_NON_INTERACTIVE

Defaulted to: False/0

This environment variable, if set to True/1, will prevent interactive prompts. Invocations of Conan commands where an interactive prompt would otherwise appear, will fail instead.

This variable can also be set in conan.conf as non_interactive = True in the [general] section.

CONAN_ENV_XXXX_YYYY

You can override the default settings (located in your ~/.conan/profiles/default directory) with environment variables.

The XXXX is the setting name upper-case, and the YYYY (optional) is the sub-setting name.

Examples:

  • Override the default compiler:

CONAN_ENV_COMPILER = "Visual Studio"

  • Override the default compiler version:

CONAN_ENV_COMPILER_VERSION = "14"

  • Override the architecture:

CONAN_ENV_ARCH = "x86"

CONAN_LOG_RUN_TO_FILE

Defaulted to: 0

If set to 1 will log every self.run("{Some command}") command output in a file called conan_run.log. That file will be located in the current execution directory, so if we call self.run in the conanfile.py’s build method, the file will be located in the build folder.

In case we execute self.run in our source() method, the conan_run.log will be created in the source directory, but then conan will copy it to the build folder following the regular execution flow. So the conan_run.log will contain all the logs from your conanfile.py command executions.

The file can be included in the Conan package (for debugging purposes) using the package method.

def package(self):
    self.copy(pattern="conan_run.log", dst="", keep_path=False)

CONAN_LOG_RUN_TO_OUTPUT

Defaulted to: 1

If set to 0 Conan won’t print the command output to the stdout. Can be used with CONAN_LOG_RUN_TO_FILE set to 1 to log only to file and not printing the output.

CONAN_LOGGING_LEVEL

Defaulted to: critical

By default Conan logging level is only set for critical events. If you want to show more detailed logging information, set this variable according to Python Logging Levels or, use a logging level name:

logging level name

logging level id

critical

50

error

40

warning/warn

30

info

20

debug

10

Both names and IDs are acceptable by environment variable, or using the conan.conf file.

CONAN_LOGIN_USERNAME, CONAN_LOGIN_USERNAME_{REMOTE_NAME}

Defaulted to: Not defined

You can define the username for the authentication process using environment variables. Conan will use a variable CONAN_LOGIN_USERNAME_{REMOTE_NAME}, if the variable is not declared Conan will use the variable CONAN_LOGIN_USERNAME, if the variable is not declared either, Conan will request to the user to input a username.

These variables are useful for unattended executions like CI servers or automated tasks.

If the remote name contains “-” you have to replace it with “_” in the variable name:

For example: For a remote named “conan-center”:

SET CONAN_LOGIN_USERNAME_CONAN_CENTER=MyUser

See also

See the conan user command documentation for more information about login to remotes

CONAN_MAKE_PROGRAM

Defaulted to: Not defined

Specify an alternative make program to use with:

For example:

CONAN_MAKE_PROGRAM="/path/to/mingw32-make"

# Or only the exe name if it is in the path

CONAN_MAKE_PROGRAM="mingw32-make"

CONAN_CMAKE_PROGRAM

Defaulted to: Not defined

Specify an alternative cmake program to use with CMake build helper.

For example:

CONAN_CMAKE_PROGRAM="scan-build cmake"

CONAN_MSBUILD_VERBOSITY

Defaulted to: Not defined

Specify `MSBuild` verbosity level to use with:

For list of allowed values and their meaning, check out the MSBuild documentation.

CONAN_PASSWORD, CONAN_PASSWORD_{REMOTE_NAME}

Defaulted to: Not defined

You can define the authentication password using environment variables. Conan will use a variable CONAN_PASSWORD_{REMOTE_NAME}, if the variable is not declared Conan will use the variable CONAN_PASSWORD, if the variable is not declared either, Conan will request to the user to input a password.

These variables are useful for unattended executions like CI servers or automated tasks.

The remote name is transformed to all uppercase. If the remote name contains “-“, you have to replace it with “_” in the variable name.

For example, for a remote named “conan-center”:

SET CONAN_PASSWORD_CONAN_CENTER=Mypassword

See also

See the conan user command documentation for more information about login to remotes

CONAN_HOOKS

Defaulted to: Not defined

Can be set to a comma separated list with the names of the hooks that will be executed when running a Conan command.

CONAN_PRINT_RUN_COMMANDS

Defaulted to: 0

If set to 1, every self.run("{Some command}") call will log the executed command {Some command} to the output.

For example: In the conanfile.py file:

self.run("cd %s && %s ./configure" % (self.ZIP_FOLDER_NAME, env_line))

Will print to the output (stout and/or file):

----Running------
> cd zlib-1.2.9 && env LIBS="" LDFLAGS=" -m64   $LDFLAGS" CFLAGS="-mstackrealign -fPIC $CFLAGS -m64  -s -DNDEBUG  " CPPFLAGS="$CPPFLAGS -m64  -s -DNDEBUG  " C_INCLUDE_PATH=$C_INCLUDE_PATH: CPLUS_INCLUDE_PATH=$CPLUS_INCLUDE_PATH: ./configure
-----------------
...

CONAN_READ_ONLY_CACHE

Defaulted to: Not defined

This environment variable if defined, will make the Conan cache read-only. This could prevent developers to accidentally edit some header of their dependencies while navigating code in their IDEs.

This variable can also be set in conan.conf as read_only_cache = True in the [general] section.

The packages are made read-only in two points: when a package is built from sources, and when a package is retrieved from a remote repository.

The packages are not modified for upload, so users should take that into consideration before uploading packages, as they will be read-only and that could have other side-effects.

Warning

It is not recommended to upload packages directly from developers machines with read-only mode as it could lead to inconsistencies. For better reproducibility we recommend that packages are created and uploaded by CI machines.

CONAN_RUN_TESTS

Defaulted to: Not defined (True/False if defined)

This environment variable (if defined) can be used in conanfile.py to enable/disable the tests for a library or application.

It can be used as a convention variable and it’s specially useful if a library has unit tests and you are doing cross building, the target binary can’t be executed in current host machine building the package.

It can be defined in your profile files at ~/.conan/profiles

...
[env]
CONAN_RUN_TESTS=False

or declared in command line when invoking conan install to reduce the variable scope for conan execution

$ conan install . -e CONAN_RUN_TESTS=0

See how to retrieve the value with tools.get_env() and check a use case with a header only with unit tests recipe while cross building.

See example of build method in conanfile.py to enable/disable running tests with CMake:

from conans import ConanFile, CMake, tools

class HelloConan(ConanFile):
    name = "hello"
    version = "0.1"

    def build(self):
        cmake = CMake(self)
        cmake.configure()
        cmake.build()
        if tools.get_env("CONAN_RUN_TESTS", True):
            cmake.test()

CONAN_SKIP_VS_PROJECTS_UPGRADE

Defaulted to: False/0

When set to True/1, the tools.build_sln_command(), the tools.msvc_build_command() and the MSBuild() build helper, will not call devenv command to upgrade the sln project, irrespective of the upgrade_project parameter value.

CONAN_SYSREQUIRES_MODE

Defaulted to: Not defined (allowed values enabled/verify/disabled)

This environment variable controls whether system packages should be installed into the system via SystemPackageTool helper, typically used in system_requirements().

See values behavior:

  • enabled: Default value and any call to install method of SystemPackageTool helper should modify the system packages.

  • verify: Display a report of system packages to be installed and abort with exception. Useful if you don’t want to allow Conan to modify your system but you want to get a report of packages to be installed.

  • disabled: Display a report of system packages that should be installed but continue the Conan execution and doesn’t install any package in your system. Useful if you want to keep manual control of these dependencies, for example in your development environment.

CONAN_SYSREQUIRES_SUDO

Defaulted to: True/1

This environment variable controls whether sudo is used for installing apt, yum, etc. system packages via SystemPackageTool helper, typically used in system_requirements(). By default when the environment variable does not exist, “True” is assumed, and sudo is automatically prefixed in front of package management commands. If you set this to “False” or “0” sudo will not be prefixed in front of the commands, however installation or updates of some packages may fail due to a lack of privilege, depending on the user account Conan is running under.

CONAN_TEMP_TEST_FOLDER

Defaulted to: False/0

Activating this variable will make build folder of test_package to be created in the temporary folder of your machine.

CONAN_TRACE_FILE

Defaulted to: Not defined

If you want extra logging information about your Conan command executions, you can enable it by setting the CONAN_TRACE_FILE environment variable. Set it with an absolute path to a file.

export CONAN_TRACE_FILE=/tmp/conan_trace.log

When the Conan command is executed, some traces will be appended to the specified file. Each line contains a JSON object. The _action field contains the action type, like COMMAND for command executions, EXCEPTION for errors and REST_API_CALL for HTTP calls to a remote.

The logger will append the traces until the CONAN_TRACE_FILE variable is unset or pointed to a different file.

See also

Read more here: How to log and debug a conan execution

CONAN_USERNAME, CONAN_CHANNEL

Warning

Environment variables CONAN_USERNAME and CONAN_CHANNEL are deprecated and will be removed in Conan 2.0. Don’t use them to populate the value of self.user and self.channel.

These environment variables will be checked when using self.user or self.channel in package recipes in user space, where the user and channel have not been assigned yet (they are assigned when exported in the local cache). More about these variables in the attributes reference.

CONAN_USER_HOME

Defaulted to: Not defined

Allows defining a custom base directory for Conan cache directory. Can be useful for concurrent builds under different users in CI, to retrieve and store per-project specific dependencies (useful for deployment, for example). Conan will generate the folder .conan under the custom base path.

See also

Read more about it in Conan local cache: concurrency, Continuous Integration, isolation

CONAN_USER_HOME_SHORT

Defaulted to: Not defined

Specify the base folder to be used with the short paths feature. When not specified, the packages marked as short_paths will be stored in the C:\.conan (or the current drive letter).

If set to None, it will disable the short_paths feature in Windows for modern Windows that enable long paths at the system level.

Setting this variable equal to, or to a subdirectory of, the local conan cache (e.g. ~/.conan) would result in an invalid cache configuration and is therefore disallowed.

CONAN_USE_ALWAYS_SHORT_PATHS

Defaulted to: Not defined

If defined to True or 1, every package will be stored in the short paths directory resolved by Conan after evaluating CONAN_USER_HOME_SHORT variable (see above). This variable, therefore, overrides the value defined in recipes for the attribute short paths.

If the variable is not defined or it evaluates to False then every recipe will be stored according to the value of its short_paths attribute. So, CONAN_USE_ALWAYS_SHORT_PATHS can force every recipe to use short paths, but it won’t work to force the opposite behavior.

CONAN_VERBOSE_TRACEBACK

Defaulted to: 0

When an error is raised in a recipe or even in the Conan code base, if set to 1 it will show the complete traceback to ease the debugging.

CONAN_ERROR_ON_OVERRIDE

Defaulted to: False

When a consumer overrides one transitive requirement without using explicitly the keyword override Conan will raise an error if this environmente variable is set to True.

This variable can also be set in the *conan.conf* file under the section [general].

CONAN_VS_INSTALLATION_PREFERENCE

Defaulted to: Enterprise, Professional, Community, BuildTools

This environment variables defines the order of preference when searching for a Visual installation product. This would affect every tool that uses tools.vs_installation_path() and will search in the order indicated.

For example:

set CONAN_VS_INSTALLATION_PREFERENCE=Enterprise, Professional, Community, BuildTools

It can also be used to fix the type of installation you want to use indicating just one product type:

set CONAN_VS_INSTALLATION_PREFERENCE=BuildTools

CONAN_CACERT_PATH

Defaulted to: Not defined

Specify an alternative path to a cacert.pem file to be used for requests. This variable overrides the value defined in the conan.conf as cacert_path = <path/to/cacert.pem> under the section [general].

CONAN_DEFAULT_PACKAGE_ID_MODE

Defaulted to: semver_direct_mode

It changes the way package IDs are computed, but can change to any value defined in Using package_id() for Package Dependencies.

CONAN_PYLINT_WERR

Defaulted to: Not defined

This environment variable changes the PyLint behavior from warning level to error. Therefore, any inconsistency found in the recipe will break the process during linter analysis.