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

Сгенерированный справочник вспомогательных CLI

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

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

Этот справочник создаётся из объектов argparse.ArgumentParser, используемых исполняемыми вспомогательными скриптами движка. Манифест владеет назначением и аудиторией, а исходные парсеры владеют исполняемым синтаксисом.

Статус контракта

Поле Значение
Стабильность internal
Начиная с версии Не объявлено
Политика поддержки Командные строки helpers являются привязанными к ревизии интерфейсами реализации; автоматизация должна закреплять ревизию движка.
Исходный манифест BuildTools/HelperCliInterface.json
Digest контракта 346c42d340cb39623bfca5120856f5ae2d9198368758ea39ca7e672baeeb85e6

Инвентарь

Стабильный ID Helper Владелец Владелец вызова Исходный парсер Команды / глобальные аргументы
helper-cli.codegen Генерация кода build-release BuildTools/cmake/stages/Codegen.cmake BuildTools/codegen.py 0 / 10
helper-cli.codecoverage Покрытие кода quality BuildTools/cmake/stages/Applications.cmake BuildTools/codecoverage.py 4 / 0
helper-cli.gameplay-test-runner Запуск игровых тестов quality CMake-цели подключающего проекта и CI smoke-задачи игровых тестов BuildTools/gameplay_test_runner.py 0 / 3
helper-cli.ai-control-client Клиент протокола AiControl tooling ИИ-адаптеры проекта, smoke-тесты протокола и непосредственная диагностика разработчиком BuildTools/ai_control_client.py 5 / 5
helper-cli.windows7-import-check Проверка импортов Windows 7 quality CI и релизная проверка Windows 7 подключающего проекта BuildTools/check_windows7_imports.py 0 / 2
helper-cli.android-device Управление устройством Android platform Android-задачи подключающего проекта и непосредственное использование разработчиком BuildTools/android_device.py 7 / 1
helper-cli.simple-web-server Локальный Web-сервер platform payload WebServer в BuildTools/package.py BuildTools/web/simple-web-server.py 0 / 2
helper-cli.createmsi Создание MSI build-release пакет Wix в BuildTools/package.py BuildTools/msicreator/createmsi.py 0 / 2

Покрытие

Модель содержит 8 helpers, 16 подкоманд, 25 глобальных аргументов и 52 аргументов подкоманд.

Включено:

  • принадлежащие движку вспомогательные скрипты Python с фабрикой верхнего уровня create_parser();
  • точные usage и вывод справки argparse, аргументы, подкоманды, владельцы, аудитории и контекст вызова.

Исключено:

  • отдельно моделируемая командная строка BuildTools/buildtools.py;
  • отдельно моделируемая командная строка BuildTools/package.py и контракт объявления пакетов;
  • генераторы документации, тесты, библиотечные модули, shell-скрипты и инструменты подключающего проекта.
Введите запрос.