cargo-init(1)

名称

cargo-init — 在现有目录中创建一个新的 Cargo 包

概要

cargo init [选项] [路径]

描述

此命令将在当前目录中创建一个新的 Cargo 清单。提供一个路径作为参数，以便在给定目录中创建。

如果目录中已经存在典型命名的 Rust 源文件，则将使用这些文件。否则，将创建一个示例 src/main.rs 文件，如果传递了 --lib，则会创建 src/lib.rs 文件。

如果该目录尚未在 VCS 仓库中，则将创建一个新的仓库（请参阅下面的 --vcs）。

有关在新的目录中创建新包的类似命令，请参阅 cargo-new(1)。

选项

Init 选项

--bin
创建一个带有二进制目标（src/main.rs）的包。这是默认行为。
--lib
创建一个带有库目标（src/lib.rs）的包。
--edition 版本
指定要使用的 Rust 版本。默认为 2021。可能的值：2015、2018、2021、2024
--name 名称
设置包名称。默认为目录名称。
--vcs vcs
为给定的版本控制系统（git、hg、pijul 或 fossil）初始化一个新的 VCS 仓库，或者根本不初始化任何版本控制（none）。如果未指定，则默认为 git 或配置值 cargo-new.vcs，如果已经在 VCS 仓库中，则默认为 none。
--registry 注册表
这将 Cargo.toml 中的 publish 字段设置为给定的注册表名称，这将限制仅发布到该注册表。

注册表名称在 Cargo 配置文件中定义。如果未指定，则使用由 registry.default 配置键定义的默认注册表。如果未设置默认注册表且未使用 --registry，则不会设置 publish 字段，这意味着发布将不受限制。

显示选项

-v
--verbose
使用详细输出。可以指定两次以获得“非常详细”的输出，其中包括额外的输出，例如依赖项警告和构建脚本输出。也可以使用 term.verbose 配置值 指定。
-q
--quiet
不打印 cargo 日志消息。也可以使用 term.quiet 配置值 指定。
--color when
控制何时使用彩色输出。有效值

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

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

常用选项

+工具链
如果 Cargo 是使用 rustup 安装的，并且 cargo 的第一个参数以 + 开头，它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖如何工作的更多信息，请参阅 rustup 文档。
--config KEY=VALUE 或 PATH
覆盖 Cargo 配置值。参数应该采用 KEY=VALUE 的 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 未能完成。

示例

  1. 在当前目录中创建一个二进制 Cargo 包

    cargo init

另请参阅

cargo(1), cargo-new(1)