16.3K ·GitHub
What is this?
Hammerspoon is a bridge between macOS and a Lua scripting engine, letting you automate and control your Mac through extensions that expose system functionality to Lua scripts.
Hammerspoon is a bridge between macOS and a Lua scripting engine, letting you automate and control your Mac through extensions that expose system functionality to Lua scripts.Is this an app I run, or a library I import into a project?It's a standalone macOS app (Hammerspoon.app) that runs in the background and executes your Lua configuration file, rather than something you embed in another project.
It's a standalone macOS app (Hammerspoon.app) that runs in the background and executes your Lua configuration file, rather than something you embed in another project.How do I install and start using it?Install via Homebrew (brew install hammerspoon --cask) or by downloading the release and dragging Hammerspoon.app to Applications. Then create ~/.hammerspoon/init.lua and fill it with your own automation code.
Install via Homebrew (brew install hammerspoon --cask) or by downloading the release and dragging Hammerspoon.app to Applications. Then create ~/.hammerspoon/init.lua and fill it with your own automation code.Do I need to know Lua before using it?Yes, you write your automations in Lua, since Hammerspoon's extensions are controlled entirely through Lua scripts.
Yes, you write your automations in Lua, since Hammerspoon's extensions are controlled entirely through Lua scripts.Does it do anything useful right out of the box?No, Hammerspoon ships empty-handed; it has no default behavior until you write your own init.lua configuration using its API and sample configs from the community.
No, Hammerspoon ships empty-handed; it has no default behavior until you write your own init.lua configuration using its API and sample configs from the community.Does it work on any Mac, or just newer ones?It's built for macOS (originally OS X) specifically; no restriction to a particular Mac chip or OS version is mentioned.
It's built for macOS (originally OS X) specifically; no restriction to a particular Mac chip or OS version is mentioned.Why does Hammerspoon exist instead of just using Mjolnir?Hammerspoon forked from Mjolnir because the team wanted a more integrated experience, whereas Mjolnir aims to stay minimal with externally hosted, Lua-package-managed extensions.
Hammerspoon forked from Mjolnir because the team wanted a more integrated experience, whereas Mjolnir aims to stay minimal with externally hosted, Lua-package-managed extensions.What kind of things can I automate with it?Since it exposes system APIs as Lua extensions, you can script things like window management, hotkeys, and other OS-level behaviors, with the project's stated goal being ever-wider coverage of system APIs and tighter integration between extensions.
Since it exposes system APIs as Lua extensions, you can script things like window management, hotkeys, and other OS-level behaviors, with the project's stated goal being ever-wider coverage of system APIs and tighter integration between extensions.What are similar projects?mas, spectacle, KiwiDesk, tmuxinator, DockDoor, awesome-zsh-plugins, finder-menu, tiny11builder
mas, spectacle, KiwiDesk, tmuxinator, DockDoor, awesome-zsh-plugins, finder-menu, tiny11builderWhich topics is it in?osx, desktop-automation, window-manager, scripting, objective-c, configuration, lua, hacking, apple, homebrew, sysadmin, customization
osx, desktop-automation, window-manager, scripting, objective-c, configuration, lua, hacking, apple, homebrew, sysadmin, customization