CARGO-FETCH(1)

📦 version 1.82.0, in ubuntu jammy, ubuntu noble

🦋 CARGO-FETCH(1) — the General Commands Manual glow-up

okay bestie, welcome to cargo-fetch — the command that goes and gets your deps off the internet so you can vibe offline later. it lives in the General Commands Manual, section 1, and it's giving "errand runner but make it essential" ✨

💖 NAME

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

🌸 SYNOPSIS

cargo fetch [options]

🎀 DESCRIPTION

so here's the tea 🍵 — 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. and the slay part? subsequent Cargo commands will be able to run offline after a cargo fetch, unless the lock file changes. no cap.

if the lock file is not available, then this command will generate the lock file before fetching the dependencies. it's proactive like that 💅

if --target is not specified, then all target dependencies are fetched.

also!! see 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. iykyk 🧚

✨ 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/guide/build-cache.html> for more details. don't say i didn't warn you 💀

🌈 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>. double it and it gets louder, iconic.
  • -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. 🌈
    • 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 will find it, it always does 🔍
  • --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. 🔒

  • --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. airplane mode main character energy ✈️
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. not a bug, just the vibe.

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 bundle 🫶
  • --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. lowkey genius.
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>). so if you're on stable, bestie, this one's not for you 😭

💜 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 skip that part 🙈
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. chaos mode, but make it documented 🌀

🌱 ENVIRONMENT

see the reference <https://doc.rust-lang.org/cargo/reference/environment-variables.html> for details on environment variables that Cargo reads. yes, it reads your env, it's nosy like that 💚

⭐ EXIT STATUS

  • 0: Cargo succeeded. 🎉
  • 101: Cargo failed to complete. 💀

🌟 EXAMPLES

  1. Fetch all dependencies:
cargo fetch

👑 SEE ALSO

cargo(1), cargo-update(1), cargo-generate-lockfile(1)

and that's the whole page, bestie 💖 this was CARGO-FETCH(1) from the General Commands Manual, and the footer is literally just the same name again (CARGO-FETCH(1)) because manpages love a symmetry moment. go fetch your deps, you absolute icon 🎀✨

📦 where this page comes from