Skip to content
Please note that GitHub no longer supports Internet Explorer.

We recommend upgrading to the latest Microsoft Edge, Google Chrome, or Firefox.

Learn more
Staggeringly powerful OS X desktop automation with Lua
Branch: master
Clone or download
Cannot retrieve the latest commit at this time.
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.fauxpas Add config blob for checking extensions in Faux Pas Feb 9, 2016
Hammerspoon Tests
Hammerspoon.xcodeproj
Hammerspoon.xcworkspace
Hammerspoon Prepare for 0.9.73 Oct 19, 2018
HammerspoonUITests Fix UI Tests to load init.lua, and put in a print() so it's easier to… Jan 26, 2016
LuaSkin Disable some warnings in liblua.a since we're not going to modify ups… Oct 31, 2018
Pods Update MIKMIDI Pod to 1.7.0. Closes #2009 Jan 30, 2019
extensions
scripts Use the cocoapods version of Fabric's upload-symbols instead of the s… Oct 17, 2018
.bettercodehub.yml Add config file for BetterCodeHub Apr 11, 2017
.editorconfig Add a root .editorconfig Apr 25, 2017
.gitignore Add rebuild.sh for folks doing self-signed local builds. Closes #1160 Dec 25, 2016
.luacheckrc Update .luacheckrc Mar 15, 2018
.stickler.yml
.syntastic_objc_config
.travis.yml
CODE_OF_CONDUCT.md Update CoC to 1.3.0 Jan 15, 2016
CONTRIBUTING.md
CREDITS.md Added Chris Hocking & Added some GitHub Links Oct 17, 2017
LICENSE Updated License Date & Link Oct 17, 2017
Makefile
Podfile Update MIKMIDI Pod to 1.7.0. Closes #2009 Jan 30, 2019
Podfile.lock
README.md
SPOONS.md Fix a Lua syntax error in SPOONS.md. Closes #1594 Nov 22, 2017
appcast.xml
codecov.yml Add codecov.yaml Jun 27, 2016
requirements.txt Switch to mistune for MD rendering, fix up CSS to current version, fi… Jan 6, 2017

README.md

Hammerspoon

IRC Build Status codecov.io Downloads current release Downloads all releases Latest tag Latest release

What is Hammerspoon?

This is a tool for powerful automation of OS X. At its core, Hammerspoon is just a bridge between the operating system and a Lua scripting engine.

What gives Hammerspoon its power is a set of extensions that expose specific pieces of system functionality, to the user. With these, you can write Lua scripts to control many aspects of your OS X environment.

How do I install it?

  • Download the latest release
  • Drag Hammerspoon.app from your Downloads folder to Applications

What next?

Out of the box, Hammerspoon does nothing - you will need to create ~/.hammerspoon/init.lua and fill it with useful code. There are several resources which can help you:

What is the history of the project?

Hammerspoon is a fork of Mjolnir by Steven Degutis. Mjolnir aims to be a very minimal application, with its extensions hosted externally and managed using a Lua package manager. We wanted to provide a more integrated experience.

What is the future of the project?

Our intentions for Hammerspoon broadly fall into these categories:

  • Ever wider coverage of system APIs in Extensions
  • Tighter integration between extensions
  • Smoother user experience
You can’t perform that action at this time.