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 keeps Roblox Studio and your local filesystem in sync — without requiring you to change how you build. Studio remains the source of truth for your place hierarchy, and Azul mirrors that structure to a local folder so you can use linting, search, refactoring, and version control in any editor you prefer. If you already have files on disk, azul build and azul push let you push them back into Studio on demand.

Installation

Install the Azul daemon CLI and companion Studio plugin in two steps.

Project setup

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

Commands

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

Configuration

Tune defaults for the daemon and plugin to match your workflow.

How Azul works

Azul runs as a local daemon that opens a connection the Studio companion plugin can join. Once connected, every change you make in Studio is written to your local folder, and every local edit is pushed back to Studio in real time. The daemon does not require a project file to start — it reads your DataModel directly from Studio.
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 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 you prefer.

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.

Build and push local files

Use azul build for a full push or azul push with targeted mappings for repeatable imports.

Rojo compatibility

Import from existing Rojo-based projects with the --rojo flag when you need it.

Sourcemap support

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

Works with existing places

No required schema. Open any place in Studio and start syncing without migration.

How Azul differs from Rojo

Azul and Rojo solve a similar problem but from opposite directions. Rojo treats local files as the source of truth and builds the DataModel from them. Azul treats Studio as the source of truth and mirrors the DataModel to local files.
AzulRojo
Source of truthStudio DataModelLocal project files
Project file requiredNoYes (default.project.json)
Workflow directionStudio → disk (with push back)Disk → Studio
Rojo compatibilityOpt-in via --rojoNative
Targeted importsazul push mappingsN/A
If you have an existing Rojo project, you can import it into Azul using azul build --rojo to get started without rewriting your file structure.