CARGO-PKGID(1)

📦 version 1.80.1, in ubuntu jammy, ubuntu noble

💖 CARGO-PKGID — the manual page, but make it cute 💖

okay bestie, welcome to the cargo-pkgid page from the General Commands Manual, i'm your host and i'm obsessed with this command actually.

✨ NAME ✨

cargo-pkgid — print a fully qualified package specification. that's it. that's the job. she's simple, she's precise, she eats 💅

🦋 SYNOPSIS 🦋

cargo pkgid [options] [spec]

🌸 DESCRIPTION 🌸

so here's the vibe: you hand her a spec argument, and she prints out the fully qualified package ID specifier for a package or a dependency in the current workspace. literally just the full glow-up version of whatever you pointed at.

⚠️ heads up: if spec is ambiguous about which package it refers to in the dependency graph, this command will throw an error. no guessing, no coin flips, she will simply not do it.

and if you give her no spec at all? she prints the specifier for the local package. lowkey the default behavior is giving main character 🫶

also this command requires that a lockfile is available and that dependencies have been fetched. no lockfile, no crumbs, no service 😭

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. one. singular. don't be greedy 💀

and this same specifier format is used by other parts in Cargo too, like cargo-metadata(1) and the JSON messages emitted by Cargo (https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages). it's iconic across the whole ecosystem, iykyk.

the format of a spec can be one of these:

the full specification grammar lives in chapter Package ID Specifications (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html) if you wanna go read the source material bestie 📖

👑 OPTIONS 👑

Package Selection

  • -p spec, --package spec — get the package ID for the given package instead of the current package. like, "not this one, that one" energy.

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 (https://doc.rust-lang.org/cargo/reference/config.html). double it and it gets louder, periodt.
  • -q, --quiet — do not print cargo log messages. may also be specified with the term.quiet config value (https://doc.rust-lang.org/cargo/reference/config.html). silence is golden, she said it first 🌙
  • --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. rainbow mode forever 🌈
    • never: never display colors.

may also be specified with the term.color config value (https://doc.rust-lang.org/cargo/reference/config.html).

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. she will climb the whole family tree to find it fr fr 🌳
  • --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. if you're a CI girlie, this one's for you 🎀

  • --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 bestie: 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. do your homework before you go offline, not during.

may also be specified with the net.offline config value (https://doc.rust-lang.org/cargo/reference/config.html).

  • --frozen — equivalent to specifying both --locked and --offline. two-for-one, a bundle deal, she's efficient 💅

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 (https://rust-lang.github.io/rustup/overrides.html) for more information about how toolchain overrides work. pick your fighter ✨
  • --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 (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. order matters, don't fight it 🫠
🔥 this option is only available on the nightly channel (https://doc.rust-lang.org/book/appendix-07-nightly-rust.html) and requires the -Z unstable-options flag to enable (see #10098 https://github.com/rust-lang/cargo/issues/10098). nightly girlies only, sorry to the stable girlies, i don't make the rules.
  • -h, --help — prints help information. when in doubt, ask her directly 🎀
  • -Z flag — unstable (nightly-only) flags to Cargo. run cargo -Z help for details.

🌈 ENVIRONMENT 🌈

see the reference (https://doc.rust-lang.org/cargo/reference/environment-variables.html) for details on environment variables that Cargo reads. the full tea is over there, i'm just the messenger 💜

⭐ 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 🧚

cargo(1), cargo-generate-lockfile(1), cargo-metadata(1), Package ID Specifications (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html), JSON messages (https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages)

and that's the whole page bestie — this one's from the General Commands Manual, titled CARGO-PKGID(1), and yeah, that little CARGO-PKGID(1) down at the bottom is just her signature. go forth and get those fully qualified specs 💖✨

📦 where this page comes from