Azul CLI quick reference: commands at a glance

A concise cheatsheet of the most common Azul commands for starting sync, building, pushing, packing, and configuring your project.

This page gives you the most common Azul commands at a glance. For full flag documentation and detailed descriptions, see the commands reference.

Start sync

Run azul from your project root to start the live sync daemon. Studio will connect automatically once you click Connect in the Azul plugin.

azul

Build local files into Studio

Use azul build for a one-time push from your local filesystem into Studio. Pass --from-sourcemap to build from a saved sourcemap, or use --rojo for Rojo-compatible projects.

Default build

azul build

Push a specific folder

Use azul push to sync a single local folder to a Studio destination path. Specify source and destination with -s and -d.

Push server scripts

azul push -s src/Server -d ServerScriptService.Server

Generate sourcemap

Use azul pack to serialize your Studio instance properties into a sourcemap.json file. This file is used by tools like Luau LSP for type awareness.

Generate sourcemap

azul pack

Open config

Use azul config to open your configuration file in your default editor, or print its path.

Open config file

azul config

Global options

These flags work with azul and any subcommand.

Flag	Description
--debug	Enable verbose logs
--no-warn	Skip confirmation prompts
--sync-dir [PATH]	Override the sync directory
--port [NUMBER]	Override the daemon port
--help, -h	Show help for the current command
--version	Print the installed Azul version

For the full flag reference with descriptions and examples, see Azul CLI commands reference.