命令¶
本节介绍 Conan 内置命令,例如 conan install
或 conan search
。
也可以创建用户自定义命令,请访问 自定义命令参考 和这些 自定义命令示例
使用者命令
conan cache: 返回缓存中 recipe 和 package 的路径
conan config: 管理 Conan 配置 (远程仓库, 设置, 插件等)
conan graph: 获取关于依赖关系图的信息,无需获取二进制文件
conan inspect: 检查 conanfile.py 以返回公共字段
conan install: 安装依赖
conan list: 列出本地缓存或远程仓库中的 recipe、修订版本和 package
conan lock: 创建和管理 lockfile
conan pkglist: 操作 package 列表,合并它们或在远程仓库中查找 package。
conan profile: 显示和管理 profile 文件
conan remove: 从本地缓存或远程仓库中移除 package
conan remote: 添加、移除、登录/注销和管理远程服务器
conan search: 搜索与名称匹配的 package
conan version: 提供关于 Conan 客户端版本的信息
创建者命令
conan build: 安装 package 并调用其 build 方法
conan create: 从 recipe 创建一个 package
conan download: 从远程服务器下载 (不安装) 单个 conan package。
conan editable: 允许在用户文件夹中使用 package
conan export: 将 recipe 导出到 Conan package 缓存
conan export-pkg: 直接从预编译的二进制文件创建 package
conan new: 从预定义模板创建一个新的 recipe
conan source: 调用 source() 方法
conan test: 测试 package
conan upload: 将 package 从本地缓存上传到指定的远程仓库
命令输出到 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 格式显示 graph 信息。它被多个命令使用。