cargo install

NAME

cargo-install - Build and install a Rust binary

SYNOPSIS

cargo install [OPTIONS] CRATE…​cargo install [OPTIONS] —path PATHcargo install [OPTIONS] —git URL [CRATE…​]cargo install [OPTIONS] —list

DESCRIPTION

This command manages Cargo’s local set of installed binary crates. Onlypackages which have executable [[bin]] or [[example]] targets can beinstalled, and all executables are installed into the installation root’sbin 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 defaultlocation is crates.io but the —git, —path, and —registry flags canchange this source. If the source contains more than one package (such ascrates.io or a git repository with multiple crates) the CRATE argument isrequired to indicate which crate should be installed.

Crates from crates.io can optionally specify the version they wish to installvia the —version flags, and similarly packages from git repositories canoptionally specify the branch, tag, or revision that should be installed. If acrate has multiple binaries, the —bin argument can selectively install onlyone of them, and if you’d rather install examples the —example argument canbe used as well.

If the source is crates.io or —git then by default the crate will be builtin a temporary target directory. To avoid this, the target directory can bespecified by setting the CARGO_TARGET_DIR environment variable to a relativepath. In particular, this can be useful for caching build artifacts oncontinuous integration systems.

By default, the Cargo.lock file that is included with the package will beignored. This means that Cargo will recompute which versions of dependenciesto use, possibly using newer versions that have been released since thepackage was published. The —locked flag can be used to force Cargo to usethe packaged Cargo.lock file if it is available. This may be useful forensuring reproducible builds, to use the exact same set of dependencies thatwere available when the package was published. It may also be useful if anewer version of a dependency is published that no longer builds on yoursystem, or has other problems. The downside to using —locked is that youwill not receive any fixes or updates to any dependency. Note that Cargo didnot start publishing Cargo.lock files until version 1.37, which meanspackages published with prior versions will not have a Cargo.lock fileavailable.

OPTIONS

Install Options

  • —versVERSION
  • —versionVERSION

  • Specify a version to install.

  • —gitURL

  • Git URL to install the specified crate from.

  • —branchBRANCH

  • Branch to use when installing from git.

  • —tagTAG

  • Tag to use when installing from git.

  • —revSHA

  • Specific commit to use when installing from git.

  • —pathPATH

  • Filesystem path to local crate to install.

  • —list

  • List all installed packages and their versions.

  • -f

  • —force

  • Force overwriting existing crates or binaries. This can be used toreinstall or upgrade a crate.

  • —binNAME…​

  • Install only the specified binary.

  • —bins

  • Install all binaries.

  • —exampleNAME…​

  • Install only the specified example.

  • —examples

  • Install all examples.

  • —rootDIR

  • Directory to install packages into.

  • —registryREGISTRY

  • 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 theregistry.default config key which defaults to crates-io.

Feature Selection

When no feature options are given, the default feature is activated forevery selected package.

  • —featuresFEATURES

  • Space or comma separated list of features to activate. These features onlyapply to the current directory’s package. Features of direct dependenciesmay be enabled with <dep-name>/<feature-name> syntax.

  • —all-features

  • Activate all available features of all selected packages.

  • —no-default-features

  • Do not activate the default feature of the current directory’spackage.

Compilation Options

  • —targetTRIPLE
  • Install for the given architecture. The default is the hostarchitecture. The general format of the triple is<arch><sub>-<vendor>-<sys>-<abi>. Run rustc —print target-list for alist of supported targets.

This may also be specified with the build.targetconfig value.

  • —debug
  • Build with the dev profile instead the release profile.

Manifest Options

  • —frozen
  • —locked
  • Either of these flags requires that the Cargo.lock file isup-to-date. If the lock file is missing, or it needs to be updated, Cargo willexit with an error. The —frozen flag also prevents Cargo fromattempting to access the network to determine if it is out-of-date.

These may be used in environments where you want to assert that theCargo.lock file is up-to-date (such as a CI build) or want to avoid networkaccess.

  • —offline
  • Prevents Cargo from accessing the network for any reason. Without thisflag, Cargo will stop with an error if it needs to access the network andthe network is not available. With this flag, Cargo will attempt toproceed without the network if possible.

Beware that this may result in different dependency resolution than onlinemode. Cargo will restrict itself to crates that are downloaded locally, evenif 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 goingoffline.

May also be specified with the net.offline config value.

Miscellaneous Options

  • -jN
  • —jobsN
  • Number of parallel jobs to run. May also be specified with thebuild.jobs config value. Defaults tothe number of CPUs.

Display Options

  • -v
  • —verbose

  • Use verbose output. May be specified twice for "very verbose" output whichincludes extra output such as dependency warnings and build script output.May also be specified with the term.verboseconfig value.

  • -q

  • —quiet

  • No output printed to stdout.

  • —colorWHEN

  • Control when colored output is used. Valid values:

  • auto (default): Automatically detect if color support is available on theterminal.

  • always: Always display colors.

  • never: Never display colors.

May also be specified with the term.colorconfig value.

Common Options

  • -h
  • —help

  • Prints help information.

  • -ZFLAG…​

  • Unstable (nightly-only) flags to Cargo. Run cargo -Z help fordetails.

ENVIRONMENT

See the reference fordetails on environment variables that Cargo reads.

Exit Status

  • 0

  • Cargo succeeded.

  • 101

  • Cargo failed to complete.

EXAMPLES

  • Install a package from crates.io:
  1. cargo install ripgrep
  • Reinstall or upgrade a package:
  1. cargo install ripgrep --force

SEE ALSO

cargo(1), cargo-uninstall(1), cargo-search(1), cargo-publish(1)