CARGO-VENDOR(1)

📦 version 1.78.0, in ubuntu jammy, ubuntu noble

💖 CARGO-VENDOR(1) — the General Commands Manual glow-up 💖

okay bestie, pull up a chair (or like, a beanbag, whatever's comfy) because we're diving into cargo-vendor, straight out of the General Commands Manual. this is the one that takes all your remote deps and ✨moves them in✨ locally. no cap.

🌸 NAME 🌸

cargo-vendor — vendor all dependencies locally 🫶

✨ SYNOPSIS ✨

cargo vendor [options] [path]

🦋 DESCRIPTION 🦋

so this cargo subcommand is literally the "come through, stay a while" of dependency management. it vendors all crates.io and git dependencies for a project into the directory you point at with <path>. once the command finishes, that vendor directory contains every remote source from the dependencies you specified. and if you've got extra manifests beyond the default one, you can hand them over with the -s option. periodt.

the configuration you need in order to actually use those vendored sources gets printed to stdout once cargo vendor wraps up the vendoring. you'll want to add it, or redirect it, into your Cargo configuration file — which is usually .cargo/config.toml, locally, for the current package. iykyk.

here's the important part, bestie, and i'm being so serious: Cargo treats vendored sources as read-only, same as it does for registry and git sources. if you're trying to modify a crate that came from a remote source, use [patch] or a path dependency pointing at a local copy of that crate instead. then Cargo will handle the crate correctly on incremental rebuilds, because it knows it's no longer a read-only dependency. slay.

💅 OPTIONS 💅

🎀 Vendor Options 🎀

  • -s manifest, --sync manifest — drop an extra Cargo.toml manifest to the workspaces that should also be vendored and synced into the output. you can specify this multiple times, go off.
  • --no-delete — don't delete the "vendor" directory when vendoring. instead, keep all the existing contents of the vendor directory. minimal disruption energy.
  • --respect-source-config — instead of ignoring [source] configuration by default in .cargo/config.toml, this reads it and uses it when downloading crates from crates.io, for example. it's giving respect.
  • --versioned-dirs — normally versions are only added to disambiguate multiple versions of the same package. this option causes all directories in the "vendor" directory to be versioned, which makes tracking the history of vendored packages over time easier, and can help with the performance of re-vendoring when only a subset of the packages have changed. obsessed.

🌈 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 find you, don't worry.
  • --frozen, --locked — either of these flags requires that the Cargo.lock file is up-to-date. if the lock file is missing, or it needs to be updated, Cargo will exit with an error. the --frozen flag also prevents Cargo from attempting to access the network to determine if it's out-of-date.

these may be used in environments where you want to assert that the Cargo.lock file is up-to-date (like, say, a CI build) or where you want to avoid network access. very demure, very mindful.

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

may also be specified with the net.offline config value <https://doc.rust-lang.org/cargo/reference/config.html>.

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

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

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. your bestie when you're lost 🫶
  • -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. it's all in there, fr fr.

💀 EXIT STATUS 💀

  • 0: Cargo succeeded. 🎉 ate.
  • 101: Cargo failed to complete. 😭 it's not giving.

🍓 EXAMPLES 🍓

  1. Vendor all dependencies into a local "vendor" folder
cargo vendor
  1. Vendor all dependencies into a local "third-party/vendor" folder
cargo vendor third-party/vendor
  1. Vendor the current workspace as well as another to "vendor"
cargo vendor -s ../path/to/Cargo.toml
  1. Vendor and redirect the necessary vendor configs to a config file.
cargo vendor > path/to/my/cargo/config.toml

🧚 SEE ALSO 🧚

cargo(1)

and that's the whole page, bestie 💜 this was CARGO-VENDOR(1), living its best life in the General Commands Manual — main character energy, read-only sources, and all. go vendor something iconic. ✨🎀

📦 where this page comes from