Skip to content

Recmon is a Hammerspoon spoon to obtain system information at the press of a button.

License

Notifications You must be signed in to change notification settings

TheQuinbox/recmon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Recmon

Recmon is a Hammerspoon spoon that allows you to obtain information about your CPU load, drive usage, etc at the press of a button.

Installation

First, download and install Hammerspoon. You can do so either from their Github, or if you have it installed, through homebrew simply by running:

$ brew install Hammerspoon

in the terminal. Once you have it installed, run it, and follow the prompts to grant accessibility permissions (I also choose to hide the app from the dock here so it stays out of your command-tab switcher)

You also need to allow external apps to control VoiceOver through Apple Script. To do so, open VoiceOver utility with VO + f8, navigate to the "General" section and check the "Allow VoiceOver to be controlled with AppleScript" checkbox.

Once Hammerspoon is installed and configured, navigate into the folder where you cloned this repository with Finder or another file manager, and open "Recmon.spoon" which should cause Hammerspoon to install it into the right place. Finally, from the Hammerspoon menu extra select the open configuration option which should open your default text editor with your init.lua file. To make Recmon work and do its thing, simply add the following 2 lines:

hs.loadSpoon("recmon")
spoon.recmon:start()

Save the file, return to the Hammerspoon menu extra but this time click the reload configuration option for your new changes to take effect. Mac OS will warn you that Hammerspoon is trying to control Voice Over. Grant it permission and the spoon should start working.

Features

To use each feature, simply press ctrl+shift+the number next to it.

  1. Speak average CPU load, and how its distributed.
  2. Speak RAM usage (not working yet, see todo).
  3. Speak storage information about all connected drives.
  4. Speak OS version.
  5. Speak system uptime.
  6. Speak battery percentage, state, and time remaining.
  7. Speak information about your default input/output devices, their volume, and in the case of your input device, if its muted or not.
  8. Speak the text that's currently on your clipboard/pasteboard (if any).

Todo

  • Add RAM usage. I couldn't find a reliable way to obtain RAM usage like Activity Monitor does, because the Mac had to be a special snowflake and introduce app memory and document no way to obtain it other than activity monitor. The outline for RAM usage is there, and the hotkey is bound, it just doesn't do anything yet.

Contributing

If there's a feature you'd like to see added, feel free to open a pull request/issue. I'd prefer issues get opened before forging ahead with huge pull requests, unless the feature is already on the todo list.

Credits

Instillation instructions adapted from Indent Beeper, and Speech History.

About

Recmon is a Hammerspoon spoon to obtain system information at the press of a button.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •