Command-line interface (CLI)

General CLI Format

Use the full path to run AzureLabel from the command line:

"C:\Program Files (x86)\AzureLabel 15\AzureLabel.exe" <Command> [<Parameters>]

Replace <Command> and <Parameters> with actual values. For example:

"C:\Program Files (x86)\AzureLabel 15\AzureLabel.exe" print --label "My Label"

If the program is in your system PATH, you can use azurelabel instead of the full path. Like this:

azurelabel preview --label "My Second Label"

For simplicity, all command examples below will omit the full program path — only the command and its parameters will be shown.

Note: All parameters of commands are optional unless explicitly marked with * required.

Available Commands

The following commands can be used with AzureLabel from the command line:

  • print – Print one or more labels using available data sources.
  • preview – Open the Preview window using the same data sources and options as the print command.
  • designer – Open the Label Designer to create a new label or edit an existing one.
  • batch – Start automated batch printing based on the settings stored in one or more labels.
  • allInOneFile – Load and execute a single file that contains label, data, and print options.
  • printServerDesktop – Start the Print Server (Desktop).
  • runTask – Run a task from a .json file, usually created in the program and stored in the Tasks folder.
  • printServerManager – Open the Print Server Manager to manage the Print Server (Service).
  • labels – Save a list of available labels from the Labels folder to a file.
  • lastPrintTime – Write the last label print time to a file.
  • userGuide – Open the User Guide in the default browser.

print

Print one or more labels using available data sources:

  • Values passed via the command line.
  • Data defined inside the label (such as embedded print data or import settings).
  • External sources (such as shared import settings files or PDF documents).
Additionally, the Data Entry window may appear at print time, based on label settings or the dataEntryUsage parameter.

Parameters

  • --label <name or path> * required — Label name or location. This value can be either the name of a label file, a full file path, or a path using placeholders such as [Labels]\My Label.
    Accepts one or more label names or paths. To specify multiple labels, separate them with a vertical bar |, e.g., "Label A|Label B".
  • --printQuantity <string> — Specifies how many times each label design should be printed. (default: 1)
    Supported formats:

    Simple Quantity
    4 → Each design prints 4 times.

    Grouped Printing
    2,3 → First design prints 2 times, second design prints 3 times.

    Alternating Printing
    2/2 → First design prints 1 time, second design 1 time, then repeats (total 2 prints per design).
    3/2 → First design prints 1 time, second design 1 time, then repeats, but first design completes 3 cycles, second design completes 2 cycles.

    Skipping a design
    3,0 → First design prints 3 times, second design is skipped.
  • --printer <printer name> — Specifies the printer to use.
    Supported values:
    • The name of a physical or virtual printer available in the system
    • printToPdf – saves the output as a PDF file
    • printToImages – saves each label as a PNG image
    • printToExcel – saves the output as an Excel file
    If not specified, or if the specified printer is not found, the following fallback is used:
    • If the label has a printer assigned (via print preferences), that printer is used
    • Otherwise, the system default printer is used
  • --printDataSource <string> – Defines how print data is supplied.
    Supported values:
    • ready - A ready-to-use list of records provided directly in the command line as a JSON array of objects, where each object contains multiple field name–value pairs such as [{"name":"ItemA","price":45.67,"printQuantity":1},{"name":"ItemB","price":56.78,"printQuantity":2}].
    • label - Uses data embedded within the label.
    • import - Uses the label’s built-in import settings.
    • importLocation - Uses import settings from a specified location.
    • pdf - A file path, or a URL pointing to a PDF.

    If printDataSource is omitted, the program will try to retrieve the print data based on the settings from the Label Print Data tab in the Label Properties window - unless this behavior is overridden by usage parameters.
    To override the behavior defined in label properties, use labelUsage, importUsage, or dataEntryUsage to control how each source is used (auto, force, or deny).

  • --data <string> – Provides external data, based on the selected printDataSource type.
    • If printDataSource is ready, this should be a JSON-encoded array of records.
    • If printDataSource is importLocation, this is the path to the import settings.
    • If printDataSource is pdf, this is a Base64 string, file path, or URL to the PDF file.
  • --labelUsage <string> – Defines how data embedded within the label is used as a print data source. (default: auto).
    Supported values:
    • auto – Use if no other sources are available.
    • force – Always use this source.
    • deny – Do not use this source.
  • --importUsage <string> – Defines how the label’s built-in import settings are used as a print data source. (default: auto).
    Supported values:
    • auto – Use if no other sources are available.
    • force – Always use this source.
    • deny – Do not use this source.
  • --dataEntryUsage <string> – Defines how the data entry window is used as a print data source. (default: auto).
    Supported values:
    • auto – Use if no other sources are available.
    • force – Always use this source.
    • deny – Do not use this source.
  • --outputFile <string> – The full path to the file, or a formula to generate file names when saving to PDF, Excel, or images.
    If enableUI is true and outputFile is empty or invalid, a file selection dialog will be shown.
  • --simulatePrint <boolean> – Nothing sent to printer. The program prints to a temporary .prn file instead of a real printer, or to a temporary file when using virtual printers provided by the program. (default: false).
  • --returnPrintResult <boolean> – If true, detailed print result information will be returned in the response. (default: false).
  • --enableUI <boolean> – Enables UI elements such as progress dialogs, file selection windows, and error message popups during print and preview operations. (default: false).
    Important: This does not suppress the preview window when preview is requested.
  • --encoding <string> – Specifies the character encoding for both input and output file operations. (default: utf-8).
    Supported values:
    • utf-8
    • utf-16
    • A Windows code page ID (e.g., 1252 for ANSI Latin 1 – Western European)
      For a full list of supported code pages, see: https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers?redirectedfrom=MSDN.

