cargo(1)

名称

cargo — Rust 包管理器

概要

cargo [选项] 命令 [参数]

cargo [选项] --version

cargo [选项] --list

cargo [选项] --help

cargo [选项] --explain 代码

描述

此程序是 Rust 语言的包管理器和构建工具，可在 https://www.rust-lang.net.cn 获取。

命令

构建命令

cargo-bench(1)

执行包的基准测试。

cargo-build(1)

编译包。

cargo-check(1)

检查本地包及其所有依赖项是否存在错误。

cargo-clean(1)

删除 Cargo 过去生成的工件。

cargo-doc(1)

构建包的文档。

cargo-fetch(1)

从网络获取包的依赖项。

cargo-fix(1)

自动修复 rustc 报告的 lint 警告。

cargo-run(1)

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

cargo-rustc(1)

编译包，并将额外的选项传递给编译器。

cargo-rustdoc(1)

使用指定的自定义标志构建包的文档。

cargo-test(1)

执行包的单元和集成测试。

清单命令

cargo-generate-lockfile(1)

为项目生成 Cargo.lock。

cargo-locate-project(1)

打印 Cargo.toml 文件位置的 JSON 表示形式。

cargo-metadata(1)

以机器可读格式输出包的已解析依赖项。

cargo-pkgid(1)

打印完全限定的包规范。

cargo-tree(1)

显示依赖图的树形可视化。

cargo-update(1)

更新本地锁定文件中记录的依赖项。

cargo-vendor(1)

在本地提供所有依赖项。

cargo-verify-project(1)

检查 crate 清单的正确性。

包命令

cargo-init(1)

在现有目录中创建新的 Cargo 包。

cargo-install(1)

构建并安装 Rust 二进制文件。

cargo-new(1)

创建新的 Cargo 包。

cargo-search(1)

在 crates.io 中搜索包。

cargo-uninstall(1)

删除 Rust 二进制文件。

发布命令

cargo-login(1)

将注册表的 API 令牌保存在本地。

cargo-logout(1)

从本地删除注册表的 API 令牌。

cargo-owner(1)

管理注册表上 crate 的所有者。

cargo-package(1)

将本地包组装到可分发的 tarball 中。

cargo-publish(1)

将包上传到注册表。

cargo-yank(1)

从索引中删除已推送的 crate。

常规命令

cargo-help(1)

显示有关 Cargo 的帮助信息。

cargo-version(1)

显示版本信息。

选项

特殊选项

-V
--version: 打印版本信息并退出。如果与 --verbose 一起使用，则打印额外信息。
--list: 列出所有已安装的 Cargo 子命令。如果与 --verbose 一起使用，则打印额外信息。
--explain 代码: 运行 rustc --explain 代码，它将打印出错误消息的详细说明（例如，E0004）。

显示选项

-v

--verbose

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

-q

--quiet

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

--color 何时

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

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

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

清单选项

--frozen

--locked

这些标志中的任何一个都要求 Cargo.lock 文件是最新的。如果缺少锁定文件，或者需要更新，Cargo 将退出并报错。--frozen 标志还会阻止 Cargo 尝试访问网络以确定它是否已过期。

这些标志可以在您想要断言 Cargo.lock 文件是最新的环境中使用（例如 CI 构建）或想要避免网络访问。

--offline

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

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

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

常用选项

+工具链

如果 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 频道上可用，并且需要 -Z unstable-options 标志才能启用（请参阅 #10098）。

-h

--help

打印帮助信息。

-Z 标志

Cargo 的不稳定（仅限 nightly）标志。运行 cargo -Z help 获取详细信息。

环境

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

退出状态

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

文件

~/.cargo/

Cargo “主”目录的默认位置，用于存储各种文件。可以使用 CARGO_HOME 环境变量更改位置。

$CARGO_HOME/bin/

cargo-install(1) 安装的二进制文件将位于此处。如果使用 rustup，则 Rust 附带的可执行文件也位于此处。

$CARGO_HOME/config.toml

全局配置文件。有关配置文件的更多信息，请参阅参考。

.cargo/config.toml

Cargo 会自动在当前目录和所有父目录中搜索名为 .cargo/config.toml 的文件。这些配置文件将与全局配置文件合并。

$CARGO_HOME/credentials.toml

用于登录注册表的私有身份验证信息。

$CARGO_HOME/registry/

此目录包含注册表索引和任何已下载依赖项的缓存下载。

$CARGO_HOME/git/

此目录包含 git 依赖项的缓存下载。

请注意，$CARGO_HOME 目录的内部结构尚不稳定，可能会发生变化。

示例

构建本地包及其所有依赖项
```
cargo build
```
使用优化构建包
```
cargo build --release
```

为交叉编译目标运行测试

cargo test --target i686-unknown-linux-gnu

创建一个构建可执行文件的新包
```
cargo new foobar
```
在当前目录中创建一个包
```
mkdir foo && cd foo
cargo init .
```
了解命令的选项和用法
```
cargo help clean
```

错误

有关问题，请参阅 https://github.com/rust-lang/cargo/issues。

另请参阅

rustc(1)，rustdoc(1)

Cargo 指南