Command-line interface (CLI)

Particulars provides a command-line interface (CLI) for use in terminal applications and scripts. Before you can use this interface, you must download and install the ParticularsCLI package. (To comply with Mac App Store submission guidelines, the Particulars CLI cannot be included with the app and therefore must be downloaded separately. However, once installed, the Particulars CLI does not need re-installed or upgraded every time you upgrade Particulars.)

The examples below assume the ParticularsCLI package has been installed.


The --help option shows all the options available.

$ particulars --help
Particulars 37 (196)
   particulars -v | --version
   particulars --help
   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
   -w, --darwin     Darwin version
   -u, --uptime     Uptime
   -s, --disk       Disk free space
   -t, --network    Network


$ particulars -v
Particulars 37 (196)
© 2014-21 Fraser Hess

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

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

$ particulars --name --osversion --server
macOS 10.14.5 (Build 18F132)
macOS Server 5.8 (Build 18S2071)

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

Installation Location

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

Help Home