CARGO-INFO(1)

📦 version 1.93.1, in ubuntu resolute

💖 CARGO-INFO — the cargo-info(1) manual, bestie edition 💖

okay so picture this: it's a general commands manual page, it's giving very "let me tell you about a package", and honestly? iconic. welcome to cargo-info, the cargo subcommand that spills the tea on any crate you want. let's get into it 🫶

✨ NAME ✨

cargo-info — display information about a package. that's it, that's the whole job, and she does it flawlessly 💅

🌸 SYNOPSIS 🌸

cargo info [options] spec

🦋 DESCRIPTION 🦋

so this command shows you the deets on a package. it goes and fetches the data straight out of that package's Cargo.toml file and then presents it to you in a human-readable format — no cap, actually readable, not a wall of chaos 😭

🎀 OPTIONS 🎀

💜 Info Options

  • spec — fetch info about the package you named. this spec can be a package ID, and you should peek at cargo-pkgid(1) for the whole SPEC format situation. if the package you named is part of the current workspace, then the info shown comes from the local Cargo.toml file. if the Cargo.lock file doesn't exist yet, it will be created. and if you didn't specify a version, the appropriate version gets picked based on the Minimum Supported Rust Version (MSRV) ✨
  • --index index — the URL of the registry index to use. drop the URL right there.
  • --registry registry — name of the registry to use. registry names are defined in Cargo config files <https://doc.rust-lang.org/cargo/reference/config.html>. if you don't specify one, the default registry is used, which is defined by the registry.default config key — and that one defaults to crates-io 👑

🌈 Display Options

  • -v, --verbose — use verbose output. you can specify it 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>. yes she can be extra, it's her right 💅
  • -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>. shhh era 🤫
  • --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 <https://doc.rust-lang.org/cargo/reference/config.html>. personally? always. rainbows only 🌈

🍓 Manifest Options

  • --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. this is the "i said what i said" flag 💀

  • --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 <https://doc.rust-lang.org/cargo/reference/config.html>.

  • --frozen — equivalent to specifying both --locked and --offline. two flags, one vibe ✨

🧚 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.
  • --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.

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 🥲

  • -h, --help — prints help information. the classic.
  • -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. all the env lore lives over there 📚

⭐ EXIT STATUS ⭐

  • 0: Cargo succeeded. we love a win 🎉
  • 101: Cargo failed to complete. it happens, we move 💔

🔥 EXAMPLES 🔥

  1. inspect the serde package from crates.io:
cargo info serde
  1. inspect the serde package with version 1.0.0:
cargo info serde@1.0.0
  1. inspect the serde package form the local registry:
cargo info serde --registry my-registry

👑 SEE ALSO 👑

cargo(1), cargo-search(1)

and that's the whole page, bestie 🎀 it came from the General Commands Manual, it's CARGO-INFO(1), and it's lowkey the most useful little subcommand in the whole toolbox. go read some Cargo.tomls, you deserve it. mwah 💖✨🦋

📦 where this page comes from