CARGO-HELP(1)

📦 version 1.95.0, in ubuntu stonking

✨ CARGO-HELP(1) ✨

okay bestie, welcome to the CARGO-HELP(1) page, straight outta the General Commands Manual, and it's literally just about asking Cargo for help. iconic behavior, honestly. 🎀

💖 NAME 💖

cargo-help — Get help for a Cargo command

no cap, that's the whole job. it helps you. it's the supportive bestie of commands. 🫶

🌸 SYNOPSIS 🌸

cargo help [subcommand]

🦋 DESCRIPTION 🦋

Prints a help message for the given command. that's it, that's the vibe. you ask, it tells. main character energy fr. ✨

💅 OPTIONS 💅

🌈 Display Options 🌈

  • -v, --verbose — Use verbose output. you can specify this 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 up and get the tea ☕
  • -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 🤫 lowkey silence mode.
  • --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>. yes you can force the rainbow 🌈 and no we will not judge you.

🎀 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. it's giving "no surprises allowed" 🔒

  • --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>. airplane mode but make it builds ✈️

  • --frozen — Equivalent to specifying both --locked and --offline. two flags for the price of one, ate. 🔥

👑 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. stack 'em up, it's fine 💜
  • -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 test 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 ✨
  • -h, --help — Prints help information. help-ception. you're literally reading the help page for help. 💖
  • -Z flag — Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details. forbidden fruit, handle with care 🍓

🧚 ENVIRONMENT 🧚

See the reference <https://doc.rust-lang.org/cargo/reference/environment-variables.html> for details on environment variables that Cargo reads. yes it peeks at your env, it contains multitudes. 🌸

⭐ EXIT STATUS ⭐

  • 0: Cargo succeeded. 🎉
  • 101: Cargo failed to complete. 😭 not the 101, every rust dev knows that number in their bones fr fr

💜 EXAMPLES 💜

  1. Get help for a command:
cargo help build
  1. Help is also available with the --help flag:
cargo build --help

🦋 SEE ALSO 🦋

and that's the whole page, bestie. this lil beauty lives in the General Commands Manual and is signed off, bottom of the page, as CARGO-HELP(1) — go forth and get yourself some help (the documentation kind). slay, no cap, periodt. 💅🎀✨

📦 where this page comes from