Skip to content

API

Приложение имеет API интерфейс для использования его в других приложениях. Интерфейс CLI (Command line interface) предназначен для удобного использования приложения через терминал, а API (Application programming interface) предназначен для удобного использования приложения во всевозможных скриптах, приложениях или расширениях для IDE.

По API можно вызвать справку в приложении через аргумент --help, так же, как и для других команд. Команда имеет один аргумент - --route, он принимает URL в виде строки:

aurora-cli api --route '/device/command?host=192.168.2.15&execute=ls -1'

/device

Получить список устройств.

/device/list
No arguments

Выполните команду на устройстве.

/device/command
 host - IP-адрес устройства.
 execute - Команда, которая будет выполнена на устройстве.

Загрузите файл в каталог ~/Download устройства.

/device/upload
 host - IP-адрес устройства.
 path - Путь к файлу.

Запустите пакет на устройстве.

/device/package/run
 host - IP-адрес устройства.
 package - Имя пакета.
 mode [dart, gdb] (необязательный) - Режим запуска приложения.
 project (необязательный) - Путь к проекту. По умолчанию текущая директория.

Установите пакет RPM на устройство.

/device/package/install
 host - IP-адрес устройства.
 path - Путь к файлу.
 apm [по умолчанию = false, true] - Использовать APM.

Удалите пакет с устройства.

/device/package/remove
 host - IP-адрес устройства.
 package - Имя пакета.
 apm [по умолчанию = false, true] - Использовать APM.

/emulator

Запустите эмулятор.

/emulator/start
No arguments

Сделать скриншот эмулятора.

/emulator/screenshot
No arguments

Старт записи видео с эмулятора.

/emulator/recording/start
No arguments

Остановка записи видео с эмулятора.

/emulator/recording/stop
No arguments

Выполните команду на эмуляторе.

/emulator/command
 execute - Команда, которая будет выполнена на эмуляторе.

Загрузите файл в каталог ~/Download эмулятора.

/emulator/upload
 path - Путь к файлу.

Запустите пакет на эмуляторе.

/emulator/package/run
 package - Имя пакета.
 mode [dart, gdb] (необязательный) - Режим запуска приложения.
 project (необязательный) - Путь к проекту. По умолчанию текущая директория.

Установите пакет RPM на эмулятор.

/emulator/package/install
 path - Путь к файлу.
 apm [по умолчанию = false, true] - Использовать APM.

Удалите пакет с эмулятора.

/emulator/package/remove
 package - Имя пакета.
 apm [по умолчанию = false, true] - Использовать APM.

/flutter

Получите доступные версии Flutter для ОС Аврора.

/flutter/available
No arguments

Получите версии установленных Flutter для ОС Аврора.

/flutter/installed
No arguments

Загрузите и установите Flutter для ОС Аврора.

/flutter/install
 version - Установленная версия Flutter.

Удалите Flutter для ОС Аврора.

/flutter/remove
 version - Установленная версия Flutter.

Добавьте устройства с ОС Aurora во Flutter.

/flutter/custom-devices
 version - Установленная версия Flutter.

Форматирование проекта.

/flutter/project/format
 version - Установленная версия Flutter.
 path - Путь к проекту. По умолчанию текущая директория.

Сборка проекта.

/flutter/project/build
 version - Установленная версия Flutter.
 psdk - Установленная версия Aurora Platform SDK.
 target - Имя цели установленной версии Aurora Platform SDK.
 path - Путь к проекту. По умолчанию текущая директория.
 clean [по умолчанию = false, true] - Очистка сборки.
 install [по умолчанию = false, true] - Установите на устройство или эмулятор.
 apm [по умолчанию = false, true] - Использовать APM.
 run [по умолчанию = false, true] - Запустите приложение на устройстве или эмуляторе.
 verbose [по умолчанию = false, true] - Подробный вывод.
 mode [dart, gdb] (необязательный) - Режим сборки с отладкой.
 host (необязательный) - IP-адрес устройства.
 key (необязательный) - Название ключа для подписи пакета из конфигурации приложения.

Составить отчет проекта Flutter.

/flutter/project/report
 version - Установленная версия Flutter.
 path - Путь к проекту. По умолчанию текущая директория.

Генерируйте иконки разных размеров для приложения.

