Difference between revisions of "Conan --help"
Jump to navigation
Jump to search
(7 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
conan --help | conan --help | ||
Consumer commands | Consumer commands | ||
− | install Installs the requirements specified in a recipe (conanfile.py or conanfile.txt). | + | [[conan install|install]] Installs the requirements specified in a recipe (conanfile.py or conanfile.txt). |
− | config Manages Conan configuration. | + | [[conan config|config]] Manages Conan configuration. |
− | get Gets a file or list a directory of a given reference or package. | + | [[conan get|get]] Gets a file or list a directory of a given reference or package. |
info Gets information about the dependency graph of a recipe. | info Gets information about the dependency graph of a recipe. | ||
search Searches package recipes and binaries in the local cache or a remote. Unless a | search Searches package recipes and binaries in the local cache or a remote. Unless a | ||
Line 11: | Line 11: | ||
new Creates a new package recipe template with a 'conanfile.py' and optionally, | new Creates a new package recipe template with a 'conanfile.py' and optionally, | ||
'test_package' testing files. | 'test_package' testing files. | ||
− | create Builds a binary package for a recipe (conanfile.py). | + | [[conan create|create]] Builds a binary package for a recipe ([[conanfile.py]]). |
upload Uploads a recipe and binary packages to a remote. | upload Uploads a recipe and binary packages to a remote. | ||
export Copies the recipe (conanfile.py & associated files) to your local cache. | export Copies the recipe (conanfile.py & associated files) to your local cache. | ||
Line 18: | Line 18: | ||
Package development commands | Package development commands | ||
source Calls your local conanfile.py 'source()' method. | source Calls your local conanfile.py 'source()' method. | ||
− | build Calls your local conanfile.py 'build()' method. | + | [[conan build|build]] Calls your local conanfile.py 'build()' method. |
package Calls your local conanfile.py 'package()' method. | package Calls your local conanfile.py 'package()' method. | ||
editable Manages editable packages (packages that reside in the user workspace, but are | editable Manages editable packages (packages that reside in the user workspace, but are | ||
Line 26: | Line 26: | ||
Misc commands | Misc commands | ||
profile Lists profiles in the '.conan/profiles' folder, or shows profile details. | profile Lists profiles in the '.conan/profiles' folder, or shows profile details. | ||
− | remote Manages the remote list and the package recipes associated with a remote. | + | [[conan remote|remote]] Manages the remote list and the package recipes associated with a remote. |
user Authenticates against a remote with user/pass, caching the auth token. | user Authenticates against a remote with user/pass, caching the auth token. | ||
imports Calls your local conanfile.py or conanfile.txt 'imports' method. | imports Calls your local conanfile.py or conanfile.txt 'imports' method. | ||
copy Copies conan recipes and packages to another user/channel. | copy Copies conan recipes and packages to another user/channel. | ||
− | remove Removes packages or binaries matching pattern from local cache or remote. | + | [[conan remove|remove]] Removes packages or binaries matching pattern from local cache or remote. |
alias Creates and exports an 'alias package recipe'. | alias Creates and exports an 'alias package recipe'. | ||
download Downloads recipe and binaries to the local cache, without using settings. | download Downloads recipe and binaries to the local cache, without using settings. | ||
Line 41: | Line 41: | ||
Conan commands. Type "conan <command> -h" for help | Conan commands. Type "conan <command> -h" for help | ||
+ | |||
+ | [[conan new --help]] | ||
== See also == | == See also == |
Latest revision as of 09:51, 4 May 2021
conan --help Consumer commands install Installs the requirements specified in a recipe (conanfile.py or conanfile.txt). config Manages Conan configuration. get Gets a file or list a directory of a given reference or package. info Gets information about the dependency graph of a recipe. search Searches package recipes and binaries in the local cache or a remote. Unless a remote is specified only the local cache is searched. Creator commands new Creates a new package recipe template with a 'conanfile.py' and optionally, 'test_package' testing files. create Builds a binary package for a recipe (conanfile.py). upload Uploads a recipe and binary packages to a remote. export Copies the recipe (conanfile.py & associated files) to your local cache. export-pkg Exports a recipe, then creates a package from local source and build folders. test Tests a package consuming it from a conanfile.py with a test() method. Package development commands source Calls your local conanfile.py 'source()' method. build Calls your local conanfile.py 'build()' method. package Calls your local conanfile.py 'package()' method. editable Manages editable packages (packages that reside in the user workspace, but are consumed as if they were in the cache). workspace Manages a workspace (a set of packages consumed from the user workspace that belongs to the same project). Misc commands profile Lists profiles in the '.conan/profiles' folder, or shows profile details. remote Manages the remote list and the package recipes associated with a remote. user Authenticates against a remote with user/pass, caching the auth token. imports Calls your local conanfile.py or conanfile.txt 'imports' method. copy Copies conan recipes and packages to another user/channel. remove Removes packages or binaries matching pattern from local cache or remote. alias Creates and exports an 'alias package recipe'. download Downloads recipe and binaries to the local cache, without using settings. inspect Displays conanfile attributes, like name, version, and options. Works locally, in local cache and remote. help Shows help for a specific command. lock Generates and manipulates lock files. frogarian Conan The Frogarian Conan commands. Type "conan <command> -h" for help
conan new --help
See also[edit]
Advertising: