Skip to main content

Documentation Index

Fetch the complete documentation index at: https://vercel.mintlify.app/llms.txt

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

Azul is a sync tool for Roblox developers. It mirrors your Studio DataModel to a local folder so you can use real editor features — linting, search, refactoring, version control — while keeping Studio as the authoritative source for your place hierarchy. When you’re ready to push local changes back, azul build and azul push have you covered.

Installation

Install the Azul daemon and companion Studio plugin to get started.

Project Setup

Start a new sync session or push an existing local project into Studio.

Commands

Full reference for azul, azul build, azul push, azul pack, and more.

Configuration

Tune the daemon and plugin to match your workflow and team setup.

How it works

1

Install the daemon and plugin

Install the azul-sync CLI globally with npm, then add the companion plugin to Roblox Studio from the Creator Store.
2

Start the daemon

Open your project folder in a terminal and run azul. The daemon starts and waits for Studio to connect.
3

Connect in Studio

Open your place in Roblox Studio and click Connect in the Azul plugin. Your DataModel is mirrored to the local sync/ folder immediately.
4

Edit anywhere

Edit scripts in Studio or your local editor. Both sides stay in sync automatically. Commit local changes with any version control tool.

Key features

Bi-directional sync

Changes in Studio appear on disk instantly. Local edits sync back to Studio in real time.

No project file required

Start from any place — new or existing. No default.project.json needed by default.

Rojo compatibility

Import from existing Rojo-based projects using the --rojo flag when needed.

Sourcemap support

Generate a Rojo-compatible sourcemap.json with azul pack for tools like Luau LSP.