Skip to content
Margo v0.0.22

Doctor report schema

#

This schema describes the complete report produced by margo doctor --diagnostics json, including renderer candidates and their availability.

Margo doctor report v1

The JSON envelope emitted by margo doctor --diagnostics json.

  • buildobject*

    Identity of the Margo binary that produced the report.

    • archstring*

      Target architecture.

    • commitstring*

      Source commit used to build the binary.

    • goVersionstring*

      Go toolchain identity.

    • osstring*

      Target operating system.

    • versionstring*

      Margo release or development version.

  • candidatesarray*

    PDF engine candidates in deterministic discovery order.

    • *
      • availableboolean*

        Whether the candidate can be selected for rendering.

      • codestring

        Stable diagnostic code when discovery or probing failed.

      • compiledboolean*

        Whether this candidate is compiled into the binary.

      • namestring*

        Engine name.

      • pathstring

        Executable path when the candidate is external.

      • reasonstring

        Human-readable discovery or probe explanation.

      • sourcestring*

        How the candidate was discovered.

        enum=["flag","environment","path","known-location","native"]

      • versionstring

        Detected executable version.

Used by

  • The margo doctor JSON output.
  • Automation that records local PDF renderer availability.
  • margo schema doctor-report, which emits the exact embedded bytes.