cargo-update(1)

名称

cargo-update — 更新本地锁文件中记录的依赖项

概要

cargo update [选项] spec

描述

此命令将 Cargo.lock 文件中的依赖项更新到最新版本。如果 Cargo.lock 文件不存在,则将使用最新的可用版本创建它。

选项

更新选项

spec
仅更新指定的包。此标志可以多次指定。有关 SPEC 格式,请参阅 cargo-pkgid(1)

如果使用 spec 指定包,则将执行锁文件的保守更新。这意味着仅更新 SPEC 指定的依赖项。只有当更新 SPEC 时必须更新其传递依赖项时,才会更新其传递依赖项。所有其他依赖项将保持锁定在其当前记录的版本。

如果未指定 spec,则会更新所有依赖项。

--recursive
spec 一起使用时,spec 的依赖项也会被强制更新。不能与 --precise 一起使用。
--precise precise
spec 一起使用时,允许您指定一个特定的版本号来设置包。如果该包来自 git 仓库,则这可以是 git 修订版(例如 SHA 哈希或标签)。

虽然不推荐,但您可以指定已撤销的包版本。如果可能,请尝试其他未撤销的 SemVer 兼容版本或寻求包维护者的帮助。

即使 Cargo.toml 中的版本要求不包含任何预发布标识符(仅限 nightly),也可以指定兼容的 pre-release 版本。

--breaking 目录
spec 更新到最新的 SemVer 破坏性版本。

将修改版本要求以允许此更新。

这仅适用于以下情况下的依赖项:

  • 该包是工作区成员的依赖项
  • 该依赖项未被重命名
  • 有不兼容 SemVer 的版本可用
  • 使用了“SemVer 运算符”(^,这是默认值)

此选项不稳定,仅在 nightly channel 上可用,并且需要 -Z unstable-options 标志才能启用。有关更多信息,请参见 https://github.com/rust-lang/cargo/issues/12425

-w
--workspace
尝试仅更新工作区中定义的包。仅当锁文件中不存在其他包时,才会更新其他包。在您更改了 Cargo.toml 中的版本号后,此选项对于更新 Cargo.lock 非常有用。
--dry-run
显示将要更新的内容,但实际上不写入锁文件。

显示选项

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

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

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

清单选项

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

  • 锁文件丢失。
  • 由于依赖项解析不同,Cargo 尝试更改锁文件。

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

--offline
阻止 Cargo 出于任何原因访问网络。如果没有此标志,如果 Cargo 需要访问网络且网络不可用,则 Cargo 将停止并报错。使用此标志,如果可能,Cargo 将尝试在没有网络的情况下继续执行。

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

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

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

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

常用选项

+工具链
如果 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. 更新锁文件中的所有依赖项

    cargo update
    
  2. 仅更新特定的依赖项

    cargo update foo bar
    
  3. 将特定依赖项设置为特定版本

    cargo update foo --precise 1.2.3
    

另请参阅

cargo(1)cargo-generate-lockfile(1)