CARGO-VENDOR(1)

✨ CARGO-VENDOR(1) ✨

okay bestie, welcome to the cargo-vendor page 💖 this is the General Commands Manual entry, and we're gonna go through it together, no skimming, no skipping, periodt.

---

🌸 NAME 🌸

cargo-vendor — Vendor all dependencies locally

---

🎀 SYNOPSIS 🎀

cargo vendor [options] [path]

---

🦋 DESCRIPTION 🦋

So like, this cargo subcommand vendors all the crates.io and git dependencies for a project into the directory you point at with <path>. Once the command finishes, that vendor directory holds literally every remote source from the dependencies you specified. And if you've got extra manifests beyond the default one? You can name them with the -s option, no biggie 💅

The configuration you need in order to actually use those vendored sources gets printed to stdout after cargo vendor is done doing its thing. You'll have 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, it's giving "I forgot my keys" energy if you skip it 🔑

Cargo treats vendored sources as read-only, 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. Then Cargo will correctly handle that 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. May be specified multiple times.
• --no-delete — Don't delete the "vendor" directory when vendoring, but rather keep all existing contents of the vendor directory.
• --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.
• --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 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. tracking history? main character behavior ✨

🍓 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.
• --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 builds are so valid 🙌

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

• --frozen — Equivalent to specifying both --locked and --offline. two-for-one deal, obsessed 💅

🌟 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>.
• --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.
• -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. that's it, that's the section, go read the reference bestie 📖

---

⭐ 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 🎀 we went through every single option, every default, every config value, every link, no cap. this was the CARGO-VENDOR(1) page from the General Commands Manual — the footer just says CARGO-VENDOR(1) right back at ya, no extra version or date drama, so consider this your cute little sign-off: go vendor those deps, you absolute icon 💖✨🦋