CARGO-VENDOR(1)

🎀 CARGO-VENDOR(1) 🎀

okay bestie, gather round, because this is the cargo-vendor page from the General Commands Manual and it's genuinely so useful. it's all about grabbing every single dependency your project needs and parking it in a folder so you never have to touch the network again. iconic behaviour, no cap. 💅

---

✨ NAME ✨

cargo-vendor — vendor all dependencies locally 🫶

---

🌈 SYNOPSIS 🌈

cargo vendor [options] [path]

---

💖 DESCRIPTION 💖

so this cargo subcommand is gonna vendor all your crates.io and git dependencies for a project, dumping them into the directory you give it at <path>. once the command finishes, that vendor directory specified by <path> will contain every single remote source from the dependencies you specified. and if you've got extra manifests beyond the default one, you can point at them with the -s option. easy. 🌸

the configuration you need in order to actually use those vendored sources gets printed to stdout once cargo vendor finishes the vendoring process. you'll need to add it — or redirect it — into your Cargo configuration file, which is usually .cargo/config.toml locally for the current package. don't forget this part, bestie, or the whole thing is giving nothing. 😭

Cargo treats vendored sources as read-only, exactly the same way it treats registry and git sources. so if you're planning 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. that way Cargo correctly handles the crate on incremental rebuilds, because it knows it's no longer a read-only dependency. slay. 🔥

---

👑 OPTIONS 👑

🛍️ Vendor Options

• -s manifest, --sync manifest — specify an extra Cargo.toml manifest to workspaces which should also be vendored and synced to the output. you can use this one multiple times if you're feeling extra. ✨
• --no-delete — don't delete the "vendor" directory when vendoring; instead keep all the existing contents of the vendor directory. nothing gets thrown out, we're hoarding. 🐿️
• --respect-source-config — instead of ignoring [source] configuration by default in .cargo/config.toml, read it and use it when downloading crates from crates.io, for example. respect the config, periodt. 💅
• --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 it way easier to track the history of vendored packages over time, and can help with the performance of re-vendoring when only a subset of the packages have changed. glow-up for your directory tree. 🌟

📜 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 it, she's thorough. 🕵️‍♀️
• --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. very "we do not improvise here" energy.

• --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, bestie: this may result in a 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 at https://doc.rust-lang.org/cargo/reference/config.html.

• --frozen — equivalent to specifying both --locked and --offline. the combo meal. 🍔

🖥️ 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 at https://doc.rust-lang.org/cargo/reference/config.html. she's chatty, we love her. 🗣️
• -q, --quiet — do not print cargo log messages. may also be specified with the term.quiet config value at https://doc.rust-lang.org/cargo/reference/config.html. shhh, main character silence. 🤫
• --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 at 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 at 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 at 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 at https://github.com/rust-lang/cargo/issues/10098). nightly girlies only. 🌙

• -h, --help — prints help information. the classic. 🆘
• -Z flag — unstable (nightly-only) flags to Cargo. run cargo -Z help for details.

---

🌍 ENVIRONMENT 🌍

see the reference at https://doc.rust-lang.org/cargo/reference/environment-variables.html for details on environment variables that Cargo reads. it reads them. it reads all of them. 👀

---

🚦 EXIT STATUS 🚦

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

---

🧪 EXAMPLES 🧪

1. Vendor all dependencies into a local "vendor" folder

cargo vendor

2. Vendor all dependencies into a local "third-party/vendor" folder

cargo vendor third-party/vendor

3. Vendor the current workspace as well as another to "vendor"

cargo vendor -s ../path/to/Cargo.toml

4. 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) from the General Commands Manual, signed off with CARGO-VENDOR(1) at the bottom because she likes to make an entrance and an exit. go vendor something, you've got this 💜🦋✨