cargo-generate-lockfile(1)

名称

cargo-generate-lockfile — 为包生成锁文件

概要

cargo generate-lockfile [选项]

描述

此命令将为当前包或工作区创建 Cargo.lock 锁文件。如果锁文件已存在,它将使用每个包的最新可用版本重建。

另请参阅 cargo-update(1),它也能够创建 Cargo.lock 锁文件,并且具有更多控制更新行为的选项。

选项

显示选项

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

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

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

清单选项

--manifest-path path
Cargo.toml 文件的路径。默认情况下,Cargo 会在当前目录或任何父目录中搜索 Cargo.toml 文件。
--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
--lockfile-path PATH
将锁文件的路径从默认路径 (<workspace_root>/Cargo.lock) 更改为 PATHPATH 必须以 Cargo.lock 结尾(例如,--lockfile-path /tmp/temporary-lockfile/Cargo.lock)。请注意,提供 --lockfile-path 将忽略默认路径下的现有锁文件,而是使用 PATH 中的锁文件,或者如果该锁文件不存在,则将新的锁文件写入提供的 PATH。此标志可用于在只读目录中运行大多数命令,并将锁文件写入提供的 PATH

此选项仅在 nightly 频道上可用,并且需要 -Z unstable-options 标志才能启用(请参阅 #14421)。

常用选项

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

此选项仅在 nightly 频道上可用,并且需要 -Z unstable-options 标志才能启用(请参阅 #10098)。

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

环境变量

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

退出状态

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

示例

  1. 为当前包或工作区创建或更新锁文件

    cargo generate-lockfile
    

另请参阅

cargo(1), cargo-update(1)