Commands

Azul is used from the terminal with the azul command.

Syntax notes

• <value> means required.
• [value] means optional.
• --flag value and --flag=value are both accepted.
• Short aliases are available for some options.

azul

Start live sync daemon:

azul [command] [options]

Global options

Option	Short	Description
--help	-h	Show help text
--version		Print Azul version
--debug		Enable verbose debug logs
--no-warn		Skip confirmation prompts
--sync-dir <dir>		Set sync directory
--port <number>		Set daemon port

Example:

azul --sync-dir ./sync --port 8080

azul build

Mounts the entire local project into Studio.

azul build [options]

Option	Description
--from-sourcemap [file]	Build from sourcemap data. If passed without file, uses ./sourcemap.json
--rojo	Enable Rojo-compatible parsing
--rojo-project <file>	Override Rojo project path
--destructive	Wipe the entire Studio state before building.

Examples:

azul build
azul build --from-sourcemap ./sourcemap.json
azul build --rojo --rojo-project default.project.json

azul push

Mounts a local folder or file into Studio at a specific path.

azul push [options]

Option	Short	Description
--source <dir>	-s	Local source folder
--destination <path>	-d	Studio destination path
--from-sourcemap [file]		Push from sourcemap data
--destructive		Wipe destination children before pushing
--no-place-config		Ignore place config mappings
--rojo		Enable Rojo-compatible parsing
--rojo-project <file>		Override Rojo project path

Example:

azul push -s Packages -d ReplicatedStorage.Packages --destructive --rojo

Tip

Use per-place pushMappings to run azul push without repeating paths. See Per-place Daemon Config.

azul pack

Serializes Studio instance properties into a sourcemap for hermetic builds.

azul pack [options]

Option	Short	Description
--output <file>	-o	Output sourcemap path
--scripts-only		Serialize only scripts + descendants

Example:

azul pack -o sourcemap.json

Caution

Not all property types can be properly serialized by Azul due to Roblox API limitations.

These include: Terrain, Unions (CSG Parts).

Support for these types is planned in the future!

azul open-studio

Open Roblox Studio on the place recorded in a sourcemap.

azul open-studio [options]

Option	Description
--from-sourcemap <file>	Sourcemap to read the place ID from
--place-id <number>	Open this place ID instead of reading a sourcemap

azul config

Opens the Azul config file in your default editor.

azul config [options]

Option	Description
--path	Print config file path

Examples:

azul config
azul config --path