cargo-clean(1)

名称

cargo-clean - 删除生成的文件

概要

cargo clean [选项]

描述

删除 Cargo 过去在目标目录中生成的文件。

不带任何选项时，cargo clean 将删除整个目标目录。

选项

包选择

未选择任何包时，将清理工作空间中的所有包和所有依赖项。

-p 规格…
--package 规格…
仅清理指定的包。此标志可以指定多次。有关规格格式，请参阅 cargo-pkgid(1)。

清理选项

--dry-run
显示将要删除的内容的摘要，但不实际删除任何内容。与 --verbose 一起使用可显示将要删除的实际文件。
--doc
此选项将导致 cargo clean 仅删除目标目录中的 doc 目录。
--release
删除 release 目录中的所有文件。
--profile 名称
删除具有给定配置文件名称的目录中的所有文件。
--target-dir 目录
所有生成的文件和中间文件的目录。也可以使用 CARGO_TARGET_DIR 环境变量或 build.target-dir 配置值 指定。默认为工作空间根目录下的 target。
--target 目标架构
清理给定架构的文件。默认为主机架构。目标架构的一般格式为 <arch><sub>-<vendor>-<sys>-<abi>。运行 rustc --print target-list 以获取支持的目标列表。此标志可以指定多次。

这也可以使用 build.target 配置值 指定。

请注意，指定此标志会使 Cargo 以不同的模式运行，其中目标文件放置在单独的目录中。有关更多详细信息，请参阅构建缓存文档。

显示选项

-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 将退出并报错

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

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

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

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

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

--frozen
等同于同时指定 --locked 和 --offline。

通用选项

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

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

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

环境

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

退出状态

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

示例

  1. 删除整个 target 目录

    cargo clean

  2. 仅删除发布工件

    cargo clean --release

另请参阅

cargo(1)，cargo-build(1)