search

ashfinal / awesome-hammerspoon

awesome configuration for Hammerspoon.
http://www.hammerspoon.org
MIT License
1.25k stars 173 forks source link
automation awesome config dotfiles hammerspoon macos productivity

readme

awesome-hammerspoon configuration

awesome-hammerspoon is my configuration for Hammerspoon. It has highly modal-based, vim-style keybindings, provides some functionality like desktop widgets, window management, application launcher, instant search, aria2 frontend ... etc.

Get started

  1. Install Hammerspoon first.

  2. git clone https://github.com/ashfinal/awesome-hammerspoon.git ~/.hammerspoon

  3. Reload the configutation.

Keep update

cd ~/.hammerspoon && git pull

How to use

Just press opt, plus A or C or R… to start. If need help, press tab to toggle the keybindings cheatsheet.

Press opt + ? to toggle the help panel, which will show all opt related keybindings.

Screenshots

These screenshots demostrate what awesome-hammerspoon is capable of. Learn more about built-in Spoons.

Desktop widgets

More details ![widgets](https://github.com/ashfinal/bindata/raw/master/screenshots/awesome-hammerspoon-deskwidgets.png)

Window manpulation ⌥ + R

More details ![winresize](https://github.com/ashfinal/bindata/raw/master/screenshots/awesome-hammerspoon-winresize.gif)

Search something ⌥ + G

More details ![hsearch](https://github.com/ashfinal/bindata/raw/master/screenshots/awesome-hammerspoon-hsearch.gif)

aria2 Frontend ⌥ + D

More details ![hsearch](https://github.com/ashfinal/bindata/raw/master/screenshots/awesome-hammerspoon-aria2.png) You need to [run aria2 with RPC enabled](https://github.com/ashfinal/awesome-hammerspoon/wiki/Run-aria2-with-rpc-enabled) before using this. Config aria2 host and token in `~/.hammerspoon/private/config.lua`, then you're ready to go. ```lua hsaria2_host = "http://localhost:6800/jsonrpc" -- default host hsaria2_secret = "token" -- YOUR OWN SECRET ```

Customization

More details ```shell cp ~/.hammerspoon/config-example.lua ~/.hammerspoon/private/config.lua ``` Then modify the file `~/.hammerspoon/private/config.lua`: - Add/remove Spoons. Define `hspoon_list` to decide which Spoons (a distributing format of Hammerspoon module) to be loaded. There are 15 built-in Spoons, learn about them at [here](https://github.com/ashfinal/awesome-hammerspoon/wiki/The-built-in-Spoons). *There are more Spoons at [official spoon repository](http://www.hammerspoon.org/Spoons/) (you may need a little config before using them).* - Customize keybindings Please read `~/.hammerspoon/private/config.lua`for more details. Finally press `cmd + ctrl + shift + r` to reload the configuration.

Contribute

More details - Improve existing Spoons A "Spoon" is just a directory, right-click on it -> "Show Package Contents". Feel free to file issues or open PRs. - Create new Spoons Some resources you may find helpful: [Learn Lua in Y minutes](http://learnxinyminutes.com/docs/lua/) [Getting Started with Hammerspoon](http://www.hammerspoon.org/go/) [Hammerspoon API Docs](http://www.hammerspoon.org/docs/index.html) [hammerspoon/SPOONS.md at master · Hammerspoon/hammerspoon](https://github.com/Hammerspoon/hammerspoon/blob/master/SPOONS.md)

Thanks to

More details [https://github.com/zzamboni/oh-my-hammerspoon](https://github.com/zzamboni/oh-my-hammerspoon) [https://github.com/scottcs/dot_hammerspoon](https://github.com/scottcs/dot_hammerspoon) [https://github.com/dharmapoudel/hammerspoon-config](https://github.com/dharmapoudel/hammerspoon-config) [http://tracesof.net/uebersicht/](http://tracesof.net/uebersicht/)