CLI

The Rogen command-line interface builds and watches projects.

Run the tool without any flags to execute a single build of the .project.json file:

rogen

Use flags to change Rogen behavior or override configurations.

Commands

watch

Watches source directories and regenerates the map automatically upon file changes.

init

Generates a default .rogen.json configuration file in the current directory.

Options

-c, --config <path>

Specifies a custom configuration file path.

-m, --mode <mode>

Overrides the target mode (e.g., luau, ts, darklua, or custom modes). Rogen detects the mode from the configuration file if omitted.

-s, --source <path>

Overrides the source directories defined in the configuration. Pass the flag multiple times to merge multiple directories.

-t, --tag <tag>

Activates specific tags. Pass the flag multiple times to activate multiple tags.

-p, --project <path>

Overrides the project object by specifying a path to a project file.

-b, --build <path>

Overrides the output directory for transpiled code.

-o, --output <path>

Overrides the file path of the generated Rojo project file.

-h, --help

Prints the help menu with all available options.

-v, --version

Prints the installed version of Rogen.