cargo-install(1)

名称

cargo-install — 构建并安装 Rust 二进制文件

概要

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

功能选择

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

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

-F 功能
--features 功能
要激活的功能的空格或逗号分隔列表。可以使用 包名/功能名 语法启用工作区成员的功能。此标志可以指定多次，这将启用所有指定的功能。
--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 时，默认情况下，它将使用本地包工作区中的 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 将限制自己使用本地下载的包，即使索引的本地副本中指示可能有更新的版本。请参阅 cargo-fetch(1) 命令以下载依赖项，然后再脱机。

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

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

其他选项

-j N
--jobs N
要运行的并行作业数。也可以使用 build.jobs 配置值 指定。默认为逻辑 CPU 的数量。如果为负数，则将最大并行作业数设置为逻辑 CPU 数加上提供的值。如果提供了字符串 default，则将值设置回默认值。不应为 0。
--keep-going
在依赖关系图中尽可能多地构建包，而不是在第一个构建失败时中止构建。

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

显示选项

-v
--verbose
使用详细输出。可以指定两次以获得“非常详细”的输出，其中包括额外的输出，例如依赖项警告和构建脚本输出。也可以使用 term.verbose 配置值 指定。
-q
--quiet
不打印 cargo 日志消息。也可以使用 term.quiet 配置值 指定。
--color 何时
控制何时使用彩色输出。有效值

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

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

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

  • human（默认）：以人类可读的文本格式显示。与 short 和 json 冲突。
  • short：发出更短、人类可读的文本消息。与 human 和 json 冲突。
  • json：将 JSON 消息发送到标准输出。有关更多详细信息，请参阅 参考。与 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 一起使用。

常用选项

+工具链
如果 Cargo 是使用 rustup 安装的，并且 cargo 的第一个参数以 + 开头，则它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖如何工作的更多信息，请参阅 rustup 文档。
--config 键=值 或 路径
覆盖 Cargo 配置值。参数应采用 键=值 的 TOML 语法，或作为额外配置文件的路径提供。此标志可以指定多次。有关更多信息，请参阅 命令行覆盖部分。
-C 路径
在执行任何指定的操作之前更改当前工作目录。这会影响 Cargo 默认查找项目清单 (Cargo.toml) 的位置，以及搜索 .cargo/config.toml 的目录等。此选项必须出现在命令名称之前，例如 cargo -C path/to/my-project build。

此选项仅在 nightly 频道 上可用，并且需要 -Z unstable-options 标志才能启用（请参阅 #10098）。

-h
--help
打印帮助信息。
-Z 标志
Cargo 的不稳定（仅限 nightly）标志。运行 cargo -Z help 以获取详细信息。

环境

有关 Cargo 读取的环境变量的详细信息，请参阅参考。

退出状态

  • 0：Cargo 成功。
  • 101：Cargo 未能完成。

示例

  1. 从 crates.io 安装或升级软件包

    cargo install ripgrep

  2. 在当前目录中安装或重新安装软件包

    cargo install --path .

  3. 查看已安装软件包的列表

    cargo install --list

另请参阅

cargo(1)，cargo-uninstall(1)，cargo-search(1)，cargo-publish(1)