Reporting

You can use the patch command line tool to generate a comprehensive Patch Report. This report includes details about each installed app on your Mac that exists in the Patch Catalog. Additionally, it provides information on update deferrals, including reasons and timestamps, the installed version of Patch, and various macOS system details.

A few examples of executing the report subcommand in Terminal:

# Generate a Patch Report that includes all installed apps that exist in the Patch Catalog
sudo patch report

# Limit the report to include only updatable (out-of-date) apps
sudo patch report --updatable

# Write the Patch Report to a file
sudo patch report --out-file /path/to/report.json

tip

Use the --updatable flag to generate a Patch Report that includes only the apps with available updates:

sudo patch report --updatable

Example Output

{
  "appInventory" : [
    {
      "deferralLimit" : 5,
      "id" : "1password", /* The app ID in the Patch Catalog */
      "managementType" : "updateOnly",
      "version" : "8.10.46.266664" /* The installed version of the app */
    },
    {
      "deferralLimit" : 5,
      "id" : "docker-desktop",
      "managementType" : "updateOnly",  /* How the app is manged by Alectrona Patch */
      "version" : "4.34.3"
    },
    {
      "deferralCount" : 1, /* The current number of deferrals for the app */
      "deferralLimit" : 5, /* The specified deferral limit for the app */
      /* Deferral details including reasons and timestamps */
      "deferrals" : [
        {
          "reason" : "Respect meetings deferral (Zoom meeting in progress)",
          "timestamp" : "2024-10-10T17:09:41Z"
        }
      ],
      "id" : "visual-studio-code",
      "managementType" : "updateOnly",
      "version" : "1.94.2"
    },
    {
      "deferralLimit" : 5,
      "id" : "jq",
      "managementType" : "installOrUpdate",
      "version" : "1.7.1"
    },
    {
      "deferralLimit" : 5,
      "id" : "vlc",
      "version" : "3.0.21"
    }
  ],
  "machineInfo" : {
    "architecture" : "arm64",
    "consumedCapacityGB" : 1076.24,
    "hostName" : "Road Warrior's MacBook Pro",
    "machineId" : "397A723F-A865-4A39-B286-8FA8C8444BD5",
    "model" : "MacBookPro18,2",
    "physicalMemoryGB" : 64,
    "serialNumber" : "QWERTY1234",
    "storageCapacityGB" : 3721.87,
    "uptimeSeconds" : 123048 /* System uptime in seconds */
  },
  "osInfo" : {
    "osBuild" : "24A348",
    "osVersion" : "15.0.1",
    "platform" : "macOS"
  },
  "patchInfo" : {
    "build" : "1071",
    "cacheSizeMB" : 437.29,
    "cachedInstallerCount" : 2,
    /* The installers currently cached by Alectrona Patch */
    "cachedInstallers" : [
      "visual-studio-code-1.94.2.zip",
      "spotify-1.2.48.405.dmg"
    ],
    /* When Alectrona Patch last ran update tasks */
    "lastUpdateTaskRun" : "2024-10-15T14:07:50Z",
    "managedConfig" : {
      "com.alectrona.patch" : {
        "DisableSelfUpdate" : true,
        "EnableDashboardReporting" : true
      },
      "com.alectrona.patch-agent" : {
        "InstallOrUpdate" : [
          "1password",
          "rectangle",
          "jamf-actions"
        ],
        "RespectMeetings" : true,
        "RunInterval" : 3600,
        "UpdateAll" : true
      },
      "com.alectrona.patch-notifier" : {
        "DeferralLimit" : 5,
        "DeferralLimitExceptions" : {
          "slack" : 2,
          "zoom-us" : 0
        },
        "DialogTimeout" : 10,
        "DialogTransparencyLevel" : false,
        "DisplayOnActiveScreen" : true,
        "RecordTimeoutAsDeferral" : true
      }
    },
    /* The number of update tasks that have ran */
    "updateTaskRunCount" : 193,
    "version" : "2.2"
  },
  "timestamp" : "2024-10-15T14:07:50Z"
}