> ## Documentation Index
> Fetch the complete documentation index at: https://vercel.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Azul: Studio-first sync for Roblox projects

> Azul keeps Roblox Studio and your local files in sync — without changing how you build. Mirror your DataModel to disk and use any editor tooling you want.

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.

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/getting-started/installation">
    Install the Azul daemon and companion Studio plugin to get started.
  </Card>

  <Card title="Project Setup" icon="folder-open" href="/getting-started/projects">
    Start a new sync session or push an existing local project into Studio.
  </Card>

  <Card title="Commands" icon="terminal" href="/commands">
    Full reference for `azul`, `azul build`, `azul push`, `azul pack`, and more.
  </Card>

  <Card title="Configuration" icon="sliders" href="/configuration">
    Tune the daemon and plugin to match your workflow and team setup.
  </Card>
</CardGroup>

## How it works

<Steps>
  <Step title="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.
  </Step>

  <Step title="Start the daemon">
    Open your project folder in a terminal and run `azul`. The daemon starts and waits for Studio to connect.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Edit anywhere">
    Edit scripts in Studio or your local editor. Both sides stay in sync automatically. Commit local changes with any version control tool.
  </Step>
</Steps>

## Key features

<CardGroup cols={2}>
  <Card title="Bi-directional sync" icon="arrows-rotate">
    Changes in Studio appear on disk instantly. Local edits sync back to Studio in real time.
  </Card>

  <Card title="No project file required" icon="circle-check">
    Start from any place — new or existing. No `default.project.json` needed by default.
  </Card>

  <Card title="Rojo compatibility" icon="plug">
    Import from existing Rojo-based projects using the `--rojo` flag when needed.
  </Card>

  <Card title="Sourcemap support" icon="map">
    Generate a Rojo-compatible `sourcemap.json` with `azul pack` for tools like Luau LSP.
  </Card>
</CardGroup>