Go to file

Chris Jones 0ccc9d0764 Replace another IRC server instance with Discord		2023-06-20 23:52:50 +01:00
.fauxpas	Add config blob for checking extensions in Faux Pas	2016-02-09 15:50:17 +00:00
.github/workflows	Add a workflow for manually generating release notes	2023-03-12 15:12:39 +00:00
Hammerspoon	Disable App Hang tracking in Sentry, it's flooding us with hundreds of reports	2023-03-13 09:41:23 +00:00
Hammerspoon Tests	spelling: gamma	2023-02-27 22:42:13 +00:00
Hammerspoon.xcodeproj	Prevent hs.httpserver header generation from running on every build if it doesn't have to	2023-03-06 13:45:28 +00:00
Hammerspoon.xcworkspace	Ignore xcode recommendations and remove a couple of stale NSWorkspace instances	2022-12-14 18:02:37 +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	Actually finish setting deployment target to macOS 11.0 (#3413 )	2023-03-08 09:30:10 +00:00
Pods	Revert SocketRocket pod update. Closes #3422 (#3424 )	2023-03-13 12:25:56 +00:00
extensions	Fix blockAlert documentation (#3484 )	2023-05-08 09:51:19 +01:00
scripts	Replace another IRC server instance with Discord	2023-06-20 23:52:50 +01: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	spelling: just	2023-02-27 22:42:14 +00:00
CREDITS.md	spelling: hammerspoon	2023-02-27 22:42:14 +00:00
LICENSE	Updated License Date & Link	2017-10-18 08:17:07 +11:00
Podfile	Revert SocketRocket pod update. Closes #3422 (#3424 )	2023-03-13 12:25:56 +00:00
Podfile.lock	Revert SocketRocket pod update. Closes #3422 (#3424 )	2023-03-13 12:25:56 +00:00
README.md	Replace IRC badge in README.md with Discord server invite	2023-06-20 23:47:32 +01:00
SPOONS.md	spelling: hammerspoon	2023-02-27 22:42:14 +00:00
appcast.xml	Update appcast.xml for 0.9.100	2023-03-14 17:52:19 +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

Discord: Click to join

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