Log inGet started

shell

The shell namespace — the engine's Luau API reference for shell.

The shell namespace — 2 functions.

globals/shell/run

globals/shell/run(command: string) -> ShellResult

Execute a command in the engine's emulated Unix shell. Blocks until the command completes. This is the same shell as the MCP bash tool — 60+ builtins (ls, cat, grep, find, echo, ...) operating on the virtual scene filesystem.

globals/shell/runAsync

globals/shell/runAsync(command: string) -> string

Asynchronous version of shell.run. Returns a promise ID that resolves to a JSON-encoded result string. Use with task.await().

  • api
  • reference