MAN page from openSUSE Tumbleweed cargo-1.31.1-186.1.i586.rpm
CARGO\-INSTALL
Section: Cargo Manual (1)
Updated: May 2016
Index NAME
cargo-install - Install a Rust binary
SYNOPSIS
I]cargo install] [OPTIONS] <CRATE>
I]cargo install] [OPTIONS] --list
DESCRIPTION
Install a Rust binary
This command manages Cargo[aq]s local set of install binary crates.Only packages which have [[bin]] targets can be installed, and allbinaries are installed into the installation root[aq]s I]bin]folder.The installation root is determined, in order of precedence, byB]--root], I]$CARGO_INSTALL_ROOT], theI]install.root] configuration key, and finally the home directory(which is either I]$CARGO_HOME] if set or I]$HOME/.cargo] bydefault).
There are multiple sources from which a crate can be installed.The default location is crates.io but the B]--git] andB]--path] flags can change this source.If the source contains more than one package (such as I]crates.io]or a git repository with multiple crates) the B]] argument isrequired to indicate which crate should be installed.
Crates from crates.io can optionally specify the version they wish toinstall via the B]--vers] flags, and similarly packages from gitrepositories can optionally specify the branch, tag, or revision thatshould be installed.If a crate has multiple binaries, the B]--bin] argument canselectively install only one of them, and if you[aq]d rather installexamples the B]--example] argument can be used as well.
As a special convenience, omitting the <crate> specification entirelywill install the crate in the current directory.That is, I]install] is equivalent to the more explicit "install--path .".
If the source is crates.io or B]--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 B]CARGO_TARGET_DIR] environment variable to a relative path.In particular, this can be useful for caching build artifacts on continuous integration systems.
The B]--list] option will list all installed packages (and theirversions).
OPTIONS
Query options
- --list
- List all installed packages (and their versions).
Specifying what crate to install
- --vers I]VERS]
- Specify a version to install from crates.io.
- --git I]URL]
- Git URL to install the specified crate from.
- --branch I]BRANCH]
- Branch to use when installing from git.
- --tag I]TAG]
- Tag to use when installing from git.
- --rev I]SHA]
- Specific commit to use when installing from git.
- --path I]PATH]
- Filesystem path to local crate to install.
Built and install options
- -h, --help
- Print this message.
- -j I]N], --jobs I]N]
- Number of parallel jobs, defaults to # of CPUs.
- --features I]FEATURES]
- Space-separated list of features to activate.
- --all-features
- Build all available features.
- -f, --force
- Force overwriting existing crates or binaries
- --no-default-features
- Do not build the C]default] feature.
- --debug
- Build in debug mode instead of release mode.
- --bin I]NAME]
- Only install the binary NAME.
- --example I]EXAMPLE]
- Install the example EXAMPLE instead of binaries.
- --root I]DIR]
- Directory to install packages into.
- -v, --verbose
- Use verbose output.
- -q, --quiet
- No output printed to stdout.
- --color I]WHEN]
- Coloring: auto, always, never.
SEE ALSO
cargo(1), cargo-search(1), cargo-publish(1)
COPYRIGHT
This work is dual-licensed under Apache 2.0 and MIT terms.See I]COPYRIGHT] file in the cargo source distribution.
Index
- NAME
- SYNOPSIS
- DESCRIPTION
- OPTIONS
- Query options
- Specifying what crate to install
- Built and install options
- SEE ALSO
- COPYRIGHT
This document was created byman2html,using the manual pages.
