Project Setup

This page covers the two most common starting points:

1. You want to start syncing a place to local files.
2. You already have local files and want to push them into Studio.

Start a new sync session (most common)

In Azul, your place in Studio is the source of truth. The local folder is a mirror.

1. Create or open a local folder for your project.

2. Open that folder in your editor and run:

   azul

3. Open the target place in Roblox Studio.

4. In the Azul plugin, click Connect.

5. Make a test edit (for example, create a Script in Studio) and confirm it appears locally.

That is all you need for live sync.

Note

While a session is running, new local files are not automatically treated as new Studio instances. For best results, create the instance in Studio first, then edit the synced file locally.

Build from an existing local project

Use this when your files already exist on disk and you want to create/overwrite matching instances in Studio.

1. Open the local project folder.

2. Run:

   azul build

3. Confirm the prompt in your terminal.

4. Open Studio and connect with the plugin.

Remember that azul build creates or overwrites matching instances, but does not delete unrelated existing instances. If you want to start fresh, you should use a new, empty place.

Next steps

• Use Commands to learn push, pack, and CLI options.
• Use Configuration to tune defaults.
• Use Advanced Usage for per-place config and workflows.