rocale-cli

A command-line tool for building, uploading, and running Roblox projects via Roblox's Open Cloud APIs for Luau Execution.

Usage

The tool can be installed as a dependency to your project using foreman. Simply add this line to your foreman.toml.

rocale-cli = { source = "Roblox/rocale-cli", version = "0.1.0" }

You can also manually grab a release from the releases page.

Run rocale-cli help to see available commands and run rocale-cli <command> --help for more information on how to use each command.

rocale-cli run

To spawn an OCALE task and use rocale-cli run, you will need to create a new place and generate an Open Cloud API Key. Your key will need the following permissions to your place:

• universe-places:write
• luau-execution-sessions:write

USAGE:
  rocale-cli run [options]

REQUIRED:
  -u, --universeId <id>      	Target universe ID to spawn an Open Cloud instance of
  -p, --placeId <id>         	Target place ID to spawn an Open Cloud instance of
  --apiKey <key>            	Roblox API key (or set ROBLOX_API_KEY env var)

LOAD OPTIONS:
  --load.project <file>      	Rojo project.json/rbxp to build and load (requires rojo or robloxdev-cli)
  --load.place <file>       	Load an rbxl
  --load.version <num>      	Load existing place version without building/uploading
                            	(set to 0 to rerun last uploaded version)

BUILD OPTIONS:
  --output <file>            	Output file path for the built place file
                             	(default: output.rbxl)
  --script <file>            	Luau script to load and set as entrypoint

EXECUTION OPTIONS:
  --lua.globals <key=value,...>	Comma-separated list of Lua globals to inject
  --timeout <seconds>        	Timeout for polling task completion (default: 300)
  --pollInterval <seconds>   	Interval between polling attempts (default: 2)
  --binaryOutput <file>      	Path to save binary output from the task

FLAGS:
  -v, --verbose              	Enable verbose logging
  --help                     	Show this help message

Building

First, run foreman install to install dependencies.

To build, run lute scripts/build. The build artifacts will be created in the build directory.

To build for release, run lute scripts/build <version> $(git rev-parse HEAD) to bake the version and commit hash of the build into the binary.

To run tests, see Contributing.