Skip to content

CLI Reference

Lute provides a command-line interface for running, type checking, compiling, testing, and linting Luau code.

Usage

bash
lute <command> [options] [arguments...]

If no command is specified, run is used by default.

Commands

CommandDescription
checkType check Luau files.
compileCompile a Luau script into a standalone executable.
lintLint the specified Luau file using the specified lint rule(s) or using the default rules.
runRun a Luau script.
setupGenerate type definition files for the language server.
testRun tests discovered in .test.luau and .spec.luau files.
transformRun a specified code transformation on specified Luau files.

Global Options

OptionDescription
-h, --helpDisplay help message for the command.
--versionShow the lute version.