Интерфейс командной строки (CLI)

Общий формат команд CLI

Используйте полный путь, чтобы запустить AzureLabel из командной строки:

"C:\Program Files (x86)\AzureLabel 15\AzureLabel.exe" <Команда> [<Параметры>]

Замените <Команда> и <Параметры> на фактические значения. Например:

"C:\Program Files (x86)\AzureLabel 15\AzureLabel.exe" print --label "Моя этикетка"

Если программа добавлена в переменную окружения PATH, можно использовать azurelabel вместо полного пути. Например:

azurelabel preview --label "Моя вторая этикетка"

Для простоты во всех примерах ниже полный путь к программе опущен — показаны только команды и параметры.

Примечание: Все параметры команд являются необязательными, если явно не указано * обязательно.

Доступные команды

Следующие команды можно использовать с AzureLabel через командную строку:

  • print – Печатает одну или несколько этикеток, используя доступные источники данных.
  • preview – Открывает окно предварительного просмотра, используя те же источники данных и параметры, что и команда print.
  • designer – Открывает Дизайнер Этикеток для создания новой или редактирования существующей этикетки.
  • batch – Запускает автоматическую пакетную печать на основе настроек, сохранённых в одной или нескольких этикетках.
  • allInOneFile – Загружает и выполняет один файл, содержащий этикетку, данные и параметры печати.
  • printServerDesktop – Запускает Сервер Печати (приложение).
  • runTask – Выполняет задачу из файла .json, как правило, созданного в программе и сохранённого в папке Tasks.
  • printServerManager – Открывает Менеджер Сервера Печати для управления режимом службы (Service).
  • labels – Сохраняет список доступных этикеток из папки Этикетки в файл.
  • lastPrintTime – Записывает время последней печати этикетки в файл.
  • userGuide – Открывает Руководство пользователя в браузере по умолчанию.

print

Печатает одну или несколько этикеток, используя доступные источники данных:

  • Значения, переданные через командную строку.
  • Данные, заданные внутри самой этикетки (например, встроенные данные для печати или настройки импорта).
  • Внешние источники (например, общий файл настроек импорта или PDF-документ).

Кроме того, во время печати может отображаться окно ввода данных — в зависимости от настроек этикетки или параметра dataEntryUsage.

