CARGO-FETCH(1)

📦 version 1.88.0, in ubuntu questing

💖 CARGO-FETCH 💖

okay so bestie, welcome to CARGO-FETCH(1) — yes that's section 1 of the General Commands Manual, we're in the big-girl section now 💅. This is the page for cargo fetch, and by the end of it you're gonna be fetching deps like it's nothing. no cap. 🫶

✨ NAME ✨

cargo-fetch — fetch dependencies of a package from the network 🌐💖

🌸 SYNOPSIS 🌸

cargo fetch [options]

🦋 DESCRIPTION 🦋

so here's the tea, bestie 🍓:

If a Cargo.lock file is available, this command will make sure that all of the git dependencies and/or registry dependencies are downloaded and locally available. The way that subsequent Cargo commands will be able to run offline after a cargo fetch unless the lock file changes? iconic. ✨

If the lock file is not available, then this command will generate the lock file before fetching the dependencies. it's giving prepared. 👑

If --target is not specified, then all target dependencies are fetched. all of them. the whole squad. 🎀

See also the cargo-prefetch plugin (https://crates.io/crates/cargo-prefetch) which adds a command to download popular crates. This may be useful if you plan to use Cargo without a network with the --offline flag. lowkey a lifesaver for offline vibes 🌈

💅 OPTIONS 💅

Fetch options

  • --target triple — fetch for the given architecture. The default is all architectures. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for a list of supported targets. This flag may be specified multiple times. 👯‍♀️

This may also be specified with the build.target config value (https://doc.rust-lang.org/cargo/reference/config.html).

Note that specifying this flag makes Cargo run in a different mode where the target artifacts are placed in a separate directory. See the build cache documentation (https://doc.rust-lang.org/cargo/reference/build-cache.html) for more details. not me moving your artifacts to a whole new address 🏠💀

Display Options

  • -v, --verbose — use verbose output. May be specified 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). tell me everything, I wanna know everything 🗣️✨
  • -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 🤫
  • --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. 🌈 periodt
    • never: never display colors. 🚫

May also be specified with the term.color config value (https://doc.rust-lang.org/cargo/reference/config.html).

Manifest Options

  • --manifest-path path — path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory. it'll go looking for it, don't worry 🕵️‍♀️
  • --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. deterministic queen behavior fr fr 👑

  • --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. so like, she's working with what she's got 💀

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-for-one deal, we love a combo 🎀
  • --lockfile-path PATH — changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will either use the lockfile from PATH, or write a new lockfile into the provided PATH if it doesn’t exist. This flag can be used to run most commands in read-only directories, writing lockfile into the provided PATH. 🗂️✨
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 #14421, https://github.com/rust-lang/cargo/issues/14421). nightly girlies only 💜

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. ✍️
  • -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). ✨
  • -h, --help — prints help information. when in doubt, ask for help, that's the vibe 🙋‍♀️
  • -Z flag — unstable (nightly-only) flags to Cargo. Run cargo -Z help for details. the secret menu 🔮

🌈 ENVIRONMENT 🌈

See the reference (https://doc.rust-lang.org/cargo/reference/environment-variables.html) for details on environment variables that Cargo reads. Cargo's out here reading env vars like they're the group chat 📱👀

⭐ EXIT STATUS ⭐

  • 0: Cargo succeeded. 🎉 slay
  • 101: Cargo failed to complete. 😭 rip

🧚 EXAMPLES 🧚

  1. Fetch all dependencies:
cargo fetch

that's it. that's the whole thing. go get your deps bestie 💖

🔥 SEE ALSO 🔥

cargo(1), cargo-update(1), cargo-generate-lockfile(1) — the rest of the girlies, go say hi 👑

and that's the whole page!! this footer's just CARGO-FETCH(1) again — same name, General Commands Manual, section 1 — no version stamp or date on it, she's simply timeless like that 💅✨ mwah, go fetch something 🫶

📦 where this page comes from