Skip to content

conan

conan documentation

Conan

Bases: Tool[_R]

Classes:

Name Description
Cache
Create
Editable
Install
List
Profile
Remote
Upload

Methods:

Name Description
__call__

Consumer commands

flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
cache Cache[_R]
create Create[_R]
editable Editable[_R]
install Install[_R]
list List[_R]
profile Profile[_R]
remote Remote[_R]
upload Upload[_R]
argv Conan[Argv]

cache instance-attribute

cache: Cache[_R]

create instance-attribute

create: Create[_R]

editable instance-attribute

editable: Editable[_R]

install instance-attribute

install: Install[_R]

list instance-attribute

list: List[_R]

profile instance-attribute

profile: Profile[_R]

remote instance-attribute

remote: Remote[_R]

upload instance-attribute

upload: Upload[_R]

argv property

argv: Conan[Argv]

Cache

Bases: Tool[_R2]

Methods:

Name Description
__call__

Perform file operations in the local cache (of recipes and/or packages).

Attributes:

Name Type Description
argv Cache[Argv]

argv property

argv: Cache[Argv]

__call__

__call__(*args: str | PathLike[str], core_conf: Value = ..., out_file: Value = ..., v: Value = ..., **flags: Any) -> _R2

Perform file operations in the local cache (of recipes and/or packages).

Parameters:

Name Type Description Default
core_conf Value

Define core configuration, overwriting global.conf values.

...
out_file Value

Write the output of the command to the specified file instead of stdout.

...
v Value

Level of detail of the output.

...

Create

Bases: Tool[_R2]

Methods:

Name Description
__call__

Create a package.

Attributes:

Name Type Description
argv Create[Argv]

argv property

argv: Create[Argv]

__call__

__call__(*args: str | PathLike[str], build: Value = ..., build_require: Flag = ..., build_test: Value = ..., core_conf: Value = ..., format: Value = ..., out_file: Value = ..., test_folder: Value = ..., test_missing: Flag = ..., v: Value = ..., **flags: Any) -> _R2

Create a package.

Parameters:

Name Type Description Default
build Value

Optional, specify which packages to build from source.

...
build_require Flag

Whether the package being created is a build-require (to be used as tool_requires() by other packages).

...
build_test Value

Same as '--build' but only for the test_package requires.

...
core_conf Value

Define core configuration, overwriting global.conf values.

...
format Value

Select the output format: json.

...
out_file Value

Write the output of the command to the specified file instead of stdout.

...
test_folder Value

Alternative test folder name.

...
test_missing Flag

Run the test_package checks only if the package is built from source but not if it already existed (using --build=missing).

...
v Value

Level of detail of the output.

...

Editable

Bases: Tool[_R2]

Methods:

Name Description
__call__

Allow working with a package that resides in user folder.

Attributes:

Name Type Description
argv Editable[Argv]

argv property

argv: Editable[Argv]

__call__

__call__(*args: str | PathLike[str], core_conf: Value = ..., out_file: Value = ..., v: Value = ..., **flags: Any) -> _R2

Allow working with a package that resides in user folder.

Parameters:

Name Type Description Default
core_conf Value

Define core configuration, overwriting global.conf values.

...
out_file Value

Write the output of the command to the specified file instead of stdout.

...
v Value

Level of detail of the output.

...

Install

Bases: Tool[_R2]

Methods:

Name Description
__call__

