cargo-clean(1)

名称

cargo-clean — 移除生成的构件

概要

cargo clean [选项]

描述

移除 Cargo 过去在 target 目录中生成的构件。

不带任何选项,cargo clean 将会删除整个 target 目录。

选项

包选择

当没有选择任何包时,工作区中的所有包和所有依赖项都会被清理。

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

清理选项

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

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

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

显示选项

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

  • 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 将尝试在没有网络的情况下继续。

请注意,这可能会导致与在线模式不同的依赖项解析。Cargo 将把自己限制在本地下载的 crates 上,即使在本地索引副本中可能存在更新的版本。请参阅 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)。

常用选项

+toolchain
如果 Cargo 是使用 rustup 安装的,并且 cargo 的第一个参数以 + 开头,则它将被解释为 rustup toolchain 名称 (例如 +stable+nightly)。有关 toolchain 覆盖如何工作的更多信息,请参阅 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. 删除整个 target 目录

    cargo clean
    
  2. 仅删除 release 构件

    cargo clean --release
    

另请参阅

cargo(1), cargo-build(1)