Lune 🌙

A standalone Luau script runner
🚀 Use the ergonomics and readability of Luau for your shell scripts 🚀

---

⚙️ Installation

The preferred way of installing Lune is using Aftman.

This will add lune to an aftman.toml file in the current directory, or create one if it does not exist:

aftman add filiptibell/lune

You can also download pre-built binaries for most systems directly from the GitHub Releases page.

✏️ Writing Lune Scripts

A great starting point and walkthrough of Lune can be found in Hello, Lune.
More examples of how to write Lune scripts can be found in the examples folder.

🔎 List of APIs

fs - Filesystem
net - Networking
process - Current process & child processes
stdio - Standard input / output & utility functions
task - Task scheduler & thread spawning

Documentation for individual members and types can be found using your editor of choice and Luau LSP.

🔀 Example translation from Bash

#!/bin/bash
VALID=true
COUNT=1
while [ $VALID ]
do
    echo $COUNT
    if [ $COUNT -eq 5 ];
    then
        break
    fi
    ((COUNT++))
done

With Lune & Luau:

local valid = true
local count = 1
while valid do
    print(count)
    if count == 5 then
        break
    end
    count += 1
end

🧑‍💻 Configuring VSCode for Lune

Lune puts developer experience first, and as such provides type definitions and configurations for several tools out of the box.

These steps assume you have already installed Lune and that it is available to run in the current directory.

Luau LSP

1. Run lune --generate-luau-types to generate a Luau type definitions file (luneTypes.d.luau) in the current directory

2. Run lune --generate-docs-file to generate a Luau LSP documentation file (luneDocs.json) in the current directory

3. Modify your VSCode settings, either by using the settings menu or in settings.json:

   {
   	"luau-lsp.require.mode": "relativeToFile", // Set the require mode to work with Lune
   	"luau-lsp.types.definitionFiles": ["luneTypes.d.luau"], // Add type definitions for Lune globals
   	"luau-lsp.types.documentationFiles": ["luneDocs.json"] // Add documentation for Lune globals
   }
   

Selene

1. Run lune --generate-selene-types to generate a Selene type definitions file (lune.yml) in the current directory

2. Modify your Selene settings in selene.toml:

   # Use this if Lune is the only thing you use Luau files with:
   std = "luau+lune"
   # OR use this if your project also contains Roblox-specific Luau code:
   std = "roblox+lune"
   # If you are also using the Luau type definitions file, it may cause issues, and can be safely ignored:
   exclude = ["luneTypes.d.luau"]
   

NOTE: It is highly recommended to add any generated files to your .gitignore and to only generate them using these commands, since this guarantees that you have type definitions compatible with your installed version of Lune.

🏃 Running Lune Scripts

After you've written a script file, for example script-name.luau, you can run it:

lune script-name

This will look for the file script-name.luau in a few locations:

• The current directory
• The folder lune in the current directory, if it exists
• The folder .lune in the current directory, if it exists

If you don't want Lune to look in sub-directories you can provide a full file path with the file extension included, instead of only the file name.

💭 Additional Commands

lune --list

Lists all scripts found in lune or .lune directories, including any top-level description comments.
Lune description comments are always written at the top of a file and start with a lua-style comment arrow (-->).

---

NOTE: Lune also supports files with the .lua extension but using the .luau extension is highly recommended.