Skip to content
Azul

Commands

Azul is used from the terminal with the azul command.

Syntax notes

Section titled “Syntax notes”
  • <value> means required.
  • [value] means optional.
  • --flag value and --flag=value are both accepted.
  • Short aliases are available for some options.

azul

Section titled “azul”

Start live sync daemon:

Terminal window
azul [command] [options]

Global options

Section titled “Global options”
OptionShortDescription
--help-hShow help text
--versionPrint Azul version
--debugEnable verbose debug logs
--no-warnSkip confirmation prompts
--sync-dir <dir>Set sync directory
--port <number>Set daemon port

Example:

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

azul build

Section titled “azul build”

One-time push from local filesystem into Studio.

Terminal window
azul build [options]
OptionDescription
--from-sourcemap [file]Build from sourcemap data. If passed without file, uses ./sourcemap.json
--rojoEnable Rojo-compatible parsing
--rojo-project <file>Override Rojo project path
--destructiveCompletely replace Studio state with your local project (all instances, scripts, and properties).

Examples:

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

azul push

Section titled “azul push”

Selective push from local files to a specific Studio destination.

Terminal window
azul push [options]
OptionShortDescription
--source <dir>-sLocal source folder
--destination <path>-dStudio destination path
--from-sourcemap [file]Push from sourcemap data
--destructiveWipe destination children first
--no-place-configIgnore place config mappings
--rojoEnable Rojo-compatible parsing
--rojo-project <file>Override Rojo project path

Example:

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

azul pack

Section titled “azul pack”

Serialize Studio instance properties into sourcemap.json for hermetic builds.

Terminal window
azul pack [options]
OptionShortDescription
--output <file>-oOutput sourcemap path
--scripts-onlySerialize only scripts + descendants

Example:

Terminal window
azul pack -o sourcemap.json

azul config

Section titled “azul config”

Opens the Azul config file in your default editor.

Terminal window
azul config [options]
OptionDescription
--pathPrint config file path

Examples:

Terminal window
azul config
azul config --path