查看源代码 mix archive.install (Mix v1.16.2)

在本地安装归档文件。

如果未提供任何参数,但项目根目录中存在一个归档文件(使用 mix archive.build 创建),则该归档文件将在本地安装。例如

$ mix do archive.build + archive.install

如果提供了参数,则应为预构建归档文件的本地路径、Git 仓库、GitHub 仓库或 Hex 包。

$ mix archive.install archive.ez
$ mix archive.install path/to/archive.ez
$ mix archive.install git https://path/to/git/repo
$ mix archive.install git https://path/to/git/repo branch git_branch
$ mix archive.install git https://path/to/git/repo tag git_tag
$ mix archive.install git https://path/to/git/repo ref git_ref
$ mix archive.install github user/project
$ mix archive.install github user/project branch git_branch
$ mix archive.install github user/project tag git_tag
$ mix archive.install github user/project ref git_ref
$ mix archive.install hex hex_package
$ mix archive.install hex hex_package 1.2.3

安装后,归档文件中的任务可在本地使用。

$ mix some_task

请注意,通过 Git、GitHub 或 Hex 安装会获取归档文件的源代码并构建它,而使用本地路径会使用预构建的归档文件。

命令行选项

  • --sha512 - 检查归档文件是否与给定的 SHA-512 校验和匹配。仅适用于通过本地路径进行的安装。

  • --force - 强制安装,无需 shell 提示;主要用于自动化构建系统,如 Make。

  • --submodules - 在从 Git 或 GitHub 构建归档文件之前获取仓库子模块。

  • --sparse - 检出一个 Git 仓库内的单个目录,并将其用作归档文件根目录。

  • --app - 指定一个自定义应用程序名称,用于从 Git、GitHub 或 Hex 构建归档文件。

  • --organization - 为属于组织的 Hex 私有包设置此选项。

  • --repo - 为自托管 Hex 实例设置此选项,默认为 hexpm