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 token。
cargo-logout(1)
在本地移除来自注册表的 API token。
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何时- 控制何时使用彩色输出。有效值：
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。 -h--help- 打印帮助信息。
-Z标志- Cargo 的不稳定（仅限每夜构建）标志。运行
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 了解已知问题。