Параметры

  • --label <имя или путь> * обязательно — Имя или путь к этикетке. Это значение может быть либо именем файла этикетки, либо полным путем к файлу.
    Путь может содержать подстановку [Labels], которая указывает на папку Этикетки, заданную в настройках программы, например: [Labels]\My Label.
    Если указано только имя (без пути), программа будет искать этикетку в папке Этикетки.
    Поддерживается указание нескольких этикеток через вертикальную черту |, например: "Этикетка A|Этикетка B".
  • --printQuantity <строка> — Указывает, сколько раз печатать каждый дизайн этикетки. (по умолчанию: 1)
    Поддерживаемые форматы:

    Простое количество
    4 → Каждый дизайн печатается 4 раза.

    Групповая печать
    2,3 → Первый дизайн печатается 2 раза, второй — 3 раза.

    Чередующаяся печать
    2/2 → Первый и второй дизайн печатаются по очереди по одному разу, пока каждый не будет напечатан дважды.
    3/2 → Первый дизайн напечатается трижды (по одному разу за цикл), второй — дважды.

    Пропуск дизайна
    3,0 → Первый дизайн печатается 3 раза, второй не печатается.
  • --printer <имя принтера> — Указывает принтер для печати.
    Поддерживаемые значения:
    • Имя установленного в системе принтера
    • printToPdf – сохранить в PDF-файл
    • printToImages – сохранить каждую этикетку как PNG-изображение
    • printToExcel – сохранить результат как Excel-файл
    Если принтер не указан или не найден:
    • Если в этикетке задан принтер (в настройках печати), будет использован он
    • В противном случае будет использован системный принтер по умолчанию
  • --printDataSource <строка> – Указывает источник данных для печати.
    Поддерживаемые значения:
    • ready — Готовый список записей.
    • label – Встроенные в этикетку данные
    • import – Настройки импорта, встроенные в этикетку
    • importLocation – Настройки импорта из указанного внешнего файла
    • pdf – Путь к PDF-файлу или ссылка на него

    Если параметр printDataSource не указан, программа попытается получить данные для печати на основе настроек из вкладки Данные для печати этикетки в окне Свойства этикетки — если это поведение не переопределено параметрами использования.
    Чтобы переопределить поведение, заданное в свойствах этикетки, используйте параметры labelUsage, importUsage или dataEntryUsage для управления тем, как используется каждый источник данных (auto, force или deny).

  • --data <строка> – Данные из внешнего источника, в зависимости от значения printDataSource.
    • Если printDataSource установлен в ready, значение должно быть одним из следующих:
      • Готовый список записей, переданный напрямую в командной строке как JSON-массив объектов, где каждый объект содержит несколько пар «имя поля – значение», например: 
        "[{^Имя^:^Товар А^,^Цена^:45.67,^printQuantity^:1},{^Имя^:^Товар Б^,^Цена^:56.78,^printQuantity^:2}]"

        Чтобы передать JSON-массив через командную строку, используйте ^ вместо " для кавычек. Это необходимо, потому что командная строка Windows ненадёжно обрабатывает стандартные двойные кавычки (") в параметрах — они могут быть удалены, интерпретированы неверно или привести к ошибке команды. Программа автоматически преобразует ^ обратно в " при разборе входных данных.

      • Путь к файлу, содержащему JSON-массив объектов, где каждый объект содержит несколько пар «имя поля – значение», например: 
        [{"Имя":"Товар А","Цена":45.67,"printQuantity":1},{"Имя":"Товар Б","Цена":56.78,"printQuantity":2}]
    • Если importLocation – путь к файлу настроек импорта
    • Если pdf – строка Base64, путь к файлу или ссылка на PDF
  • --labelUsage <строка> – Указывает, использовать ли встроенные данные как источник печати. (по умолчанию: auto)
    Значения:
    • auto – использовать, если нет других источников
    • force – всегда использовать
    • deny – не использовать
  • --importUsage <строка> – Указывает, использовать ли настройки импорта этикетки как источник печати. (по умолчанию: auto)
    Значения:
    • auto – использовать, если нет других источников
    • force – всегда использовать
    • deny – не использовать
  • --dataEntryUsage <строка> – Указывает, использовать ли окно ввода данных как источник. (по умолчанию: auto)
    Значения:
    • auto – использовать, если нет других источников
    • force – всегда использовать
    • deny – не использовать
  • --outputFile <строка> – Полный путь к файлу или формула генерации имени при сохранении в PDF, Excel или изображение.
    Если enableUI установлено в true и путь недействителен, появится окно выбора файла.
  • --simulatePrint <логическое значение> – Печать без отправки на принтер. Печать будет выполнена во временный .prn-файл или в файл от встроенного виртуального принтера. (по умолчанию: false).
  • --returnPrintResult <логическое значение> – Если установлено в true, в ответе будет возвращена подробная информация о результате печати. (по умолчанию: false).
  • --enableUI <логическое значение> – Включает элементы интерфейса, такие как окна прогресса, выбора файла и сообщений об ошибках. (по умолчанию: false).
    Важно: это не влияет на появление окна предварительного просмотра, если он запрошен.
  • --encoding <строка> – Указывает кодировку для ввода и вывода файлов. (по умолчанию: utf-8).
    Поддерживаемые значения:
    • utf-8
    • utf-16
    • ID кодовой страницы Windows. Например, 1251 (CP1251 или Windows-1251) – это стандартная таблица кодирования кириллических символов.
      Полный список кодировок: Code Page Identifiers

Примеры

  • print --label "Этикетка товара"
  • print --label "[Labels]\Моя этикетка.albl" --printQuantity 3 --printer "Zebra GX430t"
  • print --label "[Labels]\Склад.albl" --data '[{"имя":"Товар А","цена":45,"printQuantity":1},{"имя":"Товар Б","цена":560,"printQuantity":2}]'
  • print --label "[Labels]\Моя этикетка.albl|Другая этикетка.albl" --printQuantity 4

preview

То же, что и команда print, но вместо отправки на принтер открывает окно предварительного просмотра.

designer

Открывает Дизайнер этикеток для создания новой или редактирования существующей этикетки.

Параметры

  • --label <имя или путь> — Имя или путь к этикетке. Это значение может быть либо именем файла этикетки, либо полным путем к файлу.
    Путь может содержать подстановку [Labels], которая указывает на папку Этикетки, заданную в настройках программы, например: [Labels]\My Label.
    Если указано только имя (без пути), программа будет искать этикетку в папке Этикетки.

Примеры

  • designer
  • designer --label "Этикетка товара"

batch

Запускает автоматическую пакетную печать на основе настроек, сохранённых в одной или нескольких этикетках.
Откроется то же окно Пакетной печати, что и при запуске из Дизайнера Этикеток.