/flutter/project/icons
 image - Путь к изображению.
 path - Путь к проекту. По умолчанию текущая директория.

/psdk

Получить список доступных версий Аврора Platform SDK.

/psdk/available
No arguments

Получите список установленных Аврора Platform SDK.

/psdk/installed
No arguments

Получить список таргетов Аврора Platform SDK.

/psdk/targets
 version - Установленная версия Aurora Platform SDK.

Загрузите и установите Аврора Platform SDK.

/psdk/install
 version - Установленная версия Aurora Platform SDK.

Удалить Аврора Platform SDK.

/psdk/remove
 version - Установленная версия Aurora Platform SDK.

Удалить снимок таргета.

/psdk/clear
 version - Установленная версия Aurora Platform SDK.
 target - Имя цели установленной версии Aurora Platform SDK.

Добавьте разрешения sudoers Аврора Platform SDK.

/psdk/sudoers/add
 version - Установленная версия Aurora Platform SDK.

Удалите разрешения sudoers Аврора Platform SDK.

/psdk/sudoers/remove
 version - Установленная версия Aurora Platform SDK.

Найдите установленный пакет в таргете.

/psdk/package/search
 version - Установленная версия Aurora Platform SDK.
 target - Имя цели установленной версии Aurora Platform SDK.
 package - Имя пакета.

Установите пакеты RPM в таргет.

/psdk/package/install
 version - Установленная версия Aurora Platform SDK.
 target - Имя цели установленной версии Aurora Platform SDK.
 path - Путь к RPM-файлу.

Удалить пакет из таргета.

/psdk/package/remove
 version - Установленная версия Aurora Platform SDK.
 target - Имя цели установленной версии Aurora Platform SDK.
 package - Имя пакета.

Валидация пакетов RPM.

/psdk/package/validate
 version - Установленная версия Aurora Platform SDK.
 target - Имя цели установленной версии Aurora Platform SDK.
 path - Путь к RPM-файлу.
 profile [regular, extended, mdm, antivirus, auth] - Выберите профиль.

Подписать пакет RPM ключевой парой (с переподпиской).

/psdk/package/sign
 version - Установленная версия Aurora Platform SDK.
 path - Путь к RPM-файлу.
 key (необязательный) - Название ключа для подписи пакета из конфигурации приложения.

Форматирование проекта.

/psdk/project/format
 path - Путь к проекту. По умолчанию текущая директория.

Сборка проекта.

/psdk/project/build
 version - Установленная версия Aurora Platform SDK.
 target - Имя цели установленной версии Aurora Platform SDK.
 path - Путь к проекту. По умолчанию текущая директория.
 clean [по умолчанию = false, true] - Очистка сборки.
 install [по умолчанию = false, true] - Установите на устройство или эмулятор.
 apm [по умолчанию = false, true] - Использовать APM.
 run [по умолчанию = false, true] - Запустите приложение на устройстве или эмуляторе.
 debug [по умолчанию = false, true] - Режим сборки с отладкой.
 verbose [по умолчанию = false, true] - Подробный вывод.
 host (необязательный) - IP-адрес устройства.
 key (необязательный) - Название ключа для подписи пакета из конфигурации приложения.

Генерируйте иконки разных размеров для приложения.

/psdk/project/icons
 image - Путь к изображению.
 path - Путь к проекту. По умолчанию текущая директория.

/sdk

Получите доступные версии Аврора SDK.

/sdk/available
No arguments

Получите версию установленной Аврора SDK.

/sdk/installed
No arguments

Загрузите и запустите установку Аврора SDK.

/sdk/install
 version - Установленная версия Aurora Platform SDK.
 offline [по умолчанию = false, true] - Загрузите установщик offline типа.

Запустите инструмент обслуживания (удаление, обновление).

/sdk/tool
No arguments

/vscode

Получить список расширений VS Code.

/vscode/extensions/list
No arguments

Получить список расширений Flutter, необходимых для работы с VS Code.

/vscode/extensions/check/flutter
No arguments

Получить список расширений C++, необходимых для работы с VS Code.

/vscode/extensions/check/cpp
No arguments

Получить список других расширений, необходимых для работы с VS Code.

/vscode/extensions/check/other
No arguments

Установка расширения VS Code.

/vscode/extensions/install
 extension - Название расширения VS Code.

Обновить настройки VS Code.

/vscode/settings/update
No arguments