The MUFL toolchain is installed from npm. You get mufl-compile (the
compiler) and mufl (the REPL).
Install from npm
The toolchain is published as the
@adapt-toolkit/mufl
package. Install it globally to put the binaries on your PATH:
npm install -g @adapt-toolkit/mufl
This gives you two commands:
mufl-compile— the MUFL compiler. Reads.mufl/.mu/.mmsources, writes content-addressed.mufloartifacts.mufl— the MUFL REPL. Useful for quick experiments and for running compiled.muflofiles outside an embedding application.
To install it into a project instead of globally, run
npm install @adapt-toolkit/mufl and invoke the tools with
npx mufl-compile / npx mufl.
What the package contains
Alongside the two binaries, the package bundles everything the compiler needs, in the layout it expects:
- Native
prebuildsfor the supported platforms. - The MUFL standard library (
mufl_stdlib/) and themetaandtransactionslibraries.
The standard library and support libraries ship inside the package, so no additional setup is required to compile MUFL.
After installing
Once mufl-compile is on your PATH, the next steps are:
- Learn the MUFL language.
- Read Compile your MUFL code for end-to-end compiler usage.
- Set up the VS Code language server for inline diagnostics.