$ conan create [-h] [-j JSON] [-k] [-kb] [-ne] [-tbf TEST_BUILD_FOLDER] [-tf TEST_FOLDER] [--ignore-dirty] [-m [MANIFESTS]] [-mi [MANIFESTS_INTERACTIVE]] [-v [VERIFY]] [-b [BUILD]] [-r REMOTE] [-u] [-l [LOCKFILE]] [-e ENV_HOST] [-e:b ENV_BUILD] [-e:h ENV_HOST] [-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] path [reference]
Builds a binary package for a recipe (conanfile.py).
Uses the specified configuration in a profile or in -s settings, -o options etc. If a ‘test_package’ folder (the name can be configured with -tf) is found, the command will run the consumer project to ensure that the package has been created correctly. Check ‘conan test’ command to know more about ‘test_folder’ project.
positional arguments: path Path to a folder containing a conanfile.py or to a recipe file e.g., my_folder/conanfile.py reference user/channel, version@user/channel or pkg/version@user/channel (if name or version declared in conanfile.py, they should match) optional arguments: -h, --help show this help message and exit -j JSON, --json JSON json file path where the install information will be written to -k, -ks, --keep-source Do not remove the source folder in the local cache, even if the recipe changed. Use this for testing purposes only -kb, --keep-build Do not remove the build folder in local cache. Implies --keep- source. Use this for testing purposes only -ne, --not-export Do not export the conanfile.py -tbf TEST_BUILD_FOLDER, --test-build-folder TEST_BUILD_FOLDER Working directory for the build of the test project. -tf TEST_FOLDER, --test-folder TEST_FOLDER Alternative test folder name. By default it is "test_package". Use "None" to skip the test stage --ignore-dirty When using the "scm" feature with "auto" values, capture the revision and url even if there are uncommitted changes -m [MANIFESTS], --manifests [MANIFESTS] Install dependencies manifests in folder for later verify. Default folder is .conan_manifests, but can be changed -mi [MANIFESTS_INTERACTIVE], --manifests-interactive [MANIFESTS_INTERACTIVE] Install dependencies manifests in folder for later verify, asking user for confirmation. Default folder is .conan_manifests, but can be changed -v [VERIFY], --verify [VERIFY] Verify dependencies manifests against stored ones -b [BUILD], --build [BUILD] Optional, use it to choose if you want to build from sources: --build Build all from sources, do not use binary packages. --build=never Never build, use binary packages or fail if a binary package is not found. --build=missing Build from code if a binary package is not found. --build=cascade Will build from code all the nodes with some dependency being built (for any reason). Can be used together with any other build policy. Useful to make sure that any new change introduced in a dependency is incorporated by building again the package. --build=outdated Build from code if the binary is not built with the current recipe or when missing a binary package. --build=[pattern] Build always these packages from source, but never build the others. Allows multiple --build parameters. 'pattern' is a fnmatch file pattern of a package reference. Default behavior: If you don't specify anything, it will be similar to '--build=package name', but package recipes can override it with their 'build_policy' attribute in the conanfile.py. -r REMOTE, --remote REMOTE Look in the specified remote server -u, --update Check updates exist from upstream remotes -l [LOCKFILE], --lockfile [LOCKFILE] Path to a lockfile or folder containing 'conan.lock' file. Lockfile can be updated if packages change -e ENV_HOST, --env ENV_HOST Environment variables that will be set during the package build (host machine). e.g.: -e CXX=/usr/bin/clang++ -e:b ENV_BUILD, --env:build ENV_BUILD Environment variables that will be set during the package build (build machine). e.g.: -e CXX=/usr/bin/clang++ -e:h ENV_HOST, --env:host ENV_HOST Environment variables that will be set during the package build (host machine). e.g.: -e CXX=/usr/bin/clang++ -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 Pkg:with_qt=true -o:h OPTIONS_HOST, --options:host OPTIONS_HOST Define options values (host machine), e.g.: -o 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 compiler=gcc -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST Settings to build the package, overwriting the defaults (host machine). e.g.: -s compiler=gcc
This is the recommended way to create packages.
reference field can be:
- A complete package reference:
pkg/version@user/channel. In this case, the recipe doesn’t need to declare the name or the version. If the recipe declares them, they should match the provided values in the command line.
- The user and channel:
user/channel. The command will assume that the name and version are provided by the recipe.
- The version, user and channel:
version@user/channel. The recipe must provide the name, and if it does provide the version, it should match the command line one.
conan create . demo/testing is equivalent to:
$ conan export . demo/testing $ conan install hello/0.1@demo/testing --build=hello # package is created now, use test to test it $ cd test_package $ conan test . hello/0.1@demo/testing
Sometimes you need to skip/disable test stage to avoid a failure while creating the package, i.e: when you are cross compiling libraries and target code cannot be executed in current host platform. In that case you can skip/disable the test package stage:
$ conan create . demo/testing --test-folder=None
conan create executes methods of a conanfile.py in the following order:
In case of installing a pre-built binary, steps from 5 to 11 will be skipped. Note that
deploy() method is only used in
Installation of binaries can be accelerated setting up parallel downloads with the
experimental configuration in conan.conf.