cargo-publish(1)

描述

此命令将创建一个可分发的、压缩的 .crate 文件，其中包含当前目录中软件包的源代码，并将其上传到注册表。默认注册表是 https://crates.io。它执行以下步骤：

执行一些检查，包括：
- 检查清单中的 package.publish 键，以限制允许您发布到的注册表。
按照 cargo-package(1) 中的步骤创建一个 .crate 文件。
将 crate 上传到注册表。服务器将对 crate 执行额外的检查。
客户端将轮询，等待包出现在索引中，并且可能会超时。在这种情况下，您需要手动检查是否完成。此超时不影响上传。

此命令要求您使用 --token 选项或使用 cargo-login(1) 进行身份验证。

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

选项

发布选项

--dry-run

执行所有检查而不上传。

--token token

身份验证时使用的 API 令牌。这将覆盖存储在凭据文件中的令牌（该文件由 cargo-login(1) 创建）。

可以使用 Cargo 配置环境变量来覆盖存储在凭据文件中的令牌。crates.io 的令牌可以使用 CARGO_REGISTRY_TOKEN 环境变量指定。其他注册表的令牌可以使用 CARGO_REGISTRIES_NAME_TOKEN 形式的环境变量指定，其中 NAME 是注册表的名称，全部为大写字母。

--no-verify

不通过构建来验证内容。

--allow-dirty

允许打包具有未提交 VCS 更改的工作目录。

--index index

要使用的注册表索引的 URL。

--registry registry

要发布到的注册表的名称。注册表名称在Cargo 配置文件中定义。如果未指定，并且 Cargo.toml 中有一个包含单个注册表的 package.publish 字段，那么它将发布到该注册表。否则，它将使用默认注册表，该默认注册表由 registry.default 配置键定义，该配置键默认为 crates-io。

包选择

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

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

选择多个包是不稳定的，仅在 nightly channel 上可用，并且需要 -Z package-workspace 标志才能启用。有关更多信息，请参阅 https://github.com/rust-lang/cargo/issues/10948。

-p spec…

--package spec…

仅发布指定的包。有关 SPEC 格式，请参阅 cargo-pkgid(1)。此标志可以指定多次，并支持常见的 Unix glob 模式，如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理它们之前意外扩展 glob 模式，您必须在每个模式周围使用单引号或双引号。

使用此选项选择多个包是不稳定的，仅在 nightly channel 上可用，并且需要 -Z package-workspace 标志才能启用。有关更多信息，请参阅 https://github.com/rust-lang/cargo/issues/10948。

--workspace

发布工作区中的所有成员。

此选项是不稳定的，仅在 nightly channel 上可用，并且需要 -Z package-workspace 标志才能启用。有关更多信息，请参阅 https://github.com/rust-lang/cargo/issues/10948。

--exclude SPEC…

排除指定的包。必须与 --workspace 标志结合使用。此标志可以指定多次，并支持常见的 Unix glob 模式，如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理它们之前意外扩展 glob 模式，您必须在每个模式周围使用单引号或双引号。

编译选项

--target triple

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

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

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

--target-dir directory

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

功能选择

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

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

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

清单选项

--manifest-path 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 PATH

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

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

其他选项

-j N

--jobs N

要运行的并行作业数。也可以使用 build.jobs 配置值指定。默认为逻辑 CPU 的数量。如果为负数，则将最大并行作业数设置为逻辑 CPU 的数量加上提供的值。如果提供了字符串 default，则将值设置回默认值。不应为 0。

--keep-going

尽可能构建依赖关系图中尽可能多的 crate，而不是在第一个构建失败的 crate 上中止构建。

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

显示选项

-v

--verbose

使用详细输出。可以指定两次以获得“非常详细”的输出，其中包括额外的输出，如依赖警告和构建脚本输出。也可以使用 term.verbose 配置值来指定。

-q

--quiet

不打印 cargo 日志消息。也可以使用 term.quiet 配置值来指定。

--color when

控制何时使用彩色输出。有效值：

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

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

常用选项

+toolchain

如果 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 未能完成。

示例

发布当前包
```
cargo publish
```

另请参阅

cargo(1), cargo-package(1), cargo-login(1)

Cargo 手册