Rogen

CLI

The complete command-line interface for Rogen

Updated

The rogen command builds and watches your project. To build once, run rogen build (or just rogen):

rogen build

Flags let you change how Rogen behaves or override parts of the config.

Commands

build

Builds the project. It's the default command.

watch

Watches the source folders and rebuilds whenever a file changes.

init

Writes a default .rogen.json in the current folder.

Options

-c, --config <path>

Uses a config file at a custom path.

-m, --mode <mode>

Picks the mode to build, such as luau, ts, darklua or one of your own. Without it, Rogen works out the mode from the config.

-s, --source <path>

Overrides the source folders from the config. Repeat it to merge several.

-t, --tag <tag>

Turns a tag on. Repeat it to turn on more.

-p, --project <path>

Overrides project with the path to a project file.

-b, --build <path>

Overrides the folder with the compiled code (build).

-o, --output <path>

Overrides where the Rojo project file is written.

-h, --help

Prints help with every option.

-v, --version

Prints the installed version.

On this page