命令

本节介绍了 Conan 内置命令，例如 conan install 或 conan search。

也可以创建用户自定义命令，请访问 自定义命令参考 和这些 自定义命令示例

消费者命令

• conan cache：返回缓存中 recipe 和包的路径

• conan config：管理 Conan 配置（远程、设置、插件等）

• conan graph：获取依赖图信息，无需获取二进制文件

• conan inspect：检查 conanfile.py 以返回公共字段

• conan install：安装依赖项

• conan list：列出本地缓存或远程中的 recipes、revisions 和包

• conan lock：创建和管理 lockfiles

• conan pkglist：操作包列表，合并它们或在远程查找包。

• conan profile：显示和管理 profile 文件

• conan remove：从本地缓存或远程中移除包

• conan remote：添加、移除、登录/登出和管理远程服务器

• conan search：搜索匹配指定名称的包

• conan version：提供关于 Conan 客户端版本的信息

• conan workspace (incubating)：管理 Conan 工作区

创建者命令

• conan build：安装包并调用其 build 方法

• conan create：从 recipe 创建包

• conan download：从远程服务器下载（不安装）单个 conan 包。

• conan editable：允许在用户文件夹中使用包

• conan export：将 recipe 导出到 Conan 包缓存

• conan export-pkg：直接从预编译的二进制文件创建包

• conan new：从预定义的模板创建一个新的 recipe

• conan source：调用 source() 方法

• conan test：测试一个包

• conan upload：将包从本地缓存上传到指定的远程

安全命令

• conan audit：检查您的 Conan 包中的漏洞。

• conan report：获取关于包的信息

命令输出到 stdout 和 stderr

Conan 命令的输出遵循许多 CLI 工具的通用实践和 POSIX 标准 的既定设计选择。

• stdout：用于最终命令结果（例如，JSON、HTML）。

• stderr：用于诊断输出，包括日志、警告、错误和进度消息。

更多信息可以在 FAQ 部分 中找到。

将输出重定向到文件

您可以使用 shell 重定向将 Conan 输出重定向到文件

$ conan install . --format=json > output.json

或者，使用 --out-file 参数（Conan 2.12.0 及更高版本可用）直接指定输出文件

$ conan install . --format=json --out-file=output.json

命令格式化器

几乎所有命令都有一个 --format xxxx 参数，用于应用输出转换。命令格式化器可以帮助用户以不同的方式查看命令输出，以更好地满足他们的需求。这里只列出一些最重要的，它们的细节值得拥有一个单独的部分。

• graph-info 格式化器：以 JSON 格式显示图信息。它被多个命令使用。