Welcome to Eryx

Welcome to the Eryx documentation. This site contains a collection of high level tutorials and guides, along with a complete API reference for all libraries provided with Eryx.

Eryx's standard library covers a vast array of functions and utilities you are likely to need when writing code. The search bar at the top of this site can be used to quickly find what you are looking for.

Installing Eryx

Currently, Eryx is distributed via GitHub. At the time of writing, no official releases are available. "Nighly" builds can be found by visiting the Actions Page on GitHub and downloading build artifacts.

For normal use, the "Standard" build should be used.

For convenience, is it recommended to modify your PATH variable to include the folder that contains eryx (or eryx.exe on Windows). A packaged installer is planned for the future.

Using Eryx

Eryx is intended to be used from the command line.

Running eryx with no command line arguments enters a REPL. Note that every line is run within a new scope, so a local defined on one line is not available on the next. Globals are shared across all lines.

To run a script, simply use:

eryx script.luau

The run command (eryx run script.luau) is provided as an alias.

Two other commands exist, eryx compile and eryx test. These will be explored in subsequent sections.