FOnline Engine
Current master GitHub
Документация Docs/ru/reference/helper-cli/commands.md

Команды вспомогательных CLI

Сгенерированный справочник. Не редактируйте эту страницу напрямую. Обновите BuildTools/HelperCliInterface.json или владеющий исполняемый парсер, затем выполните python BuildTools/docs_helper_cli.py --write.

Индекс справочника Команды Каноническая JSON-модель Контракт генерации

Команды приведены с точными созданными парсером usage и справкой фиксированной ширины 80 столбцов. Запускайте helper из корня репозитория движка, если владелец вызова не задаёт другой рабочий каталог.

Генерация кода

Создаёт конфигурацию движка, регистрацию метаданных, привязки скриптов и исходники встроенных ресурсов.

  • Стабильный ID: helper-cli.codegen
  • Программа: codegen.py
  • Владелец: build-release
  • Аудитория: engine-contributor, embedding-project-build-system
  • Владелец вызова: BuildTools/cmake/stages/Codegen.cmake
  • Исходный парсер: BuildTools/codegen.py

Аргументы верхнего уровня

Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.codegen.argument.maincfg -maincfg option да 1 - - Основной файл конфигурации.
helper-cli.codegen.argument.buildhash -buildhash option да 1 - - Хеш сборки.
helper-cli.codegen.argument.devname -devname option да 1 - - Краткое имя игры для разработки.
helper-cli.codegen.argument.nicename -nicename option да 1 - - Читаемое имя игры.
helper-cli.codegen.argument.embedded -embedded option да 1 - - Ёмкость буфера встроенных данных.
helper-cli.codegen.argument.enginedefine -enginedefine option нет 1 - - Define конфигурации движка NAME=VALUE, создаваемый как макрос в EngineConfig.gen.h.
helper-cli.codegen.argument.meta -meta option да 1 - - Путь к метаданным Script API, то есть тегам ///@.
helper-cli.codegen.argument.commonheader -commonheader option нет 1 - - Путь к общему header-файлу.
helper-cli.codegen.argument.genoutput -genoutput option да 1 - - Каталог выходного сгенерированного кода.
helper-cli.codegen.argument.verbose -verbose option нет 0 - false Подробный режим.

Точный вывод --help верхнего уровня

usage: codegen.py [-h] -maincfg MAINCFG -buildhash BUILDHASH -devname DEVNAME -nicename NICENAME -embedded EMBEDDED [-enginedefine ENGINEDEFINE] -meta META [-commonheader COMMONHEADER] -genoutput GENOUTPUT [-verbose]

FOnline code generator

