Headless workflow

PSXRecompStudio headless CLI

Build and run the current recompilation pipeline from scripts, CI, or a terminal without depending on the Avalonia GUI.

Supported CLI inputs

The production CLI accepts a PS-X EXE directly or a supported CHD disc image. For CHD input, the analysis pipeline resolves SYSTEM.CNF and the boot PS-X EXE before recompilation. Invalid or unsupported inputs fail closed with classified diagnostics.

Commands

psxrecomp recompile <input.exe|input.chd> --output <dir> [--json]
psxrecomp run       <input.exe|input.chd> [--output <dir>] [--segment-budget <n>] [--report] [--json]
psxrecomp doctor    [--json]

recompile builds a runnable generated-host artifact. run rebuilds that artifact and launches the current bounded execution path. doctor checks the OS, .NET, native runtime, and C compiler the CLI needs (exit 0 ok, 1 tooling check failed, 2 unsupported OS/architecture).

Machine-readable results and reports

--json emits deterministic machine-readable output. Exit code 0 means success, 1 means an input/tooling/build/launcher failure, and 2 means execution reached an explicit unsupported or blocked guest boundary.

run --report can create a privacy-safe diagnostic-report.zip containing a report, bounded environment metadata, sanitized diagnostics, and an Issue-ready summary. Input game bytes, RAM, save data, credentials, usernames, and local absolute paths are not bundled automatically.

Current limitation

A successful build proves that the pipeline produced and launched the artifact; it does not mean a complete commercial title is supported. Real software may still stop at an explicit unsupported BIOS, control-flow, or Runtime boundary.

Authoritative CLI documentation

For the exact option grammar, JSON envelopes, exit codes, and diagnostic-bundle contract, read docs/development/headless-cli.md.