CARGO-REPORT(1)

๐Ÿ“ฆ
version 1.99.1 ยท 3 versions
, in alpine 3.24, centos-stream 10, centos-stream 9, debian bookworm, debian trixie, fedora 43, fedora 44, nixos 26.05, opensuse-leap 16.0

๐ŸŒธ CARGO-REPORT(1) ๐ŸŒธ

okay bestie, welcome to the General Commands Manual page for cargo-report โ€” yes, the manual name is literally General Commands Manual, and this whole thing lives under it. let's get into it ๐Ÿ’…


โœจ NAME โœจ

cargo-report โ€” Generate and display various kinds of reports ๐ŸŽ€


โœจ SYNOPSIS โœจ

cargo report type [options]

โœจ DESCRIPTION โœจ

It shows you a report of whatever type you asked for โ€” and right now, the only type on the menu is future-incompat. that's it, that's the whole vibe. only future-incompat is supported. periodt โœจ


โœจ OPTIONS โœจ

๐Ÿ’– Display Options ๐Ÿ’–

  • -v, --verbose โ€” bestie wants the verbose output. say it twice and you get "very verbose" mode, which is the one that also throws in extra stuff like dependency warnings and build script output ๐Ÿ‘€. you can also just set this with the term.verbose config value (<https://doc.rust-lang.org/cargo/reference/config.html>).
  • -q, --quiet โ€” do NOT print cargo log messages, we're being chill ๐Ÿ˜Œ. you can also set this with the term.quiet config value (<https://doc.rust-lang.org/cargo/reference/config.html>).
  • --color when โ€” controls when colored output happens. the valid values are:
    • auto (this is the default): automatically detect if the terminal supports color. it figures out the vibe check itself ๐Ÿฆ‹
    • always: always show colors. rainbow mode, no cap ๐ŸŒˆ
    • never: never show colors. monochrome era ๐Ÿ’€

you can also set this with the term.color config value (<https://doc.rust-lang.org/cargo/reference/config.html>).

๐Ÿ’– 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 these scenarios shows up:
    • the lock file is missing ๐Ÿ˜ญ
    • cargo attempted to change the lock file because of a different dependency resolution

it's giving deterministic builds, so use it in environments where you want that โ€” like CI pipelines ๐Ÿซถ

  • --offline โ€” prevents cargo from accessing the network, for any reason. without this flag, cargo will stop with an error if it needs the network and the network isn't available. with this flag, cargo will try to proceed without the network if it can ๐ŸŒ™
beware bestie โ€” this may result in a 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.

you can also set this with the net.offline config value (<https://doc.rust-lang.org/cargo/reference/config.html>).

  • --frozen โ€” literally equivalent to specifying both --locked and --offline at the same time. two for one, iconic ๐Ÿ‘‘

๐Ÿ’– Common Options ๐Ÿ’–

  • +toolchain โ€” if cargo was installed with rustup, and the first argument to cargo begins with +, it gets interpreted as a rustup toolchain name (like +stable or +nightly). see the rustup documentation (<https://rust-lang.github.io/rustup/overrides.html>) for more info on 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 given 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 info.
  • -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), and also the directories searched for discovering .cargo/config.toml, for example. this option must appear before the command name, like 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>).
  • -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 ๐ŸŒฑ


โœจ EXIT STATUS โœจ

  • 0: cargo succeeded ๐ŸŽ‰
  • 101: cargo failed to complete ๐Ÿ˜ญ

โœจ EXAMPLES โœจ

  1. Display the available kinds of reports:
cargo report --help

โœจ SEE ALSO โœจ

cargo(1), cargo-report-future-incompatibilities(1)


and that's the whole page, bestie ๐Ÿซถ this was CARGO-REPORT(1) from the General Commands Manual, version/date line reading CARGO-REPORT(1) โ€” slay, go forth and generate those reports ๐Ÿ’–โœจ๐ŸŒธ

๐Ÿ“ฆ where this page comes from