src/doc/man/generated/cargo-install.html

<h2 id="cargo_install_name">NAME</h2>
<div class="sectionbody">
<p>cargo-install - Build and install a Rust binary</p>
</div>
<div class="sect1">
<h2 id="cargo_install_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph">
<p><code>cargo install [<em>OPTIONS</em>] <em>CRATE</em>&#8230;&#8203;</code><br>
<code>cargo install [<em>OPTIONS</em>] --path <em>PATH</em></code><br>
<code>cargo install [<em>OPTIONS</em>] --git <em>URL</em> [<em>CRATE</em>&#8230;&#8203;]</code><br>
<code>cargo install [<em>OPTIONS</em>] --list</code></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cargo_install_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This command manages Cargo&#8217;s local set of installed binary crates. Only
packages which have executable <code>[[bin]]</code> or <code>[[example]]</code> targets can be
installed, and all executables are installed into the installation root&#8217;s
<code>bin</code> folder.</p>
</div>
<div class="paragraph">
<p>The installation root is determined, in order of precedence:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--root</code> option</p>
</li>
<li>
<p><code>CARGO_INSTALL_ROOT</code> environment variable</p>
</li>
<li>
<p><code>install.root</code> Cargo <a href="../reference/config.html">config value</a></p>
</li>
<li>
<p><code>CARGO_HOME</code> environment variable</p>
</li>
<li>
<p><code>$HOME/.cargo</code></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>There are multiple sources from which a crate can be installed. The default
location is crates.io but the <code>--git</code>, <code>--path</code>, and <code>--registry</code> 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 <em>CRATE</em> argument is
required to indicate which crate should be installed.</p>
</div>
<div class="paragraph">
<p>Crates from crates.io can optionally specify the version they wish to install
via the <code>--version</code> 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 <code>--bin</code> argument can selectively install only
one of them, and if you&#8217;d rather install examples the <code>--example</code> argument can
be used as well.</p>
</div>
<div class="paragraph">
<p>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:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>The package version and source.</p>
</li>
<li>
<p>The set of binary names installed.</p>
</li>
<li>
<p>The chosen features.</p>
</li>
<li>
<p>The release mode (<code>--debug</code>).</p>
</li>
<li>
<p>The target (<code>--target</code>).</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Installing with <code>--path</code> will always build and install, unless there are
conflicting binaries from another package. The <code>--force</code> flag may be used to
force Cargo to always reinstall the package.</p>
</div>
<div class="paragraph">
<p>If the source is crates.io or <code>--git</code> 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 <code>CARGO_TARGET_DIR</code> environment variable to a relative
path. In particular, this can be useful for caching build artifacts on
continuous integration systems.</p>
</div>
<div class="paragraph">
<p>By default, the <code>Cargo.lock</code> 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 <code>--locked</code> flag can be used to force Cargo to use
the packaged <code>Cargo.lock</code> 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 <code>--locked</code> is that you
will not receive any fixes or updates to any dependency. Note that Cargo did
not start publishing <code>Cargo.lock</code> files until version 1.37, which means
packages published with prior versions will not have a <code>Cargo.lock</code> file
available.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cargo_install_options">OPTIONS</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="cargo_install_install_options">Install Options</h3>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>--vers</strong> <em>VERSION</em></dt>
<dt class="hdlist1"><strong>--version</strong> <em>VERSION</em></dt>
<dd>
<p>Specify a version to install. This may be a
<a href="../reference/specifying-dependencies.md">version requirement</a>, like
<code>~1.2</code>, to have Cargo select the newest version from the given
requirement. If the version does not have a requirement operator (such as
<code>^</code> or <code>~</code>), then it must be in the form <em>MAJOR.MINOR.PATCH</em>, and will
install exactly that version; it is <strong>not</strong> treated as a caret requirement
like Cargo dependencies are.</p>
</dd>
<dt class="hdlist1"><strong>--git</strong> <em>URL</em></dt>
<dd>
<p>Git URL to install the specified crate from.</p>
</dd>
<dt class="hdlist1"><strong>--branch</strong> <em>BRANCH</em></dt>
<dd>
<p>Branch to use when installing from git.</p>
</dd>
<dt class="hdlist1"><strong>--tag</strong> <em>TAG</em></dt>
<dd>
<p>Tag to use when installing from git.</p>
</dd>
<dt class="hdlist1"><strong>--rev</strong> <em>SHA</em></dt>
<dd>
<p>Specific commit to use when installing from git.</p>
</dd>
<dt class="hdlist1"><strong>--path</strong> <em>PATH</em></dt>
<dd>
<p>Filesystem path to local crate to install.</p>
</dd>
<dt class="hdlist1"><strong>--list</strong></dt>
<dd>
<p>List all installed packages and their versions.</p>
</dd>
<dt class="hdlist1"><strong>-f</strong></dt>
<dt class="hdlist1"><strong>--force</strong></dt>
<dd>
<p>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 <code>rustc</code>.</p>
</dd>
<dt class="hdlist1"><strong>--no-track</strong></dt>
<dd>
<p>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 <code>--force</code> flag is used. This also disables
Cargo&#8217;s ability to protect against multiple concurrent invocations of
Cargo installing at the same time.</p>
</dd>
<dt class="hdlist1"><strong>--bin</strong> <em>NAME</em>&#8230;&#8203;</dt>
<dd>
<p>Install only the specified binary.</p>
</dd>
<dt class="hdlist1"><strong>--bins</strong></dt>
<dd>
<p>Install all binaries.</p>
</dd>
<dt class="hdlist1"><strong>--example</strong> <em>NAME</em>&#8230;&#8203;</dt>
<dd>
<p>Install only the specified example.</p>
</dd>
<dt class="hdlist1"><strong>--examples</strong></dt>
<dd>
<p>Install all examples.</p>
</dd>
<dt class="hdlist1"><strong>--root</strong> <em>DIR</em></dt>
<dd>
<p>Directory to install packages into.</p>
</dd>
<dt class="hdlist1"><strong>--registry</strong> <em>REGISTRY</em></dt>
<dd>
<p>Name of the registry to use. Registry names are defined in <a href="../reference/config.html">Cargo config files</a>.
If not specified, the default registry is used, which is defined by the
<code>registry.default</code> config key which defaults to <code>crates-io</code>.</p>
</dd>
</dl>
</div>
</div>
<div class="sect2">
<h3 id="cargo_install_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>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 the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>--features</strong> <em>FEATURES</em></dt>
<dd>
<p>Space or comma separated list of features to activate. These features only
apply to the current directory&#8217;s package. Features of direct dependencies
may be enabled with <code>&lt;dep-name&gt;/&lt;feature-name&gt;</code> syntax. This flag may be
specified multiple times, which enables all specified features.</p>
</dd>
<dt class="hdlist1"><strong>--all-features</strong></dt>
<dd>
<p>Activate all available features of all selected packages.</p>
</dd>
<dt class="hdlist1"><strong>--no-default-features</strong></dt>
<dd>
<p>Do not activate the <code>default</code> feature of the current directory&#8217;s
package.</p>
</dd>
</dl>
</div>
</div>
<div class="sect2">
<h3 id="cargo_install_compilation_options">Compilation Options</h3>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>--target</strong> <em>TRIPLE</em></dt>
<dd>
<p>Install for the given architecture. The default is the host
architecture. The general format of the triple is
<code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>. Run <code>rustc --print target-list</code> for a
list of supported targets.</p>
<div class="paragraph">
<p>This may also be specified with the <code>build.target</code>
<a href="../reference/config.html">config value</a>.</p>
</div>
<div class="paragraph">
<p>Note that specifying this flag makes Cargo run in a different mode where the
target artifacts are placed in a separate directory. See the
<a href="../guide/build-cache.html">build cache</a> documentation for more details.</p>
</div>
</dd>
<dt class="hdlist1"><strong>--debug</strong></dt>
<dd>
<p>Build with the <code>dev</code> profile instead the <code>release</code> profile.</p>
</dd>
</dl>
</div>
</div>
<div class="sect2">
<h3 id="cargo_install_manifest_options">Manifest Options</h3>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>--frozen</strong></dt>
<dt class="hdlist1"><strong>--locked</strong></dt>
<dd>
<p>Either of these flags requires that the <code>Cargo.lock</code> file is
up-to-date. If the lock file is missing, or it needs to be updated, Cargo will
exit with an error. The <code>--frozen</code> flag also prevents Cargo from
attempting to access the network to determine if it is out-of-date.</p>
<div class="paragraph">
<p>These may be used in environments where you want to assert that the
<code>Cargo.lock</code> file is up-to-date (such as a CI build) or want to avoid network
access.</p>
</div>
</dd>
<dt class="hdlist1"><strong>--offline</strong></dt>
<dd>
<p>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.</p>
<div class="paragraph">
<p>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 <a href="cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going
offline.</p>
</div>
<div class="paragraph">
<p>May also be specified with the <code>net.offline</code> <a href="../reference/config.html">config value</a>.</p>
</div>
</dd>
</dl>
</div>
</div>
<div class="sect2">
<h3 id="cargo_install_miscellaneous_options">Miscellaneous Options</h3>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>-j</strong> <em>N</em></dt>
<dt class="hdlist1"><strong>--jobs</strong> <em>N</em></dt>
<dd>
<p>Number of parallel jobs to run. May also be specified with the
<code>build.jobs</code> <a href="../reference/config.html">config value</a>. Defaults to
the number of CPUs.</p>
</dd>
</dl>
</div>
</div>
<div class="sect2">
<h3 id="cargo_install_display_options">Display Options</h3>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>-v</strong></dt>
<dt class="hdlist1"><strong>--verbose</strong></dt>
<dd>
<p>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 <code>term.verbose</code>
<a href="../reference/config.html">config value</a>.</p>
</dd>
<dt class="hdlist1"><strong>-q</strong></dt>
<dt class="hdlist1"><strong>--quiet</strong></dt>
<dd>
<p>No output printed to stdout.</p>
</dd>
<dt class="hdlist1"><strong>--color</strong> <em>WHEN</em></dt>
<dd>
<p>Control when colored output is used. Valid values:</p>
<div class="ulist">
<ul>
<li>
<p><code>auto</code> (default): Automatically detect if color support is available on the
terminal.</p>
</li>
<li>
<p><code>always</code>: Always display colors.</p>
</li>
<li>
<p><code>never</code>: Never display colors.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>May also be specified with the <code>term.color</code>
<a href="../reference/config.html">config value</a>.</p>
</div>
</dd>
</dl>
</div>
</div>
<div class="sect2">
<h3 id="cargo_install_common_options">Common Options</h3>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>-h</strong></dt>
<dt class="hdlist1"><strong>--help</strong></dt>
<dd>
<p>Prints help information.</p>
</dd>
<dt class="hdlist1"><strong>-Z</strong> <em>FLAG</em>&#8230;&#8203;</dt>
<dd>
<p>Unstable (nightly-only) flags to Cargo. Run <code>cargo -Z help</code> for
details.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cargo_install_environment">ENVIRONMENT</h2>
<div class="sectionbody">
<div class="paragraph">
<p>See <a href="../reference/environment-variables.html">the reference</a> for
details on environment variables that Cargo reads.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cargo_install_exit_status">Exit Status</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>Cargo succeeded.</p>
</dd>
<dt class="hdlist1">101</dt>
<dd>
<p>Cargo failed to complete.</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cargo_install_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Install or upgrade a package from crates.io:</p>
<div class="literalblock">
<div class="content">
<pre>cargo install ripgrep</pre>
</div>
</div>
</li>
<li>
<p>Install or reinstall the package in the current directory:</p>
<div class="literalblock">
<div class="content">
<pre>cargo install --path .</pre>
</div>
</div>
</li>
<li>
<p>View the list of installed packages:</p>
<div class="literalblock">
<div class="content">
<pre>cargo install --list</pre>
</div>
</div>
</li>
</ol>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cargo_install_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph">
<p><a href="index.html">cargo(1)</a>, <a href="cargo-uninstall.html">cargo-uninstall(1)</a>, <a href="cargo-search.html">cargo-search(1)</a>, <a href="cargo-publish.html">cargo-publish(1)</a></p>
</div>
</div>
</div>