cargo-vendor(1)

名称

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

概要

cargo vendor [选项] [路径]

描述

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

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

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

选项

本地化选项

-s 清单
--sync 清单
指定工作区中也应本地化并同步到输出的额外 Cargo.toml 清单。可以指定多次。
--no-delete
本地化时不要删除“vendor”目录，而是保留“vendor”目录中的所有现有内容
--respect-source-config
例如，不要默认忽略 .cargo/config.toml 中的 [source] 配置，而是在从 crates.io 下载 crate 时读取并使用它
--versioned-dirs
通常，仅添加版本以消除同一软件包的多个版本之间的歧义。此选项会导致“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。

显示选项

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

  • auto（默认）：自动检测终端上是否支持彩色。
  • always：始终显示颜色。
  • never：从不显示颜色。

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

通用选项

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

此选项仅在 夜间版 上可用，并且需要 -Z unstable-options 标志才能启用（请参阅 #10098）。

-h
--help
打印帮助信息。
-Z 标志
Cargo 的不稳定（仅限夜间版）标志。运行 cargo -Z help 以获取详细信息。

环境

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

退出状态

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

示例

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

    cargo vendor

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

    cargo vendor third-party/vendor

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

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

  4. 本地化并将必要的本地化配置重定向到配置文件。

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

另请参阅

cargo(1)