MAN page from OpenSuSE cargo-1.43.1-12.1.x86_64.rpm

CARGO\-INSTALL

Section: \ \& (1)
Updated: 2020-02-06
Index

NAME

cargo-install - Build and install a Rust binary

SYNOPSIS

cargo install [OPTIONS] CRATE...
cargo install [OPTIONS] --path PATH
cargo install [OPTIONS] --git URL [CRATE...]
cargo install [OPTIONS] --list

DESCRIPTION

This command manages Cargocqs local set of installed binary crates. Onlypackages which have executable [[bin]] or [[example]] targets can beinstalled, and all executables are installed into the installation rootcqsbin folder.

The installation root is determined, in order of precedence:

: *--root option

: *CARGO_INSTALL_ROOT environment variable

: *install.root Cargo https://doc.rust-lang.org/cargo/reference/config.html <L>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 youcqd rather install examples the --example argument canbe used as well.

If the package is already installed, Cargo will reinstall it if the installedversion does not appear to be up-to-date. If any of the following valueschange, then Cargo will reinstall the package:

: *The package version and source.

: *The set of binary names installed.

: *The chosen features.

: *The release mode (--debug).

: *The target (--target).

Installing with --path will always build and install, unless there areconflicting binaries from another package. The --force flag may be used toforce Cargo to always reinstall the package.

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

--vers VERSION, --version VERSION

: Specify a version to install. This may be ahttps://doc.rust-lang.org/cargo/reference/specifying-dependencies.md <L>version requirementlike~1.2, to have Cargo select the newest version from the givenrequirement. If the version does not have a requirement operator (such as^ or ~), then it must be in the form MAJOR.MINOR.PATCH, and willinstall exactly that version; it is not treated as a caret requirementlike Cargo dependencies are.

--git URL

: Git URL to install the specified crate from.

--branch BRANCH

: Branch to use when installing from git.

--tag TAG

: Tag to use when installing from git.

--rev SHA

: Specific commit to use when installing from git.

--path PATH

: 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 if apackage has installed a binary with the same name as another package. Thisis also useful if something has changed on the system that you want torebuild with, such as a newer version of rustc.

--no-track

: By default, Cargo keeps track of the installed packages with a metadatafile stored in the installation root directory. This flag tells Cargo notto use or create that file. With this flag, Cargo will refuse to overwriteany existing files unless the --force flag is used. This also disablesCargocqs ability to protect against multiple concurrent invocations ofCargo installing at the same time.

--bin NAME...

: Install only the specified binary.

--bins

: Install all binaries.

--example NAME...

: Install only the specified example.

--examples

: Install all examples.

--root DIR

: Directory to install packages into.

--registry REGISTRY

: Name of the registry to use. Registry names are defined in https://doc.rust-lang.org/cargo/reference/config.html <L>Cargo config filesIf not specified, the default registry is used, which is defined by theregistry.default config key which defaults to crates-io.

Feature Selection

The feature flags allow you to control the enabled features for the "current"package. The "current" package is the package in the current directory, or theone specified in --manifest-path. If running in the root of a virtualworkspace, then the default features are selected for all workspace members,or all features if --all-features is specified.

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

--features FEATURES

: Space or comma separated list of features to activate. These features onlyapply to the current directorycqs package. Features of direct dependenciesmay be enabled with <dep-name>/<feature-name> syntax. This flag may bespecified 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 current directorycqspackage.

Compilation Options

--target TRIPLE

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.targethttps://doc.rust-lang.org/cargo/reference/config.html <L>config value

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

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

Miscellaneous Options

-j N, --jobs N

: Number of parallel jobs to run. May also be specified with thebuild.jobs https://doc.rust-lang.org/cargo/reference/config.html <L>config valueDefaults 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.verbosehttps://doc.rust-lang.org/cargo/reference/config.html <L>config value

-q, --quiet