cargo-vendor(1)
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 configuration necessary to use the vendored sources would be printed to
stdout after cargo vendor
completes the vendoring process.
You will need to add or redirect it to your Cargo configuration file,
which is usually .cargo/config.toml
locally for the current package.
Cargo treats vendored sources as read-only as it does to registry and git sources.
If you intend to modify a crate from a remote source,
use [patch]
or a path
dependency pointing to a local copy of that crate.
Cargo will then correctly handle the crate on incremental rebuilds,
as it knows that it is no longer a read-only dependency.
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.
Manifest Options
--manifest-path
path- Path to the
Cargo.toml
file. By default, Cargo searches for theCargo.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.
--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. --frozen
- Equivalent to specifying both
--locked
and--offline
. --lockfile-path
PATH- Changes the path of the lockfile from the default (
<workspace_root>/Cargo.lock
) to PATH. PATH must end withCargo.lock
(e.g.--lockfile-path /tmp/temporary-lockfile/Cargo.lock
). Note that providing--lockfile-path
will ignore 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 lockfile into the provided PATH.This option is only available on the nightly channel and requires the
-Z unstable-options
flag to enable (see #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. -q
--quiet
- Do not print cargo log messages.
May also be specified with the
term.quiet
config value. --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.
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 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 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 examplecargo -C path/to/my-project build
.This option is only available on the nightly channel and requires the
-Z unstable-options
flag to enable (see #10098). -h
--help
- Prints help information.
-Z
flag- Unstable (nightly-only) flags to Cargo. Run
cargo -Z help
for details.
ENVIRONMENT
See the reference for details 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
-
Vendor and redirect the necessary vendor configs to a config file.
cargo vendor > path/to/my/cargo/config.toml