asdf-vm / asdf-vm/asdf-elixir

Feature Request: Automatically reshim after a mix escript.install command successfully finishes

Open
#103 8 comments 5 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
528
Forks
79
PR merge metrics
No merged PRs in 30d

Description

The current Livebook instructions say that if you're using asdf you need to run `asdf reshim elixir` after installing livebook as an escript:
> Running Livebook using Escript makes for a very convenient option
> for local usage and provides easy configuration via CLI options.
>
> ```shell
> mix escript.install hex livebook
>
> # Start the Livebook server
> livebook server
>
> # See all the configuration options
> livebook server --help
> ```
>
> After you install the escript, make sure you add the directory where
> Elixir keeps escripts to your [$PATH](https://en.wikipedia.org/wiki/PATH_(variable)).
> If you installed Elixir with `asdf`, you'll need to run `asdf reshim elixir`
> once the escript is built.

Source:
https://github.com/elixir-nx/livebook/blob/26226a42e0544fe3870c29bc68d752e7d6d3e63c/README.md#escript

Is it possible for asdf-elixir to detect that `asdf escript.install` has successfully installed an escript and then automatically reshim? If not that's fine, just figured I'd ask to remove a potential stumbling block. Escripts are always executable binaries so reshiming makes sense (to me). We'd probably have to do it when uninstalling an escript as well.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the README.md escript instructions and the `mix escript.install` and `asdf reshim elixir` commands described in the issue. Determine whether asdf-elixir can detect successful escript installation and trigger reshiming, with automatic reshiming after uninstall as a possible follow-up; done means the documented stumbling block is removed or the limitation is confirmed.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.