cargo-package(1)

名称

cargo-package — 将本地包组装成可分发的 tarball

概要

cargo package [选项]

描述

此命令将使用当前目录中包的源代码创建一个可分发的压缩 .crate 文件。生成的文件将存储在 target/package 目录中。这将执行以下步骤

  1. 加载并检查当前工作区，执行一些基本检查。

    • 除非路径依赖项具有版本键，否则不允许使用。Cargo 将忽略已发布包中依赖项的路径键。dev-dependencies 没有此限制。

  2. 创建压缩的 .crate 文件。

    • 原始 Cargo.toml 文件将被重写并规范化。
    • [patch]、[replace] 和 [workspace] 部分将从清单中删除。
    • 如果包包含可执行二进制文件或示例目标，则会自动包含 Cargo.lock。cargo-install(1) 如果使用 --locked 标志，则将使用打包的锁定文件。
    • 将包含一个 .cargo_vcs_info.json 文件，其中包含有关当前 VCS 检出哈希的信息（如果可用），以及工作树是否脏的标志。
    • 符号链接将被展平为其目标文件。
    • 文件和目录将根据 [include] 和 [exclude] 字段 中提到的规则包含或排除。

  3. 提取 .crate 文件并构建它以验证它是否可以构建。

    • 这将从头开始重新构建您的包，以确保它可以从原始状态构建。可以使用 --no-verify 标志跳过此步骤。

  4. 检查构建脚本是否修改了任何源文件。

包含的文件列表可以使用清单中的 include 和 exclude 字段进行控制。

有关打包和发布的更多详细信息，请参阅参考。

.cargo_vcs_info.json 格式

将生成以下格式的 .cargo_vcs_info.json

{
 "git": {
   "sha1": "aac20b6e7e543e6dd4118b246c77225e3a3a1302",
   "dirty": true
 },
 "path_in_vcs": ""
}

dirty 表示在构建包时 Git 工作树是脏的。

path_in_vcs 将设置为版本控制存储库子目录中包的存储库相对路径。

此文件的兼容性与 cargo-metadata(1) 的 JSON 输出采用相同的策略进行维护。

请注意，此文件提供了 VCS 信息的尽力而为快照。但是，包的来源未经验证。不能保证 tarball 中的源代码与 VCS 信息匹配。

选项

包选项

-l
--list
打印包中包含的文件，而不创建包。
--no-verify
不通过构建来验证内容。
--no-metadata
忽略缺少人类可用的元数据（例如描述或许可证）的警告。
--allow-dirty
允许打包具有未提交的 VCS 更改的工作目录。
--index 索引
要使用的注册表索引的 URL。
--registry 注册表
要打包的注册表的名称；有关注册表名称配置的更多详细信息，请参阅 cargo publish --help。这些包不会发布到此注册表，但如果我们正在打包多个相互依赖的 crate，则将在假设依赖项将发布到此注册表的情况下生成锁定文件。

包选择

默认情况下，当未给出包选择选项时，选择的包取决于选择的清单文件（如果未给出 --manifest-path，则基于当前工作目录）。如果清单是工作区的根，则将选择工作区的默认成员，否则只会选择由清单定义的包。

可以使用根清单中的 workspace.default-members 键显式设置工作区的默认成员。如果未设置此项，则虚拟工作区将包含所有工作区成员（等效于传递 --workspace），而非虚拟工作区将仅包含根 crate 本身。

-p 规格…
--package 规格…
仅打包指定的包。有关 SPEC 格式，请参阅 cargo-pkgid(1)。此标志可以多次指定，并支持常见的 Unix glob 模式，例如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理它们之前意外扩展 glob 模式，您必须在每个模式周围使用单引号或双引号。
--workspace
打包工作区中的所有成员。
--exclude 规格…
排除指定的包。必须与 --workspace 标志一起使用。此标志可以多次指定，并支持常见的 Unix glob 模式，例如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理它们之前意外扩展 glob 模式，您必须在每个模式周围使用单引号或双引号。

编译选项

