cargo-pkgid(1)

名称

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

概要

cargo pkgid [选项] [规范]

描述

给定一个 规范 参数，打印出当前工作区中包或依赖项的完全限定的包 ID 标识符。如果在依赖图谱中，规范 所指代的包不明确，该命令将生成错误。如果没有给出 规范，则打印出本地包的标识符。

此命令要求存在 lockfile（锁定文件）且已获取依赖项。

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

规范 的格式可以是以下之一：

规范的语法可以在 包 ID 规范 章中找到。

选项

包选择

-p 规范

--package 规范

获取给定包而不是当前包的包 ID。

显示选项

-v

--verbose

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

-q

--quiet

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

--color 何时

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

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

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

清单选项

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

通用选项

+工具链

如果 Cargo 是通过 rustup 安装的，并且 cargo 的第一个参数以 + 开头，则它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖工作原理的更多信息，请参阅 rustup 文档。

--config 键=值 或 路径

覆盖 Cargo 配置值。参数应为 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. 获取 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 消息