Documentation
Installation
Install the tools the CLI depends on. Init creates a mise.toml with pinned Rojo and Wally versions, then guides you through the remaining setup.
Prerequisites
Node.js 20.12+
Required to run the CLI. Check with `node --version`, or install from nodejs.org.
Roblox Studio
Required to open game.rbxl and press Play. Init generates game.rbxl when Rojo is available.
mise
The CLI bootstraps mise with the official installer when needed, then installs pinned Rojo and Wally from `mise.toml`.
A Roblox project
Run `npx robloxui init` to scaffold one, or use an existing project with rojo.json / wally.toml. Components install to src/client/ui/components/.
Existing project? You only need Node 20.12+ and a rojo.json or wally.toml — skip init and use npx robloxui add directly.
CLI
global install:
bashnpm i -g robloxui@latestmise (recommended)
Pins Rojo and Wally per project. Init generates mise.toml; run mise install in the project folder.