Examples

  • print --label "Product Label"
  • print --label "[Labels]\My Label.albl" --printQuantity 3 --printer "Zebra GX430t"
  • print --label "[Labels]\Warehouse.albl" --data '[{"name":"ItemA","price":45.67,"printQuantity":1},{"name":"ItemB","price":56.78,"printQuantity":2}]'.
  • print --label "[Labels]\My Label.albl|Another label.albl" --printQuantity 4

preview

Same as the print command, but opens the Preview window instead of sending the label to the printer.

designer

Open the Label Designer to create a new label or edit an existing one.

Parameters

  • --label <name or path> — Label name or location. This value can be either the name of a label file, a full file path, or a path using placeholders such as [Labels]\My Label.

Examples

  • designer
  • designer --label "Product Label"

batch

Start automated batch printing based on the settings stored in one or more labels.
The same Batch Printing window will appear as when starting Batch Printing from the Label Designer.

Parameters

  • --label <name or path> * required — Label name or location. This value can be either the name of a label file, a full file path, or a path using placeholders such as [Labels]\My Label.
    Accepts one or more label names or paths. To specify multiple labels, separate them with a vertical bar |, e.g., "Label A|Label B".

Examples

  • batch --label "Warehouse label.albl"
  • batch --label "Product Label|Pack label"

allInOneFile

Load and execute a single file that contains label, data, and print options.

Parameters

  • <Path to data file> * required – Full path to a JSON data file.

    The file must be in JSON format as described in the "Request body" section of the "/labels/print" endpoint in the REST API documentation.

    In addition, one extra field must be included in the JSON:

    "request": "<Endpoint>"

    where <Endpoint> refers to the REST API endpoint, such as: "request": "/labels/print".

    Example JSON file:

    
{
    "request": "/labels/preview",
    "label": "My label",
    "printData": {
        "source": "ready",
        "data": [
            {
                "PrintQuantity": 3,
                "Name": "AzureLabel Pro, yearly subscription",
                "Barcode": "5678901234562",
                "Price": 69,
                "Unit": "ea",
                "Code": "pro-y"
            },
            {
                "PrintQuantity": 1,
                "Name": "AzureLabel Corporate, yearly subscription",
                "Barcode": "8901234567890",
                "Price": 102,
                "Price2": 95,
                "PriceOld": 110,
                "Unit": "ea",
                "Code": "corp-y"
            }
        ]
    }
}

  • --encoding <string> – Specifies the character encoding for both input and output file operations. (default: utf-8).
    Supported values:
    • utf-8
    • utf-16
    • A Windows code page ID (e.g., 1252 for ANSI Latin 1 – Western European)
      For a full list of supported code pages, see: https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers?redirectedfrom=MSDN.

Examples

  • allinonefile data.json

printServerDesktop

Start the Print Server (Desktop).

Parameters

  • --apiServerPort <integer> — Port for the internal API server. (default: 42103)

Examples

  • printServerDesktop
  • printServerDesktop --apiServerPort 8080

runTask

Run a task from a .json file, usually created in the program and stored in the Tasks folder.

Parameters

  • --task <string> * required — Full path to a JSON task file.

Examples

  • runTask --task "[Tasks]\My task"
  • runTask --task "C:\My task.json"

printServerManager

Open the Print Server Manager to manage the Print Server (Service).

Examples

  • printServerManager

labels

Save a list of available labels from the Labels folder to a file.
Each line in the file will contain: label name, followed by a tab character, and then the label location.

Parameters

  • --outputFile <string> * required — Full path to the output file.
  • --encoding <string> – Specifies the character encoding for both input and output file operations. (default: utf-8).
    Supported values:
    • utf-8
    • utf-16
    • A Windows code page ID (e.g., 1252 for ANSI Latin 1 – Western European)
      For a full list of supported code pages, see: https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers?redirectedfrom=MSDN.

Examples

  • labels --outputFile "C:\labels.txt"

lastPrintTime

Write the last label print time to a file.
The time is written in ISO format, such as 2025-06-15T12:34:56.789Z.

Parameters

  • --outputFile <string> * required — Full path to the output file.
  • --encoding <string> – Specifies the character encoding for both input and output file operations. (default: utf-8).
    Supported values:
    • utf-8
    • utf-16
    • A Windows code page ID (e.g., 1252 for ANSI Latin 1 – Western European)
      For a full list of supported code pages, see: https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers?redirectedfrom=MSDN.

Examples

  • lastPrintTime --outputFile "C:\lastPrintTime.txt"

userGuide

Open the User Guide in the default browser.

Examples

  • userGuide
On this page
azurelabel

https://azurelabel.com

contact@azurelabel.com