Skip to content

About

Elixir vfox plugin. Use the vfox to manage multiple Elixir versions in Linux/Darwin MacOS/Windows. all platform~

Topics

Resources

Stars

8 stars

Watchers

2 watching

Forks

Repository files navigation

中文 | English

logo

lint test license vfox E2E tests mise E2E tests

vfox-elixir plugin

A vfox plugin for Elixir. It installs and switches between Elixir versions on Linux, macOS and Windows, and it manages the Erlang/OTP that each version needs.

Before you install

Elixir runs on Erlang/OTP, which the plugin does not install for you. Install an Erlang/OTP version that Elixir supports first, see Erlang/OTP.

vfox add erlang
vfox install erlang@26.2.3
vfox use -g erlang@26.2.3

Usage

# install the plugin
vfox add elixir

# list the versions you can install
vfox search elixir

# install and select a version
vfox install elixir@1.16.2
vfox use -g elixir@1.16.2
elixir --version

Linux and macOS build Elixir from source with make. On Windows, the plugin runs the official installer, and the names end in the OTP version, such as 1.16.2-elixir-otp-26. See platforms.md for the requirements of each platform, and versions.md for the names.

Windows

vfox add erlang
vfox install erlang@26.2.3
vfox use -g erlang@26.2.3
vfox add elixir
vfox install elixir@1.16.2-elixir-otp-26
vfox use -g elixir@1.16.2-elixir-otp-26

Windows needs vfox 0.5.3 or later. Versions before 1.15 are not listed for Windows. See platforms.md.

Hex prebuilt packages

With VFOX_ELIXIR_MIRROR=hex, Linux and macOS install prebuilt Elixir from builds.hex.pm instead of compiling it. vfox search elixir hex lists those builds. Windows does not support them. See mirror.md.

vfox search elixir hex
VFOX_ELIXIR_MIRROR=hex vfox install elixir@1.16.2-otp-26

Elixir already on the machine

vfox link --detect elixir links an Elixir that is already installed, from asdf, mise, Homebrew, Scoop, the system or the official installer, instead of installing another copy. It needs vfox 1.1.0 or later. See link.md.

Usage with mise

The plugin can also be used with mise, a development tool manager:

# Elixir need Erlang/OTP, so install Erlang/OTP first
mise install vfox:version-fox/vfox-erlang@26.2.3
mise use -g vfox:version-fox/vfox-erlang@26.2.3

# Install an available version
mise install vfox:version-fox/vfox-elixir@1.16.2

Documentation

Using the plugin

  • Versions and names: how to write a version, and how the names of installed versions are chosen
  • Platforms: the install method, requirements and limits of Linux, macOS and Windows
  • Erlang/OTP: the versions to pick, how the plugin finds erlc, and installing Erlang/OTP with vfox-erlang
  • Hex prebuilt packages: installing Elixir from builds.hex.pm with VFOX_ELIXIR_MIRROR=hex
  • Elixir already on the machine: adopting an Elixir that is installed elsewhere with vfox link --detect elixir
  • Troubleshooting: the messages the plugin prints and what to do about them
  • Changes: what each release changed

Working on the plugin

Releasing this plugin

Maintainers can publish from Actions → Plugin → Run workflow on the default branch by entering a stable plugin version without the v prefix. The shared workflow updates metadata.lua, creates the version commit and tag, and publishes the ZIP and manifest in this repository. No local tag or extra release token is needed. Pull requests run checks only; PR titles no longer trigger publication.

Existing version-tag pushes are supported when PLUGIN.version already matches the tag. If publication fails, re-run the original failed job to resume it.

The workflow follows the shared @v1 release-tool version. Updating the tool does not release this plugin. See the shared workflow documentation for the package contract and first-rollout requirements.

Documentation website

中文 · English

The bilingual site is maintained under website/. See website/README.md for local build and deployment instructions.

License

Apache 2.0. See LICENSE.

About

Elixir vfox plugin. Use the vfox to manage multiple Elixir versions in Linux/Darwin MacOS/Windows. all platform~

Topics

Resources

Stars

8 stars

Watchers

2 watching

Forks

Releases

Used by

Contributors

Languages