Set up your first Azul sync project in Studio

Learn the two main workflows: start syncing a Studio place to local files, or push existing local files into Studio using azul build.

Azul supports two starting points depending on where your work currently lives. If your place lives in Studio and you want a local mirror, follow the sync session workflow. If you already have scripts and assets on disk and want to create matching instances in Studio, use the build workflow. Both approaches give you the same live sync experience once they’re running.

Start a new sync session

This is the most common workflow. Your place in Studio is the source of truth, and Azul creates a local mirror that stays in sync as you work.

1. Create or open a local folder

   Create a new empty folder (or open an existing one) where you want your project files to live. Open that folder in your terminal.

2. Start the daemon

   Run azul in the project folder:

   azul
   

   The daemon starts and waits for a Studio connection. You’ll see a message in the terminal indicating it’s ready.

3. Open your place in Studio

   Open the target Roblox place in Roblox Studio. This can be a new place or any existing one.

4. Connect the plugin

   In Studio, open the Plugins toolbar and click Connect in the Azul plugin. The daemon and plugin handshake, and your DataModel structure is written to the local folder immediately.

5. Confirm sync is working

   Make a test edit — for example, create a Script inside ServerScriptService in Studio. Confirm that a matching file appears in your local folder within a moment. You’re now live.

Build from an existing local project

Use this workflow when you already have Luau files on disk and want to create or overwrite matching instances in Studio.

1. Open the local project folder

   Navigate to the folder that contains your existing local files.

2. Run azul build

   azul build
   

   Azul will display a summary of what it intends to create or overwrite and prompt you to confirm before proceeding.

3. Confirm the prompt

   Review the listed changes in your terminal and confirm to proceed. Azul creates or updates the corresponding instances in Studio.

4. Connect in Studio

   Open your place in Roblox Studio and click Connect in the Azul plugin to begin the live sync session.

azul build creates or overwrites instances that match your local files, but it does not delete unrelated instances that already exist in your place. If you want a completely clean slate, open a new empty place before running azul build.

Next steps

• Read Commands for the full reference on azul push, azul pack, and CLI flags.
• Read Configuration to tune sync behavior and daemon defaults.
• Read Advanced usage for per-place configuration and multi-project workflows.