CARGO-VENDOR(1)

📦 version 1.93.1, in ubuntu resolute

💖 cargo-vendor — the manual, but make it cute 💖

okay bestie, so this is cargo-vendor(1), a page from the General Commands Manual, and I'm about to make vendoring make sense. strap in. 🎀

✨ NAME ✨

cargo-vendor — Vendor all dependencies locally 🫶

🌸 SYNOPSIS 🌸

cargo vendor [options] [path]

🦋 DESCRIPTION 🦋

okay so this little cargo subcommand is literally the plug 💅 it takes all your crates.io and git dependencies for a project and vendors them into the directory you point at with <path>. the moment this command finishes, that vendor directory is gonna be full of every remote source from the dependencies you specified. and listen — you can also toss in extra manifests beyond the default one, that's what the -s option is for. no cap. ✨

and here's the part where I need you to pay attention: the configuration you need in order to actually use those vendored sources gets printed to stdout once cargo vendor finishes vendoring. you 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 skip this step bestie, it's giving necessary. 😭

also important: Cargo treats vendored sources as read-only, the exact same way it treats registry and git sources. so if you're planning to modify a crate that came from a remote source, the move is to use [patch] or a path dependency that points to a local copy of that crate. 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 — point at an extra Cargo.toml manifest for workspaces that should also be vendored and synced to the output. you can specify this multiple times, no limits. 💜
  • --no-delete — don't delete the "vendor" directory when vendoring, bestie. instead, keep all the existing contents of the vendor directory. it's giving preservation. 🫶
  • --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. 👑
  • --versioned-dirs — normally versions only get added to disambiguate multiple versions of the same package. this option makes every directory in the "vendor" directory versioned, which makes tracking the history of vendored packages over time way easier, and can help with the performance of re-vendoring when only a subset of the packages have changed. iconic behaviour honestly. ✨

🎀 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 goes hunting. 🔍
  • --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 these scenarios arises:
    • The lock file is missing.
    • Cargo attempted to change the lock file due to a different dependency resolution.

you'd use this in environments where deterministic builds are the vibe, like CI pipelines. 🏗️

  • --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. check out 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, we love efficiency. 💅
  • --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 the 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 the 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>).

🌈 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. classic. 🫶
  • -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. 🌍

💀 EXIT STATUS 💀

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

🍓 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 🫶

and that's the whole page bestie, periodt 💖 this was CARGO-VENDOR(1) — the manual page, the legend, the moment. go forth and vendor responsibly. 🎀✨🦋

📦 where this page comes from