src/doc/src/commands/cargo-install.md
cargo-install --- Build and install a Rust binary
cargo install [options] crate[@version]...
cargo install [options] --path path
cargo install [options] --git url [crate...]
cargo install [options] --list
This command manages Cargo's local set of installed binary crates. Only
packages which have executable [[bin]] or [[example]] targets can be
installed, and all executables are installed into the installation root's
bin folder. By default only binaries, not examples, are installed.
The installation root is determined, in order of precedence:
--root optionCARGO_INSTALL_ROOT environment variableinstall.root Cargo config valueCARGO_HOME environment variable$HOME/.cargoThere are multiple sources from which a crate can be installed. The default
source location is crates.io but the --git, --path, and --registry flags
can change this source. If the source contains more than one package (such as
crates.io or a git repository with multiple crates) the crate argument is
required to indicate which crate should be installed.
Crates from crates.io can optionally specify the version they wish to install
via the --version flags, and similarly packages from git repositories can
optionally specify the branch, tag, or revision that should be installed. If a
crate has multiple binaries, the --bin argument can selectively install only
one of them, and if you'd rather install examples the --example argument can
be used as well.
If the package is already installed, Cargo will reinstall it if the installed version does not appear to be up-to-date. If any of the following values change, then Cargo will reinstall the package:
--profile).--target).Installing with --path will always build and install, unless there are
conflicting binaries from another package. The --force flag may be used to
force Cargo to always reinstall the package.
If the source is crates.io or --git then by default the crate will be built
in a temporary target directory. To avoid this, the target directory can be
specified by setting the CARGO_TARGET_DIR environment variable to a
path. In particular, this can be useful for caching build artifacts on
continuous integration systems.
By default, the Cargo.lock file that is included with the package will be
ignored. This means that Cargo will recompute which versions of dependencies
to use, possibly using newer versions that have been released since the
package was published. The --locked flag can be used to force Cargo to use
the packaged Cargo.lock file if it is available. This may be useful for
ensuring reproducible builds, to use the exact same set of dependencies that
were available when the package was published. It may also be useful if a
newer version of a dependency is published that no longer builds on your
system, or has other problems. The downside to using --locked is that you
will not receive any fixes or updates to any dependency. Note that Cargo did
not start publishing Cargo.lock files until version 1.37, which means
packages published with prior versions will not have a Cargo.lock file
available.
This command operates on system or user level, not project level.
This means that the local configuration discovery is ignored.
Instead, the configuration discovery begins at $CARGO_HOME/config.toml.
If the package is installed with --path $PATH, the local configuration
will be used, beginning discovery at $PATH/.cargo/config.toml.
The feature flags allow you to control which features are enabled. When no
feature options are given, the default feature is activated for every
selected package.
See the features documentation for more details.
<dl> <dt class="option-term" id="option-cargo-install--F"><a class="option-anchor" href="#option-cargo-install--F"><code>-F</code> <em>features</em></a></dt> <dt class="option-term" id="option-cargo-install---features"><a class="option-anchor" href="#option-cargo-install---features"><code>--features</code> <em>features</em></a></dt> <dd class="option-desc"><p>Space or comma separated list of features to activate. Features of workspace members may be enabled with <code>package-name/feature-name</code> syntax. This flag may be specified multiple times, which enables all specified features.</p> </dd> <dt class="option-term" id="option-cargo-install---all-features"><a class="option-anchor" href="#option-cargo-install---all-features"><code>--all-features</code></a></dt> <dd class="option-desc"><p>Activate all available features of all selected packages.</p> </dd> <dt class="option-term" id="option-cargo-install---no-default-features"><a class="option-anchor" href="#option-cargo-install---no-default-features"><code>--no-default-features</code></a></dt> <dd class="option-desc"><p>Do not activate the <code>default</code> feature of the selected packages.</p> </dd> </dl>See the reference for details on environment variables that Cargo reads.
0: Cargo succeeded.101: Cargo failed to complete.Install or upgrade a package from crates.io:
cargo install ripgrep
Install or reinstall the package in the current directory:
cargo install --path .
View the list of installed packages:
cargo install --list
cargo(1), cargo-uninstall(1), cargo-search(1), cargo-publish(1)