conan create¶
$ conan create -h
usage: conan create [-h] [-v [V]] [-cc CORE_CONF] [-f FORMAT]
[--out-file OUT_FILE] [--name NAME] [--version VERSION]
[--user USER] [--channel CHANNEL] [-l LOCKFILE]
[--lockfile-partial] [--lockfile-out LOCKFILE_OUT]
[--lockfile-clean]
[--lockfile-overrides LOCKFILE_OVERRIDES] [-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] [--build-require]
[-tf TEST_FOLDER] [-tm] [-bt BUILD_TEST]
path
Create a package.
positional arguments:
path Path to a folder containing a recipe (conanfile.py)
options:
-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
-cc CORE_CONF, --core-conf CORE_CONF
Define core configuration, overwriting global.conf
values. E.g.: -cc core:non_interactive=True
-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.
--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
-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
-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)
-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.
-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
--build-require Whether the package being created is a build-require
(to be used as tool_requires() by other packages)
-tf TEST_FOLDER, --test-folder TEST_FOLDER
Alternative test folder name. By default it is
"test_package". Use "" to skip the test stage
-tm, --test-missing Run the test_package checks only if the package is
built from source but not if it already existed (using
--build=missing)
-bt BUILD_TEST, --build-test BUILD_TEST
Same as '--build' but only for the test_package
requires. By default if not specified it will take the
'--build' value if specified
conan create 命令从 path 中指定的 recipe 创建一个 package。
此命令将首先 export recipe 到本地缓存，然后构建并创建 package。如果找到 test_package 文件夹（你可以使用 -tf 参数或 test_package_folder recipe 属性更改文件夹名称），该命令将运行 consumer 项目以确保 package 已正确创建。查看 testing Conan packages 部分以了解更多关于如何测试你的 Conan packages 的信息。
提示
有时你可能想要跳过/禁用测试阶段。在这种情况下，你可以通过传递一个空值作为 -tf 参数来跳过/禁用 test package 阶段
$ conan create . --test-folder=""
你可能还想执行 conan create . --build=missing，这样如果服务器中已存在二进制文件，则不会构建 package。如果你还想在二进制文件已存在时避免 test_package 步骤，你可以使用 conan create . --build=missing --test-missing，它将仅在从源代码构建二进制文件时启动 test-package。
使用 conan create 和构建需求¶
--build-require 参数允许使用 “build” 上下文的配置和设置来创建 package，就像它是 build_require 一样。此功能允许以与之后使用它们的方式一致的方式创建 packages。
$ conan create . --name=cmake --version=3.23.1 --build-require
Conan create 输出¶
conan create ... --format=json 创建一个 json 输出，其中包含完整的依赖关系图信息。此 json 与使用 conan graph info 创建的 json 相同（参见 graph info json format），其中包含有关二进制文件的扩展信息，例如更完整的 cpp_info 字段。这个生成的 json 是正在创建的 package recipe 的依赖关系图，不包括所有 test_package 以及 test_package/conanfile.py 的其他可能的依赖项。这些依赖项仅存在于 test_package 功能中，因此不属于 “main” 产品或 package 的一部分。如果你有兴趣捕获包括 test_package 的依赖关系图（在大多数情况下可能不是必需的），那么你可以通过单独运行 conan test 命令来实现。
对于使用 --lockfile-out 参数创建的 lockfiles 也是如此。 lockfile 将仅包含创建的 package 及其传递依赖项版本，但它不会包含 test_package 或 test_package/conanfile.py 的传递依赖项。 可以使用 conan test 命令捕获包含这些内容的 lockfile（尽管同样，这可能不是真的必要）。
注意
最佳实践
一般来说，应该避免 test_package/conanfile.py 具有除被测试项之外的依赖项。test_package 功能应该用作一个简单的检查，以确保 package 已正确创建。向 test_package 添加额外的依赖项可能表明检查不直接或其功能被滥用。如果由于任何原因，你的 test_package 具有额外的依赖项，你可以使用 --build-test 参数控制它们的构建。
方法执行顺序¶
conan create 按照以下顺序执行 conanfile.py 的 methods
- 导出 recipe 到缓存
init()set_name()set_version()export()export_sources()
- 计算依赖关系图
ìnit()config_options()configure()requirements()build_requirements()
- 计算必要的 packages
validate_build()validate()package_id()layout()system_requirements()
- 安装 packages
source()build_id()generate()build()package()package_info()
如果 package 不是从源代码构建的，则不会调用 安装 packages 步骤中的 generate(), build(), package() 步骤。
之后，如果你的项目中有名为 test_package 的文件夹，或者你使用 --test-folder 标志调用 conan create 命令，则该命令将按以下顺序调用文件夹内 conanfile.py 文件的方法
- 启动 test_package
(test package)
init()(test package)
set_name()(test package)
set_version()
- 计算依赖关系图
(test package)
config_options()(test package)
configure()(test package)
requirements()(test package)
build_requirements()ìnit()config_options()configure()requirements()build_requirements()
- 计算必要的 packages
validate_build()validate()package_id()layout()(test package)
validate_build()(test package)
validate()(test package)
package_id()(test package)
layout()system_requirements()(test package)
system_requirements()
- 安装 packages
build_id()generate()build()package_info()
- 测试 package
(test package)
build()(test package)
test()
带有 (test package) 的函数属于 test_package 文件夹中的 conanfile.py。如果项目已安装，则将跳过 安装 packages 步骤中的 build_id(), generate(), build() 步骤。 通常，它应该像在之前的 “安装 packages” 步骤中安装一样进行安装。
构建模式¶
conan create --build=<xxxx> 构建模式与 Build Modes 中记录的 conan install 构建模式非常相似，但有一些差异。
默认情况下，conan create 定义 --build=current_pkg/current_version 以强制从源代码构建当前 revision。这假设源代码（recipe，C/C++ 代码）已更改，并将创建一个新的 revision。如果不是这种情况，则建议使用 --build=missing:current_pkg/current_version 以避免从源代码重新构建已存在的二进制文件。
当在命令行中定义 --build=xxx 参数时，将不再传递自动定义的 --build=current_pkg/current_version，并且也应将其作为显式参数传递。
注意
最佳实践
在大多数情况下，不鼓励为给定的 recipe_revision 和 package_id 拥有多个 package_revision，因为它意味着不必要地从源代码重新构建已经存在的二进制文件。因此，不鼓励在没有任何会导致新的 recipe_revision 的源代码更改的情况下，在同一 recipe 上重复使用 conan create，建议使用 conan create . --build=missing:[pattern]。
另请参阅
阅读更多关于在 dedicated tutorial 中创建 packages 的信息
阅读更多关于 testing Conan packages 的信息