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

在本地安装 escript。

如果未提供参数,但项目根目录中存在 escript(使用 mix escript.build 创建),则该 escript 将在本地安装。例如

$ mix do escript.build + escript.install

如果提供参数,则它应该是指向预构建 escript 的本地路径、Git 仓库、GitHub 仓库或 Hex 包。

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

安装后,escript 可以调用为

$ ~/.mix/escripts/foo

为了方便,请考虑将 ~/.mix/escripts 目录添加到您的 $PATH 环境变量中。有关更多信息,请查看维基百科关于 PATH 的文章:https://en.wikipedia.org/wiki/PATH_(variable)

命令行选项

  • --sha512 - 检查 escript 是否与提供的 SHA-512 校验和匹配。仅适用于通过本地路径安装。

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

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

  • --sparse - 检查 Git 仓库内的单个目录,并将其用作 escript 项目目录。

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

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

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