cargo-run(1)

名称

cargo-run — 运行当前包

概要

cargo run [选项] [-- 参数]

描述

运行本地包的二进制文件或示例。

所有跟在两个破折号（--）后面的参数都会传递给要运行的二进制文件。如果你既要向 Cargo 传递参数，又要向二进制文件传递参数，那么 -- 后面的参数会传递给二进制文件，前面的则传递给 Cargo。

与 cargo-test(1) 和 cargo-bench(1) 不同，cargo run 会将执行的二进制文件的工作目录设置为当前工作目录，这与直接在 shell 中执行它是一样的。

选项

包选择

默认情况下，会选择当前工作目录中的包。可以使用 -p 标志选择工作区中的不同包。

-p 规格

--package 规格

要运行的包。有关 SPEC 格式，请参阅 cargo-pkgid(1)。

目标选择

未指定目标选择选项时，cargo run 将运行二进制目标。如果存在多个二进制目标，必须传递目标标志来选择一个。或者，可以在 Cargo.toml 的 [package] 部分指定 default-run 字段，以选择默认运行的二进制文件的名称。

--bin 名称

运行指定的二进制文件。

--example 名称

运行指定的示例。

特性选择

特性标志允许你控制启用哪些特性。未指定特性选项时，会为每个选定的包激活 default 特性。

有关更多详细信息，请参阅特性文档。

-F 特性

--features 特性

要激活的特性列表，用空格或逗号分隔。可以使用 package-name/feature-name 语法启用工作区成员的特性。此标志可以指定多次，这将启用所有指定的特性。

--all-features

激活所有选定包的所有可用特性。

--no-default-features

不激活选定包的 default 特性。

编译选项

--target triple

针对给定的架构运行。默认是主机架构。triple 的一般格式是 <arch><sub>-<vendor>-<sys>-<abi>。运行 rustc --print target-list 查看支持的目标列表。

也可以通过 build.target 配置值来指定。

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

-r

--release

使用 release profile 运行优化的工件。另请参阅 --profile 选项，用于按名称选择特定的 profile。

--profile 名称

使用给定的 profile 运行。有关 profile 的更多详细信息，请参阅参考资料。

--timings=fmts

输出每次编译耗时信息，并跟踪随时间变化的并发信息。接受一个可选的逗号分隔的输出格式列表；不带参数的 --timings 将默认为 --timings=html。指定输出格式（而非默认格式）是不稳定的，需要 -Zunstable-options。有效的输出格式

• html（不稳定，需要 -Zunstable-options）：将人类可读的 cargo-timing.html 文件写入 target/cargo-timings 目录，其中包含编译报告。如果你想查看旧的运行结果，也会在同一目录下写入一个文件名中包含时间戳的报告。HTML 输出仅适用于人类阅读，不提供机器可读的计时数据。
• json（不稳定，需要 -Zunstable-options）：输出机器可读的 JSON 格式的计时信息。

输出选项

--target-dir 目录

所有生成的工件和中间文件的目录。也可以通过 CARGO_TARGET_DIR 环境变量或 build.target-dir 配置值来指定。默认是工作区根目录下的 target。

显示选项

-v

--verbose

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

-q

--quiet

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

--color 何时

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

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

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

--message-format 格式

诊断消息的输出格式。可以指定多次，由逗号分隔的值组成。有效值

• human（默认）：以人类可读的文本格式显示。与 short 和 json 冲突。
• short：输出更短的、人类可读的文本消息。与 human 和 json 冲突。
• json：向 stdout 输出 JSON 消息。有关更多详细信息，请参阅参考资料。与 human 和 short 冲突。
• json-diagnostic-short：确保 JSON 消息的 rendered 字段包含 rustc 的“短”渲染结果。不能与 human 或 short 一起使用。
• json-diagnostic-rendered-ansi：确保 JSON 消息的 rendered 字段包含嵌入的 ANSI 颜色代码，以遵循 rustc 的默认颜色方案。不能与 human 或 short 一起使用。
• json-render-diagnostics：指示 Cargo 不要在打印的 JSON 消息中包含 rustc 诊断信息，而是由 Cargo 本身渲染来自 rustc 的 JSON 诊断信息。Cargo 自身的 JSON 诊断信息以及来自 rustc 的其他信息仍然会输出。不能与 human 或 short 一起使用。

清单选项

--manifest-path 路径

Cargo.toml 文件的路径。默认情况下，Cargo 会在当前目录或任何父目录中搜索 Cargo.toml 文件。

--ignore-rust-version

忽略包中的 rust-version 规范。

--locked

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

• 锁定文件丢失。
• 由于依赖解析不同，Cargo 试图更改锁定文件。

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

--offline

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

请注意，这可能导致与在线模式不同的依赖解析。Cargo 将仅限于本地下载的 crate，即使本地索引副本中可能指示有更新版本。有关离线前下载依赖项的信息，请参阅 cargo-fetch(1) 命令。

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

--frozen

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

--lockfile-path 路径

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

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

通用选项

+工具链

如果 Cargo 是使用 rustup 安装的，并且 cargo 的第一个参数以 + 开头，它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖如何工作的更多信息，请参阅 rustup 文档。

--config 键=值 或 路径

覆盖 Cargo 配置值。参数应为 TOML 语法 KEY=VALUE，或作为额外配置文件的路径提供。此标志可以指定多次。有关更多信息，请参阅命令行覆盖部分。

-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 查看详细信息。

杂项选项

-j N

--jobs N

要运行的并行作业数。也可以通过 build.jobs 配置值来指定。默认为逻辑 CPU 的数量。如果为负数，则将最大并行作业数设置为逻辑 CPU 数量加上提供的值。如果提供字符串 default，则将其值重置为默认值。不应为 0。

--keep-going

尽可能多地构建依赖图中的 crate，而不是在第一个构建失败时中止构建。

例如，如果当前包依赖于 fails 和 works，其中一个构建失败，那么 cargo run -j1 可能会或可能不会构建成功的那个（取决于 Cargo 选择先运行哪一个构建），而 cargo run -j1 --keep-going 则肯定会运行这两个构建，即使先运行的那个失败了。

环境变量

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

退出状态

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

示例

1. 构建本地包并运行其主目标（假设只有一个二进制文件）

   cargo run
   

2. 运行带额外参数的示例

   cargo run --example exname -- --exoption exarg1 exarg2
   

另请参阅

cargo(1), cargo-build(1)