FOnline Engine
Current master GitHub
Documentation Docs/en/reference/buildtools/commands.md

BuildTools Commands

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

Run commands from the engine repository root with python BuildTools/buildtools.py <command>. The exact usage and help blocks below are emitted by the executable parser.

env

resolve BuildTools environment

Stable ID: cli.buildtools.command.env

usage: buildtools.py env [-h] [--shell {bash,cmd,plain}] [--summary] [--summary-only]
Stable ID Argument Kind Required Values Choices Default Description
cli.buildtools.command.env.argument.shell --shell option no 1 bash, cmd, plain plain environment output syntax
cli.buildtools.command.env.argument.summary --summary option no 0 - false append the resolved environment summary
cli.buildtools.command.env.argument.summary_only --summary-only option no 0 - false print only the resolved environment summary

Exact --help output

usage: buildtools.py env [-h] [--shell {bash,cmd,plain}] [--summary] [--summary-only]

options:
  -h, --help            show this help message and exit
  --shell {bash,cmd,plain}
                        environment output syntax
  --summary             append the resolved environment summary
  --summary-only        print only the resolved environment summary

build

configure and build a target

Stable ID: cli.buildtools.command.build

usage: buildtools.py build [-h] platform target [config]
Stable ID Argument Kind Required Values Choices Default Description
cli.buildtools.command.build.argument.platform platform positional yes 1 - - engine platform key, such as linux, win64, web, or android-arm64
cli.buildtools.command.build.argument.target target positional yes 1 - - BuildTools target profile, such as client, server, baker, or unit-tests
cli.buildtools.command.build.argument.config config positional no ? - Release CMake build configuration

Exact --help output

usage: buildtools.py build [-h] platform target [config]

positional arguments:
  platform    engine platform key, such as linux, win64, web, or android-arm64
  target      BuildTools target profile, such as client, server, baker, or unit-tests
  config      CMake build configuration

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

validate

configure and validate scenarios

Stable ID: cli.buildtools.command.validate

usage: buildtools.py validate [-h] names [names ...]
Stable ID Argument Kind Required Values Choices Default Description
cli.buildtools.command.validate.argument.names names positional yes + - - one or more named validation scenarios

Exact --help output

usage: buildtools.py validate [-h] names [names ...]

positional arguments:
  names       one or more named validation scenarios

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

setup-mono

prepare mono runtime

Stable ID: cli.buildtools.command.setup-mono

usage: buildtools.py setup-mono [-h] os_name arch config
Stable ID Argument Kind Required Values Choices Default Description
cli.buildtools.command.setup-mono.argument.os_name os_name positional yes 1 - - runtime operating-system key
cli.buildtools.command.setup-mono.argument.arch arch positional yes 1 - - runtime architecture key
cli.buildtools.command.setup-mono.argument.config config positional yes 1 - - runtime build configuration

Exact --help output

usage: buildtools.py setup-mono [-h] os_name arch config

positional arguments:
  os_name     runtime operating-system key
  arch        runtime architecture key
  config      runtime build configuration

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

format-source

format engine source files

Stable ID: cli.buildtools.command.format-source

usage: buildtools.py format-source [-h]

No command-specific arguments.

Exact --help output

usage: buildtools.py format-source [-h]

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

toolset

build an existing toolset target

Stable ID: cli.buildtools.command.toolset

usage: buildtools.py toolset [-h] target
Stable ID Argument Kind Required Values Choices Default Description
cli.buildtools.command.toolset.argument.target target positional yes 1 - - target from the configured toolset build tree

Exact --help output

usage: buildtools.py toolset [-h] target

positional arguments:
  target      target from the configured toolset build tree

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

build-auxiliary

build a separately packaged auxiliary tool

Stable ID: cli.buildtools.command.build-auxiliary

usage: buildtools.py build-auxiliary [-h] {effekseer-editor} [{Debug,Release}]
Stable ID Argument Kind Required Values Choices Default Description
cli.buildtools.command.build-auxiliary.argument.target target positional yes 1 effekseer-editor - auxiliary tool to build
cli.buildtools.command.build-auxiliary.argument.config config positional no ? Debug, Release Release build configuration (default: Release)

Exact --help output

usage: buildtools.py build-auxiliary [-h] {effekseer-editor} [{Debug,Release}]

positional arguments:
  {effekseer-editor}  auxiliary tool to build
  {Debug,Release}     build configuration (default: Release)

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

prepare-workspace

prepare shared workspace parts

Stable ID: cli.buildtools.command.prepare-workspace

usage: buildtools.py prepare-workspace [-h] [--check] {toolset,emscripten,android-sdk,android-ndk,dotnet,xwin,wix,msan-libcxx} [{toolset,emscripten,android-sdk,android-ndk,dotnet,xwin,wix,msan-libcxx} ...]
Stable ID Argument Kind Required Values Choices Default Description
cli.buildtools.command.prepare-workspace.argument.parts parts positional yes + toolset, emscripten, android-sdk, android-ndk, dotnet, xwin, wix, msan-libcxx - workspace components to prepare
cli.buildtools.command.prepare-workspace.argument.check --check option no 0 - false check availability without installing or building

Exact --help output

