CARGO-PKGID(1)

📦 version 1.96.1, in ubuntu stonking

💖 CARGO-PKGID 💖

okay so bestie, welcome to cargo-pkgid — it's a page straight out of the General Commands Manual and it's about to tell you literally everything you need to know about printing a fully qualified package spec. grab a boba, we're doing this ✨

🌸 NAME 🌸

cargo-pkgid — Print a fully qualified package specification

🦋 SYNOPSIS 🦋

cargo pkgid [options] [spec]

✨ DESCRIPTION ✨

So here's the vibe 🫶 if you hand it a spec argument, it prints out the fully qualified package ID specifier for a package or dependency in the current workspace. Like, the whole entire glow-up name, not the nickname.

Heads up bestie: if spec is ambiguous about which package it means in the dependency graph, this command will generate an error. no cap. it does not guess. 🙈

If you don't give it a spec at all, then it just prints the specifier for the local package. easy.

This command requires that a lockfile is available and dependencies have been fetched. it's giving "do your homework first" energy 😭

A package specifier is made of a name, a version, and a source URL. You're allowed to use partial specifiers to succinctly match a specific package — as long as it matches only one package. slay. This specifier is also used by other parts in Cargo, such as cargo-metadata(1) and JSON messages emitted by Cargo — that's at https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages btw 👑

The format of a spec can be one of the following:

The specification grammar lives in chapter Package ID Specifications at https://doc.rust-lang.org/cargo/reference/pkgid-spec.html. iykyk 💜

🎀 OPTIONS 🎀

📦 Package Selection 📦

  • -p spec, --package spec — Get the package ID for the given package instead of the current package. periodt.

🌈 Display Options 🌈

  • -v, --verbose — Use verbose output. May be specified twice for "very verbose" output, which includes extra output such as dependency warnings and build script output. May also be specified with the term.verbose config value at https://doc.rust-lang.org/cargo/reference/config.html.
  • -q, --quiet — Do not print cargo log messages. May also be specified with the term.quiet config value at https://doc.rust-lang.org/cargo/reference/config.html. shhh 🤫
  • --color when — Control when colored output is used. Valid values:
    • auto (default): Automatically detect if color support is available on the terminal.
    • always: Always display colors.
    • never: Never display colors.

May also be specified with the term.color config value at https://doc.rust-lang.org/cargo/reference/config.html. aesthetic choices are valid ✨

🧚 Manifest Options 🧚

  • --manifest-path path — Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory. it goes looking, bestie 🔍
  • --locked — Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:
    • The lock file is missing.
    • Cargo attempted to change the lock file due to a different dependency resolution.

It may be used in environments where deterministic builds are desired, such as in CI pipelines. main character energy for reproducibility 💅

  • --offline — Prevents Cargo from accessing the network for any reason. Without this flag, Cargo will stop with an error if it needs to access the network and the network is not available. With this flag, Cargo will attempt to proceed without the network if possible.
⚠️ Beware that this may result in different dependency resolution than online mode. Cargo will restrict itself to crates that are downloaded locally, even if there might be a newer version as indicated in the local copy of the index. See the cargo-fetch(1) command to download dependencies before going offline.

May also be specified with the net.offline config value at https://doc.rust-lang.org/cargo/reference/config.html. airplane mode but make it Rust ✈️

  • --frozen — Equivalent to specifying both --locked and --offline. two for one deal, obsessed 🍓

👑 Common Options 👑

  • +toolchain — If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). See the rustup documentation at https://rust-lang.github.io/rustup/overrides.html for more information about how toolchain overrides work.
  • --config KEY=VALUE or PATH — Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section at https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides for more information.
  • -C PATH — Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must appear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly channel at https://doc.rust-lang.org/book/appendix-07-nightly-rust.html and requires the -Z unstable-options flag to enable (see #10098 at https://github.com/rust-lang/cargo/issues/10098). so like, unstable babe, handle with care 💀
  • -h, --help — Prints help information. when in doubt 🫶
  • -Z flag — Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

🌈 ENVIRONMENT 🌈

See the reference at https://doc.rust-lang.org/cargo/reference/environment-variables.html for details on environment variables that Cargo reads. that's the whole section, it's short and it knows it 💜

💅 EXIT STATUS 💅

  • 0: Cargo succeeded. 🎉
  • 101: Cargo failed to complete. 😭

⭐ EXAMPLES ⭐

  1. Retrieve package specification for foo package:
cargo pkgid foo
  1. Retrieve package specification for version 1.0.0 of foo:
cargo pkgid foo@1.0.0
  1. Retrieve package specification for foo from crates.io:
cargo pkgid https://github.com/rust-lang/crates.io-index#foo
  1. Retrieve package specification for foo from a local package:
cargo pkgid file:///path/to/local/package#foo

🔥 SEE ALSO 🔥

and that's the whole thing bestie, no crumbs left 🎀 this was the CARGO-PKGID(1) page from the General Commands Manual — go forth and print those fully qualified package specs, you absolute icon 👑💖

📦 where this page comes from