02-cargo help

译文 · 基于 The Cargo Book

cargo-help(1)

原文链接: https://doc.rust-lang.org/cargo/commands/cargo-help.html

名称

cargo-help — 获取 Cargo 命令的帮助

大纲

cargo help [subcommand]

描述

打印给定命令的帮助消息。

对于带子命令的命令，用空格分隔命令层级。例如，cargo help report future-incompatibilities 显示 cargo report future-incompatibilities 命令的帮助。

空格仅用于分隔父命令与其子命令之间的层级。命令名本身中的连字符（如 generate-lockfile）必须始终保留。

多个命令层级也可写成用连字符连接的单个词。 例如，cargo help report-future-incompatibilities 等价于 cargo help report future-incompatibilities。

选项

显示选项

-v

--verbose

使用详细输出。可指定两次以获得「非常详细」的输出，其中包括依赖警告与构建脚本输出等额外信息。 也可通过 term.verbose 配置值 指定。

-q

--quiet

不打印 cargo 日志消息。 也可通过 term.quiet 配置值 指定。

--color when

控制何时使用彩色输出。有效值：

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

也可通过 term.color 配置值 指定。

Manifest 选项

--locked

断言使用与生成现有 Cargo.lock 文件时完全相同的依赖与版本。出现以下任一情况时，Cargo 将以错误退出：

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

可用于需要确定性构建的环境，例如 CI 流水线。

--offline

禁止 Cargo 因任何原因访问网络。若未指定此标志，当 Cargo 需要访问网络而网络不可用时会以错误停止。指定此标志后，Cargo 会在可能的情况下尝试在无网络时继续。

注意：这可能导致与在线模式不同的依赖解析结果。Cargo 将仅使用本地已下载的 crate，即使本地索引副本表明可能有更新版本。 可先使用 cargo-fetch(1) 命令下载依赖再离线使用。

也可通过 net.offline 配置值 指定。

--frozen

等价于同时指定 --locked 与 --offline。

通用选项

+toolchain

若 Cargo 通过 rustup 安装，且传给 cargo 的第一个参数以 + 开头，则会被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。 关于工具链覆盖的工作方式，请参阅 rustup 文档。

--config KEY=VALUE or PATH

覆盖 Cargo 配置值。参数应为 TOML 语法的 KEY=VALUE，或指向额外配置文件的路径。此标志可指定多次。 更多信息见 命令行覆盖一节。

-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 help build
   

2. 获取嵌套命令的帮助：

   cargo help report future-incompatibilities
   

3. 连字符连接形式同样有效：

   cargo help report-future-incompatibilities
   

4. 也可通过 --help 标志获取帮助：

   cargo build --help
   

参见

cargo(1)