--target 三元组
为给定的架构打包。默认值是主机架构。三元组的一般格式为 <arch><sub>-<vendor>-<sys>-<abi>。运行 rustc --print target-list 获取受支持的目标列表。此标志可以多次指定。

也可以使用 build.target 配置值 指定此项。

请注意，指定此标志会使 Cargo 在不同的模式下运行，其中目标工件放置在单独的目录中。有关更多详细信息，请参阅构建缓存文档。

--target-dir 目录
所有生成的工件和中间文件的目录。也可以使用 CARGO_TARGET_DIR 环境变量或 build.target-dir 配置值 指定。默认值为工作区根目录中的 target。

功能选择

功能标志允许您控制启用哪些功能。当未给出任何功能选项时，将为每个选定的包激活 default 功能。

有关更多详细信息，请参阅功能文档。

-F 功能
--features 功能
要激活的功能的空格或逗号分隔列表。可以使用 package-name/feature-name 语法启用工作区成员的功能。此标志可以多次指定，这将启用所有指定的功能。
--all-features
激活所有选定包的所有可用功能。
--no-default-features
不激活所选包的 default 功能。

清单选项

--manifest-path 路径
Cargo.toml 文件的路径。默认情况下，Cargo 会在当前目录或任何父目录中搜索 Cargo.toml 文件。
--locked
断言使用的依赖项和版本与最初生成现有 Cargo.lock 文件时使用的完全相同。当出现以下任何一种情况时，Cargo 将以错误退出

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

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

--offline
阻止 Cargo 以任何理由访问网络。如果没有此标志，如果 Cargo 需要访问网络但网络不可用，则会停止并出现错误。使用此标志，如果可能，Cargo 将尝试在没有网络的情况下继续操作。

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

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

--frozen
等效于同时指定 --locked 和 --offline。
--lockfile-path 路径
将锁定文件的路径从默认值 (<workspace_root>/Cargo.lock) 更改为 路径。路径 必须以 Cargo.lock 结尾（例如 --lockfile-path /tmp/temporary-lockfile/Cargo.lock）。请注意，提供 --lockfile-path 将忽略默认路径中的现有锁定文件，而是使用来自 路径 的锁定文件，或者如果 路径 不存在，则将新的锁定文件写入提供的 路径 中。此标志可用于在只读目录中运行大多数命令，并将锁定文件写入提供的 路径 中。

此选项仅在 nightly channel 上可用，并且需要使用 -Z unstable-options 标志启用（请参阅 #14421）。

杂项选项

-j N
--jobs N
要运行的并行任务数量。也可以使用 build.jobs 配置值 来指定。默认为逻辑 CPU 的数量。如果为负数，则将最大并行任务数设置为逻辑 CPU 的数量加上提供的值。如果提供字符串 default，则将值设置回默认值。不应为 0。
--keep-going
尽可能多地构建依赖关系图中的 crate，而不是在第一个构建失败时中止构建。

例如，如果当前包依赖于 fails 和 works 依赖项，其中一个构建失败，则 cargo package -j1 可能会也可能不会构建成功的那一个（取决于 Cargo 选择先运行哪个构建），而 cargo package -j1 --keep-going 肯定会运行这两个构建，即使第一个运行的构建失败。

显示选项

-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 PATH
在执行任何指定的操作之前更改当前工作目录。这会影响诸如 cargo 默认查找项目清单 (Cargo.toml) 的位置，以及搜索 .cargo/config.toml 的目录。此选项必须出现在命令名称之前，例如 cargo -C path/to/my-project build。

此选项仅在 nightly channel 上可用，并且需要 -Z unstable-options 标志来启用（请参阅 #10098）。

-h
--help
打印帮助信息。
-Z flag
Cargo 的不稳定（仅限 nightly）标志。运行 cargo -Z help 获取详细信息。

环境变量

有关 Cargo 读取的环境变量的详细信息，请参阅 参考。

退出状态

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

示例

  1. 创建当前包的压缩 .crate 文件

    cargo package

另请参阅

cargo(1), cargo-publish(1)