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,而不是当前包的包 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 将限制自己使用本地下载的包,即使本地索引副本中可能指示有更新的版本。请参阅 cargo-fetch(1) 命令以下载依赖项,然后再脱机。

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

--frozen
等效于同时指定 --locked--offline

通用选项

+工具链
如果 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 频道 上可用,并且需要使用 -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 [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 消息