Go to file

Chris Jones edf99326ac improve testing		2022-03-18 23:43:50 +00:00
.fauxpas	Add config blob for checking extensions in Faux Pas	2016-02-09 15:50:17 +00:00
.github/workflows	Hopefully fix the automatic milestone management when a new tag is pushed	2022-02-25 22:24:02 +00:00
Hammerspoon	Fix preload function for streamlining	2022-03-13 17:44:48 -05:00
Hammerspoon Tests	Skip some unreliable tests in CI	2021-11-20 22:46:52 +00:00
Hammerspoon.xcodeproj	Update xcodeproj files to latest version to get rid of 'recommended' settings changes we don't want	2022-03-13 15:03:58 +00:00
Hammerspoon.xcworkspace	Update xcodeproj files to latest version to get rid of 'recommended' settings changes we don't want	2022-03-13 15:03:58 +00:00
HammerspoonUITests	Fix UI Tests to load init.lua, and put in a print() so it's easier to confirm that it loaded	2016-01-26 21:57:41 +00:00
LuaSkin	improve testing	2022-03-18 23:43:50 +00:00
Pods	Update xcodeproj files to latest version to get rid of 'recommended' settings changes we don't want	2022-03-13 15:03:58 +00:00
extensions	Switch the Lua thread aliveness check to being a class method and use that in hs.http	2022-03-18 22:58:19 +00:00
scripts	Update appcast.xml for 0.9.95	2022-03-09 00:22:32 +00:00
.editorconfig	Add a root .editorconfig	2017-04-25 17:37:38 +09:00
.flake8rc	Add flake8 config, add it to Stickler and fix up some python issues in build_docs.py	2021-05-19 09:15:35 +01:00
.gitignore	Migrate from xcpretty for build output and junit test result conversion, to xcbeautify for build output and trainer for junit test result conversion	2021-06-09 00:32:15 +01:00
.luacheckrc	Stop Stickler from complaining about long Lua lines	2021-05-19 09:15:35 +01:00
.stickler.yml	Add flake8 config, add it to Stickler and fix up some python issues in build_docs.py	2021-05-19 09:15:35 +01:00
.syntastic_objc_config	Add a .syntastic_objc_config because not having it is annoying me	2015-07-24 17:09:56 +01:00
CODE_OF_CONDUCT.md	Update CoC to 1.3.0	2016-01-15 10:21:47 +00:00
CONTRIBUTING.md	Do not maim! ;)	2022-01-13 00:54:28 +00:00
CREDITS.md	Significant refactor of build settings/process (#2983 )	2021-11-16 00:25:56 +00:00
LICENSE	Updated License Date & Link	2017-10-18 08:17:07 +11:00
Podfile	Update Podfile	2022-03-08 22:50:56 +00:00
Podfile.lock	Update pods	2022-03-08 22:50:56 +00:00
README.md	Make a trivial change to increment the build number	2022-03-08 22:50:56 +00:00
SPOONS.md	Update SPOONS.md	2022-02-10 10:57:42 +00:00
appcast.xml	Update appcast.xml for 0.9.95	2022-03-09 00:22:32 +00:00
codecov.yml	Add codecov.yaml	2016-06-27 13:27:34 +01:00
requirements.txt	Add more explicit version numbers to requirements.txt. Closes #3145	2022-03-09 09:35:49 +00:00

README.md

Hammerspoon

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 install hammerspoon --cask

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:

Getting Started Guide
API docs
FAQ
Sample Configurations supplied by various users
Contribution Guide for developers looking to get involved
An IRC channel for general chat/support/development (#hammerspoon on Libera)
Google Group for support

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