options:
  -h, --help            show this help message and exit
  -maincfg MAINCFG      main config file
  -buildhash BUILDHASH  build hash
  -devname DEVNAME      dev game name
  -nicename NICENAME    nice game name
  -embedded EMBEDDED    embedded buffer capacity
  -enginedefine ENGINEDEFINE
                        engine configuration define NAME=VALUE emitted as a macro into EngineConfig.gen.h
  -meta META            path to script api metadata (///@ tags)
  -commonheader COMMONHEADER
                        path to common header file
  -genoutput GENOUTPUT  generated code output dir
  -verbose              verbose mode

Покрытие кода

Очищает, собирает и формирует отчёты покрытия кода движка для сгенерированных тестовых целей.

  • Стабильный ID: helper-cli.codecoverage
  • Программа: codecoverage.py
  • Владелец: quality
  • Аудитория: engine-contributor, ci-maintainer
  • Владелец вызова: BuildTools/cmake/stages/Applications.cmake
  • Исходный парсер: BuildTools/codecoverage.py

Аргументы верхнего уровня

На этом уровне аргументов нет.

Точный вывод --help верхнего уровня

usage: codecoverage.py [-h] {clean,run,report,full} ...

Run and analyze engine code coverage

positional arguments:
  {clean,run,report,full}
    clean               Remove previously collected coverage data and reports
    run                 Run the instrumented test binary and collect coverage data
    report              Generate text and HTML reports from collected coverage data
    full                Clean, run the instrumented binary, and generate reports

options:
  -h, --help            show this help message and exit

clean

Удалить ранее собранные данные покрытия и отчёты.

Stable ID: helper-cli.codecoverage.command.clean

usage: codecoverage.py clean [-h] --workspace-root WORKSPACE_ROOT --build-dir BUILD_DIR --binary BINARY --backend {gcc,llvm,msvc} --output-dir OUTPUT_DIR [--object OBJECTS] ...
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.codecoverage.command.clean.argument.workspace_root --workspace-root option да 1 - - Каталог исходников подключающего проекта.
helper-cli.codecoverage.command.clean.argument.build_dir --build-dir option да 1 - - Настроенный каталог сборки CMake.
helper-cli.codecoverage.command.clean.argument.binary --binary option да 1 - - Инструментированный исполняемый файл тестов.
helper-cli.codecoverage.command.clean.argument.backend --backend option да 1 gcc, llvm, msvc - Backend компилятора/toolchain покрытия.
helper-cli.codecoverage.command.clean.argument.output_dir --output-dir option да 1 - - Каталог выходных данных покрытия и отчётов.
helper-cli.codecoverage.command.clean.argument.objects --object option нет 1 - - Дополнительный инструментированный исполняемый файл или динамическая библиотека для отчёта LLVM; аргумент можно повторять.
helper-cli.codecoverage.command.clean.argument.binary_args binary_args positional да ... - - Аргументы, передаваемые тестовому бинарному файлу.

Точный вывод --help

usage: codecoverage.py clean [-h] --workspace-root WORKSPACE_ROOT --build-dir BUILD_DIR --binary BINARY --backend {gcc,llvm,msvc} --output-dir OUTPUT_DIR [--object OBJECTS] ...

Remove previously collected coverage data and reports

positional arguments:
  binary_args           arguments passed to the test binary

options:
  -h, --help            show this help message and exit
  --workspace-root WORKSPACE_ROOT
                        embedding-project source directory
  --build-dir BUILD_DIR
                        configured CMake build directory
  --binary BINARY       instrumented test executable
  --backend {gcc,llvm,msvc}
                        coverage compiler/toolchain backend
  --output-dir OUTPUT_DIR
                        coverage data and report output directory
  --object OBJECTS      additional instrumented executable or shared library for LLVM reporting; repeatable

run

Запустить инструментированный тестовый бинарный файл и собрать данные покрытия.

Stable ID: helper-cli.codecoverage.command.run

usage: codecoverage.py run [-h] --workspace-root WORKSPACE_ROOT --build-dir BUILD_DIR --binary BINARY --backend {gcc,llvm,msvc} --output-dir OUTPUT_DIR [--object OBJECTS] ...
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.codecoverage.command.run.argument.workspace_root --workspace-root option да 1 - - Каталог исходников подключающего проекта.
helper-cli.codecoverage.command.run.argument.build_dir --build-dir option да 1 - - Настроенный каталог сборки CMake.
helper-cli.codecoverage.command.run.argument.binary --binary option да 1 - - Инструментированный исполняемый файл тестов.
helper-cli.codecoverage.command.run.argument.backend --backend option да 1 gcc, llvm, msvc - Backend компилятора/toolchain покрытия.
helper-cli.codecoverage.command.run.argument.output_dir --output-dir option да 1 - - Каталог выходных данных покрытия и отчётов.
helper-cli.codecoverage.command.run.argument.objects --object option нет 1 - - Дополнительный инструментированный исполняемый файл или динамическая библиотека для отчёта LLVM; аргумент можно повторять.
helper-cli.codecoverage.command.run.argument.binary_args binary_args positional да ... - - Аргументы, передаваемые тестовому бинарному файлу.

Точный вывод --help

usage: codecoverage.py run [-h] --workspace-root WORKSPACE_ROOT --build-dir BUILD_DIR --binary BINARY --backend {gcc,llvm,msvc} --output-dir OUTPUT_DIR [--object OBJECTS] ...

Run the instrumented test binary and collect coverage data

positional arguments:
  binary_args           arguments passed to the test binary

options:
  -h, --help            show this help message and exit
  --workspace-root WORKSPACE_ROOT
                        embedding-project source directory
  --build-dir BUILD_DIR
                        configured CMake build directory
  --binary BINARY       instrumented test executable
  --backend {gcc,llvm,msvc}
                        coverage compiler/toolchain backend
  --output-dir OUTPUT_DIR
                        coverage data and report output directory
  --object OBJECTS      additional instrumented executable or shared library for LLVM reporting; repeatable

report

Создать текстовый и HTML-отчёты из собранных данных покрытия.

Stable ID: helper-cli.codecoverage.command.report

usage: codecoverage.py report [-h] --workspace-root WORKSPACE_ROOT --build-dir BUILD_DIR --binary BINARY --backend {gcc,llvm,msvc} --output-dir OUTPUT_DIR [--object OBJECTS] ...
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.codecoverage.command.report.argument.workspace_root --workspace-root option да 1 - - Каталог исходников подключающего проекта.
helper-cli.codecoverage.command.report.argument.build_dir --build-dir option да 1 - - Настроенный каталог сборки CMake.
helper-cli.codecoverage.command.report.argument.binary --binary option да 1 - - Инструментированный исполняемый файл тестов.
helper-cli.codecoverage.command.report.argument.backend --backend option да 1 gcc, llvm, msvc - Backend компилятора/toolchain покрытия.
helper-cli.codecoverage.command.report.argument.output_dir --output-dir option да 1 - - Каталог выходных данных покрытия и отчётов.
helper-cli.codecoverage.command.report.argument.objects --object option нет 1 - - Дополнительный инструментированный исполняемый файл или динамическая библиотека для отчёта LLVM; аргумент можно повторять.
helper-cli.codecoverage.command.report.argument.binary_args binary_args positional да ... - - Аргументы, передаваемые тестовому бинарному файлу.

Точный вывод --help

usage: codecoverage.py report [-h] --workspace-root WORKSPACE_ROOT --build-dir BUILD_DIR --binary BINARY --backend {gcc,llvm,msvc} --output-dir OUTPUT_DIR [--object OBJECTS] ...

Generate text and HTML reports from collected coverage data

positional arguments:
  binary_args           arguments passed to the test binary

options:
  -h, --help            show this help message and exit
  --workspace-root WORKSPACE_ROOT
                        embedding-project source directory
  --build-dir BUILD_DIR
                        configured CMake build directory
  --binary BINARY       instrumented test executable
  --backend {gcc,llvm,msvc}
                        coverage compiler/toolchain backend
  --output-dir OUTPUT_DIR
                        coverage data and report output directory
  --object OBJECTS      additional instrumented executable or shared library for LLVM reporting; repeatable

full

Очистить данные, запустить инструментированный бинарный файл и создать отчёты.

Stable ID: helper-cli.codecoverage.command.full

usage: codecoverage.py full [-h] --workspace-root WORKSPACE_ROOT --build-dir BUILD_DIR --binary BINARY --backend {gcc,llvm,msvc} --output-dir OUTPUT_DIR [--object OBJECTS] ...
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.codecoverage.command.full.argument.workspace_root --workspace-root option да 1 - - Каталог исходников подключающего проекта.
helper-cli.codecoverage.command.full.argument.build_dir --build-dir option да 1 - - Настроенный каталог сборки CMake.
helper-cli.codecoverage.command.full.argument.binary --binary option да 1 - - Инструментированный исполняемый файл тестов.
helper-cli.codecoverage.command.full.argument.backend --backend option да 1 gcc, llvm, msvc - Backend компилятора/toolchain покрытия.
helper-cli.codecoverage.command.full.argument.output_dir --output-dir option да 1 - - Каталог выходных данных покрытия и отчётов.
helper-cli.codecoverage.command.full.argument.objects --object option нет 1 - - Дополнительный инструментированный исполняемый файл или динамическая библиотека для отчёта LLVM; аргумент можно повторять.
helper-cli.codecoverage.command.full.argument.binary_args binary_args positional да ... - - Аргументы, передаваемые тестовому бинарному файлу.

Точный вывод --help

usage: codecoverage.py full [-h] --workspace-root WORKSPACE_ROOT --build-dir BUILD_DIR --binary BINARY --backend {gcc,llvm,msvc} --output-dir OUTPUT_DIR [--object OBJECTS] ...

Clean, run the instrumented binary, and generate reports

positional arguments:
  binary_args           arguments passed to the test binary

options:
  -h, --help            show this help message and exit
  --workspace-root WORKSPACE_ROOT
                        embedding-project source directory
  --build-dir BUILD_DIR
                        configured CMake build directory
  --binary BINARY       instrumented test executable
  --backend {gcc,llvm,msvc}
                        coverage compiler/toolchain backend
  --output-dir OUTPUT_DIR
                        coverage data and report output directory
  --object OBJECTS      additional instrumented executable or shared library for LLVM reporting; repeatable

Запуск игровых тестов

Запускает упорядоченные многопроцессные игровые smoke-сценарии с контрактами готовности, маркеров, deadline, очистки и JSON-отчёта.

  • Стабильный ID: helper-cli.gameplay-test-runner
  • Программа: gameplay_test_runner.py
  • Владелец: quality
  • Аудитория: game-developer, engine-contributor, embedding-project-build-system, ci-maintainer
  • Владелец вызова: CMake-цели подключающего проекта и CI smoke-задачи игровых тестов
  • Исходный парсер: BuildTools/gameplay_test_runner.py

Аргументы верхнего уровня

Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.gameplay-test-runner.argument.manifest --manifest option да 1 - - Путь к манифесту сценария.
helper-cli.gameplay-test-runner.argument.value --value option нет 1 - - Значение placeholder; повторяйте при необходимости.
helper-cli.gameplay-test-runner.argument.report --report option нет 1 - - Необязательный путь результата JSON.

Точный вывод --help верхнего уровня

usage: gameplay_test_runner.py [-h] --manifest MANIFEST [--value KEY=VALUE] [--report REPORT]

Run project-neutral multi-process gameplay smoke scenarios from a checked JSON manifest.

options:
  -h, --help           show this help message and exit
  --manifest MANIFEST  scenario manifest path
  --value KEY=VALUE    placeholder value; repeat as needed
  --report REPORT      optional JSON result path

Клиент протокола AiControl

Вызывает совместимый с Engine проектный мост AiControl через версионированный NDJSON/TCP envelope, не раскрывая shared tokens в командной строке.

  • Стабильный ID: helper-cli.ai-control-client
  • Программа: ai_control_client.py
  • Владелец: tooling
  • Аудитория: game-developer, engine-contributor, tool-developer, ci-maintainer
  • Владелец вызова: ИИ-адаптеры проекта, smoke-тесты протокола и непосредственная диагностика разработчиком
  • Исходный парсер: BuildTools/ai_control_client.py

Аргументы верхнего уровня

Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.ai-control-client.argument.host --host option нет 1 - 127.0.0.1 Host моста.
helper-cli.ai-control-client.argument.port --port option нет 1 - 43011 Порт моста.
helper-cli.ai-control-client.argument.timeout --timeout option нет 1 - 5.0 Timeout сокета в секундах.
helper-cli.ai-control-client.argument.token_env --token-env option нет 1 - FONLINE_AI_TOKEN Переменная окружения с общим токеном.
helper-cli.ai-control-client.argument.allow_remote --allow-remote option нет 0 - false Разрешить endpoint вне loopback; транспорт остаётся незашифрованным.

Точный вывод --help верхнего уровня

usage: ai_control_client.py [-h] [--host HOST] [--port PORT] [--timeout TIMEOUT] [--token-env TOKEN_ENV] [--allow-remote] {ping,status,observe,events,act} ...

Call an Engine-compatible AiControl bridge over NDJSON/TCP.

positional arguments:
  {ping,status,observe,events,act}
    ping                Check bridge liveness.
    status              Read bridge status and queue limits.
    observe             Read the latest project observation.
    events              Read events after a sequence cursor.
    act                 Enqueue one project-defined command.

options:
  -h, --help            show this help message and exit
  --host HOST           Bridge host.
  --port PORT           Bridge port.
  --timeout TIMEOUT     Socket timeout in seconds.
  --token-env TOKEN_ENV
                        Environment variable containing the shared token.
  --allow-remote        Permit a non-loopback endpoint; transport remains unencrypted.

ping

Проверить доступность моста.

Stable ID: helper-cli.ai-control-client.command.ping

usage: ai_control_client.py ping [-h]

На этом уровне аргументов нет.

Точный вывод --help

usage: ai_control_client.py ping [-h]

options:
  -h, --help  show this help message and exit

status

Прочитать состояние моста и ограничения очереди.

Stable ID: helper-cli.ai-control-client.command.status

usage: ai_control_client.py status [-h]

На этом уровне аргументов нет.

Точный вывод --help

usage: ai_control_client.py status [-h]

options:
  -h, --help  show this help message and exit

observe

Прочитать последнее наблюдение проекта.

Stable ID: helper-cli.ai-control-client.command.observe

usage: ai_control_client.py observe [-h]

На этом уровне аргументов нет.

Точный вывод --help

usage: ai_control_client.py observe [-h]

options:
  -h, --help  show this help message and exit

events

Прочитать события после sequence-cursor.

Stable ID: helper-cli.ai-control-client.command.events

usage: ai_control_client.py events [-h] [--after-seq AFTER_SEQ] [--limit LIMIT]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.ai-control-client.command.events.argument.after_seq --after-seq option нет 1 - 0 Исключающий cursor событий.
helper-cli.ai-control-client.command.events.argument.limit --limit option нет 1 - 100 Максимальное количество возвращаемых событий.

Точный вывод --help

usage: ai_control_client.py events [-h] [--after-seq AFTER_SEQ] [--limit LIMIT]

options:
  -h, --help            show this help message and exit
  --after-seq AFTER_SEQ
                        Exclusive event cursor.
  --limit LIMIT         Maximum events to return.

act

Поставить в очередь одну определённую проектом команду.

Stable ID: helper-cli.ai-control-client.command.act

usage: ai_control_client.py act [-h] --type TYPE [--target-id TARGET_ID] [--item-id ITEM_ID] [--aux-id AUX_ID] [--x X] [--y Y] [--screen-x SCREEN_X] [--screen-y SCREEN_Y] [--int-arg INT_ARG] [--string-arg STRING_ARG] [--append]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.ai-control-client.command.act.argument.type --type option да 1 - - Определённый проектом тип команды.
helper-cli.ai-control-client.command.act.argument.target_id --target-id option нет 1 - - Необязательный идентификатор целевой сущности.
helper-cli.ai-control-client.command.act.argument.item_id --item-id option нет 1 - - Необязательный идентификатор сущности предмета.
helper-cli.ai-control-client.command.act.argument.aux_id --aux-id option нет 1 - - Необязательный идентификатор вспомогательной сущности.
helper-cli.ai-control-client.command.act.argument.x --x option нет 1 - - Необязательная мировая координата X проекта.
helper-cli.ai-control-client.command.act.argument.y --y option нет 1 - - Необязательная мировая координата Y проекта.
helper-cli.ai-control-client.command.act.argument.screen_x --screen-x option нет 1 - - Необязательная экранная координата X.
helper-cli.ai-control-client.command.act.argument.screen_y --screen-y option нет 1 - - Необязательная экранная координата Y.
helper-cli.ai-control-client.command.act.argument.int_arg --int-arg option нет 1 - - Необязательный целочисленный payload.
helper-cli.ai-control-client.command.act.argument.string_arg --string-arg option нет 1 - - Необязательный строковый payload.
helper-cli.ai-control-client.command.act.argument.append --append option нет 0 - false Запросить проектную семантику добавления в очередь.

Точный вывод --help

usage: ai_control_client.py act [-h] --type TYPE [--target-id TARGET_ID] [--item-id ITEM_ID] [--aux-id AUX_ID] [--x X] [--y Y] [--screen-x SCREEN_X] [--screen-y SCREEN_Y] [--int-arg INT_ARG] [--string-arg STRING_ARG] [--append]

options:
  -h, --help            show this help message and exit
  --type TYPE           Project-defined command type.
  --target-id TARGET_ID
                        Optional target entity identifier.
  --item-id ITEM_ID     Optional item entity identifier.
  --aux-id AUX_ID       Optional auxiliary entity identifier.
  --x X                 Optional project world X coordinate.
  --y Y                 Optional project world Y coordinate.
  --screen-x SCREEN_X   Optional screen X coordinate.
  --screen-y SCREEN_Y   Optional screen Y coordinate.
  --int-arg INT_ARG     Optional integer payload.
  --string-arg STRING_ARG
                        Optional string payload.
  --append              Request project queue append semantics.

Проверка импортов Windows 7

Проверяет совместимость импортов слинкованных PE-файлов с Windows 7 и по запросу требует флаг большого адресного пространства у исполняемых файлов.

  • Стабильный ID: helper-cli.windows7-import-check
  • Программа: check_windows7_imports.py
  • Владелец: quality
  • Аудитория: engine-contributor, embedding-project-build-system, release-operator
  • Владелец вызова: CI и релизная проверка Windows 7 подключающего проекта
  • Исходный парсер: BuildTools/check_windows7_imports.py

Аргументы верхнего уровня

Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.windows7-import-check.argument.require_large_address_aware --require-large-address-aware option нет 0 - false Требовать флаг большого адресного пространства у проверяемых исполняемых файлов.
helper-cli.windows7-import-check.argument.binaries binaries positional да + - - Проверяемый слинкованный исполняемый PE-файл или DLL.

Точный вывод --help верхнего уровня

usage: check_windows7_imports.py [-h] [--require-large-address-aware] binaries [binaries ...]

Reject imports Windows 7 SP1 cannot resolve from Windows 7-compatible PE binaries

positional arguments:
  binaries              linked PE executable or DLL to inspect

options:
  -h, --help            show this help message and exit
  --require-large-address-aware
                        Require the large-address flag on checked executables

Управление устройством Android

Находит, подключает, устанавливает, запускает, останавливает и проверяет Android Wi-Fi-устройства через adb.

  • Стабильный ID: helper-cli.android-device
  • Программа: android_device.py
  • Владелец: platform
  • Аудитория: game-developer, engine-contributor
  • Владелец вызова: Android-задачи подключающего проекта и непосредственное использование разработчиком
  • Исходный парсер: BuildTools/android_device.py

Аргументы верхнего уровня

Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.android-device.argument.workspace_root --workspace-root option нет 1 - - Путь к рабочему каталогу, содержащему android-sdk и android-debug.

Точный вывод --help верхнего уровня

usage: android_device.py [-h] [--workspace-root WORKSPACE_ROOT] {discover,connect,install,launch,launch-game,stop,logcat} ...

Android Wi-Fi device helper for BuildTools tasks

positional arguments:
  {discover,connect,install,launch,launch-game,stop,logcat}
    discover            List Android Wi-Fi devices discovered through adb mdns
    connect             Connect to an Android Wi-Fi device and cache the endpoint
    install             Install an APK on the selected Android Wi-Fi device
    launch              Launch an Android activity on the selected device
    launch-game         Launch the Android game activity and pass RemoteSceneLaunch server host override
    stop                Force-stop an Android package on the selected device
    logcat              Stream logcat from the selected device

options:
  -h, --help            show this help message and exit
  --workspace-root WORKSPACE_ROOT
                        Workspace directory path containing android-sdk and android-debug

discover

Перечислить Android-устройства Wi-Fi, найденные через adb mdns.

Stable ID: helper-cli.android-device.command.discover

usage: android_device.py discover [-h]

На этом уровне аргументов нет.

Точный вывод --help

usage: android_device.py discover [-h]

options:
  -h, --help  show this help message and exit

connect

Подключиться к Android-устройству по Wi-Fi и кешировать endpoint.

Stable ID: helper-cli.android-device.command.connect

usage: android_device.py connect [-h] [--device DEVICE]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.android-device.command.connect.argument.device --device option нет 1 - - IP-адрес устройства с необязательным портом; при отсутствии используются автоматический поиск и интерактивный выбор.

Точный вывод --help

usage: android_device.py connect [-h] [--device DEVICE]

options:
  -h, --help       show this help message and exit
  --device DEVICE  Device IP[:port]; if omitted, auto-discovery and interactive selection are used

install

Установить APK на выбранное Android-устройство Wi-Fi.

Stable ID: helper-cli.android-device.command.install

usage: android_device.py install [-h] --apk APK [--device DEVICE]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.android-device.command.install.argument.apk --apk option да 1 - - Путь к APK.
helper-cli.android-device.command.install.argument.device --device option нет 1 - - IP-адрес устройства с необязательным портом; при отсутствии используется кешированный endpoint или поиск.

Точный вывод --help

usage: android_device.py install [-h] --apk APK [--device DEVICE]

options:
  -h, --help       show this help message and exit
  --apk APK        APK path
  --device DEVICE  Device IP[:port]; if omitted, cached endpoint or discovery is used

launch

Запустить Android activity на выбранном устройстве.

Stable ID: helper-cli.android-device.command.launch

usage: android_device.py launch [-h] --activity ACTIVITY [--device DEVICE]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.android-device.command.launch.argument.activity --activity option да 1 - - Полностью квалифицированный компонент activity, например com.example.game/.FOnlineActivity.
helper-cli.android-device.command.launch.argument.device --device option нет 1 - - IP-адрес устройства с необязательным портом; при отсутствии используется кешированный endpoint или поиск.

Точный вывод --help

usage: android_device.py launch [-h] --activity ACTIVITY [--device DEVICE]

options:
  -h, --help           show this help message and exit
  --activity ACTIVITY  Fully qualified activity component, e.g. com.example.game/.FOnlineActivity
  --device DEVICE      Device IP[:port]; if omitted, cached endpoint or discovery is used

launch-game

Запустить Android activity игры и передать переопределение хоста сервера RemoteSceneLaunch.

Stable ID: helper-cli.android-device.command.launch-game

usage: android_device.py launch-game [-h] --activity ACTIVITY [--device DEVICE] [--server-host SERVER_HOST]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.android-device.command.launch-game.argument.activity --activity option да 1 - - Полностью квалифицированный компонент activity, например com.example.game/.FOnlineActivity.
helper-cli.android-device.command.launch-game.argument.device --device option нет 1 - - IP-адрес устройства с необязательным портом; при отсутствии используется кешированный endpoint или поиск.
helper-cli.android-device.command.launch-game.argument.server_host --server-host option нет 1 - - IP-адрес или имя host для ClientNetwork.ServerHost; при отсутствии определяется по маршруту к выбранному устройству.

Точный вывод --help

usage: android_device.py launch-game [-h] --activity ACTIVITY [--device DEVICE] [--server-host SERVER_HOST]

options:
  -h, --help            show this help message and exit
  --activity ACTIVITY   Fully qualified activity component, e.g. com.example.game/.FOnlineActivity
  --device DEVICE       Device IP[:port]; if omitted, cached endpoint or discovery is used
  --server-host SERVER_HOST
                        Host IP or name for ClientNetwork.ServerHost; if omitted, auto-detected from the route to the selected device

stop

Принудительно остановить Android-пакет на выбранном устройстве.

Stable ID: helper-cli.android-device.command.stop

usage: android_device.py stop [-h] --package PACKAGE_NAME [--device DEVICE]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.android-device.command.stop.argument.package_name --package option да 1 - - Имя Android-пакета.
helper-cli.android-device.command.stop.argument.device --device option нет 1 - - IP-адрес устройства с необязательным портом; при отсутствии используется кешированный endpoint или поиск.

Точный вывод --help

usage: android_device.py stop [-h] --package PACKAGE_NAME [--device DEVICE]

options:
  -h, --help            show this help message and exit
  --package PACKAGE_NAME
                        Android package name
  --device DEVICE       Device IP[:port]; if omitted, cached endpoint or discovery is used

logcat

Передавать поток logcat с выбранного устройства.

Stable ID: helper-cli.android-device.command.logcat

usage: android_device.py logcat [-h] [--device DEVICE]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.android-device.command.logcat.argument.device --device option нет 1 - - IP-адрес устройства с необязательным портом; при отсутствии используется кешированный endpoint или поиск.

Точный вывод --help

usage: android_device.py logcat [-h] [--device DEVICE]

options:
  -h, --help       show this help message and exit
  --device DEVICE  Device IP[:port]; if omitted, cached endpoint or discovery is used

Локальный Web-сервер

Раздаёт упакованный Web-клиент с локального HTTP-сервера без кеширования.

  • Стабильный ID: helper-cli.simple-web-server
  • Программа: simple-web-server.py
  • Владелец: platform
  • Аудитория: game-developer, release-operator
  • Владелец вызова: payload WebServer в BuildTools/package.py
  • Исходный парсер: BuildTools/web/simple-web-server.py

Аргументы верхнего уровня

Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.simple-web-server.argument.port --port option нет 1 - 7000 Порт Web-сервера.
helper-cli.simple-web-server.argument.fork --fork option нет 0 - false Создать дочерний процесс.

Точный вывод --help верхнего уровня

usage: simple-web-server.py [-h] [--port PORT] [--fork]

Simple HTTP server

options:
  -h, --help   show this help message and exit
  --port PORT  web server port
  --fork       fork process

Создание MSI

Собирает установщик MSI из созданного упаковщиком определения WiX.

  • Стабильный ID: helper-cli.createmsi
  • Программа: createmsi.py
  • Владелец: build-release
  • Аудитория: release-operator, engine-contributor
  • Владелец вызова: пакет Wix в BuildTools/package.py
  • Исходный парсер: BuildTools/msicreator/createmsi.py

Аргументы верхнего уровня

Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
helper-cli.createmsi.argument.wix_dir --wix-dir option нет 1 - - Каталог инструментов WiX; без этого параметра они ищутся в PATH.
helper-cli.createmsi.argument.jsonfile definition.json positional да 1 - - Только имя файла определения пакета WiX в рабочем каталоге.

Точный вывод --help верхнего уровня

usage: createmsi.py [-h] [--wix-dir directory] definition.json

Build an MSI package from a WiX definition

positional arguments:
  definition.json      bare WiX package definition filename in the working directory

options:
  -h, --help           show this help message and exit
  --wix-dir directory  directory containing WiX tools; omit to find them on PATH
Введите запрос.