cargo-install — Build and install a Rust binary

       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 option

       •  CARGO_INSTALL_ROOT environment variable

       •  install.root Cargo configvalue <https://doc.rust-lang.org/cargo/reference/config.html>

       •  CARGO_HOME environment variable

       •  $HOME/.cargo

       There 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:

       •  The package version and source.

       •  The set of binary names installed.

       •  The chosen features.

       •  The profile (--profile).

       •  The target (--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 relative path. In particular, this can be useful for caching build artifacts on
       continuous integration systems.

   DealingwiththeLockfile
       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.

   ConfigurationDiscovery
       This command operates on system or user level, not project level. This means that the local configurationdiscovery <https://doc.rust-lang.org/cargo/reference/config.html#hierarchical-structure> 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.

       See thereference <https://doc.rust-lang.org/cargo/reference/environment-variables.html> for details on
       environment variables that Cargo reads.

        1. Install or upgrade a package from crates.io:

               cargo install ripgrep

        2. Install or reinstall the package in the current directory:

               cargo install --path .

        3. View the list of installed packages:

               cargo install --list

       •  0: Cargo succeeded.

       •  101: Cargo failed to complete.

       cargo-install — Build and install a Rust binary

InstallOptions--versversion, --versionversion
           Specify a version to install. This may be a versionrequirement
           <https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html>, like ~1.2, to have Cargo
           select the newest version from the given requirement. If the version does not have a requirement
           operator (such as ^ or ~), then it must be in the form MAJOR.MINOR.PATCH, and will install exactly
           that version; it is not treated as a caret requirement like Cargo dependencies are.

       --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 from.

       --list
           List all installed packages and their versions.

       -f, --force
           Force overwriting existing crates or binaries. This can be used if a package has installed a binary
           with the same name as another package. This is also useful if something has changed on the system
           that you want to rebuild with, such as a newer version of rustc.

       --no-track
           By default, Cargo keeps track of the installed packages with a metadata file stored in the
           installation root directory. This flag tells Cargo not to use or create that file. With this flag,
           Cargo will refuse to overwrite any existing files unless the --force flag is used. This also disables
           Cargo’s ability to protect against multiple concurrent invocations of Cargo installing at the same
           time.

       --binname…
           Install only the specified binary.

       --bins
           Install all binaries. This is the default behavior.

       --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 Cargoconfigfiles
           <https://doc.rust-lang.org/cargo/reference/config.html>. If not specified, the default registry is
           used, which is defined by the registry.default config key which defaults to crates-io.

       --indexindex
           The URL of the registry index to use.

   FeatureSelection
       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 thefeaturesdocumentation
       <https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options> for more details.

       -Ffeatures, --featuresfeatures
           Space or comma separated list of features to activate. Features of workspace members may be enabled
           with package-name/feature-name syntax. This flag may be specified multiple times, which enables all
           specified features.

       --all-features
           Activate all available features of all selected packages.

       --no-default-features
           Do not activate the default feature of the selected packages.

   CompilationOptions--targettriple
           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--printtarget-list for a list of supported
           targets.

           This may also be specified with the build.targetconfigvalue
           <https://doc.rust-lang.org/cargo/reference/config.html>.

           Note that specifying this flag makes Cargo run in a different mode where the target artifacts are
           placed in a separate directory. See the buildcache
           <https://doc.rust-lang.org/cargo/guide/build-cache.html> documentation for more details.

       --target-dirdirectory
           Directory for all generated artifacts and intermediate files. May also be specified with the
           CARGO_TARGET_DIR environment variable, or the build.target-dirconfigvalue
           <https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to a new temporary folder located
           in the temporary directory of the platform.

           When using --path, by default it will use target directory in the workspace of the local crate unless
           --target-dir is specified.

       --debug
           Build with the dev profile instead of the release profile. See also the --profile option for choosing
           a specific profile by name.

       --profilename
           Install with the given profile. See thereference
           <https://doc.rust-lang.org/cargo/reference/profiles.html> for more details on profiles.

       --timings=fmts
           Output information how long each compilation takes, and track concurrency information over time.
           Accepts an optional comma-separated list of output formats; --timings without an argument will
           default to --timings=html. Specifying an output format (rather than the default) is unstable and
           requires -Zunstable-options. Valid output formats:

           •  html (unstable, requires -Zunstable-options): Write a human-readable file cargo-timing.html to the
               target/cargo-timings directory with a report of the compilation. Also write a report to the same
               directory with a timestamp in the filename if you want to look at older runs. HTML output is
               suitable for human consumption only, and does not provide machine-readable timing data.

           •  json (unstable, requires -Zunstable-options): Emit machine-readable JSON information about timing
               information.

   ManifestOptions--ignore-rust-version
           Ignore rust-version specification in packages.

       --locked
           Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file
           was originally generated. Cargo will exit with an error when either of the following scenarios
           arises:

           •  The lock file is missing.

           •  Cargo attempted to change the lock file due to a different dependency resolution.

           It may be used in environments where deterministic builds are desired, such as in CI pipelines.

       --offline
           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.

           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. See the cargo-fetch(1) command to download dependencies before going
           offline.

           May also be specified with the net.offlineconfigvalue
           <https://doc.rust-lang.org/cargo/reference/config.html>.

       --frozen
           Equivalent to specifying both --locked and --offline.

   MiscellaneousOptions-jN, --jobsN
           Number of parallel jobs to run. May also be specified with the build.jobsconfigvalue
           <https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to the number of logical CPUs. If
           negative, it sets the maximum number of parallel jobs to the number of logical CPUs plus provided
           value. If a string default is provided, it sets the value back to defaults. Should not be 0.

       --keep-going
           Build as many crates in the dependency graph as possible, rather than aborting the build on the first
           one that fails to build.

           For example if the current package depends on dependencies fails and works, one of which fails to
           build, cargoinstall-j1 may or may not build the one that succeeds (depending on which one of the
           two builds Cargo picked to run first), whereas cargoinstall-j1--keep-going would definitely run
           both builds, even if the one run first fails.

   DisplayOptions-v, --verbose
           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.verboseconfigvalue <https://doc.rust-lang.org/cargo/reference/config.html>.

       -q, --quiet
           Do not print cargo log messages. May also be specified with the term.quietconfigvalue
           <https://doc.rust-lang.org/cargo/reference/config.html>.

       --colorwhen
           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.colorconfigvalue
           <https://doc.rust-lang.org/cargo/reference/config.html>.

       --message-formatfmt
           The output format for diagnostic messages. Can be specified multiple times and consists of
           comma-separated values. Valid values:

           •  human (default): Display in a human-readable text format. Conflicts with short and json.

           •  short: Emit shorter, human-readable text messages. Conflicts with human and json.

           •  json: Emit JSON messages to stdout. See thereference
               <https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages> for more details.
               Conflicts with human and short.

           •  json-diagnostic-short: Ensure the rendered field of JSON messages contains the “short” rendering
               from rustc. Cannot be used with human or short.

           •  json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages contains embedded ANSI
               color codes for respecting rustc’s default color scheme. Cannot be used with human or short.

           •  json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed,
               but instead Cargo itself should render the JSON diagnostics coming from rustc. Cargo’s own JSON
               diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.

   CommonOptions+toolchain
           If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be
           interpreted as a rustup toolchain name (such as +stable or +nightly). See the rustupdocumentation
           <https://rust-lang.github.io/rustup/overrides.html> for more information about how toolchain
           overrides work.

       --configKEY=VALUE or PATH
           Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or
           provided as a path to an extra configuration file. This flag may be specified multiple times. See the
           command-lineoverridessection
           <https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides> for more information.

       -CPATH
           Changes the current working directory before executing any specified operations. This affects things
           like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories
           searched for discovering .cargo/config.toml, for example. This option must appear before the command
           name, for example cargo-Cpath/to/my-projectbuild.

           This option is only available on the nightlychannel
           <https://doc.rust-lang.org/book/appendix-07-nightly-rust.html> and requires the -Zunstable-options
           flag to enable (see #10098 <https://github.com/rust-lang/cargo/issues/10098>).

       -h, --help
           Prints help information.

       -Zflag
           Unstable (nightly-only) flags to Cargo. Run cargo-Zhelp for details.

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

                                                                                                CARGO-INSTALL(1)

cargoinstall [options] crate[@version]…
       cargoinstall [options] --pathpathcargoinstall [options] --giturl [crate…]
       cargoinstall [options] --list