CARGO-HELP(1)

📦 version 1.97.1, in ubuntu stonking

✨ CARGO-HELP ✨

okay so bestie, welcome to the General Commands Manual page for cargo-help 💖 this is the lil' corner of the Cargo universe that's literally just here to hand you help. no builds, no drama, just answers 🫶

🌸 NAME 🌸

cargo-help — get help for a Cargo command 💅

🎀 SYNOPSIS 🎀

cargo help [subcommand]

🦋 DESCRIPTION 🦋

It prints a help message for whatever command you name. that's it. that's the whole job. iconic behaviour honestly ✨

For commands that have subcommands, you separate the command levels with spaces. So like, cargo help report future-incompatibilities shows you the help for the cargo report future-incompatibilities command. no cap 💖

⚠️ spaces only separate hierarchy levels between a parent command and its subcommands. if a dash is genuinely part of a command's name — think generate-lockfile — you gotta keep that dash. always. fr fr.

You can also write multiple command levels as a single dash-joined word</> 🧚 so cargo help report-future-incompatibilities is literally equivalent to cargo help report future-incompatibilities. same energy, different fit 💅

💖 OPTIONS 💖

🌈 Display Options 🌈

  • -v, --verbose — use verbose output. You can specify it twice for "very verbose" output, which adds extra stuff like dependency warnings and build script output. You can also set this with the term.verbose config value <https://doc.rust-lang.org/cargo/reference/config.html>. obsessed with the double-v, honestly 😭
  • -q, --quiet — do not print cargo log messages. Can also be set with the term.quiet config value <https://doc.rust-lang.org/cargo/reference/config.html>. the introvert flag 🫶
  • --color when — controls when colored output gets used. the valid values are:
    • auto (default) — automatically detects whether your terminal can do color support.
    • always — always display colors. go off 🌈
    • never — never display colors. minimalist moment.

Can also be set 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 due to a different dependency resolution.

It may be used in environments where deterministic builds are the vibe, such as in CI pipelines. reproducibility queen 👑

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

Can also be set 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 deal, slay 💅

💜 Common Options 💜

  • +toolchain — if Cargo has been 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 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 info. stack 'em up 🧚
  • -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, 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>). nightly girlies only 🌙
  • -h, --help — prints help information. very meta of us 💖
  • -Z flag — unstable (nightly-only) flags to Cargo. Run cargo -Z help for details. mysterious. secret menu energy 🫣

🌱 ENVIRONMENT 🌱

See the reference <https://doc.rust-lang.org/cargo/reference/environment-variables.html> for the deets on environment variables that Cargo reads. iykyk 💚

⭐ EXIT STATUS ⭐

  • 0 — Cargo succeeded. we love a win 🎉
  • 101 — Cargo failed to complete. it's giving tragedy 😭

🌟 EXAMPLES 🌟

  1. Get help for a command:
cargo help build
  1. Get help for a nested command:
cargo help report future-incompatibilities
  1. The dash-joined form also works:
cargo help report-future-incompatibilities
  1. Help is also available with the --help flag:
cargo build --help

👑 SEE ALSO 👑

cargo(1)

and that's the whole page bestie!! 🎀 this was the CARGO-HELP(1) page from the General Commands Manual, and yeah — the little footer tag at the bottom says CARGO-HELP(1) too, so now you know where you are 💖 go read some help, you deserve it ✨🦋

📦 where this page comes from