cargo-install(1)

概要

cargo install [选项] crate[@版本]…
cargo install [选项] --path 路径
cargo install [选项] --git url [crate…]
cargo install [选项] --list

描述

此命令管理 Cargo 本地安装的二进制 crate 集合。只有具有可执行的 [[bin]] 或 [[example]] 目标的包才能安装，并且所有可执行文件都安装到安装根目录的 bin 文件夹中。默认情况下，只安装二进制文件，不安装示例。

安装根目录的确定顺序如下：

--root 选项
CARGO_INSTALL_ROOT 环境变量
install.root Cargo 配置值
CARGO_HOME 环境变量
$HOME/.cargo

crate 可以从多个源进行安装。默认源位置是 crates.io，但是 --git、--path 和 --registry 标志可以更改此源。如果源包含多个包（例如 crates.io 或具有多个 crate 的 git 存储库），则需要 crate 参数来指示应安装哪个 crate。

来自 crates.io 的 Crate 可以选择通过 --version 标志指定要安装的版本，类似地，来自 git 存储库的包可以选择指定应安装的分支、标签或修订版本。如果一个 crate 有多个二进制文件，则可以使用 --bin 参数有选择地仅安装其中一个，并且如果您更愿意安装示例，则也可以使用 --example 参数。

如果已安装该包，则如果已安装的版本似乎不是最新的，Cargo 将重新安装它。如果以下任何值发生更改，则 Cargo 将重新安装该包：

包版本和源。
已安装的二进制名称集。
选择的功能。
配置文件 (--profile)。
目标 (--target)。

使用 --path 安装将始终构建和安装，除非存在来自另一个包的冲突二进制文件。可以使用 --force 标志强制 Cargo 始终重新安装该包。

如果源是 crates.io 或 --git，则默认情况下，crate 将在临时目标目录中构建。要避免这种情况，可以通过将 CARGO_TARGET_DIR 环境变量设置为相对路径来指定目标目录。特别是，这对于在持续集成系统上缓存构建工件非常有用。

默认情况下，将忽略包中包含的 Cargo.lock 文件。这意味着 Cargo 将重新计算要使用的依赖项版本，可能使用自包发布以来发布的新版本。可以使用 --locked 标志强制 Cargo 使用打包的 Cargo.lock 文件（如果可用）。这对于确保可重现的构建，使用与发布包时可用的完全相同的依赖项集可能很有用。如果发布了新版本的依赖项，该依赖项不再在您的系统上构建或存在其他问题，这也可能很有用。使用 --locked 的缺点是您不会收到任何依赖项的修复或更新。请注意，Cargo 直到 1.37 版本才开始发布 Cargo.lock 文件，这意味着使用先前版本发布的包将没有可用的 Cargo.lock 文件。

配置发现

此命令在系统或用户级别运行，而不是项目级别。这意味着本地配置发现被忽略。相反，配置发现从 $CARGO_HOME/config.toml 开始。如果使用 --path $PATH 安装包，将使用本地配置，从 $PATH/.cargo/config.toml 开始发现。

选项

安装选项

--vers 版本
--version 版本: 指定要安装的版本。这可以是版本要求，例如 ~1.2，让 Cargo 从给定的要求中选择最新版本。如果该版本没有要求运算符（例如 ^ 或 ~），则它必须采用 MAJOR.MINOR.PATCH 形式，并且将精确安装该版本；它不被视为像 Cargo 依赖项那样的插入符要求。
--git url: 要从中安装指定 crate 的 Git URL。
--branch 分支: 从 git 安装时使用的分支。
--tag 标签: 从 git 安装时使用的标签。
--rev sha: 从 git 安装时使用的特定提交。
--path 路径: 要从中安装的本地 crate 的文件系统路径。
--list: 列出所有已安装的包及其版本。
-n
--dry-run: （不稳定）执行所有检查而不安装。
-f
--force: 强制覆盖现有的 crate 或二进制文件。如果一个包安装了与另一个包名称相同的二进制文件，则可以使用此选项。如果您想使用新版本的 rustc 等系统上已更改的内容重新构建，这也很有用。
--no-track: 默认情况下，Cargo 会使用存储在安装根目录中的元数据文件来跟踪已安装的包。此标志告诉 Cargo 不要使用或创建该文件。使用此标志，除非使用 --force 标志，否则 Cargo 将拒绝覆盖任何现有文件。这也禁用了 Cargo 保护同时安装的多个并发 Cargo 调用的能力。
--bin 名称…: 仅安装指定的二进制文件。
--bins: 安装所有二进制文件。这是默认行为。
--example 名称…: 仅安装指定的示例。
--examples: 安装所有示例。
--root 目录: 要将包安装到的目录。
--registry 注册表: 要使用的注册表的名称。注册表名称在 Cargo 配置文件中定义。如果未指定，则使用默认注册表，该注册表由默认值为 crates-io 的 registry.default 配置键定义。
--index 索引: 要使用的注册表索引的 URL。

功能选择

功能标志允许您控制启用哪些功能。当没有给出功能选项时，将为每个选定的包激活 default 功能。

有关更多详细信息，请参见功能文档。

