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 a project into the specified directory at
<path>. After this command completes the vendor directory
specified by <path> will contain all remote sources from
dependencies specified. Additional manifests beyond the default one can be
specified with the -s option.
The cargo vendor command will also print out the
configuration necessary to use the vendored sources, which you will need to
add to .cargo/config.toml.
OPTIONS¶
Vendor Options¶
-s MANIFEST, --sync MANIFEST
Specify extra Cargo.toml manifests to workspaces
which should also be vendored and synced to the output.
--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.
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.
Display Options¶
-v, --verbose
-q, --quiet
No output printed to stdout.
--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://github.com/rust-lang/rustup/> for
more information about how toolchain overrides work.
-h, --help
Prints help information.
-Z FLAG...
Unstable (nightly-only) flags to Cargo. Run cargo -Z
help for details.
--frozen, --locked
Either of these flags requires that the
Cargo.lock
file is up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The
--frozen flag also prevents Cargo
from attempting to access the network to determine if it is out-of-date.
These may be used in environments where you want to assert that
the Cargo.lock file is up-to-date (such as a CI build) or want to
avoid network access.
--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 that 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>.
EXIT STATUS¶
0
Cargo succeeded.
101
Cargo failed to complete.
EXAMPLES¶
1.Vendor all dependencies into a local
"vendor" folder
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
