cargo-remove(1)

名称

cargo-remove — 从 Cargo.toml 清单文件中删除依赖项

概要

cargo remove [选项] 依赖项…

描述

从 Cargo.toml 清单文件中删除一个或多个依赖项。

选项

章节选项

--dev
作为开发依赖项删除。
--build
作为构建依赖项删除。
--target 目标
作为给定目标平台的依赖项删除。

为了避免意外的 shell 扩展，您可以使用引号将每个目标括起来，例如：--target 'cfg(unix)'。

杂项选项

--dry-run
实际上不写入清单。

显示选项

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

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

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

清单选项

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

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

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

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

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

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

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

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

包选择

-p 规范…
--package 规范…
要从中删除的包。

常用选项

+工具链
如果 Cargo 是使用 rustup 安装的，并且 cargo 的第一个参数以 + 开头，则它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖如何工作的更多信息，请参阅 rustup 文档。
--config 键=值 或 路径
覆盖 Cargo 配置值。该参数应采用 键=值 的 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. 删除 regex 作为依赖项

    cargo remove regex

  2. 删除 trybuild 作为开发依赖项

    cargo remove --dev trybuild

  3. 从 x86_64-pc-windows-gnu 依赖项表中删除 nom

    cargo remove --target x86_64-pc-windows-gnu nom

另请参阅

cargo(1)，cargo-add(1)