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'

Routes

/app

Get information about the application.

/app/info
No arguments

Clear cached data.

/app/clear
No arguments

Get information about versions the application.

/app/versions
No arguments

Check access to root user.

/app/auth/check
 version - Installed version of Aurora Platform SDK.

Authorization in sudo.

/app/auth/root
 password - Root password.

/device

Get list devices.

/device/list
No arguments

Get info device.

/device/info
 host - IP address device.

Execute the command on the device.

/device/command
 host - IP address device.
 execute - The command will be executed on the device.

Upload file to ~/Download directory device.

/device/upload
 host - IP address device.
 path - Path to file.

Run package on the device.

/device/package/run
 host - IP address device.
 package - Package name.
 mode [dart, gdb] (optional) - Application launch mode.
 project (optional) - Path to project. The default is the current directory.

Install RPM package on the device.

/device/package/install
 host - IP address device.
 path - Path to file.
 apm [default = false, true] - Use APM.

Remove package from the device.

/device/package/remove
 host - IP address device.
 package - Package name.
 apm [default = false, true] - Use APM.

/emulator

Start the emulator.

/emulator/start
No arguments

Take a screenshot of the emulator.

/emulator/screenshot
No arguments

Start recording video from the the emulator.

/emulator/recording/start
No arguments

Stop video recording from the the emulator.

/emulator/recording/stop
No arguments

Get info emulator.

/emulator/info
No arguments

Execute the command on the emulator.

/emulator/command
 execute - The command will be executed on the emulator.

Upload file to ~/Download directory emulator.

/emulator/upload
 path - Path to file.

Run package on the emulator.

/emulator/package/run
 package - Package name.
 mode [dart, gdb] (optional) - Application launch mode.
 project (optional) - Path to project. The default is the current directory.

Install RPM package on the emulator.

/emulator/package/install
 path - Path to file.
 apm [default = false, true] - Use APM.

Remove package from the emulator.

/emulator/package/remove
 package - Package name.
 apm [default = false, true] - Use APM.

/flutter

Get available version Flutter for Aurora OS.

/flutter/available
No arguments

Get versions of installed Flutter for Aurora OS.

/flutter/installed
No arguments

Download and install Flutter for Aurora OS.

/flutter/install
 version - Installed version of Flutter.

Remove Flutter for Aurora OS.

/flutter/remove
 version - Installed version of Flutter.

Add devices with Aurora OS to Flutter.

/flutter/custom-devices
 version - Installed version of Flutter.

Project formatting.

/flutter/project/format
 version - Installed version of Flutter.
 path - Path to project. The default is the current directory.

Build a project.

/flutter/project/build
 version - Installed version of Flutter.
 psdk - Installed version of Aurora Platform SDK.
 path - Path to project. The default is the current directory.
 target - Target name installed version of Aurora Platform SDK.
 debug [default = false, true] - Build debug.
 clean [default = false, true] - Build clean.
 pub_get [default = false, true] - Run pub get.
 build_runner [default = false, true] - Run build runner.
 install [default = false, true] - Install on the device or the emulator.
 apm [default = false, true] - Use APM.
 run [default = false, true] - Run application on the device or the emulator.
 verbose [default = false, true] - Command output.
 run_mode [dart, gdb] (optional) - Application launch mode.
 host (optional) - IP address device.
 key (optional) - The name of key for sign package from config application.

Compile a report of flutter project.

/flutter/project/report
 version - Installed version of Flutter.
 path - Path to project. The default is the current directory.

Gen multiple size icons for application.

/flutter/project/icons
 image - Path to image.
 path - Path to project. The default is the current directory.

/psdk

Get available version Aurora Platform SDK.

/psdk/available
No arguments

Get installed list Aurora Platform SDK.

/psdk/installed
No arguments

Get info about Aurora Platform SDK.

/psdk/info
 version - Installed version of Aurora Platform SDK.

Get list targets Aurora Platform SDK.

