cargo install ripgrep
cargo-install - Build and install a Rust binary
cargo install [OPTIONS] CRATE…
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 [[bin]]
targets can be installed, and all binaries are installed into
the installation root’s bin
folder.
The installation root is determined, in order of precedence:
--root
option
CARGO_INSTALL_ROOT
environment variable
install.root
Cargo config value
CARGO_HOME
environment variable
$HOME/.cargo
There are multiple sources from which a crate can be installed. The default
location is crates.io but the --git
and --path
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 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 relative
path. In particular, this can be useful for caching build artifacts on
continuous integration systems.
Specify a version to install from crates.io.
Git URL to install the specified crate from.
Branch to use when installing from git.
Tag to use when installing from git.
Specific commit to use when installing from git.
Filesystem path to local crate to install.
List all installed packages and their versions.
Force overwriting existing crates or binaries. This can be used to reinstall or upgrade a crate.
Install only the specified binary.
Install all binaries.
Install only the specified example.
Install all examples.
Directory to install packages into.
Name of the registry to use. Registry names are defined in Cargo config files.
If not specified, the default registry is used, which is defined by the
registry.default
config key which defaults to crates-io
.
When no feature options are given, the default
feature is activated for
every selected package.
Space or comma separated list of features to activate. These features only
apply to the current directory’s package. Features of direct dependencies
may be enabled with <dep-name>/<feature-name>
syntax.
Activate all available features of all selected packages.
Do not activate the default
feature of the current directory’s
package.
Install for the given architecture. The default is the host
architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>
. Run rustc --print target-list
for a
list of supported targets.
This may also be specified with the build.target
config value.
Build with the dev
profile instead the release
profile.
Number of parallel jobs to run. May also be specified with the
build.jobs
config value. Defaults to
the number of CPUs.
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.
No output printed to stdout.
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.
Prints help information.
Unstable (nightly-only) flags to Cargo. Run cargo -Z help
for
details.
See the reference for details on environment variables that Cargo reads.
Cargo succeeded.
Cargo failed to complete.
Install a package from crates.io:
cargo install ripgrep
Reinstall or upgrade a package:
cargo install ripgrep --force