cargo-run(1)

名称

cargo-run — 运行当前包

概要

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

描述

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

所有在双破折号（--）之后的参数都会传递给要运行的二进制文件。如果您要同时向 Cargo 和二进制文件传递参数，那么 -- 之后的参数会传递给二进制文件，之前的参数会传递给 Cargo。

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

选项

包选择

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

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

目标选择

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

--bin name
运行指定的二进制文件。
--example name
运行指定的示例。

功能选择

功能标志允许您控制启用哪些功能。如果没有给出功能选项，则为每个选定的包激活 default 功能。

有关更多详细信息，请参阅功能文档。

-F features
--features features
以空格或逗号分隔的要激活的功能列表。可以使用 package-name/feature-name 语法启用工作区成员的功能。可以多次指定此标志，这将启用所有指定的功能。
--all-features
激活所有选定包的所有可用功能。
--no-default-features
不激活选定包的 default 功能。

编译选项

--target triple
为给定的架构运行。默认值是主机架构。三元组的一般格式为 <arch><sub>-<vendor>-<sys>-<abi>。运行 rustc --print target-list 获取支持的目标列表。

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

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

-r
--release
使用 release 配置文件运行优化的工件。另请参阅 --profile 选项，以按名称选择特定的配置文件。
--profile name
使用给定的配置文件运行。有关配置文件的更多详细信息，请参阅参考。
--timings=fmts
输出每个编译花费的时间信息，并跟踪随时间的并发信息。接受可选的逗号分隔的输出格式列表；不带参数的 --timings 将默认为 --timings=html。指定输出格式（而不是默认格式）是不稳定的，并且需要 -Zunstable-options。有效的输出格式

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

输出选项

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

显示选项

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

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

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

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

  • human（默认）：以人类可读的文本格式显示。与 short 和 json 冲突。
  • short：发出更短、人类可读的文本消息。与 human 和 json 冲突。
  • json：将 JSON 消息发送到 stdout。有关更多详细信息，请参阅参考。与 human 和 short 冲突。
  • json-diagnostic-short：确保 JSON 消息的 rendered 字段包含来自 rustc 的“short”渲染。不能与 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 path
Cargo.toml 文件的路径。默认情况下，Cargo 会在当前目录或任何父目录中搜索 Cargo.toml 文件。
--ignore-rust-version
忽略包中的 rust-version 规范。
--locked
断言使用的依赖项和版本与最初生成现有 Cargo.lock 文件时使用的完全相同。当出现以下任何一种情况时，Cargo 将退出并显示错误

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

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

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

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

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

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

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

常用选项

+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。

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

-h
--help
打印帮助信息。
-Z flag
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)