cargo-init(1)

名称

cargo-init - 在一个已存在的文件夹中创建一个新的包 (package)

概要

cargo init [options] [path]

描述

这个命令会在当前文件夹中创建一个新的 Cargo 清单文件。如果指定一个路径作为参数，则会在给定的文件夹中创建。

如果文件夹中已存在典型命名的 Rust 源代码文件，则会被使用。如果没有，则会创建样板 src/main.rs，如果指定了 --lib，则创建的是 src/lib.rs 。

选项

创建选项

--bin

创建含有一个二进制 target (src/main.rs) 的包。这是默认行为。

--lib

创建含有一个库 target (src/lib.rs) 的包。

--edition edition

指定使用的 Rust 版本。默认为 2021。可选值有：2015、2018、2021。

--name name

设置包的名字。默认为文件夹名。

--vcs vcs

初始化一个新的 VCS 仓库 (git，hg，pijul 或 fossil)，或不初始化任何版本控制 (none)。如果没有指定，默认使用 git ，或者 cargo-new.vcs 中设置的值，或者为 none (如果已经在一个 VSC 库中)。

--registry registry

这会设置 Cargo.toml 中的 publish 字段，指定一个 registry 的名字，使得包只能发布到这个 registry 。

Registry 的名称定义在 Cargo config files. 如果没有指定，则使用registry.default 中设置的默认 registry 。 如果没有设置默认 registry 且没有指定 --registry ，则 publish 字段不会被设置，这意味着发布没有任何限制。

显示选项

-v

--verbose

进行 verbose 输出。可以指定两遍来开启 "very verbose" 模式，输出更多的额外信息，像是依赖项的警告和构建脚本的输出信息。 也可以通过 term.verbose 配置 。

-q

--quiet

不打印 cargo log 信息。 也可以通过 term.quiet 配置。

--color when

控制*何时*使用彩色输出。可选值有:

• auto (默认值): 自动检测终端是否支持彩色输出。
• always: 总是显示彩色。
• never: 从不显示彩色。

也可以在 term.color 配置。

通用选项

+toolchain

如果 Cargo 由 rustup 安装，那么 cargo 后第一个以 + 开头的参数会被认为是 rustup toolchain 名字(例如 +stable 或 +nightly)。 查看 rustup documentation 了解 toolchain overrides 如何工作。

--config KEY=VALUE or PATH

覆盖一个 Cargo 配置的值。参数应该是一个 TOML 语法的 KEY=VALUE，或者提供一个路径来指向一个额外的配置文件 (configuration file)。 这个标记可以指定多次。 参考 command-line overrides 一节 获取更多信息。

-h

--help

打印帮助信息。

-Z flag

不稳定 (nightly-only) 的标志。 执行 cargo -Z help 获取详细信息。

环境

查看 the reference 获取 Cargo 读取的环境变量的更多信息。

退出状态

• 0: Cargo 执行成功。
• 101: Cargo 没有执行完成。

使用案例

1. 在当前文件夹中创建一个二进制 Cargo 包:

   cargo init
   

其他参考

cargo(1), cargo-new(1)