MAN page from OpenSuSE cargo-1.36.0-lp151.5.4.1.x86_64.rpm

CARGO\-INSTALL

Section: \ \& (1)
Updated: 2019-05-12
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. Only packageswhich have [[bin]] targets can be installed, and all binaries are installed intothe installation rootcqs bin 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 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.

OPTIONS

Install Options

--vers VERSION, --version VERSION

: Specify a version to install.

--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 toreinstall or upgrade a crate.

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

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.

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

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