Installation

Azul has two parts you need:

Daemon (CLI) (azul): runs on your machine and syncs files.
Companion plugin: runs in Roblox Studio and connects to the daemon.

You must install both before starting your first sync session.

1. Install the Azul Daemon

Recommended install (npm)

Install Node.js from nodejs.org. It includes npm, which is used to install the Azul CLI.
Install Azul globally:
Terminal window
```
npm install -g azul-sync
```
Verify the install:
Terminal window
```
azul --version
```

Manual install (from source)

Click to expand

Clone the repository or download the ZIP and extract it.

Install Node.js from nodejs.org (or package manager):

# Windows (using winget)
winget install OpenJS.NodeJS.LTS
# macOS (using Homebrew)
brew install node
# Linux (using apt)
sudo apt install nodejs npm

Install dependencies:
```
npm install
```
Build the project:
```
npm run build
```
Install globally from the local checkout:
```
npm install -g .
```

2. Install the Roblox plugin

Install from the Creator Store: Azul Companion Plugin

Recommended tooling

While these tools aren’t required to use Azul, they are highly recommended to get the best experience out of Azul:

Luau LSP

Use the Luau Language Server extension for VSCode. This extension provides Luau IntelliSense, error checking, and more.

It works by reading the sourcemap.json file generated by Azul to understand the structure of your project and provide accurate suggestions and error checking.

To get Luau-LSP working with Azul, open your User Settings (JSON) from the command palette (Ctrl+Shift+P or Cmd+Shift+P) and make sure to set up luau-lsp like this:

{
  "luau-lsp.plugin.enabled": true,
  "luau-lsp.sourcemap.enabled": true,
  "luau-lsp.sourcemap.autogenerate": false,
  "luau-lsp.sourcemap.sourcemapFile": "sourcemap.json",
  "luau-lsp.sourcemap.includeNonScripts": true
}

Luau-LSP is also available for other IDEs like IntelliJ and Neovim, but setup may vary.

Verde

Verde is a great VSCode extension that mimics the Roblox Studio Explorer and Properties windows. It works great alongside Azul to provide a seamless development experience.