cargo(1)

NAME

cargo - Rust包管理器

SYNOPSIS

cargo [options] command [args]
cargo [options] --version
cargo [options] --list
cargo [options] --help
cargo [options] --explain code

DESCRIPTION

这个程序是Rust语言的包管理器和构建工具，可在https://rust-lang.org上获得。

COMMANDS

构建命令

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)
    更新本地lock file中记录的依赖。

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-owner(1)
    在注册中心管理crate的所有者。

cargo-package(1)
    将本地包打包成可分发的压缩包。

cargo-publish(1)
    上传一个包到注册中心。

cargo-yank(1)
    从索引中移除已推送的crate。

常规命令

cargo-help(1)
    显示有关Cargo的帮助信息。

cargo-version(1)
    显示版本信息。

OPTIONS

特定选项

-V
--version
打印版本信息并退出。如果有 --verbose, 打印额外的信息。
--list
列出所有已安装的Cargo子命令。如果有 --verbose, 打印额外的信息。
--explain code
运行 rustc --explain CODE 这将打印错误信息的详细解释 (例如, E0004).

显示选项

-v
--verbose
使用详细输出。可能指定两次，"非常详细" 包含额外的内容，如依赖警告和构建脚本输出。也可以用 term.verbose 配置.
-q
--quiet
不要打印cargo日志信息。也可以用 term.quiet 配置.
--color when
控制何时使用彩色输出。有效值:

  • auto (默认): 自动检测终端上是否有颜色支持。
  • always: 总是显示颜色。
  • never: 总不显示颜色。

也可以用 term.color 配置.

配置选项

--frozen
--locked
这些标志中的任何一个都要求Cargo.lock文件是最新的。 如果lock file丢失，或者需要更新，Cargo将以错误退出。 --frozen 标志还可以防止Cargo试图访问网络以确定其是否过时。

这可能用于你想断言 Cargo.lock 文件是最新的环境(如CI构建)或想避免网络访问。

--offline
阻止Cargo访问网络。如果没有这个标志，Cargo在需要访问网络而网络不可用的情况下会以错误方式停止。 有了这个标志，如果可能的话，Cargo将尝试在没有网络的情况下进行。

请注意，这可能会导致与在线模式不同的依赖解决。 Cargo会将自己限制在本地下载的crate上，即使在本地拷贝的索引中可能有一个较新的版本。 参见 cargo-fetch(1) 命令在离线前下载依赖。

也可以用 net.offline 配置。

通用选项

+toolchain
如果Cargo已经安装了rustup。 cargo的第一个参数以+开始, 它将被解释为一个rustup工具链名称 (比如 +stable 或 +nightly)。 参见 rustup 文档 有关工具链覆盖如何工作的详细信息。
--config KEY=VALUE or PATH
覆盖Cargo配置值。参数应该是TOML语法中的 KEY=VALUE, 或作为一个额外的配置文件的路径提供。这个标志可以被多次指定。 参见 command-line 覆盖部分 了解详细信息。
-h
--help
打印帮助信息。
-Z flag
Cargo 不稳定的 (每日构建) 标记 。运行 cargo -Z 获得 详细帮助。

ENVIRONMENT

关于Cargo读取的环境变量的详情，参阅 参考 。

EXIT STATUS

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

FILES

~/.cargo/
    Cargo "home" 目录的默认位置，存储各种文件。这个位置可以通过 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 目录的内部结构还不稳定，可能会有变化。

EXAMPLES

  1. 构建本地包和它的所有依赖:

    cargo build

  2. 构建优化后的包:

    cargo build --release

  3. 为交叉编译的目标运行测试:

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

  4. 创建新的包，构建可执行文件:

    cargo new foobar

  5. 在当前目录下创建包:

    mkdir foo && cd foo
cargo init .

  6. 了解命令的选项和用法:

    cargo help clean

BUGS

对于问题见 https://github.com/rust-lang/cargo/issues 。

SEE ALSO

rustc(1), rustdoc(1)