CARGO-VENDOR(1)

📦 version 1.81.0, in ubuntu jammy, ubuntu noble

💖 cargo-vendor(1) — bestie edition 💖

okay so this is a page from the General Commands Manual, and it's all about cargo-vendor, a cargo subcommand. buckle up, it's actually so good.

✨ NAME ✨

cargo-vendor — vendor all dependencies locally 🫶

🌸 SYNOPSIS 🌸

cargo vendor [options] [path]

🦋 DESCRIPTION 🦋

okay so picture this: this cargo subcommand vendors all crates.io and git dependencies for a project, and it drops them into the directory you name at <path>. once this command finishes, the vendor directory you specified with <path> will contain literally all the remote sources from the dependencies you specified. and if you've got extra manifests beyond the default one? you can name those with the -s option. so flexible of it. 💅

the config you need in order to actually use those vendored sources gets printed to stdout after cargo vendor finishes the vendoring process. and yes, you do 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 it, bestie, it's giving "I forgot the last step and nothing worked". 😭

Cargo treats vendored sources as read-only, same way it does to registry and git sources. so if you're planning to modify a crate from a remote source, use [patch] or a path dependency pointing to a local copy of that crate instead. Cargo will then correctly handle the crate on incremental rebuilds, because it knows that it is no longer a read-only dependency. slay. ✨

👑 OPTIONS 👑

🎀 Vendor Options 🎀

  • -s manifest, --sync manifest — names an extra Cargo.toml manifest to workspaces which should also be vendored and synced to the output. and yes you can specify it multiple times. 💖
  • --no-delete — doesn't delete the "vendor" directory when vendoring. instead it keeps all existing contents of the vendor directory. minimal destruction 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. 🧚
  • --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. honestly iconic. 👑

💜 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. no cap, CI besties love this one.

  • --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 <https://doc.rust-lang.org/cargo/reference/config.html>.

  • --frozen — equivalent to specifying both --locked and --offline. two-for-one, we love a combo deal. 💅

🌈 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 are:
    • 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. yes, Cargo reads them. it's nosy like that. 🙈

🍓 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 💖 it's from the Cargo manual, and the page is CARGO-VENDOR(1) — that's the section title and the footer both, so now you know exactly what you're reading and where it lives. go forth and vendor. periodt. ✨🦋🎀

📦 where this page comes from