Параметры

  • --label <имя или путь> * обязательно — Имя или путь к этикетке. Это значение может быть либо именем файла этикетки, либо полным путем к файлу.
    Путь может содержать подстановку [Labels], которая указывает на папку Этикетки, заданную в настройках программы, например: [Labels]\My Label.
    Если указано только имя (без пути), программа будет искать этикетку в папке Этикетки.
    Поддерживается указание нескольких этикеток через вертикальную черту |, например: "Этикетка A|Этикетка B".

Примеры

  • batch --label "Склад.albl"
  • batch --label "Этикетка товара|Этикетка упаковки"

allInOneFile

Загружает и выполняет один файл, содержащий этикетку, данные и параметры печати.

Параметры

  • <Путь к файлу данных> * обязательно – Полный путь к JSON-файлу с данными.

    Файл должен быть в формате JSON, как описано в разделе "Request body" для конечной точки "/labels/print" в документации по REST API.

    Дополнительно в JSON должен присутствовать один обязательный параметр:

    "request": "<Конечная точка REST API>"

    где <Конечная точка REST API> — конечная точка REST API, например: "request": "/labels/print".

    Пример JSON-файла:

    
{
  "request": "/labels/preview",
  "label": "Моя этикетка",
  "printData": {
    "source": "ready",
    "data": [
      {
        "PrintQuantity": 3,
        "Имя": "AzureLabel Pro, годовая подписка",
        "Штрихкод": "5678901234562",
        "Цена": 69,
        "Единица": "шт",
        "Код": "pro-y"
      },
      {
        "PrintQuantity": 1,
        "Имя": "AzureLabel Corporate, годовая подписка",
        "Штрихкод": "8901234567890",
        "Цена": 102,
        "Цена 2": 95,
        "Цена старая": 110,
        "Единица": "шт",
        "Код": "corp-y"
      }
    ]
  }
}
  • --encoding <строка> – Указывает кодировку для операций чтения и записи файлов. (по умолчанию: utf-8).
    Поддерживаемые значения:
    • utf-8
    • utf-16
    • ID кодовой страницы Windows. Например, 1251 (CP1251 или Windows-1251) – это стандартная таблица кодирования кириллических символов.
      Полный список поддерживаемых кодировок: Code Page Identifiers

Примеры

  • allinonefile data.json

printServerDesktop

Запускает Сервер Печати (приложение).

Параметры

  • --apiServerPort <целое число> — Порт для внутреннего API-сервера. (по умолчанию: 42103)

Примеры

  • printServerDesktop
  • printServerDesktop --apiServerPort 8080

runTask

Выполняет задачу из .json-файла, как правило, созданного в программе и сохранённого в папке Tasks.

Параметры

  • --task <строка> * обязательно — Полный путь к JSON-файлу задачи.

Примеры

  • runTask --task "[Tasks]\Моя задача"
  • runTask --task "C:\Моя задача.json"

printServerManager

Открывает Менеджер Сервера Печати для управления Сервером Печати (служба).

Примеры

  • printServerManager

labels

Сохраняет список доступных этикеток из папки Этикетки в файл.
Каждая строка файла будет содержать: имя этикетки, символ табуляции и путь к файлу этикетки.

Параметры

  • --outputFile <строка> * обязательно — Полный путь к выходному файлу.
  • --encoding <строка> – Указывает кодировку для операций чтения и записи файлов. (по умолчанию: utf-8).
    Поддерживаемые значения:
    • utf-8
    • utf-16
    • ID кодовой страницы Windows. Например, 1251 (CP1251 или Windows-1251) – это стандартная таблица кодирования кириллических символов.
      Полный список доступен здесь: Code Page Identifiers

Примеры

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

lastPrintTime

Записывает время последней печати этикетки в файл.
Время указывается в формате ISO, например: 2025-06-15T12:34:56.789Z.

Параметры

  • --outputFile <строка> * обязательно — Полный путь к выходному файлу.
  • --encoding <строка> – Указывает кодировку для операций чтения и записи файлов. (по умолчанию: utf-8).
    Поддерживаемые значения:
    • utf-8
    • utf-16
    • ID кодовой страницы Windows. Например, 1251 (CP1251 или Windows-1251) – это стандартная таблица кодирования кириллических символов.
      Полный список доступен здесь: Code Page Identifiers

Примеры

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

userGuide

Открывает руководство пользователя в браузере по умолчанию.

Примеры

  • userGuide
На этой странице
azurelabel

https://azurelabel.com

contact@azurelabel.com