-F 功能
--features 功能: 要激活的功能的空格或逗号分隔列表。可以使用 package-name/feature-name 语法启用工作区成员的功能。此标志可以多次指定，这将启用所有指定的功能。
--all-features: 激活所有选定包的所有可用功能。
--no-default-features: 不激活选定包的 default 功能。

编译选项

--target 三元组

为给定的体系结构安装。默认值是主机体系结构。三元组的通用格式为 <arch><sub>-<vendor>-<sys>-<abi>。运行 rustc --print target-list 以获取支持的目标列表。

也可以使用 build.target 配置值指定此选项。

请注意，指定此标志会使 Cargo 以不同的模式运行，其中目标工件放置在单独的目录中。有关更多详细信息，请参见构建缓存文档。

--target-dir 目录

所有生成的工件和中间文件的目录。也可以使用 CARGO_TARGET_DIR 环境变量或 build.target-dir 配置值指定。默认为位于平台临时目录中的新临时文件夹。

当使用 --path 时，默认情况下，它将使用本地 crate 工作区中的 target 目录，除非指定了 --target-dir。

--debug

使用 dev 配置文件而不是 release 配置文件进行构建。另请参见 --profile 选项，以按名称选择特定配置文件。

--profile 名称

使用给定的配置文件进行安装。有关配置文件的更多详细信息，请参见参考。

--timings=fmts

输出每个编译花费的时间以及随时间跟踪并发信息。接受可选的逗号分隔的输出格式列表；没有参数的 --timings 将默认为 --timings=html。指定输出格式（而不是默认格式）是不稳定的，并且需要 -Zunstable-options。有效的输出格式：

html（不稳定，需要 -Zunstable-options）：将人类可读的文件 cargo-timing.html 写入 target/cargo-timings 目录，其中包含编译报告。如果您想查看较早的运行，还将报告写入同一目录，并在文件名中带有时间戳。HTML 输出仅适用于人工使用，不提供机器可读的计时数据。
json（不稳定，需要 -Zunstable-options）：发出有关计时信息的机器可读 JSON 信息。

清单选项

--ignore-rust-version

忽略包中的 rust-version 规范。

--locked

断言使用的依赖项和版本与最初生成现有 Cargo.lock 文件时使用的完全相同。当出现以下任一情况时，Cargo 将退出并显示错误：

缺少锁定文件。
由于不同的依赖项解析，Cargo 尝试更改锁定文件。

它可以用在需要确定性构建的环境中，例如在 CI 管道中。

--offline

阻止 Cargo 出于任何原因访问网络。如果没有此标志，如果 Cargo 需要访问网络且网络不可用，它将停止并显示错误。使用此标志，如果可能，Cargo 将尝试在没有网络的情况下继续运行。

请注意，这可能导致与在线模式不同的依赖项解析。Cargo 将把自己限制在本地下载的 crate，即使本地索引副本中可能指示有更新的版本。请参阅 cargo-fetch(1) 命令，以便在离线前下载依赖项。

也可以使用 net.offline 配置值指定。

--frozen

等效于同时指定 --locked 和 --offline。

杂项选项

-j N

--jobs N

要运行的并行作业数。也可以使用 build.jobs 配置值指定。默认为逻辑 CPU 的数量。如果为负数，则会将最大并行作业数设置为逻辑 CPU 数量加上提供的值。如果提供字符串 default，则会将值设置回默认值。不应为 0。

--keep-going

尽可能多地构建依赖关系图中的 crate，而不是在第一个构建失败时中止构建。

例如，如果当前包依赖于 fails 和 works 依赖项，其中一个构建失败，则 cargo install -j1 可能构建或不构建成功的那个（取决于 Cargo 选择首先运行哪个构建），而 cargo install -j1 --keep-going 肯定会运行两个构建，即使首先运行的那个失败。

显示选项

-v

--verbose

使用详细输出。可以指定两次以获得“非常详细”的输出，其中包括额外的输出，例如依赖项警告和构建脚本输出。也可以使用 term.verbose 配置值指定。

-q

--quiet

不打印 cargo 日志消息。也可以使用 term.quiet 配置值指定。

--color when

控制何时使用彩色输出。有效值

auto（默认）：自动检测终端上是否支持颜色。
always：始终显示颜色。
never：从不显示颜色。

也可以使用 term.color 配置值指定。

--message-format fmt

诊断消息的输出格式。可以指定多次，并由逗号分隔的值组成。有效值

human（默认）：以人类可读的文本格式显示。与 short 和 json 冲突。
short：发出更短、人类可读的文本消息。与 human 和 json 冲突。
json：将 JSON 消息发送到 stdout。有关更多详细信息，请参阅参考。与 human 和 short 冲突。
json-diagnostic-short：确保 JSON 消息的 rendered 字段包含来自 rustc 的“短”渲染。不能与 human 或 short 一起使用。
json-diagnostic-rendered-ansi：确保 JSON 消息的 rendered 字段包含嵌入的 ANSI 颜色代码，以便尊重 rustc 的默认配色方案。不能与 human 或 short 一起使用。
json-render-diagnostics：指示 Cargo 不在打印的 JSON 消息中包含 rustc 诊断信息，而是 Cargo 本身应该渲染来自 rustc 的 JSON 诊断信息。Cargo 自己的 JSON 诊断信息和来自 rustc 的其他诊断信息仍然会发出。不能与 human 或 short 一起使用。