06-cargo pkgid

译文 · 基于 The Cargo Book

cargo-pkgid(1)

原文链接: https://doc.rust-lang.org/cargo/commands/cargo-pkgid.html

名称

cargo-pkgid — 打印完全限定的包规范

大纲

cargo pkgid [options] [spec]

描述

给定 spec 参数，打印当前工作空间中某个包或依赖的完全限定包 ID 规范。 若 spec 在依赖图中所指的包不明确，此命令将报错。若未给定 spec，则打印本地包的规范。

此命令要求锁文件可用且依赖已获取。

包规范由名称、版本与源 URL 组成。只要只匹配一个包，你可以使用部分规范来简洁地匹配特定包。 Cargo 的其他部分也使用此规范，例如 cargo-metadata(1) 与 Cargo 发出的 JSON 消息。

spec 的格式可以是以下之一：

规范语法见 包 ID 规范 一章。

选项

包选择

-p spec

--package spec

获取给定包的包 ID，而非当前包。

显示选项

-v

--verbose

使用详细输出。可指定两次以获得“非常详细”的输出，其中包含依赖警告与构建脚本输出等额外信息。 也可通过 term.verbose 配置值 指定。

-q

--quiet

不打印 cargo 日志消息。 也可通过 term.quiet 配置值 指定。

--color when

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

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

也可通过 term.color 配置值 指定。

清单选项

--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。

通用选项

+toolchain

若 Cargo 通过 rustup 安装，且传给 cargo 的第一个参数以 + 开头，则会被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。 关于工具链覆盖如何工作，见 rustup 文档。

--config KEY=VALUE or PATH

覆盖 Cargo 配置值。参数应为 TOML 语法的 KEY=VALUE， 或指向额外配置文件的路径。此标志可指定多次。 更多信息见 命令行覆盖一节。

-C PATH

在执行任何指定操作之前更改当前工作目录。这会影响 Cargo 默认查找项目清单（Cargo.toml）的位置，以及 用于发现 .cargo/config.toml 的目录搜索等。此选项必须 出现在命令名称之前，例如 cargo -C path/to/my-project build。

此选项仅在 nightly 通道 上可用，且 需要 -Z unstable-options 标志才能启用（见 #10098）。

-h

--help

打印帮助信息。

-Z flag

Cargo 的不稳定（仅 nightly）标志。运行 cargo -Z help 查看详情。

环境

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

退出状态

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

示例

1. 获取 foo 包的包规范：

   cargo pkgid foo
   

2. 获取 foo 版本 1.0.0 的包规范：

   cargo pkgid foo@1.0.0
   

3. 获取来自 crates.io 的 foo 包规范：

   cargo pkgid https://github.com/rust-lang/crates.io-index#foo
   

4. 获取来自本地包的 foo 包规范：

   cargo pkgid file:///path/to/local/package#foo
   

参见

cargo(1), cargo-generate-lockfile(1), cargo-metadata(1), 包 ID 规范, JSON 消息