usage: buildtools.py prepare-workspace [-h] [--check] {toolset,emscripten,android-sdk,android-ndk,dotnet,xwin,wix,msan-libcxx} [{toolset,emscripten,android-sdk,android-ndk,dotnet,xwin,wix,msan-libcxx} ...]

positional arguments:
  {toolset,emscripten,android-sdk,android-ndk,dotnet,xwin,wix,msan-libcxx}
                        workspace components to prepare

options:
  -h, --help            show this help message and exit
  --check               check availability without installing or building

repair-checkout-case

realign working-tree entry names with the git index

Stable ID: cli.buildtools.command.repair-checkout-case

usage: buildtools.py repair-checkout-case [-h] [--check]
Stable ID Argument Kind Required Values Choices Default Description
cli.buildtools.command.repair-checkout-case.argument.check --check option no 0 - false check for case drift without renaming entries

Exact --help output

usage: buildtools.py repair-checkout-case [-h] [--check]

options:
  -h, --help  show this help message and exit
  --check     check for case drift without renaming entries

package-web-debug

package the local web debug client

Stable ID: cli.buildtools.command.package-web-debug

usage: buildtools.py package-web-debug [-h] devname configs [configs ...]
Stable ID Argument Kind Required Values Choices Default Description
cli.buildtools.command.package-web-debug.argument.devname devname positional yes 1 - - short project name for binary/directory naming (e.g. LF)
cli.buildtools.command.package-web-debug.argument.configs configs positional yes + - - config names to package (e.g. RemoteSceneLaunch LocalTest)

Exact --help output

usage: buildtools.py package-web-debug [-h] devname configs [configs ...]

positional arguments:
  devname     short project name for binary/directory naming (e.g. LF)
  configs     config names to package (e.g. RemoteSceneLaunch LocalTest)

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

package-android-debug

package the local android debug client

Stable ID: cli.buildtools.command.package-android-debug

usage: buildtools.py package-android-debug [-h] devname {android-arm32,android-arm64,android-x86} configs [configs ...]
Stable ID Argument Kind Required Values Choices Default Description
cli.buildtools.command.package-android-debug.argument.devname devname positional yes 1 - - short project name for binary/directory naming (e.g. LF)
cli.buildtools.command.package-android-debug.argument.platform platform positional yes 1 android-arm32, android-arm64, android-x86 - Android target platform (e.g. android-arm64)
cli.buildtools.command.package-android-debug.argument.configs configs positional yes + - - config names to package (e.g. LocalTest)

Exact --help output

usage: buildtools.py package-android-debug [-h] devname {android-arm32,android-arm64,android-x86} configs [configs ...]

positional arguments:
  devname               short project name for binary/directory naming (e.g. LF)
  {android-arm32,android-arm64,android-x86}
                        Android target platform (e.g. android-arm64)
  configs               config names to package (e.g. LocalTest)

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

host-check

check host prerequisites

Stable ID: cli.buildtools.command.host-check

usage: buildtools.py host-check [-h] {linux,macos,windows}
Stable ID Argument Kind Required Values Choices Default Description
cli.buildtools.command.host-check.argument.host host positional yes 1 linux, macos, windows - host platform to inspect

Exact --help output

usage: buildtools.py host-check [-h] {linux,macos,windows}

positional arguments:
  {linux,macos,windows}
                        host platform to inspect

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

prepare-host-workspace

prepare host workspace and prerequisites

Stable ID: cli.buildtools.command.prepare-host-workspace

usage: buildtools.py prepare-host-workspace [-h] [--check]
                                            {linux,windows,macos}
                                            [{common-packages,linux-packages,web-packages,android-packages,windows-cross-packages,msi-packages,all-packages,linux,web,android-arm32,android-arm64,android-x86,toolset,dotnet,windows-cross,wix,msan-libcxx,all} ...]
Stable ID Argument Kind Required Values Choices Default Description
cli.buildtools.command.prepare-host-workspace.argument.host host positional yes 1 linux, windows, macos - host platform to prepare
cli.buildtools.command.prepare-host-workspace.argument.features features positional no * common-packages, linux-packages, web-packages, android-packages, windows-cross-packages, msi-packages, all-packages, linux, web, android-arm32, android-arm64, android-x86, toolset, dotnet, windows-cross, wix, msan-libcxx, all - feature groups to prepare; omit to use the host defaults
cli.buildtools.command.prepare-host-workspace.argument.check --check option no 0 - false check availability without installing or building

Exact --help output

usage: buildtools.py prepare-host-workspace [-h] [--check]
                                            {linux,windows,macos}
                                            [{common-packages,linux-packages,web-packages,android-packages,windows-cross-packages,msi-packages,all-packages,linux,web,android-arm32,android-arm64,android-x86,toolset,dotnet,windows-cross,wix,msan-libcxx,all} ...]

positional arguments:
  {linux,windows,macos}
                        host platform to prepare
  {common-packages,linux-packages,web-packages,android-packages,windows-cross-packages,msi-packages,all-packages,linux,web,android-arm32,android-arm64,android-x86,toolset,dotnet,windows-cross,wix,msan-libcxx,all}
                        feature groups to prepare; omit to use the host defaults

options:
  -h, --help            show this help message and exit
  --check               check availability without installing or building
Start typing to search.