Hammerspoon 2 API Documentation
ReferenceWelcome to the Hammerspoon 2 API reference. Browse modules for top-level functionality, or explore types for object APIs.
Modules
Modules are the main entry points for Hammerspoon functionality, accessible via the hs global.
console
protocols · functions
hs
protocols · functions
hs.appinfo
protocols · functions
hs.application
protocols · functions
hs.audiodevice
protocols · functions
hs.ax
protocols · functions
hs.bonjour
protocols · functions
hs.camera
protocols · functions
hs.chooser
protocols · functions
hs.docs
protocols · functions
hs.eventtap
protocols · functions
hs.fs
protocols · functions
hs.hash
protocols · functions
hs.hotkey
protocols · functions
hs.http
protocols · functions
hs.httpserver
protocols · functions
hs.ipc
protocols · functions
hs.keycodes
protocols · functions
hs.locale
protocols · functions
hs.location
protocols · functions
hs.menubar
protocols · functions
hs.midi
protocols · functions
hs.mouse
protocols · functions
hs.network
protocols · functions
hs.notify
protocols · functions
hs.ocr
protocols · functions
hs.osascript
protocols · functions
hs.pasteboard
protocols · functions
hs.permissions
protocols · functions
hs.plist
protocols · functions
hs.power
protocols · functions
hs.screen
protocols · functions
hs.serial
protocols · functions
hs.sharing
protocols · functions
hs.shortcuts
protocols · functions
hs.sound
protocols · functions
hs.spotlight
protocols · functions
hs.task
protocols · functions
hs.timer
protocols · functions
hs.translation
protocols · functions
hs.ui
protocols · functions
hs.urlevent
protocols · functions
hs.usb
protocols · functions
hs.userdefaults
protocols · functions
hs.wifi
protocols · functions
hs.window
protocols · functions
Types
Types represent objects that can be created and manipulated in Hammerspoon scripts.