cargo(1)

名称

cargo — Rust 包管理器

概要

cargo [选项] 命令 [参数]
cargo [选项] --version
cargo [选项] --list
cargo [选项] --help
cargo [选项] --explain 代码

描述

此程序是 Rust 语言的包管理器和构建工具，可在 https://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-add(1)
将依赖项添加到 Cargo.toml 清单文件中。

cargo-generate-lockfile(1)
为项目生成 Cargo.lock。

cargo-info(1)
显示注册表中有关包的信息。默认注册表是 crates.io。

cargo-locate-project(1)
打印 Cargo.toml 文件位置的 JSON 表示形式。

cargo-metadata(1)
以机器可读的格式输出包的已解析依赖项。

cargo-pkgid(1)
打印完全限定的包规范。

cargo-remove(1)
从 Cargo.toml 清单文件中删除依赖项。

cargo-tree(1)
显示依赖关系图的树形可视化。

cargo-update(1)
更新本地锁定文件中记录的依赖项。

cargo-vendor(1)
在本地供应商所有依赖项。

包命令

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 CODE，这将打印出错误消息的详细说明（例如，E0004）。

显示选项

-v

--verbose

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

-q

--quiet

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

--color when

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

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

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

清单选项

--locked

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

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

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

--offline

阻止 Cargo 以任何理由访问网络。如果没有此标志，如果 Cargo 需要访问网络且网络不可用，它将停止并显示错误。使用此标志，如果可能，Cargo 将尝试在没有网络的情况下继续。

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

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

--frozen

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

常用选项

+工具链

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

--config 键=值 或路径

覆盖 Cargo 配置值。参数应采用 键=值 的 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 未能完成。

文件

~/.cargo/
Cargo “主”目录的默认位置，它在其中存储各种文件。可以使用 CARGO_HOME 环境变量更改该位置。

$CARGO_HOME/bin/
cargo-install(1) 安装的二进制文件将位于此处。如果使用 rustup，则 Rust 分发的 exe 文件也位于此处。

$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)