Function build_run

unity_cli/cli/commands/build.py:80–149

Execute a player build (BuildPipeline.BuildPlayer) and report results. Defaults use the project's current Build Settings. Override --target for a different platform or --scene to pick a one-off scene set. Exits non-zero on build failure. --target accepts Unity BuildTarget names, e.

(
    ctx: typer.Context,
    target: Annotated[
        str | None,
        typer.Option("--target", "-t", help="BuildTarget (e.g., StandaloneWindows64, Android, WebGL)"),
    ] = None,
    output: Annotated[
        str | None,
        typer.Option("--output", "-o", help="Output path"),
    ] = None,
    scenes: Annotated[
        list[str] | None,
        typer.Option("--scene", "-s", help="Scene paths to include (repeatable)"),
    ] = None,
    json_flag: Annotated[
        bool,
        typer.Option("--json", help="Output as JSON"),
    ] = False,
)

@build_app.command("run")
def build_run(
    ctx: typer.Context,
    target: Annotated[
        str | None,
        typer.Option("--target", "-t", help="BuildTarget (e.g., StandaloneWindows64, Android, WebGL)"),
    ] = None,
    output: Annotated[
        str | None,
        typer.Option("--output", "-o", help="Output path"),
    ] = None,
    scenes: Annotated[
        list[str] | None,
        typer.Option("--scene", "-s", help="Scene paths to include (repeatable)"),
    ] = None,
    json_flag: Annotated[
        bool,
        typer.Option("--json", help="Output as JSON"),
    ] = False,
) -> None:
    """Execute a player build (BuildPipeline.BuildPlayer) and report results.

    Defaults use the project's current Build Settings. Override --target for
    a different platform or --scene to pick a one-off scene set. Exits non-zero
    on build failure.

    --target accepts Unity BuildTarget names, e.g.:
      StandaloneWindows64, StandaloneOSX, StandaloneLinux64, Android, iOS, WebGL.

    Examples:
        u build run                                          # Use current settings
        u build run -t StandaloneOSX -o Build/Mac/App.app
        u build run -t Android -o Build/app.apk -s Assets/Scenes/Main.unity
    """
    context: CLIContext = ctx.obj
    try:
        result = context.client.build.build(
            target=target,
            output_path=output,
            scenes=scenes,
        )
        if _should_json(context, json_flag):
            print_json(result)
        else:
            build_result = result.get("result", "Unknown")
            if build_result == "Succeeded":
                print_success(f"Build succeeded: {result.get('outputPath', '')}")
            else:
                print_error(f"Build {build_result}", "BUILD_FAILED")

            total_time = result.get("totalTime", 0)
            total_size = result.get("totalSize", 0)
            print_line(f"  Time: {total_time:.1f}s")
            print_line(f"  Size: {total_size} bytes")
            print_line(f"  Target: {result.get('target', '')}")
            print_line(f"  Errors: {result.get('totalErrors', 0)}")
            print_line(f"  Warnings: {result.get('totalWarnings', 0)}")

            messages = result.get("messages", [])