命令¶
本节介绍 Conan 内置命令,例如 conan install
或 conan search
。
也可以创建用户自定义命令,请访问 自定义命令参考 和这些 自定义命令示例
消费者命令
conan cache: 返回缓存中配方和包的路径
conan config: 管理 Conan 配置(远程仓库、设置、插件等)
conan graph: 获取关于依赖关系图的信息,无需获取二进制文件
conan inspect: 检查 conanfile.py 以返回公共字段
conan install: 安装依赖项
conan list: 列出本地缓存或远程仓库中的配方、修订版本和包
conan lock: 创建和管理锁定文件
conan pkglist: 操作包列表,合并它们或在远程仓库中查找包。
conan profile: 显示和管理配置文件
conan remove: 从本地缓存或远程仓库中删除包
conan remote: 添加、删除、登录/注销和管理远程服务器
conan search: 搜索与名称匹配的包
conan version: 提供关于 Conan 客户端版本的信息
创建者命令
conan build: 安装包并调用其 build 方法
conan create: 从配方创建包
conan download: 从远程服务器下载(不安装)单个 conan 包。
conan editable: 允许在用户文件夹中使用包
conan export: 将配方导出到 Conan 包缓存
conan export-pkg: 直接从预编译的二进制文件创建包
conan new: 从预定义的模板创建新配方
conan source: 调用 source() 方法
conan test: 测试包
conan upload: 将包从本地缓存上传到指定的远程仓库
命令输出到 stdout 和 stderr
Conan 命令输出信息遵循深思熟虑的设计选择,该选择与许多 CLI 工具和 POSIX 标准 中的常见做法一致
stdout
:用于最终命令结果(例如,JSON、HTML)。stderr
:用于诊断输出,包括日志、警告、错误和进度消息。
将输出重定向到文件
您可以使用 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 格式显示图形信息。它被多个命令使用。