cargo vendor
NAME
cargo-vendor - Vendor all dependencies locally
SYNOPSIS
cargo vendor [OPTIONS] [PATH]
DESCRIPTION
This cargo subcommand will vendor all crates.io and git dependencies for aproject into the specified directory at <path>
. After this command completesthe vendor directory specified by <path>
will contain all remote sources fromdependencies specified. Additional manifests beyond the default one can bespecified with the -s
option.
The cargo vendor
command will also print out the configuration necessaryto use the vendored sources, which you will need to add to .cargo/config
.
OPTIONS
Owner Options
- -sMANIFEST
- —syncMANIFEST
Specify extra
Cargo.toml
manifests to workspaces which should also bevendored and synced to the output.—no-delete
Don’t delete the "vendor" directory when vendoring, but rather keep allexisting contents of the vendor directory
—respect-source-config
- Instead of ignoring
[source]
configuration by default in.cargo/config
read it and use it when downloading crates from crates.io, for example
Manifest Options
- —manifest-pathPATH
- Path to the
Cargo.toml
file. By default, Cargo searches in the currentdirectory or any parent directory for theCargo.toml
file.
Display Options
- -v
- —verbose
Use verbose output. May be specified twice for "very verbose" output whichincludes extra output such as dependency warnings and build script output.May also be specified with the
term.verbose
config value.-q
- —quiet
No output printed to stdout.
—colorWHEN
- Control when colored output is used. Valid values:
auto
(default): Automatically detect if color support is available on theterminal.always
: Always display colors.never
: Never display colors.
May also be specified with the term.color
config value.
Common Options
- -h
- —help
Prints help information.
-ZFLAG…
Unstable (nightly-only) flags to Cargo. Run
cargo -Z help
fordetails.—frozen
- —locked
- Either of these flags requires that the
Cargo.lock
file isup-to-date. If the lock file is missing, or it needs to be updated, Cargo willexit with an error. The—frozen
flag also prevents Cargo fromattempting to access the network to determine if it is out-of-date.
These may be used in environments where you want to assert that theCargo.lock
file is up-to-date (such as a CI build) or want to avoid networkaccess.
- —offline
- Prevents Cargo from accessing the network for any reason. Without thisflag, Cargo will stop with an error if it needs to access the network andthe network is not available. With this flag, Cargo will attempt toproceed without the network if possible.
Beware that this may result in different dependency resolution than onlinemode. Cargo will restrict itself to crates that are downloaded locally, evenif 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 goingoffline.
May also be specified with the net.offline
config value.
ENVIRONMENT
See the reference fordetails on environment variables that Cargo reads.
Exit Status
- 0
Cargo succeeded.
101
- Cargo failed to complete.
EXAMPLES
- Vendor all dependencies into a local "vendor" folder
- cargo vendor
- Vendor all dependencies into a local "third-party/vendor" folder
- cargo vendor third-party/vendor
- Vendor the current workspace as well as another to "vendor"
- cargo vendor -s ../path/to/Cargo.toml