cargo-pkgid(1)

名称

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

概要

cargo pkgid [选项] [规范]

描述

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

此命令要求存在锁文件并且已经获取了依赖项。

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

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

规范结构示例规范
名称bitflags
名称@版本[email protected]
urlhttps://github.com/rust-lang/cargo
url#版本https://github.com/rust-lang/cargo#0.33.0
url#名称https://github.com/rust-lang/crates.io-index#bitflags
url#名称@版本https://github.com/rust-lang/cargo#[email protected]

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

选项

包选择

-p 规范
--package 规范
获取给定包的包 ID,而不是当前包。

显示选项

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

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

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

清单选项

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

  • 锁文件丢失。
  • 由于不同的依赖项解析,Cargo 尝试更改锁文件。

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

--offline
阻止 Cargo 以任何理由访问网络。如果没有此标志,如果 Cargo 需要访问网络且网络不可用,Cargo 将停止并显示错误。使用此标志,如果可能,Cargo 将尝试在没有网络的情况下继续。

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

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

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

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

通用选项

+工具链
如果 Cargo 是使用 rustup 安装的,并且 cargo 的第一个参数以 + 开头,它将被解释为 rustup 工具链名称(例如 +stable+nightly)。有关工具链覆盖如何工作的更多信息,请参阅 rustup 文档
--config KEY=VALUEPATH
覆盖 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. 检索 foo 包的包规范

    cargo pkgid foo
    
  2. 检索 foo 的 1.0.0 版本的包规范

    cargo pkgid [email protected]
    
  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 消息