src/etc/man/cargo-fetch.1 - rust-lang/cargo - Git at Google

 '\" t
 .TH "CARGO\-FETCH" "1"
 .nh
 .ad l
 .ss \n[.ss] 0
 .SH "NAME"
 cargo\-fetch \[em] Fetch dependencies of a package from the network
 .SH "SYNOPSIS"
 \fBcargo fetch\fR [\fIoptions\fR]
 .SH "DESCRIPTION"
 If a \fBCargo.lock\fR file is available, this command will ensure that all of the
 git dependencies and/or registry dependencies are downloaded and locally
 available. Subsequent Cargo commands will be able to run offline after a \fBcargo fetch\fR unless the lock file changes.
 .sp
 If the lock file is not available, then this command will generate the lock
 file before fetching the dependencies.
 .sp
 If \fB\-\-target\fR is not specified, then all target dependencies are fetched.
 .sp
 See also the \fIcargo\-prefetch\fR <https://crates.io/crates/cargo\-prefetch>
 plugin which adds a command to download popular crates. This may be useful if
 you plan to use Cargo without a network with the \fB\-\-offline\fR flag.
 .SH "OPTIONS"
 .SS "Fetch options"
 .sp
 \fB\-\-target\fR \fItriple\fR
 .RS 4
 Fetch for the given architecture. The default is all architectures. The general format of the triple is
 \fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
 list of supported targets. This flag may be specified multiple times.
 .sp
 This may also be specified with the \fBbuild.target\fR
 \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
 .sp
 Note that specifying this flag makes Cargo run in a different mode where the
 target artifacts are placed in a separate directory. See the
 \fIbuild cache\fR <https://doc.rust\-lang.org/cargo/reference/build\-cache.html> documentation for more details.
 .RE
 .SS "Display Options"
 .sp
 \fB\-v\fR,
 \fB\-\-verbose\fR
 .RS 4
 Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
 includes extra output such as dependency warnings and build script output.
 May also be specified with the \fBterm.verbose\fR
 \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
 .RE
 .sp
 \fB\-q\fR,
 \fB\-\-quiet\fR
 .RS 4
 Do not print cargo log messages.
 May also be specified with the \fBterm.quiet\fR
 \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
 .RE
 .sp
 \fB\-\-color\fR \fIwhen\fR
 .RS 4
 Control when colored output is used. Valid values:
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
 terminal.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
 .RE
 .sp
 May also be specified with the \fBterm.color\fR
 \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
 .RE
 .SS "Manifest Options"
 .sp
 \fB\-\-manifest\-path\fR \fIpath\fR
 .RS 4
 Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
 \fBCargo.toml\fR file in the current directory or any parent directory.
 .RE
 .sp
 \fB\-\-locked\fR
 .RS 4
 Asserts that the exact same dependencies and versions are used as when the
 existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
 error when either of the following scenarios arises:
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'The lock file is missing.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
 .RE
 .sp
 It may be used in environments where deterministic builds are desired,
 such as in CI pipelines.
 .RE
 .sp
 \fB\-\-offline\fR
 .RS 4
 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.
 .sp
 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.
 .sp
 May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
 .RE
 .sp
 \fB\-\-frozen\fR
 .RS 4
 Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
 .RE
 .sp
 \fB\-\-lockfile\-path\fR \fIPATH\fR
 .RS 4
 Changes the path of the lockfile from the default (\fB<workspace_root>/Cargo.lock\fR) to \fIPATH\fR\&. \fIPATH\fR must end with
 \fBCargo.lock\fR (e.g. \fB\-\-lockfile\-path /tmp/temporary\-lockfile/Cargo.lock\fR). Note that providing
 \fB\-\-lockfile\-path\fR will ignore existing lockfile at the default path, and instead will
 either use the lockfile from \fIPATH\fR, or write a new lockfile into the provided \fIPATH\fR if it doesn\[cq]t exist.
 This flag can be used to run most commands in read\-only directories, writing lockfile into the provided \fIPATH\fR\&.
 .sp
 This option is only available on the \fInightly
 channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
 requires the \fB\-Z unstable\-options\fR flag to enable (see
 \fI#14421\fR <https://github.com/rust\-lang/cargo/issues/14421>).
 .RE
 .SS "Common Options"
 .sp
 \fB+\fR\fItoolchain\fR
 .RS 4
 If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
 begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
 as \fB+stable\fR or \fB+nightly\fR).
 See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
 for more information about how toolchain overrides work.
 .RE
 .sp
 \fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
 .RS 4
 Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
 or provided as a path to an extra configuration file. This flag may be specified multiple times.
 See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
 .RE
 .sp
 \fB\-C\fR \fIPATH\fR
 .RS 4
 Changes the current working directory before executing any specified operations. This affects
 things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
 the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
 appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
 .sp
 This option is only available on the \fInightly
 channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
 requires the \fB\-Z unstable\-options\fR flag to enable (see
 \fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
 .RE
 .sp
 \fB\-h\fR,
 \fB\-\-help\fR
 .RS 4
 Prints help information.
 .RE
 .sp
 \fB\-Z\fR \fIflag\fR
 .RS 4
 Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
 .RE
 .SH "ENVIRONMENT"
 See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
 details on environment variables that Cargo reads.
 .SH "EXIT STATUS"
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
 .RE
 .SH "EXAMPLES"
 .sp
 .RS 4
 \h'-04' 1.\h'+01'Fetch all dependencies:
 .sp
 .RS 4
 .nf
 cargo fetch
 .fi
 .RE
 .RE
 .SH "SEE ALSO"
 \fBcargo\fR(1), \fBcargo\-update\fR(1), \fBcargo\-generate\-lockfile\fR(1)
	'\" t
	.TH "CARGO\-FETCH" "1"
	.nh
	.ad l
	.ss \n[.ss] 0
	.SH "NAME"
	cargo\-fetch \[em] Fetch dependencies of a package from the network
	.SH "SYNOPSIS"
	\fBcargo fetch\fR [\fIoptions\fR]
	.SH "DESCRIPTION"
	If a \fBCargo.lock\fR file is available, this command will ensure that all of the
	git dependencies and/or registry dependencies are downloaded and locally
	available. Subsequent Cargo commands will be able to run offline after a \fBcargo fetch\fR unless the lock file changes.
	.sp
	If the lock file is not available, then this command will generate the lock
	file before fetching the dependencies.
	.sp
	If \fB\-\-target\fR is not specified, then all target dependencies are fetched.
	.sp
	See also the \fIcargo\-prefetch\fR <https://crates.io/crates/cargo\-prefetch>
	plugin which adds a command to download popular crates. This may be useful if
	you plan to use Cargo without a network with the \fB\-\-offline\fR flag.
	.SH "OPTIONS"
	.SS "Fetch options"
	.sp
	\fB\-\-target\fR \fItriple\fR
	.RS 4
	Fetch for the given architecture. The default is all architectures. The general format of the triple is
	\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
	list of supported targets. This flag may be specified multiple times.
	.sp
	This may also be specified with the \fBbuild.target\fR
	\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
	.sp
	Note that specifying this flag makes Cargo run in a different mode where the
	target artifacts are placed in a separate directory. See the
	\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/reference/build\-cache.html> documentation for more details.
	.RE
	.SS "Display Options"
	.sp
	\fB\-v\fR,
	\fB\-\-verbose\fR
	.RS 4
	Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
	includes extra output such as dependency warnings and build script output.
	May also be specified with the \fBterm.verbose\fR
	\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
	.RE
	.sp
	\fB\-q\fR,
	\fB\-\-quiet\fR
	.RS 4
	Do not print cargo log messages.
	May also be specified with the \fBterm.quiet\fR
	\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
	.RE
	.sp
	\fB\-\-color\fR \fIwhen\fR
	.RS 4
	Control when colored output is used. Valid values:
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
	terminal.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
	.RE
	.sp
	May also be specified with the \fBterm.color\fR
	\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
	.RE
	.SS "Manifest Options"
	.sp
	\fB\-\-manifest\-path\fR \fIpath\fR
	.RS 4
	Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
	\fBCargo.toml\fR file in the current directory or any parent directory.
	.RE
	.sp
	\fB\-\-locked\fR
	.RS 4
	Asserts that the exact same dependencies and versions are used as when the
	existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
	error when either of the following scenarios arises:
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'The lock file is missing.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
	.RE
	.sp
	It may be used in environments where deterministic builds are desired,
	such as in CI pipelines.
	.RE
	.sp
	\fB\-\-offline\fR
	.RS 4
	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.
	.sp
	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.
	.sp
	May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
	.RE
	.sp
	\fB\-\-frozen\fR
	.RS 4
	Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
	.RE
	.sp
	\fB\-\-lockfile\-path\fR \fIPATH\fR
	.RS 4
	Changes the path of the lockfile from the default (\fB<workspace_root>/Cargo.lock\fR) to \fIPATH\fR\&. \fIPATH\fR must end with
	\fBCargo.lock\fR (e.g. \fB\-\-lockfile\-path /tmp/temporary\-lockfile/Cargo.lock\fR). Note that providing
	\fB\-\-lockfile\-path\fR will ignore existing lockfile at the default path, and instead will
	either use the lockfile from \fIPATH\fR, or write a new lockfile into the provided \fIPATH\fR if it doesn\[cq]t exist.
	This flag can be used to run most commands in read\-only directories, writing lockfile into the provided \fIPATH\fR\&.
	.sp
	This option is only available on the \fInightly
	channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
	requires the \fB\-Z unstable\-options\fR flag to enable (see
	\fI#14421\fR <https://github.com/rust\-lang/cargo/issues/14421>).
	.RE
	.SS "Common Options"
	.sp
	\fB+\fR\fItoolchain\fR
	.RS 4
	If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
	begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
	as \fB+stable\fR or \fB+nightly\fR).
	See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
	for more information about how toolchain overrides work.
	.RE
	.sp
	\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
	.RS 4
	Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
	or provided as a path to an extra configuration file. This flag may be specified multiple times.
	See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
	.RE
	.sp
	\fB\-C\fR \fIPATH\fR
	.RS 4
	Changes the current working directory before executing any specified operations. This affects
	things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
	the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
	appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
	.sp
	This option is only available on the \fInightly
	channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
	requires the \fB\-Z unstable\-options\fR flag to enable (see
	\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
	.RE
	.sp
	\fB\-h\fR,
	\fB\-\-help\fR
	.RS 4
	Prints help information.
	.RE
	.sp
	\fB\-Z\fR \fIflag\fR
	.RS 4
	Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
	.RE
	.SH "ENVIRONMENT"
	See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
	details on environment variables that Cargo reads.
	.SH "EXIT STATUS"
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
	.RE
	.SH "EXAMPLES"
	.sp
	.RS 4
	\h'-04' 1.\h'+01'Fetch all dependencies:
	.sp
	.RS 4
	.nf
	cargo fetch
	.fi
	.RE
	.RE
	.SH "SEE ALSO"
	\fBcargo\fR(1), \fBcargo\-update\fR(1), \fBcargo\-generate\-lockfile\fR(1)