conan profile¶

Manage profiles

conan profile detect¶

$ conan profile detect -h
usage: conan profile detect [-h] [-v [V]] [--name NAME] [-f]

Generate a profile using auto-detected values.

optional arguments:
  -h, --help   show this help message and exit
  -v [V]       Level of detail of the output. Valid options from less verbose
               to more verbose: -vquiet, -verror, -vwarning, -vnotice,
               -vstatus, -v or -vverbose, -vv or -vdebug, -vvv or -vtrace
  --name NAME  Profile name, 'default' if not specified
  -f, --force  Overwrite if exists

Warning

The output of conan profile detect is not stable. It can change at any time in future Conan releases to adapt to latest tools, latest versions, or other changes in the environment. See the Conan stability section for more information.

You can create a new auto-detected profile for your configuration using:

auto-detected profile¶

$ conan profile detect
Found apple-clang 14.0
apple-clang>=13, using the major as version
Detected profile:
[settings]
arch=x86_64
build_type=Release
compiler=apple-clang
compiler.cppstd=gnu17
compiler.libcxx=libc++
compiler.version=14
os=Macos

WARN: This profile is a guess of your environment, please check it.
WARN: Defaulted to cppstd='gnu17' for apple-clang.
WARN: The output of this command is not guaranteed to be stable and can change in future Conan versions.
WARN: Use your own profile files for stability.
Saving detected profile to /Users/barbarians/.conan2/profiles/default

Be aware that if the profile already exists you have to use --force to overwrite it. Otherwise it will fail

force overwriting already existing default profile¶

$ conan profile detect
ERROR: Profile '/Users/carlosz/.conan2/profiles/default' already exists
$ conan profile detect --force
Found apple-clang 14.0
...
Saving detected profile to /Users/carlosz/.conan2/profiles/default

Note

Best practices It is not recommended to use conan profile detect in production. To guarantee reproducibility, it is recommended to define your own profiles, store them in a git repo or in a zip in a server, and distribute it to your team and CI machines with conan config install, together with other configuration like custom settings, custom remotes definition, etc.

conan profile list¶

$ conan profile list -h
usage: conan profile list [-h] [-f FORMAT] [-v [V]]

List all profiles in the cache.

optional arguments:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        Select the output format: json
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace

force overwriting already existing default profile¶

$ conan profile list
Profiles found in the cache:
default
ios_base
ios_simulator
clang_15

conan profile path¶

$ conan profile path [-h] [-v [V]] name

Show profile path location.

positional arguments:
name        Profile name

optional arguments:
-h, --help  show this help message and exit
-v [V]      Level of detail of the output. Valid options from less verbose to more verbose: -vquiet, -verror, -vwarning,
            -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug, -vvv or -vtrace

Use to get the profile location in your [CONAN_HOME] folder:

$ conan profile path default
/Users/barbarians/.conan2/profiles/default

conan profile show¶

$ conan profile show -h
usage: conan profile show [-h] [-f FORMAT] [-v [V]] [-o OPTIONS_HOST]
                      [-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST]
                      [-pr PROFILE_HOST] [-pr:b PROFILE_BUILD]
                      [-pr:h PROFILE_HOST] [-s SETTINGS_HOST]
                      [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST]
                      [-c CONF_HOST] [-c:b CONF_BUILD] [-c:h CONF_HOST]

Show aggregated profiles from the passed arguments.

optional arguments:
-h, --help            show this help message and exit
-f FORMAT, --format FORMAT
                        Select the output format: json
-v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
-o OPTIONS_HOST, --options OPTIONS_HOST
                        Define options values (host machine), e.g.: -o
                        Pkg:with_qt=true
-o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD
                        Define options values (build machine), e.g.: -o:b
                        Pkg:with_qt=true
-o:h OPTIONS_HOST, --options:host OPTIONS_HOST
                        Define options values (host machine), e.g.: -o:h
                        Pkg:with_qt=true
-pr PROFILE_HOST, --profile PROFILE_HOST
                        Apply the specified profile to the host machine
-pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD
                        Apply the specified profile to the build machine
-pr:h PROFILE_HOST, --profile:host PROFILE_HOST
                        Apply the specified profile to the host machine
-s SETTINGS_HOST, --settings SETTINGS_HOST
                        Settings to build the package, overwriting the
                        defaults (host machine). e.g.: -s compiler=gcc
-s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD
                        Settings to build the package, overwriting the
                        defaults (build machine). e.g.: -s:b compiler=gcc
-s:h SETTINGS_HOST, --settings:host SETTINGS_HOST
                        Settings to build the package, overwriting the
                        defaults (host machine). e.g.: -s:h compiler=gcc
-c CONF_HOST, --conf CONF_HOST
                        Configuration to build the package, overwriting the
                        defaults (host machine). e.g.: -c
                        tools.cmake.cmaketoolchain:generator=Xcode
-c:b CONF_BUILD, --conf:build CONF_BUILD
                        Configuration to build the package, overwriting the
                        defaults (build machine). e.g.: -c:b
                        tools.cmake.cmaketoolchain:generator=Xcode
-c:h CONF_HOST, --conf:host CONF_HOST
                        Configuration to build the package, overwriting the
                        defaults (host machine). e.g.: -c:h
                        tools.cmake.cmaketoolchain:generator=Xcode

Use conan profile show to compute the resulting build and host profiles from the command line arguments. For example, combining different options and settings with the default profile or with any other profile using the pr:b or pr:h arguments:

$ conan profile show -s:h build_type=Debug -o:h shared=False
Host profile:
[settings]
arch=x86_64
build_type=Debug
compiler=apple-clang
compiler.cppstd=gnu17
compiler.libcxx=libc++
compiler.version=14
os=Macos
[options]
shared=False
[conf]


Build profile:
[settings]
arch=x86_64
build_type=Release
compiler=apple-clang
compiler.cppstd=gnu17
compiler.libcxx=libc++
compiler.version=14
os=Macos
[conf]

It’s also useful to show the result of the evaluation of jinja2 templates in the profiles. For example, a profile like this:

myprofile¶

[settings]
os = {{ {"Darwin": "Macos"}.get(platform.system(), platform.system()) }}

Check the evaluated profile:

$ conan profile show -pr:h=myprofile
Host profile:
[settings]
os=Macos
[conf]
...

The command can also output a json with the results:

$ conan profile show --format=json

{
"host": {
    "settings": {
        "arch": "armv8",
        "build_type": "Release",
        "compiler": "apple-clang",
        "compiler.cppstd": "gnu17",
        "compiler.libcxx": "libc++",
        "compiler.version": "15",
        "os": "Macos"
    },
    "package_settings": {},
    "options": {},
    "tool_requires": {},
    "conf": {},
    "build_env": ""
},
"build": {
    "settings": {
        "arch": "armv8",
        "build_type": "Release",
        "compiler": "apple-clang",
        "compiler.cppstd": "gnu17",
        "compiler.libcxx": "libc++",
        "compiler.version": "15",
        "os": "Macos"
    },
    "package_settings": {},
    "options": {},
    "tool_requires": {},
    "conf": {},
    "build_env": ""
}
}