Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/rojo-rbx/rojo/llms.txt

Use this file to discover all available pages before exploring further.

Rojo has two parts you need to install: the CLI binary that runs on your machine, and the Roblox Studio plugin that connects Studio to the local server. Both must be installed for live sync to work.

​
Install the CLI binary

1

Install Rokit (recommended)

Rokit is the officially recommended toolchain manager for Roblox development tools. If you don’t have it yet, follow the installation instructions in the Rokit repository for your operating system.
Rokit manages tool versions per project using a rokit.toml file, similar to how rustup manages Rust toolchains. It is the easiest way to keep Rojo up to date.
2

Add Rojo to your project

Inside your project directory, run:
rokit add rojo-rbx/rojo
This adds Rojo to your project’s rokit.toml and downloads the binary. Rokit will use this version for all Rojo commands run inside the project.To install Rojo globally (available in every directory), add the --global flag:
rokit add --global rojo-rbx/rojo
3

Verify the installation

Confirm the binary is available and check the version:
rojo --version
You should see output similar to:
rojo 7.7.0-rc.1

​
Downloading from GitHub releases

If you prefer not to use Rokit, you can download a pre-built binary directly from the Rojo GitHub releases page. Download the archive for your operating system, extract it, and place the rojo binary somewhere on your PATH.
Managing the binary manually means you are responsible for updating it when new versions are released. Rokit handles this automatically.

​
Install the Roblox Studio plugin

The Studio plugin connects Roblox Studio to the Rojo local server. You need it for live sync.
1

Install from the Roblox marketplace

The easiest way to install the plugin is from the Roblox Creator Store. Search for Rojo in the toolbox inside Roblox Studio, or use the direct link from the Rojo releases page.
The marketplace plugin version is updated with each Rojo release. Make sure the plugin version matches your CLI version to avoid compatibility issues.
2

Install the plugin from the CLI (optional)

If you need to install the version of the plugin that matches your exact Rojo binary, use the built-in plugin install command. It automatically locates Studio’s plugins folder and installs RojoManagedPlugin.rbxm there:
rojo plugin install
To remove it:
rojo plugin uninstall
Restart Roblox Studio after running either command for the change to take effect.

​
Next steps

Get started

Create your first Rojo project and sync it to Roblox Studio.

Project files

Learn how to configure your project tree with default.project.json.

Build docs developers (and LLMs) love

Get started for freeTalk to us