cargo-fetch(1)

NAME

cargo-fetch --- Fetch dependencies of a package from the network

SYNOPSIS

cargo fetch [options]

DESCRIPTION

If a Cargo.lock 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 cargo fetch unless the lock file changes.

If the lock file is not available, then this command will generate the lock file before fetching the dependencies.

If --target is not specified, then all target dependencies are fetched.

See also the 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 --offline flag.

OPTIONS

Fetch options

<dl> <dt class="option-term" id="option-cargo-fetch---target"><a class="option-anchor" href="#option-cargo-fetch---target"><code>--target</code> <em>triple</em></a></dt> <dd class="option-desc"><p>Fetch for the specified target architecture. Flag may be specified multiple times. The default is all architectures. The general format of the triple is <code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>.</p> <p>Possible values:</p> <ul> <li>Any supported target in <code>rustc --print target-list</code>.</li> <li><code>"host-tuple"</code>, which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an <code>xtask</code> in a shared project that may be worked on by many hosts).</li> <li>A path to a custom target specification. See <a href="../../rustc/targets/custom.html#custom-target-lookup-path">Custom Target Lookup Path</a> for more information.</li> </ul> <p>This may also be specified with the <code>build.target</code> <a href="../reference/config.html">config value</a>.</p> <p>Note that specifying this flag makes Cargo run in a different mode where the target artifacts are placed in a separate directory. See the <a href="../reference/build-cache.html">build cache</a> documentation for more details.</p> </dd> </dl>

Display Options

<dl> <dt class="option-term" id="option-cargo-fetch--v"><a class="option-anchor" href="#option-cargo-fetch--v"><code>-v</code></a></dt> <dt class="option-term" id="option-cargo-fetch---verbose"><a class="option-anchor" href="#option-cargo-fetch---verbose"><code>--verbose</code></a></dt> <dd class="option-desc"><p>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 <code>term.verbose</code> <a href="../reference/config.html">config value</a>.</p> </dd> <dt class="option-term" id="option-cargo-fetch--q"><a class="option-anchor" href="#option-cargo-fetch--q"><code>-q</code></a></dt> <dt class="option-term" id="option-cargo-fetch---quiet"><a class="option-anchor" href="#option-cargo-fetch---quiet"><code>--quiet</code></a></dt> <dd class="option-desc"><p>Do not print cargo log messages. May also be specified with the <code>term.quiet</code> <a href="../reference/config.html">config value</a>.</p> </dd> <dt class="option-term" id="option-cargo-fetch---color"><a class="option-anchor" href="#option-cargo-fetch---color"><code>--color</code> <em>when</em></a></dt> <dd class="option-desc"><p>Control when colored output is used. Valid values:</p> <ul> <li><code>auto</code> (default): Automatically detect if color support is available on the terminal.</li> <li><code>always</code>: Always display colors.</li> <li><code>never</code>: Never display colors.</li> </ul> <p>May also be specified with the <code>term.color</code> <a href="../reference/config.html">config value</a>.</p> </dd> </dl>

Manifest Options

<dl> <dt class="option-term" id="option-cargo-fetch---manifest-path"><a class="option-anchor" href="#option-cargo-fetch---manifest-path"><code>--manifest-path</code> <em>path</em></a></dt> <dd class="option-desc"><p>Path to the <code>Cargo.toml</code> file. By default, Cargo searches for the <code>Cargo.toml</code> file in the current directory or any parent directory.</p> </dd> <dt class="option-term" id="option-cargo-fetch---locked"><a class="option-anchor" href="#option-cargo-fetch---locked"><code>--locked</code></a></dt> <dd class="option-desc"><p>Asserts that the exact same dependencies and versions are used as when the existing <code>Cargo.lock</code> file was originally generated. Cargo will exit with an error when either of the following scenarios arises:</p> <ul> <li>The lock file is missing.</li> <li>Cargo attempted to change the lock file due to a different dependency resolution.</li> </ul> <p>It may be used in environments where deterministic builds are desired, such as in CI pipelines.</p> </dd> <dt class="option-term" id="option-cargo-fetch---offline"><a class="option-anchor" href="#option-cargo-fetch---offline"><code>--offline</code></a></dt> <dd class="option-desc"><p>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.</p> <p>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.</p> <p>May also be specified with the <code>net.offline</code> <a href="../reference/config.html">config value</a>.</p> </dd> <dt class="option-term" id="option-cargo-fetch---frozen"><a class="option-anchor" href="#option-cargo-fetch---frozen"><code>--frozen</code></a></dt> <dd class="option-desc"><p>Equivalent to specifying both <code>--locked</code> and <code>--offline</code>.</p> </dd> </dl>

Common Options

<dl> <dt class="option-term" id="option-cargo-fetch-+toolchain"><a class="option-anchor" href="#option-cargo-fetch-+toolchain"><code>+</code><em>toolchain</em></a></dt> <dd class="option-desc"><p>If Cargo has been installed with rustup, and the first argument to <code>cargo</code> begins with <code>+</code>, it will be interpreted as a rustup toolchain name (such as <code>+stable</code> or <code>+nightly</code>). See the <a href="https://rust-lang.github.io/rustup/overrides.html">rustup documentation</a> for more information about how toolchain overrides work.</p> </dd> <dt class="option-term" id="option-cargo-fetch---config"><a class="option-anchor" href="#option-cargo-fetch---config"><code>--config</code> <em>KEY=VALUE</em> or <em>PATH</em></a></dt> <dd class="option-desc"><p>Overrides a Cargo configuration value. The argument should be in TOML syntax of <code>KEY=VALUE</code>, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the <a href="../reference/config.html#command-line-overrides">command-line overrides section</a> for more information.</p> </dd> <dt class="option-term" id="option-cargo-fetch--C"><a class="option-anchor" href="#option-cargo-fetch--C"><code>-C</code> <em>PATH</em></a></dt> <dd class="option-desc"><p>Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (<code>Cargo.toml</code>), as well as the directories searched for discovering <code>.cargo/config.toml</code>, for example. This option must appear before the command name, for example <code>cargo -C path/to/my-project build</code>.</p> <p>This option is only available on the <a href="https://doc.rust-lang.org/book/appendix-07-nightly-rust.html">nightly channel</a> and requires the <code>-Z unstable-options</code> flag to enable (see <a href="https://github.com/rust-lang/cargo/issues/10098">#10098</a>).</p> </dd> <dt class="option-term" id="option-cargo-fetch--h"><a class="option-anchor" href="#option-cargo-fetch--h"><code>-h</code></a></dt> <dt class="option-term" id="option-cargo-fetch---help"><a class="option-anchor" href="#option-cargo-fetch---help"><code>--help</code></a></dt> <dd class="option-desc"><p>Prints help information.</p> </dd> <dt class="option-term" id="option-cargo-fetch--Z"><a class="option-anchor" href="#option-cargo-fetch--Z"><code>-Z</code> <em>flag</em></a></dt> <dd class="option-desc"><p>Unstable (nightly-only) flags to Cargo. Run <code>cargo -Z help</code> for details.</p> </dd> </dl>

ENVIRONMENT

See the reference for details on environment variables that Cargo reads.

EXIT STATUS

• 0: Cargo succeeded.
• 101: Cargo failed to complete.

EXAMPLES

1. Fetch all dependencies:

   Copy

   cargo fetch
   

SEE ALSO

cargo(1), cargo-update(1), cargo-generate-lockfile(1)