conan install¶
$ conan install -h
usage: conan install [-h] [-f FORMAT] [--out-file OUT_FILE]
[-v [{quiet,error,warning,notice,status,,verbose,debug,v,trace,vv}]]
[-cc CORE_CONF] [-b BUILD] [-r REMOTE | -nr]
[-u [UPDATE]] [-pr PROFILE] [-pr:b PROFILE_BUILD]
[-pr:h PROFILE_HOST] [-pr:a PROFILE_ALL] [-o OPTIONS]
[-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST]
[-o:a OPTIONS_ALL] [-s SETTINGS] [-s:b SETTINGS_BUILD]
[-s:h SETTINGS_HOST] [-s:a SETTINGS_ALL] [-c CONF]
[-c:b CONF_BUILD] [-c:h CONF_HOST] [-c:a CONF_ALL]
[--requires REQUIRES] [--tool-requires TOOL_REQUIRES]
[--name NAME] [--version VERSION] [--user USER]
[--channel CHANNEL] [-l LOCKFILE] [--lockfile-partial]
[--lockfile-out LOCKFILE_OUT] [--lockfile-clean]
[--lockfile-overrides LOCKFILE_OVERRIDES] [-g GENERATOR]
[-of OUTPUT_FOLDER] [-d DEPLOYER]
[--deployer-folder DEPLOYER_FOLDER]
[--deployer-package DEPLOYER_PACKAGE] [--build-require]
[--envs-generation {false}]
[path]
Install the requirements specified in a recipe (conanfile.py or conanfile.txt).
It can also be used to install packages without a conanfile, using the
--requires and --tool-requires arguments.
If any requirement is not found in the local cache, it will iterate the remotes
looking for it. When the full dependency graph is computed, and all dependencies
recipes have been found, it will look for binary packages matching the current settings.
If no binary package is found for some or several dependencies, it will error,
unless the '--build' argument is used to build it from source.
After installation of packages, the generators and deployers will be called.
positional arguments:
path Path to a folder containing a recipe (conanfile.py or
conanfile.txt) or to a recipe file. e.g.,
./my_project/conanfile.txt. Defaults to the current
directory when no --requires or --tool-requires is
given
options:
-h, --help show this help message and exit
-f FORMAT, --format FORMAT
Select the output format: json
--out-file OUT_FILE Write the output of the command to the specified file
instead of stdout.
-v [{quiet,error,warning,notice,status,,verbose,debug,v,trace,vv}]
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
-cc CORE_CONF, --core-conf CORE_CONF
Define core configuration, overwriting global.conf
values. E.g.: -cc core:non_interactive=True
-b BUILD, --build BUILD
Optional, specify which packages to build from source.
Combining multiple '--build' options on one command
line is allowed. Possible values: --build=never
Disallow build for all packages, use binary packages
or fail if a binary package is not found, it cannot be
combined with other '--build' options. --build=missing
Build packages from source whose binary package is not
found. --build=cascade Build packages from source that
have at least one dependency being built from source.
--build=[pattern] Build packages from source whose
package reference matches the pattern. The pattern
uses 'fnmatch' style wildcards, so '--build="*"' will
build everything from source. --build=~[pattern]
Excluded packages, which will not be built from the
source, whose package reference matches the pattern.
The pattern uses 'fnmatch' style wildcards.
--build=missing:[pattern] Build from source if a
compatible binary does not exist, only for packages
matching pattern. --build=compatible:[pattern]
(Experimental) Build from source if a compatible
binary does not exist, and the requested package is
invalid, the closest package binary following the
defined compatibility policies (method and
compatibility.py)
--requires REQUIRES Directly provide requires instead of a conanfile
--tool-requires TOOL_REQUIRES
Directly provide tool-requires instead of a conanfile
-g GENERATOR, --generator GENERATOR
Generators to use
-of OUTPUT_FOLDER, --output-folder OUTPUT_FOLDER
The root output folder for generated and build files
-d DEPLOYER, --deployer DEPLOYER
Deploy using the provided deployer to the output
folder. Built-in deployers: 'full_deploy',
'direct_deploy', 'runtime_deploy'
--deployer-folder DEPLOYER_FOLDER
Deployer output folder, base build folder by default
if not set
--deployer-package DEPLOYER_PACKAGE
Execute the deploy() method of the packages matching
the provided patterns
--build-require Whether the provided path is a build-require
--envs-generation {false}
Generation strategy for virtual environment files for
the root
remote arguments:
-r REMOTE, --remote REMOTE
Look in the specified remote or remotes server
-nr, --no-remote Do not use remote, resolve exclusively in the cache
-u [UPDATE], --update [UPDATE]
Will install newer versions and/or revisions in the
local cache for the given reference name, or all
references in the graph if no argument is supplied.
When using version ranges, it will install the latest
version that satisfies the range. It will update to
the latest revision for the resolved version range.
profile arguments:
-pr PROFILE, --profile PROFILE
Apply the specified profile. By default, or if
specifying -pr:h (--profile:host), it applies to the
host context. Use -pr:b (--profile:build) to specify
the build context, or -pr:a (--profile:all) to specify
both contexts at once
-pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD
-pr:h PROFILE_HOST, --profile:host PROFILE_HOST
-pr:a PROFILE_ALL, --profile:all PROFILE_ALL
-o OPTIONS, --options OPTIONS
Apply the specified options. By default, or if
specifying -o:h (--options:host), it applies to the
host context. Use -o:b (--options:build) to specify
the build context, or -o:a (--options:all) to specify
both contexts at once. Example:
-o="pkg/*:with_qt=True"
-o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD
-o:h OPTIONS_HOST, --options:host OPTIONS_HOST
-o:a OPTIONS_ALL, --options:all OPTIONS_ALL
-s SETTINGS, --settings SETTINGS
Apply the specified settings. By default, or if
specifying -s:h (--settings:host), it applies to the
host context. Use -s:b (--settings:build) to specify
the build context, or -s:a (--settings:all) to specify
both contexts at once. Example: -s="compiler=gcc"
-s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD
-s:h SETTINGS_HOST, --settings:host SETTINGS_HOST
-s:a SETTINGS_ALL, --settings:all SETTINGS_ALL
-c CONF, --conf CONF Apply the specified conf. By default, or if specifying
-c:h (--conf:host), it applies to the host context.
Use -c:b (--conf:build) to specify the build context,
or -c:a (--conf:all) to specify both contexts at once.
Example:
-c="tools.cmake.cmaketoolchain:generator=Xcode"
-c:b CONF_BUILD, --conf:build CONF_BUILD
-c:h CONF_HOST, --conf:host CONF_HOST
-c:a CONF_ALL, --conf:all CONF_ALL
reference arguments:
--name NAME Provide a package name if not specified in conanfile
--version VERSION Provide a package version if not specified in
conanfile
--user USER Provide a user if not specified in conanfile
--channel CHANNEL Provide a channel if not specified in conanfile
lockfile arguments:
-l LOCKFILE, --lockfile LOCKFILE
Path to a lockfile. Use --lockfile="" to avoid
automatic use of existing 'conan.lock' file
--lockfile-partial Do not raise an error if some dependency is not found
in lockfile
--lockfile-out LOCKFILE_OUT
Filename of the updated lockfile
--lockfile-clean Remove unused entries from the lockfile
--lockfile-overrides LOCKFILE_OVERRIDES
Overwrite lockfile overrides
The conan install 命令是 Conan 的主要命令之一，用于解析和安装依赖项。
此命令执行以下操作：
计算当前由设置、选项、配置文件和配置定义的整个依赖图。它解析版本范围、传递依赖项、条件需求等，以构建依赖图。
评估图中每个包的二进制文件的存在性，无论是否有可下载的预编译二进制文件，或者是否应从源代码构建（由
--build参数指示）。如果缺少二进制文件，它不会重新计算依赖图来尝试回退到包含该配置的二进制文件的先前版本。如果期望某个特定的依赖版本，应明确要求。按照依赖图的正确顺序下载预编译二进制文件，或在本地缓存中从源代码构建二进制文件。
根据“生成器”的要求创建必要的文件，以便构建系统和其他工具可以找到本地安装的依赖项。
可选地，执行所需的
deployers。
另请参阅
有关此命令的 JSON 格式输出，请参阅。
Conanfile 路径或 –requires¶
conan install 命令可以使用 2 种不同的信息来源。第一种是使用本地 conanfile.py 或 conanfile.txt，其中包含要使用的依赖项和生成器的定义。
$ conan install . # there is a conanfile.txt or a conanfile.py in the cwd
$ conan install conanfile.py # also works, direct reference file
$ conan install myconan.txt # explicit custom name
$ conan install myfolder # there is a conanfile in "myfolder" folder
即使可以使用自定义名称，但在一般情况下，建议使用位于存储库根目录的默认 conanfile.py 名称，以便用户可以执行简单的 git clone ... `` + ``conan install .
另一种可能性是没有 conanfile，而是在命令行中直接定义要安装的需求。
# Install the zlib/1.2.13 library
$ conan install --requires=zlib/1.2.13
# Install the zlib/1.2.13 and bzip2/1.0.8 libraries
$ conan install --requires=zlib/1.2.13 --requires=bzip2/1.0.8
# Install the cmake/3.23.5 and ninja/1.11.0 tools
$ conan install --tool-requires=cmake/3.23.5 --tool-requires=ninja/1.11.0
# Install the zlib/1.2.13 library and ninja/1.11.0 tool
$ conan install --requires=zlib/1.2.13 --tool-requires=ninja/1.11.0
在一般情况下，建议使用 conanfile 而不是在命令行中定义内容。
配置文件、设置、选项、Conf¶
有几个参数用于定义将使用的有效配置文件，用于“构建”和“主机”上下文。
默认情况下，参数指的是“主机”上下文，因此 --settings:host, -s:h 完全等同于 --settings, -s。同样，默认情况下，conan install 命令将使用 default 配置文件用于“构建”和“主机”上下文。这意味着，如果不存在名为“default”的配置文件，则会出错。
可以作为参数传递多个配置文件定义，它们将从左到右组合（右侧优先级最高）。
# The values of myprofile3 will have higher priority
$ conan install . -pr=myprofile1 -pr=myprofile2 -pr=myprofile3
注意
配置文件在多个位置进行搜索，此处有更多信息。
如果在命令行中提供了任何 settings、options 和 conf 的值，它们将创建一个与提供的其他 -pr（或未指定时为“default”）配置文件组合的配置文件，且优先级更高，无论参数顺序如何。
# the final "host" profile will always be build_type=Debug, even if "myprofile"
# says "build_type=Release"
$ conan install . -pr=myprofile -s build_type=Debug
生成器和部署器¶
The -g argument allows to define in the command line the different built-in generators to be used
$ conan install --requires=zlib/1.2.13 -g CMakeDeps -g CMakeToolchain
请注意，在一般情况下，推荐的方法是在 conanfile 中定义 generators，仅在 --requires 用例中，才更有可能将其作为命令行参数。
生成器的目的是为构建系统创建文件以定位依赖项，而 deployers 的主要用例是将文件从 Conan 缓存复制到用户空间，并对依赖图执行任何其他自定义操作，例如收集许可证、生成报告、将二进制文件部署到系统等。部署器的语法是
# does a full copy of the dependencies binaries to the current user folder
$ conan install . --deployer=full_deploy
有 3 个内置部署器
full_deploy 将依赖项的二进制文件完整复制到本地文件夹，并使用最小的文件夹结构来避免不同包的文件和工件之间的冲突。
direct_deploy 仅复制直接依赖项，但不包括传递依赖项。
runtime_deploy 将所有共享库和依赖项的可执行文件部署到扁平的目录结构中，并保留子目录的原样。
某些生成器可能具有重新定义目标“包文件夹”的能力。这意味着，如果使用了指向包的 CMakeDeps 等其他生成器，它将指向本地部署的副本，而不是 Conan 缓存中的原始包。请参阅 创建用于开发者使用的 Conan 不感知依赖部署 中的完整示例。
也可以（这是一个强大的扩展点）编写自定义用户部署器。有关自定义部署器的详细信息，请参阅 部署器。
还可以使用 --deployer-package 调用包配方 deploy() 方法。
# Execute deploy() method of every recipe that defines it
$ conan install --requires=pkg/0.1 --deployer-package="*"
# Execute deploy() method only for "pkg" (any version) recipes
$ conan install --requires=pkg/0.1 --deployer-package="pkg/*"
# Execute deploy() method for all packages except the "zlib" (transitive dep) one
$ conan install --requires=pkg/0.1 --deployer-package="*" --deployer-package="~zlib/*"
--deployer-package 参数是一个模式，可以接受多个值，所有匹配任何定义的模式的包引用都将执行其 deploy() 方法。这包括否定模式，例如 --deployer-package=~pkg/* 将执行 pkg 配方以外的所有包的 deploy() 方法。 --deployer-folder 参数也会影响此部署的输出位置。请参阅 deploy() 方法。
如果多个已部署包部署到同一位置，它们有责任不相互覆盖其二进制文件（如果它们具有相同的文件名）。例如，如果多个包 deploy() 一个名为“License.txt”的文件，则每个配方都有责任创建一个中间文件夹，其中包含包名称和/或版本，使其唯一，这样其他配方的 deploy() 方法就不会覆盖先前部署的“License.txt”文件。
名称、版本、用户、通道¶
conan install 命令为 --name, --version, --user, --channel 提供了可选参数。这些参数在大多数情况下可能不是必需的。对于 conanfile.txt 永远不需要，对于 conanfile.py 仅在配方中未定义它们的情况下需要。
from conan import ConanFile
from conan.tools.scm import Version
class Pkg(ConanFile):
name = "mypkg"
def requirements(self):
if Version(self.version) >= "3.23":
self.requires("...")
# If we don't specify ``--version``, it will be None and it will fail
$ conan install . --version=3.24
锁定文件¶
conan install 命令有几个参数用于加载和生成锁文件。默认情况下，如果 conan.lock 文件位于配方旁边或当前工作目录中（如果未提供路径），则将其用作输入锁文件。
默认情况下，锁文件是严格的，这意味着如果存在某个 requires 并且在锁文件中找不到匹配的锁定引用，它将出错并停止。对于预期锁文件不完整的情况（可能存在新依赖项），可以使用 --lockfile-partial 参数。
默认情况下，conan install 不会生成输出锁文件，但如果提供了指向文件名的 --lockfile-out 参数，例如 --lockfile-out=result.lock，则将从当前依赖图生成一个锁文件。如果提供了 --lockfile-clean 参数，则当前依赖图中未使用的所有版本和修订版将从生成的锁文件中删除。
假设我们已经有一个 conan.lock 输入锁文件，但我们刚刚向新依赖项添加了一个新的 requires = "newpkg/1.0"。我们可以解析依赖项，锁定所有先前锁定的版本，同时允许解析先前不在锁文件中的新版本，并将其存储在新位置或覆盖现有锁文件。
# --lockfile=conan.lock is the default, not necessary
$ conan install . --lockfile=conan.lock --lockfile-partial --lockfile-out=conan.lock
此外，很可能大部分锁文件操作可以通过 conan lock 命令更好地管理。
更新¶
conan install 命令有一个 --update 参数，它将强制重新评估依赖图的选定项，允许在将版本范围用于版本时更新依赖项到最新版本，或者在版本未锁定在给定锁文件中时更新到同一版本的最新修订版。传递 --update 将检查依赖图中的每个包，但也可以将包名传递给 --update 参数（可以多次添加不同的名称），以仅更新那些包，这避免了整个图的重新评估。
$ conan install . --update # Update all packages in the graph
$ conan install . --update=openssl # Update only the openssl package
$ conan install . --update=openssl --update=boost # Update both openssl and boost packages
请注意，--update 参数将查找命令中指定的所有远程的可能更新版本，并且不会在找到的第一个更新版本处停止。
构建模式¶
conan install --build=<mode> 参数控制有关从源代码构建包的行为。默认行为是在没有现有二进制文件时失败，并显示“缺少二进制文件”错误消息，除非包定义了 build_policy = "missing" 策略，但这可以通过 --build 参数更改。
可能的值是
--build=never Disallow build for all packages, use binary packages or fail if a binary
package is not found, it cannot be combined with other '--build' options.
--build=missing Build packages from source whose binary package is not found.
--build=cascade Build packages from source that have at least one dependency being built from
source.
--build=[pattern] Build packages from source whose package reference matches the pattern. The
pattern uses 'fnmatch' style wildcards, so '--build="*"' will build everything
from source.
--build=~[pattern] Excluded packages, which will not be built from the source, whose package
reference matches the pattern. The pattern uses 'fnmatch' style wildcards.
--build=missing:[pattern] Build from source if a compatible binary does not exist, only for
packages matching pattern.
--build=compatible:[pattern] (Experimental) Build from source if a compatible binary does not
exist, and the requested package is invalid, the closest package
binary following the defined compatibility policies (method and
compatibility.py)
--build=never 策略可用于强制从不从源代码构建，即使对于定义了 build_policy = "missing" 策略的包配方也是如此。
--build=compatible:[pattern] 是一个**实验性**的新模式，它允许使用与当前配置不同的配置构建缺少的二进制文件。例如，如果当前配置文件具有 compiler.cppstd=14，但某个包因需要至少 compiler.cppstd=17 而引发“无效”配置错误，并且二进制兼容性（例如在 compatibility.py 插件中定义）允许将其作为兼容二进制文件，那么 Conan 将从源代码构建该依赖项包，并应用 compiler.cppstd=17。
--build=[pattern] 使用模式，因此它应该使用类似 --build="zlib/*" 的内容来匹配 zlib 包的任何版本，因为 --build=zlib 将不起作用。
注意
最佳实践
强制使用 --build="*" 或任何其他 --build="pkg/*" 或类似模式重新构建现有二进制文件不是推荐的做法。如果二进制文件已存在，则没有理由从源代码重新构建它。CI 管道应特别小心不要这样做，总体而言，--build=missing 和 --build=missing:[pattern] 更受推荐。
--build=cascade 模式部分是旧的，在大多数情况下不应使用。 package_id 计算应该是决定需要构建什么的驱动程序。在 Conan 2 中，此模式仅保留用于特殊情况，例如从损坏的系统恢复，但不建议用于正常生产使用。