Commands
The nicy CLI supports three main commands plus version info.
nicy run
Execute a Luau script file.
Syntax
nicy run <file>
Arguments
| Argument | Required | Description |
|---|---|---|
<file> | Yes | Path to the .luau, .lua, or .luauc file to execute |
Examples
# Run a script
nicy run myscript.luau
# Run compiled bytecode
nicy run myscript.luauc
nicy eval
Evaluate inline Luau code.
Syntax
nicy eval "<code>"
Arguments
| Argument | Required | Description |
|---|---|---|
<code> | Yes | Luau code string to evaluate (must be quoted) |
Examples
# Simple expression
nicy eval "print(2 + 2)"
# Multi-line code
nicy eval "
local function greet(name)
print('Hello, ' .. name .. '!')
end
greet('World')
"
nicy compile
Compile a Luau source file to bytecode (.luauc).
Syntax
nicy compile <file>
Arguments
| Argument | Required | Description |
|---|---|---|
<file> | Yes | Path to the .luau or .lua source file |
Examples
# Compile with defaults
nicy compile myscript.luau
# Creates: myscript.luauc (same directory, same name)
No CLI Flags
The compile command does not accept --native, --optimize, --output, or other flags. All compiler configuration is done via in-source compiler directives:
-- myscript.luau
--!native
--!optimize 2
-- Your code here
# Correct: configure via source
nicy compile myscript.luau
# Wrong: CLI flags do not exist
nicy compile myscript.luau --native # DOES NOT EXIST
See Compiler Directives for details.
nicy version
Display the CLI version.
nicy version
Output:
nicy 1.0.0-alpha
nicy runtime-version
Display both CLI and runtime library versions.
nicy runtime-version
Output:
Engine: 1.0.0-alpha
Luau: 0.650
nicy help
Show usage information.
nicy help
Output:
nicy - The Ultimate Luau Runtime
Usage:
nicy run <script.luau>
nicy eval <"code">
nicy compile <script.luau>
nicy help
nicy version
nicy runtime-version