Command-line interface (CLI)

Particulars provides a command-line interface (CLI) for use in terminal applications and scripts. Before this interface can be used, the ParticularsCLI 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.)

The examples below assume the ParticularsCLI package has been installed.


The --help option shows all the options available.

$ particulars --help
Particulars 48 (304)
   particulars -v | --version
   particulars --help
   particulars --json | --plist
   particulars 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
   -x, --server     Server version
   -D, --darwin     Darwin version
   -u, --uptime     Uptime
   -s, --disk       Disk free space
   -N, --network    Network


$ particulars -v
Particulars 48 (304)
© 2014-22 Fraser Hess

$ particulars -u
9 days, 7 hours, 31 minutes

$ particulars --cpu
Intel® Core™ i5-4288U @ 2.60GHz

$ particulars --name --osversion
macOS 12.5.1 (Build 21G83)

$ particulars -mns
MacBook Pro (Retina, 13-inch, Late 2013)

Installation Location

The particulars command is installed at /usr/local/bin/particulars.

Help Home