Install the requirements specified in a recipe (conanfile.py or

Attributes:

Name Type Description
argv Install[Argv]

argv property

argv: Install[Argv]

__call__

__call__(*args: str | PathLike[str], build: Value = ..., build_require: Flag = ..., core_conf: Value = ..., deployer: Value = ..., deployer_folder: Value = ..., deployer_package: Value = ..., envs_generation: Value = ..., format: Value = ..., generator: Value = ..., out_file: Value = ..., output_folder: Value = ..., requires: Value = ..., tool_requires: Value = ..., v: Value = ..., **flags: Any) -> _R2

Install the requirements specified in a recipe (conanfile.py or conanfile.txt).

Parameters:

Name Type Description Default
build Value

Optional, specify which packages to build from source.

...
build_require Flag

Whether the provided path is a build-require.

...
core_conf Value

Define core configuration, overwriting global.conf values.

...
deployer Value

Deploy using the provided deployer to the output folder.

...
deployer_folder Value

Deployer output folder, base build folder by default if not set.

...
deployer_package Value

Execute the deploy() method of the packages matching the provided patterns.

...
envs_generation Value

Generation strategy for virtual environment files for the root.

...
format Value

Select the output format: json.

...
generator Value

Generators to use.

...
out_file Value

Write the output of the command to the specified file instead of stdout.

...
output_folder Value

The root output folder for generated and build files.

...
requires Value

and --tool-requires arguments.

...
tool_requires Value

Directly provide tool-requires instead of a conanfile.

...
v Value

Level of detail of the output.

...

List

Bases: Tool[_R2]

Methods:

Name Description
__call__

List existing recipes, revisions, or packages in the cache (by default)

Attributes:

Name Type Description
argv List[Argv]

argv property

argv: List[Argv]

__call__

__call__(*args: str | PathLike[str], cache: Flag = ..., core_conf: Value = ..., filter_options: Value = ..., filter_profile: Value = ..., filter_settings: Value = ..., format: Value = ..., graph: Value = ..., graph_binaries: Value = ..., graph_context: Flag = ..., graph_recipes: Value = ..., lru: Value = ..., out_file: Value = ..., package_query: Value = ..., remote: Value = ..., v: Value = ..., **flags: Any) -> _R2

List existing recipes, revisions, or packages in the cache (by default) or the remotes.

Parameters:

Name Type Description Default
cache Flag

Search in the local cache.

...
core_conf Value

Define core configuration, overwriting global.conf values.

...
filter_options Value

Options to filter the binaries.

...
filter_profile Value

Profiles to filter the binaries.

...
filter_settings Value

Settings to filter the binaries.

...
format Value

Select the output format: json, html, compact.

...
graph Value

Graph json file.

...
graph_binaries Value

Which binaries are listed.

...
graph_context Flag

Filter the results by the given context.

...
graph_recipes Value

Which recipes are listed.

...
lru Value

List recipes and binaries that have not been recently used.

...
out_file Value

Write the output of the command to the specified file instead of stdout.

...
package_query Value

List only the packages matching a specific query, e.g, os=Windows AND (arch=x86 OR compiler=gcc).

...
remote Value

Remote names.

...
v Value

Level of detail of the output.

...

Profile

Bases: Tool[_R2]

Methods:

Name Description
__call__

Manage profiles.

Attributes:

Name Type Description
argv Profile[Argv]

argv property

argv: Profile[Argv]

__call__

__call__(*args: str | PathLike[str], core_conf: Value = ..., out_file: Value = ..., v: Value = ..., **flags: Any) -> _R2

Manage profiles.

Parameters:

Name Type Description Default
core_conf Value

Define core configuration, overwriting global.conf values.

...
out_file Value

Write the output of the command to the specified file instead of stdout.

...
v Value

Level of detail of the output.

...

Remote

Bases: Tool[_R2]

Methods:

Name Description
__call__

Manage the remote list and the users authenticated on them.

Attributes:

Name Type Description
argv Remote[Argv]

argv property

argv: Remote[Argv]

__call__

__call__(*args: str | PathLike[str], core_conf: Value = ..., out_file: Value = ..., v: Value = ..., **flags: Any) -> _R2

Manage the remote list and the users authenticated on them.

Parameters:

Name Type Description Default
core_conf Value

Define core configuration, overwriting global.conf values.

...
out_file Value

Write the output of the command to the specified file instead of stdout.

...
v Value

Level of detail of the output.

...

Upload

Bases: Tool[_R2]

Methods:

Name Description
__call__

Upload packages to a remote.

Attributes:

Name Type Description
argv Upload[Argv]

argv property

argv: Upload[Argv]

__call__

__call__(*args: str | PathLike[str], allow_disabled: Flag = ..., check: Flag = ..., confirm: Flag = ..., core_conf: Value = ..., dry_run: Flag = ..., force: Flag = ..., format: Value = ..., list: Value = ..., metadata: Value = ..., only_recipe: Flag = ..., out_file: Value = ..., package_query: Value = ..., remote: Value = ..., v: Value = ..., **flags: Any) -> _R2

Upload packages to a remote.

Parameters:

Name Type Description Default
allow_disabled Flag

Allow uploading to disabled remote.

...
check Flag

Perform an integrity check, using the manifests, before upload.

...
confirm Flag

Upload all matching recipes without confirmation.

...
core_conf Value

Define core configuration, overwriting global.conf values.

...
dry_run Flag

Do not execute the real upload (experimental).

...
force Flag

Force the upload of the artifacts even if the revision already exists in the server.

...
format Value

Select the output format: json.

...
list Value

Package list file.

...
metadata Value

Upload the metadata, even if the package is already in the server and not uploaded.

...
only_recipe Flag

Upload only the recipe/s, not the binary packages.

...
out_file Value

Write the output of the command to the specified file instead of stdout.

...
package_query Value

Only upload packages matching a specific query.

...
remote Value

Upload to this specific remote.

...
v Value

Level of detail of the output.

...

__call__

__call__(*args: str | PathLike[str], **flags: Any) -> _R

Consumer commands

flags

flags(**flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.