FOnline Engine
Current master GitHub
Documentation Docs/en/reference/helper-cli/index.md

Generated Helper CLI Reference

Generated reference. Do not edit this page directly. Update BuildTools/HelperCliInterface.json or the owning executable parser, then run python BuildTools/docs_helper_cli.py --write.

Reference index Commands Canonical JSON model Generation contract

This reference is generated from the argparse.ArgumentParser objects used by executable engine helper scripts. The manifest owns purpose and audience; source parsers own executable syntax.

Contract status

Field Value
Stability internal
Since Not declared
Support policy Helper command lines are revision-pinned implementation interfaces; automation must pin an engine revision.
Source manifest BuildTools/HelperCliInterface.json
Contract digest 346c42d340cb39623bfca5120856f5ae2d9198368758ea39ca7e672baeeb85e6

Inventory

Stable ID Helper Owner Invocation owner Parser source Commands / global args
helper-cli.codegen Code generation build-release BuildTools/cmake/stages/Codegen.cmake BuildTools/codegen.py 0 / 10
helper-cli.codecoverage Code coverage quality BuildTools/cmake/stages/Applications.cmake BuildTools/codecoverage.py 4 / 0
helper-cli.gameplay-test-runner Gameplay test runner quality embedding-project CMake targets and CI gameplay smoke jobs BuildTools/gameplay_test_runner.py 0 / 3
helper-cli.ai-control-client AiControl protocol client tooling embedding-project AI adapters, protocol smoke tests, and direct developer diagnostics BuildTools/ai_control_client.py 5 / 5
helper-cli.windows7-import-check Windows 7 import validation quality embedding-project Windows 7 CI and release validation BuildTools/check_windows7_imports.py 0 / 2
helper-cli.android-device Android device control platform embedding-project Android tasks and direct developer use BuildTools/android_device.py 7 / 1
helper-cli.simple-web-server Local web server platform BuildTools/package.py WebServer payload BuildTools/web/simple-web-server.py 0 / 2
helper-cli.createmsi MSI creation build-release BuildTools/package.py Wix pack BuildTools/msicreator/createmsi.py 0 / 2

Coverage

The model contains 8 helpers, 16 subcommands, 25 global arguments, and 52 subcommand arguments.

Included:

  • engine-owned Python helper scripts that expose a top-level create_parser() factory
  • exact argparse usage, help output, arguments, subcommands, ownership, audience, and invocation context

Excluded:

  • the separately modeled BuildTools/buildtools.py command line
  • the separately modeled BuildTools/package.py command line and package declaration contract
  • documentation generators, tests, library-only modules, shell scripts, and embedding-project tools
Start typing to search.