Documentation Docs/en/reference/buildtools/index.md

Generated BuildTools CLI Reference

Generated reference. Do not edit this page directly. Update BuildTools/buildtools.py, then run python BuildTools/docs_cli.py --write.

Reference index

Commands

Canonical JSON model

Generation contract

This reference is generated from the same argparse.ArgumentParser used by the executable BuildTools entry point. Parser changes therefore make the committed model and pages stale.

Contract status

Field	Value
Stability	`internal`
Since	Not declared
Support policy	No versioned CLI support line is declared; pin an engine revision in automation.
Source parser	BuildTools/buildtools.py
Contract digest	`fe4230108f54098166ceb508251225ab910d03b975cd7bd5267b7c212341d27d`

Coverage

Reference	Entries	Purpose
Commands	13	Commands with 25 command-specific arguments.
Global arguments	0	Arguments accepted before a command.

Top-level help

usage: buildtools.py [-h] {env,build,validate,setup-mono,format-source,toolset,build-auxiliary,prepare-workspace,repair-checkout-case,package-web-debug,package-android-debug,host-check,prepare-host-workspace} ...

Shared BuildTools helpers

positional arguments:
  {env,build,validate,setup-mono,format-source,toolset,build-auxiliary,prepare-workspace,repair-checkout-case,package-web-debug,package-android-debug,host-check,prepare-host-workspace}
    env                 resolve BuildTools environment
    build               configure and build a target
    validate            configure and validate scenarios
    setup-mono          prepare mono runtime
    format-source       format engine source files
    toolset             build an existing toolset target
    build-auxiliary     build a separately packaged auxiliary tool
    prepare-workspace   prepare shared workspace parts
    repair-checkout-case
                        realign working-tree entry names with the git index
    package-web-debug   package the local web debug client
    package-android-debug
                        package the local android debug client
    host-check          check host prerequisites
    prepare-host-workspace
                        prepare host workspace and prerequisites

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

Boundary

Included:

top-level commands and arguments exposed by BuildTools/buildtools.py create_parser()
argparse defaults, choices, cardinality, descriptions, usage, and –help output

Excluded from this slice:

helper-script command lines outside BuildTools/buildtools.py
package.py declaration and payload contracts
validation-target semantics and internal Python helpers

Excluded surfaces remain implementation details until an owning parser-backed contract and compatibility policy are published.