01-cargo add
4 分钟阅读
译文 · 基于 The Cargo Book
cargo-add(1)
原文链接: https://doc.rust-lang.org/cargo/commands/cargo-add.html
名称
cargo-add — 向 Cargo.toml 清单文件添加依赖
大纲
cargo add [options] crate…cargo add [options] --path pathcargo add [options] --git url [crate…]
描述
此命令可以添加或修改依赖。
可用以下方式指定依赖的源：
- crate
@version：从注册表获取，版本约束为 “version” --pathpath：从指定 path 获取--giturl：从 url 处的 git 仓库拉取
若未指定源，将尽最大努力选择一个，包括：
- 其他表中的现有依赖（如
dev-dependencies） - 工作空间成员
- 注册表中的最新发布
当你添加已存在的包时，现有条目将用指定的标志更新。
成功调用后，指定依赖已启用（+）与已禁用（-）的特性（features）将列在命令输出中。
选项
源选项
--giturl--branchbranch从 git 添加时使用的分支。
--tagtag从 git 添加时使用的标签。
--revsha从 git 添加时使用的特定提交。
--pathpath要添加的本地 crate 的文件系统路径。
--basebase添加本地 crate 时使用的 path base。
--registryregistry要使用的注册表名称。注册表名称在 Cargo 配置 文件中定义。若未指定，则使用默认注册表， 由
registry.default配置键定义，默认为crates-io。
节选项
--dev添加为开发依赖。
--build添加为构建依赖。
--targettarget添加为给定目标平台的依赖。
为避免意外的 shell 展开，可对每个 target 使用引号，例如
--target 'cfg(unix)'。
依赖选项
--dry-run实际上不写入清单
--renamename重命名依赖。
--optional将依赖标记为可选。
--no-optional将依赖标记为必需。
--public将依赖标记为公有。
该依赖可在你的库的公共 API 中引用。
--no-public将依赖标记为私有。
虽然你可以在实现中使用该 crate，但不能在公共 API 中引用它。
--no-default-features禁用默认特性。
--default-features重新启用默认特性。
-Ffeatures--featuresfeatures空格或逗号分隔的要激活的特性列表。添加多个 crate 时，可用
package-name/feature-name语法启用特定 crate 的特性。此标志可指定多次， 以启用所有指定的特性。
显示选项
-v--verbose使用详细输出。可指定两次以获得“非常详细”的输出，其中包含依赖警告与构建脚本输出等额外信息。 也可通过
term.verbose配置值 指定。-q--quiet不打印 cargo 日志消息。 也可通过
term.quiet配置值 指定。--colorwhen控制何时使用彩色输出。有效值：
auto（默认）：自动检测终端是否支持颜色。always：始终显示颜色。never：从不显示颜色。
也可通过
term.color配置值 指定。
清单选项
--manifest-pathpathCargo.toml文件的路径。默认情况下，Cargo 在当前目录或任意父目录中搜索Cargo.toml文件。-pspec--packagespec仅向指定包添加依赖。
--ignore-rust-version忽略包中的
rust-version规范。--locked断言使用的依赖与版本与最初生成现有
Cargo.lock文件时完全相同。出现以下任一情况时 Cargo 将以错误退出：- 锁文件缺失。
- Cargo 因不同的依赖解析而试图更改锁文件。
可用于需要确定性构建的环境，例如 CI 流水线。
--offline阻止 Cargo 以任何理由访问网络。若未指定此标志，当 Cargo 需要访问网络而网络不可用时会以错误停止。指定此标志后，Cargo 会在可能时尝试在无网络情况下继续。
请注意，这可能导致与在线模式不同的依赖解析。Cargo 会将自身限制为本地已下载的 crate，即便本地索引副本表明可能有更新版本。 可先使用 cargo-fetch(1) 命令下载依赖再离线。
也可通过
net.offline配置值 指定。--frozen等价于同时指定
--locked与--offline。
通用选项
+toolchain若 Cargo 通过 rustup 安装，且传给
cargo的第一个参数以+开头，则会被解释为 rustup 工具链名称（例如+stable或+nightly）。 关于工具链覆盖如何工作，见 rustup 文档。--configKEY=VALUE or PATH覆盖 Cargo 配置值。参数应为 TOML 语法的
KEY=VALUE， 或指向额外配置文件的路径。此标志可指定多次。 更多信息见 命令行覆盖一节。-CPATH在执行任何指定操作之前更改当前工作目录。这会影响 Cargo 默认查找项目清单（
Cargo.toml）的位置，以及 用于发现.cargo/config.toml的目录搜索等。此选项必须 出现在命令名称之前，例如cargo -C path/to/my-project build。此选项仅在 nightly 通道 上可用，且 需要
-Z unstable-options标志才能启用（见 #10098）。-h--help打印帮助信息。
-ZflagCargo 的不稳定（仅 nightly）标志。运行
cargo -Z help查看详情。
环境
关于 Cargo 读取的环境变量详情，见参考文档。
退出状态
0：Cargo 成功。101：Cargo 未能完成。
示例
添加依赖
regexcargo add regex添加开发依赖
trybuildcargo add --dev trybuild添加较旧版本的
nom作为依赖cargo add nom@5添加用
derive将数据结构序列化为 json 的支持cargo add serde serde_json -F serde/derive在
cfg(windows)上添加平台特定依赖windowscargo add windows --target 'cfg(windows)'