CARGO-INFO(1)

πŸ“¦ version 1.85.1, in ubuntu jammy, ubuntu noble, ubuntu questing

πŸ’– cargo-info β€” the manual page, but make it cute πŸ’–

okay bestie, welcome to the General Commands Manual, section 1, where we're pulling up on cargo-info(1) β€” the page that shows you everything about a package without you having to go dig through crates.io like it's 2014. this is giving ✨research era✨ and we're obsessed.


🌸 NAME 🌸

cargo-info β€” display information about a package. that's it. that's the whole job. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

cargo info [options] spec

πŸŽ€ DESCRIPTION πŸŽ€

so here's the vibe: this command shows you info about a package. it goes and fetches the data from the package's Cargo.toml file and then presents it to you in a human-readable format β€” meaning, bestie, it's actually readable, not a wall of unhinged JSON. no cap. πŸ”₯


✨ OPTIONS ✨

πŸ“ Info Options πŸ“

  • spec β€” fetch info about the package you name here. the spec can be a package ID, so go peek at cargo-pkgid(1) for the SPEC format if you need the deets. here's the tea though: if the package you're asking about is part of your current workspace, then it just shows you the info from the local Cargo.toml file instead. also, if the Cargo.lock file doesn't exist, it will be created β€” surprise, you got a lock file 🫢. and if you don't specify a version, the appropriate version gets selected based on the Minimum Supported Rust Version (MSRV). slay.
  • --index index β€” the URL of the registry index to use.
  • --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 β€” and that default is defined by the registry.default config key, which defaults to crates-io. the default of the default, we love to see it πŸ’œ

🌈 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). double it and it gets chatty πŸ’€
  • -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).
  • --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). ok but always is the main character choice ngl 🌈

🧚 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. periodt. deterministic or nothing. πŸ”’

  • --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. plan ahead or perish fr fr.

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 glow-up ✨

πŸ‘‘ 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. order matters, bestie, 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). so like… nightly girlies only, iykyk πŸ™ˆ
  • -h, --help β€” prints help information. when in doubt, ask for help. iconic behaviour.
  • -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. go read it, it's right there 🫢


⭐ EXIT STATUS ⭐

  • 0: Cargo succeeded. πŸŽ‰
  • 101: Cargo failed to complete. πŸ’€

πŸ”₯ 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 from the local registry:
cargo info serde --registry my-registry

🌸 SEE ALSO 🌸

cargo(1), cargo-search(1)


okay and finally, the sign-off πŸŽ€ β€” this whole page is filed under the General Commands Manual as CARGO-INFO(1), and yeah, its footer is literally just CARGO-INFO(1) again, no date, no version, nothing extra. mysterious. lowkey iconic. anyway bestie, go inspect some packages, you're gonna eat πŸ’…βœ¨πŸ¦‹

πŸ“¦ where this page comes from