CLI

CLI

A command line tool ships inside the app bundle:

/Applications/SupportCompanion.app/Contents/Resources/SupportCompanionCLI <command>

Commands

Command	What it does
version	The installed app version.
prefs	The preferences the app currently sees.
reset	Reset preferences to their built-in defaults.
action <name>	Trigger one of your actions by name.
battery	Battery information.
device	Device information.
storage	Storage information.
mdm	MDM information.
user	User information.
kerberos	Kerberos SSO information.
psso	Platform SSO information.
help	This list.

prefs and reset

prefs prints what the app reads, which is a useful first step when a setting seems to do nothing:

Current UserDefaults values for com.github.macadmins.SupportCompanion:
{
    NotificationTitle = "Support Companion";
    NotificationInterval = 4;
    BrandName = "Support Companion";
    Mode = "Intune";
    ...
}

reset puts the preferences the app owns back to their built-in values.

Two caveats since 3.0.0:

• Values forced by a configuration profile always win. reset cannot clear them and defaults write cannot override them.
• The settings that grant privileges — elevation, IsPrivileged, the installer allowlist — are read only from administrator-managed sources, so they are not affected by reset and setting them here does nothing. See Configuration.

action

./SupportCompanionCLI action "Run Munki Check"

The name must match an entry in Actions. The CLI builds a supportcompanion://run?action=… URL and hands it to the app, so names containing spaces, & or # arrive intact. A privileged action still authenticates first if RequirePrivilegedActionAuthentication is set, and still runs through the helper, which looks the command up itself.

Output examples

battery

🔋 Battery Information
-----------------------
Health:          88% 🔋
Cycle Count:     48
Temperature:     33.0°C 🌡️
Charging Status: Not Charging
Time Remaining:  N/A

device

💻 Device Information
-----------------------
Hostname:       Awesome Mac
Model:          MacBook Pro (14-inch, Nov 2023)
Serial Number:  123456789
Processor:      Apple M3 Pro
Memory:         36 GB
IP Address(es): 192.168.68.100
Last Reboot:    7 Hours
OS Version:     15.3.1
OS Build:       24D70

storage

💾 Storage Information
-----------------------
Storage Name:  Macintosh HD
Usage:         ▓▓▓▓▓░░░░░ 51.6%
FileVault:     Enabled ✅

mdm

🔒 MDM Information
-----------------------
Enrolled:      Yes (User Approved)
ABM:           Yes
MDM URL:       i.manage.microsoft.com/DeviceGatewayProxy/ioshandler.ashx?Platform=MacMDM

user

👤 User Information
-----------------------
Login: Geralt
Name: Geralt of Rivia
Home Directory: /Users/Geralt
Shell: /bin/zsh
Admin: Yes

kerberos

🎟 Kerberos SSO Information
-----------------------
Username: geroriv
Realm: KAER.MORHEN
Password Expires: 13 days
Last Password Change: 76 days
Last Local Password Change: 98 days

psso

🎟 Platform SSO Information
-----------------------
Login Frequency: 64800
Login Type: Secure Enclave
New User Autorization Mode: None
Registration Completed: false
SDK Version: Unknown
Shared Device Keys: true
User Authorization Mode: Unknown