DOCSEARCHbyAlgolia
Submit Docs

Spacehammer Documentation

repository·master·Indexed 20 days ago

https://github.com/agzam/spacehammer

A Hammerspoon-based modal toolkit inspired by Spacemacs and Doom Emacs, providing a mnemonic, keyboard-driven workflow for window management, application switching, and multimedia control using a LEAD key and hierarchical menus.

Tokens
306
Snippets
1
Records
3
Agent score
21%

What's inside Spacehammer

  1. Configure the LEAD keybinding

    master

    The LEAD keybinding is the primary trigger for the Spacehammer modal. By default, it is set to Option+SPC.

    To customize it, edit ~/.spacehammer/config.fnl and modify the :mods and :key bindings for the lib.modal:activate-modal action string.

    Note on Cmd+SPC: If you wish to use Cmd+SPC as your LEAD key, you must first rebind Cmd+SPC in your macOS System Preferences (Keyboard settings) to avoid conflicts with Spotlight.

  2. Install Spacehammer via Homebrew

    master

    Install Spacehammer using Homebrew. If you have an existing custom configuration in a Git repository, you can specify it during installation using the HOMEBREW_SPACEHAMMER_CONFIG environment variable.

    # Standard installation
brew tap agzam/spacehammer
brew install spacehammer

# Installation with a custom Git config
HOMEBREW_SPACEHAMMER_CONFIG=git@github.com:username/my-config.git \
brew install spacehammer

  3. Configure Modal Menu Items

    master
    Menu items are defined in ~/.spacehammer/config.fnl. They map a key binding to an action (either a Fennel function or a `