Particulars provides a command-line interface (CLI) for use in terminal applications and scripts. If installing Particulars from the Mac App Store, the Particulars CLI package must be downloaded and installed. (To comply with Mac App Store review guidelines, the Particulars CLI cannot be included with the app and must be downloaded separately. However, once installed, the Particulars CLI does not need re-installed or upgraded when Particulars is upgraded.) When deploying the package for organizations, the Particulars CLI is included.
The examples below assume the Particulars CLI package has been installed.
The --help
option shows all the options available.
% particulars --help
Particulars 61 (414)
Usage:
particulars -v | --version
particulars --help
particulars --json | --plist
particulars OPTIONS
Options:
-a All particulars in detail level
-n, --name Computer name
-i, --modelid Model identifier
-m, --model Model name
-s, --serial Serial number
-c, --cpu, --soc CPU/SoC
-r, --ram Installed RAM
-g, --gpu GPU
-o, --osversion OS version
-D, --darwin Darwin version
-u, --uptime Uptime
-s, --disk Disk free space
-N, --network Network
As of Particulars 65 and CLI 5, a manual page is available via man particulars
.
% particulars -v
Particulars 61 (414)
© 2014-24 Fraser Hess
% particulars -u
9 days, 7 hours, 31 minutes
% particulars --soc
Apple M3 Pro
% particulars --name --osversion
pear
macOS 14.5 (Build 23F79)
% particulars -mns
rabbit
MacBook Pro (Retina, 13-inch, Late 2013)
C03M87ZPFH01
The particulars
command is installed at /usr/local/bin/particulars
.