cargo-vendor(1)

名称

cargo-vendor — 将所有依赖项本地化

概要

cargo vendor [选项] [路径]

描述

此 cargo 子命令会将项目的所有 crates.io 和 git 依赖项 vendor 到 <path> 指定的目录中。此命令完成后，<path> 指定的 vendor 目录将包含来自指定依赖项的所有远程源。可以使用 -s 选项指定默认清单之外的其他清单。

使用 vendor 源码所需的配置会在 cargo vendor 完成 vendor 过程后输出到标准输出。您需要将其添加到您的 Cargo 配置文件中，或将其重定向到您的 Cargo 配置文件中，该文件通常是当前软件包本地的 .cargo/config.toml。

Cargo 将 vendor 源码视为只读，就像对待注册表和 git 源码一样。如果您打算修改来自远程源的 crate，请使用 [patch] 或指向该 crate 本地副本的 path 依赖项。这样，Cargo 将正确处理增量重建中的 crate，因为它知道它不再是只读依赖项。

选项

Vendor 选项

-s 清单
--sync 清单
指定工作区中也应 vendor 并同步到输出的额外 Cargo.toml 清单。可以指定多次。
--no-delete
在 vendor 时不要删除 “vendor” 目录，而是保留 vendor 目录的所有现有内容
--respect-source-config
不要默认忽略 .cargo/config.toml 中的 [source] 配置，而是在从 crates.io 下载 crate 时读取并使用它，例如
--versioned-dirs
通常，版本仅用于消除同一软件包的多个版本的歧义。此选项使 “vendor” 目录中的所有目录都进行版本控制，这使得跟踪 vendor 软件包随时间变化的历史记录更容易，并且有助于在仅更改了软件包的子集时提高重新 vendor 的性能。

清单选项

--manifest-path 路径
Cargo.toml 文件的路径。默认情况下，Cargo 会在当前目录或任何父目录中搜索 Cargo.toml 文件。
--locked
断言使用与最初生成现有 Cargo.lock 文件时完全相同的依赖项和版本。当出现以下任何一种情况时，Cargo 将退出并显示错误

  • 缺少锁文件。
  • 由于不同的依赖项解析，Cargo 试图更改锁文件。

它可以用在需要确定性构建的环境中，例如在 CI 管道中。

--offline
阻止 Cargo 以任何理由访问网络。如果没有此标志，如果 Cargo 需要访问网络而网络不可用，它将停止并显示错误。使用此标志，如果可能，Cargo 将尝试在没有网络的情况下继续。

请注意，这可能会导致与在线模式不同的依赖项解析。即使本地索引的副本中指示了更新的版本，Cargo 也会将自己限制在本地下载的 crate 上。请参阅 cargo-fetch(1) 命令以在离线之前下载依赖项。

也可以使用 net.offline 配置值 指定。

--frozen
等效于同时指定 --locked 和 --offline。
--lockfile-path 路径
将锁文件的路径从默认值 (<workspace_root>/Cargo.lock) 更改为 路径。路径 必须以 Cargo.lock 结尾 (例如 --lockfile-path /tmp/temporary-lockfile/Cargo.lock)。请注意，提供 --lockfile-path 将忽略默认路径下的现有锁文件，而是使用 路径 中的锁文件，或者如果 路径 中不存在锁文件，则将新的锁文件写入提供的 路径。此标志可用于在只读目录中运行大多数命令，并将锁文件写入提供的 路径。

此选项仅在 nightly channel 上可用，并且需要使用 -Z unstable-options 标志启用 (请参阅 #14421)。

显示选项

-v
--verbose
使用详细输出。可以指定两次以获得 “非常详细” 的输出，其中包括额外的输出，例如依赖项警告和构建脚本输出。也可以使用 term.verbose 配置值 指定。
-q
--quiet
不打印 cargo 日志消息。也可以使用 term.quiet 配置值 指定。
--color 何时
控制何时使用彩色输出。有效值

  • auto (默认): 自动检测终端上是否支持颜色。
  • always: 始终显示颜色。
  • never: 永远不显示颜色。

也可以使用 term.color 配置值 指定。

通用选项

+工具链
如果 Cargo 是使用 rustup 安装的，并且 cargo 的第一个参数以 + 开头，则它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖如何工作的更多信息，请参阅 rustup 文档。
--config KEY=VALUE 或 路径
覆盖 Cargo 配置值。参数应采用 KEY=VALUE 的 TOML 语法，或以指向额外配置文件的路径的形式提供。可以多次指定此标志。有关更多信息，请参阅 命令行覆盖部分。
-C 路径
在执行任何指定操作之前更改当前工作目录。这会影响 cargo 默认查找项目清单 (Cargo.toml) 的位置，以及查找 .cargo/config.toml 的目录，例如。此选项必须出现在命令名称之前，例如 cargo -C path/to/my-project build。

此选项仅在 nightly channel 上可用，并且需要使用 -Z unstable-options 标志启用 (请参阅 #10098)。

-h
--help
打印帮助信息。
-Z 标志
Cargo 的不稳定 (仅限 nightly) 标志。运行 cargo -Z help 获取详细信息。

环境变量

有关 Cargo 读取的环境变量的详细信息，请参阅 参考。

退出状态

  • 0: Cargo 成功。
  • 101: Cargo 未能完成。

示例

  1. 将所有依赖项 vendor 到本地 “vendor” 文件夹中

    cargo vendor

  2. 将所有依赖项 vendor 到本地 “third-party/vendor” 文件夹中

    cargo vendor third-party/vendor

  3. 将当前工作区以及另一个工作区 vendor 到 “vendor”

    cargo vendor -s ../path/to/Cargo.toml

  4. Vendor 并将必要的 vendor 配置重定向到配置文件。

    cargo vendor > path/to/my/cargo/config.toml

另请参阅

cargo(1)