docs/pages/getting-started/3-command-line-usage.md

Command-Line Usage

Running Scripts

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

lune script-name

This will look for the file script-name.luau^[1] 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
• The folder lune in the home directory, if it exists
• The folder .lune in the home directory, if it exists

Listing Scripts

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 (-->).

Advanced Usage

lune -

Runs a script passed to Lune using stdin. Useful for running scripts piped to Lune from external sources. Example:

echo "print 'Hello, terminal!'" | lune -

---

^[1] Lune also supports files with the .lua extension but using the .luau extension is highly recommended. Additionally, if you don't want Lune to look in sub-directories or try to find files with .lua / .luau extensions at all, you can provide an absolute file path. This will disable all file path parsing and checks, and just run the file directly.