https://github.com/cmpadden/wm.spoon
Hammerpoon Window Manager
https://github.com/cmpadden/wm.spoon
Last synced: 4 months ago
JSON representation
Hammerpoon Window Manager
- Host: GitHub
- URL: https://github.com/cmpadden/wm.spoon
- Owner: cmpadden
- Created: 2024-05-13T03:14:56.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-02T22:27:02.000Z (5 months ago)
- Last Synced: 2026-02-03T10:59:27.020Z (5 months ago)
- Language: Lua
- Homepage:
- Size: 82 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# wm.spoon
Window manager built on top of [Hammerspoon](https://www.hammerspoon.org/)--the automation framework for macOS.
## Installation
Download the latest [release](https://github.com/cmpadden/wm.spoon/releases/), decompress the file, and double click the Spoon, or run the following commands:
```bash
# Replace with your desired version
λ curl -L -O "https://github.com/cmpadden/wm.spoon/releases/download/v0.2.3/wm.spoon.zip"
# The Hammerspoon Console should open and indicate that plugin has loaded
λ unzip wm.spoon.zip && open wm.spoon
```
Refer to the [official documentation](https://github.com/Hammerspoon/hammerspoon/blob/master/SPOONS.md) for more information on Spoons, and how to install them.
## Usage
There are two primary concepts of `wm.spoon`: **layouts** and **geometries**. To use `wm.spoon` one must first define a layouts (or many), which is a table of geometries. A geometry is a built-in utility of Hammerspoon, [hs.geometry](https://www.hammerspoon.org/docs/hs.geometry.html), that represents the height, width, and x-and-y positions of a rectangle.
The user defines an table of layouts on `config.layouts`, which are bound to ` + 1, 2, 3, ... n`; using these hotkeys one can cycle through window layouts.
Then, the user can cycle the position of a window between the geometries of this layout using ` + h`, and ` + l` by default.
After moving windows to their desired positions, the state can be saved using the default binding of ` + -`.
## Configuration
When initializing `wm.spoon`, the user is required to define their layouts, however, they also have the option to tweak key bindings along with a variety of other options.
A collection of pre-defined geometries can be found in `spoon.wm.builtins`.
```lua
hs.loadSpoon("wm")
spoon.wm.config.layouts = {
-- ┌-----------─┐
-- | [ ] |
-- | [ ] |
-- └------------┘
{
spoon.wm.builtins.full,
spoon.wm.builtins.pip_bottom_right,
},
-- ┌-----------─┐
-- | [ ][ ] |
-- | [ ][ ] |
-- └------------┘
{
spoon.wm.builtins.padded_left,
spoon.wm.builtins.padded_right,
spoon.wm.builtins.pip_bottom_right,
},
-- ┌-----------─┐
-- | [ ] |
-- | [ ] |
-- └------------┘
{
spoon.wm.builtins.padded_center,
spoon.wm.builtins.pip_bottom_right,
},
-- ┌-----------─┐
-- | [ ] |
-- | [ ] |
-- └------------┘
{
spoon.wm.builtins.skinny,
spoon.wm.builtins.pip_top_right,
},
}
spoon.wm:init()
```
---
