Skip to content
Staggeringly powerful macOS desktop automation with Lua
Objective-C Lua C HTML Shell Python Other
Branch: master
Clone or download

Latest commit

asmagill Merge pull request #2272 from latenitefilms/issue-2254-pasteboard-wat…
…cher

[READY] Added hs.pasteboard.watcher
Latest commit c16ca61 Jun 3, 2020

Files

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 Merge branch 'LSAndCoroutines' into cmsj-tmp-mergetest Apr 7, 2020
Hammerspoon.xcodeproj Merge remote-tracking branch 'Hammerspoon/master' into issue-2254-pas… Jun 2, 2020
Hammerspoon.xcworkspace Switch LuaSkin and Hammerspoon tests to run in a random order. Apr 7, 2020
Hammerspoon Merge remote-tracking branch 'Hammerspoon/master' into issue/2208-scr… Jun 2, 2020
HammerspoonUITests Fix UI Tests to load init.lua, and put in a print() so it's easier to… Jan 26, 2016
LuaSkin Fix LuaSkin tests, in theory Apr 8, 2020
Pods Update CocoaAsyncSocket May 9, 2020
extensions Merge remote-tracking branch 'Hammerspoon/master' into issue-2254-pas… Jun 2, 2020
scripts Merge remote-tracking branch 'Hammerspoon/master' into issue-2254-pas… Jun 2, 2020
.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 Created specific rules for test scripts Nov 29, 2019
.stickler.yml Update .stickler.yml Dec 16, 2017
.syntastic_objc_config Add a .syntastic_objc_config because not having it is annoying me Jul 24, 2015
.travis.yml Save myself a step when debugging failed travis test runs Aug 15, 2019
CODE_OF_CONDUCT.md Update CoC to 1.3.0 Jan 15, 2016
CONTRIBUTING.md Add a TOC to CONTRIBUTING.md Apr 27, 2017
CREDITS.md Added Chris Hocking & Added some GitHub Links Oct 17, 2017
LICENSE Updated License Date & Link Oct 17, 2017
Makefile Adjusted Markdown Templates Apr 10, 2017
Podfile Updated CocoaAsyncSocket from 7.6.3 to 7.6.4 May 9, 2020
Podfile.lock Update CocoaAsyncSocket May 9, 2020
README.md Added Homebrew install Nov 29, 2019
SPOONS.md Added ability to pass optional alert message in spoon hotkey bindings. May 11, 2020
appcast.xml Update appcast.xml for 0.9.78 Jan 13, 2020
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
test_math.lua Add hs.math with a couple of random number functions, and use one of … Dec 23, 2019

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?

Manually

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

Homebrew

  • brew cask install hammerspoon

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.