/psdk/targets
 version - Installed version of Aurora Platform SDK.

Download Aurora Platform SDK.

/psdk/download
 version - Installed version of Aurora Platform SDK.

Install Aurora Platform SDK.

/psdk/install
 version - Installed version of Aurora Platform SDK.

Remove Aurora Platform SDK.

/psdk/remove
 version - Installed version of Aurora Platform SDK.

Remove snapshot target.

/psdk/clear
 version - Installed version of Aurora Platform SDK.
 target - Target name installed version of Aurora Platform SDK.

Add sudoers permissions Aurora Platform SDK.

/psdk/sudoers/add
 version - Installed version of Aurora Platform SDK.

Remove sudoers permissions Aurora Platform SDK.

/psdk/sudoers/remove
 version - Installed version of Aurora Platform SDK.

Search installed package in target.

/psdk/package/search
 version - Installed version of Aurora Platform SDK.
 target - Target name installed version of Aurora Platform SDK.
 package - Package name.

Install RPM packages to target.

/psdk/package/install
 version - Installed version of Aurora Platform SDK.
 target - Target name installed version of Aurora Platform SDK.
 path - Path to RPM file.

Remove package from target.

/psdk/package/remove
 version - Installed version of Aurora Platform SDK.
 target - Target name installed version of Aurora Platform SDK.
 package - Package name.

Validate RPM packages.

/psdk/package/validate
 version - Installed version of Aurora Platform SDK.
 target - Target name installed version of Aurora Platform SDK.
 path - Path to RPM file.
 profile [regular, extended, mdm, antivirus, auth] - Select profile.

Sign (with re-sign) RPM package.

/psdk/package/sign
 version - Installed version of Aurora Platform SDK.
 path - Path to RPM file.
 key (optional) - The name of key for sign package from config application.

Project formatting.

/psdk/project/format
 path - Path to project. The default is the current directory.

Build a project.

/psdk/project/build
 version - Installed version of Aurora Platform SDK.
 target - Target name installed version of Aurora Platform SDK.
 path - Path to project. The default is the current directory.
 clean [default = false, true] - Build clean.
 install [default = false, true] - Install on the device or the emulator.
 apm [default = false, true] - Use APM.
 run [default = false, true] - Run application on the device or the emulator.
 debug [default = false, true] - Build debug.
 verbose [default = false, true] - Command output.
 host (optional) - IP address device.
 key (optional) - The name of key for sign package from config application.

Gen multiple size icons for application.

/psdk/project/icons
 image - Path to image.
 path - Path to project. The default is the current directory.

/sdk

Get available version Aurora SDK.

/sdk/available
No arguments

Get version of the installed Aurora SDK.

/sdk/installed
No arguments

Download and run Aurora SDK installation.

/sdk/install
 version - Installed version of Aurora Platform SDK.
 offline [default = false, true] - Download offline type installer.

Run maintenance tool (remove, update).

/sdk/tool
No arguments

/vscode

Information about VS Code.

/vscode/info
No arguments

Get a list of VS Code extensions.

/vscode/extensions/list
No arguments

Install VS Code extension.

/vscode/extensions/install
 extension - Name of the VS Code extension.

Update VS Code settings.

/vscode/settings/update
No arguments

/settings

Display additional application settings.

/settings/list
No arguments

Clear advanced application settings.

/settings/clear
No arguments

Set the application language.

/settings/localization
 language [ru, en] - Application language.

Controlling the --verbose parameter.

/settings/verbose
 enable [false, true] - Enable/Disable --verbose by default.

Controlling the --select parameter.

/settings/select
 enable [false, true] - Enable/Disable saving --select.

Manage application hints.

/settings/hint
 enable [false, true] - Enable/Disable application hints.

/tests

Test answers API.

/tests/answer
 time [default = 0] - Response delay time.
 code [default = 200] - Response code (100, 200, 500).
 iterate [default = 1] - Number of response iterations.