Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jasonrudolph/keyboard

⌨ Toward a more useful keyboard
https://github.com/jasonrudolph/keyboard

caps-lock hammerspoon hjkl karabiner keyboard markdown productivity seil sizeup vim

Last synced: 3 days ago
JSON representation

⌨ Toward a more useful keyboard

Awesome Lists containing this project

README 

        
## Toward a more useful keyboard



Steve Losh's [Modern Space Cadet][modern-space-cadet] is an inspiration.

It opened my eyes to the fact that there's a more useful keyboard hidden inside the vanilla QWERTY package that most of us have tolerated for all these years.

This repo represents my nascent quest to unleash that more useful keyboard.



At first, this might sound no different than the typical Emacs/Vim/\ tweakfest.

But it is.

I'm not talking about honing my editor-of-choice.

I'm not talking about pimping out my shell.

I want a more useful keyboard _everywhere_.

Whether I'm in my editor, in the terminal, in the browser, or in Keynote,

I want a more useful keyboard.



And ideally, I want the _same_ (more useful) keyboard in every app.

Ubiquitous keyboarding.

Muscle memory.

[Don't make me think][don't-make-me-think].



How do I go to the beginning of the line in this app?

The same way I go to the beginning of the line in _every_ app!

Don't make me think.



How do I go to the top of the file/screen/page in this app?

The same way I...

Well, you get the point.



## More useful (for me)



> **cus·tom·ize** (_verb_): to modify or build according to individual or personal specifications or preference [[dictionary.com][customize]]



Any customization is, by definition, personal.

While I find that these customizations yield a more-useful keyboard for me, they might not feel like a win for you.



## Features



- [Access control and escape on the home row](#a-more-useful-caps-lock-key)

- [Navigate (up/down/left/right) via the home row](#super-duper-mode)

- [Navigate to previous/next word via the home row](#super-duper-mode)

- [Arrange windows via the home row](#window-layout-mode)

- [Enable other commonly-used actions on or near the home row](#miscellaneous-goodness)

- [Format text as Markdown](#markdown-mode)

- [Launch commonly-used apps via global keyboard shortcuts](#hyper-key-for-quickly-launching-apps)

- [And more...](#miscellaneous-goodness)



### A more useful caps lock key



By repurposing the anachronistic caps lock key, we can make control and escape accessible via the home row.



- Tap caps lock for escape

- Hold caps lock for control



📣 Shout-out to [@arbelt](https://github.com/arbelt) and [@jasoncodes](https://github.com/jasoncodes) for [the implementation](https://github.com/jasonrudolph/keyboard/commit/01a7a5bd8a1e521756d1ec34769119ead5eee0b3). ⚡️🍻🌟



### (S)uper (D)uper Mode



To activate, push the s and d keys simultaneously and hold them down. Now you're in (S)uper (D)uper Mode. It's like a secret keyboard _inside_ your keyboard. (Whoa.) It's optimized for keeping you on the home row, or very close to it. Now you can:



- Use h / j / k / l for **left**/**down**/**up**/**right** respectively

- Use a for option (AKA alt)

- Use f for command

- Use space for shift

- Use a + j / k for page down / page up

- Use i / o to move to the previous/next tab

- Use u / p to go to the first/last tab (in most apps)

- Use a + h / l to move to previous/next word (in most apps)



[(S)uper (D)uper Mode Keybindings](https://cloud.githubusercontent.com/assets/2988/22397420/f2b3e346-e53e-11e6-97bb-9db71f86994b.png)



📣 Shout-out to [Karabiner's Simultaneous vi Mode](https://github.com/tekezo/Karabiner/blob/05ca98733f3e3501e0679814c3795d1cb57e177f/src/core/server/Resources/include/checkbox/simultaneouskeypresses_vi_mode.xml#L4-L10) for providing the inspiration for (S)uper (D)uper Mode. ⌨:neckbeard:✨



### Window Layout Mode



Quickly arrange and resize windows in common configurations, using keyboard shortcuts that are on or near the home row. (Or, feel free to [choose your own keyboard shortcuts](#choose-your-own-keybindings).)



#### Default keybindings



Use control + s to turn on Window Layout Mode. Then, use any shortcut below to make windows do your bidding. For example, to send the window left, hit control + s, and then hit h.



- Use h to send window left (left half of screen)

- Use j to send window down (bottom half of screen)

- Use k to send window up (top half of screen)

- Use l to send window right (right half of screen)

- Use shift + h to send window to left 40% of screen

- Use shift + l to send window to right 60% of screen

- Use i to send window to upper left quarter of screen

- Use o to send window to upper right quarter of screen

- Use , to send window to lower left quarter of screen

- Use . to send window to lower right quarter of screen

- Use space to send window to center of screen

- Use enter to resize window to fill the screen

- Use n to send window to the next monitor

- Use ← to send window to the monitor on the left (if there is one)

- Use → to send window to the monitor on the right (if there is one)

- Use control + s to exit Window Layout Mode without moving any windows



[Window Layout Mode Keybindings (1)](https://cloud.githubusercontent.com/assets/2988/22397114/715cc12e-e538-11e6-9dcd-b3447af0d9dd.png) [Window Layout Mode Keybindings (2)](https://cloud.githubusercontent.com/assets/2988/22397111/45672fe6-e538-11e6-905d-5b0234e290bb.png)



#### Choose your own keybindings



Window Layout Mode ships with the default keybindings above, but you're welcome to personalize this setup. See [`hammerspoon/windows-bindings-defaults.lua`](hammerspoon/windows-bindings-defaults.lua) for instructions on configuring shortcuts to your personal taste.



### Markdown Mode



Perform common [Markdown](https://daringfireball.net/projects/markdown/syntax)-formatting tasks anywhere that you're editing text (e.g., in a GitHub comment, in your editor, in your email client).



Use control + m to turn on Markdown Mode. Then, use any shortcut below to perform an action. For example, to format the selected text as bold in Markdown, hit control + m, and then b.



- Use b to wrap the currently-selected text in double asterisks ("B" for "Bold")



    Example: `**selection**`



- Use c to wrap the currently-selected text in backticks ("C" for "Code")



    Example: `` `selection` ``



- Use i to wrap the currently-selected text in single asterisks ("I" for "Italic")



    Example: `*selection*`



- Use s to wrap the currently-selected text in double tildes ("S" for "Strikethrough")



    Example: `~~selection~~`



- Use l to convert the currently-selected text to an inline link, using a URL from the clipboard ("L" for "Link")



    Example: `[selection](clipboard)`



- Use control + m to exit Markdown Mode without performing any actions



### Hyper key for quickly launching apps



macOS doesn't have a native hyper key. But thanks to Karabiner-Elements, we can [create our own](karabiner/karabiner.json). In this setup, we'll use the right option key as our hyper key.



With a new modifier key defined, we open a whole world of possibilities. I find it especially useful for providing global shortcuts for launching apps.



#### Choose your own apps



Hyper Mode ships with the default keybindings below, but you'll likely want to personalize this setup. See [`hammerspoon/hyper-apps-defaults.lua`](hammerspoon/hyper-apps-defaults.lua) for instructions on configuring shortcuts to launch *your* most commonly-used apps.



#### Default app keybindings



- hyper + a to open iTunes ("A" for "Apple Music")

- hyper + b to open Google Chrome ("B" for "Browser")

- hyper + c to open Slack ("C for "Chat")

- hyper + d to open [Remember The Milk](https://www.rememberthemilk.com/) ("D" for "Do!" ... or "Done!")

- hyper + e to open [Atom](https://atom.io) ("E" for "Editor")

- hyper + f to open Finder ("F" for "Finder")

- hyper + g to open [Mailplane](http://mailplaneapp.com/) ("G" for "Gmail")

- hyper + s to open [Slack](https://slack.com/downloads/osx) ("S" for "Slack")

- hyper + t to open [iTerm2](https://www.iterm2.com/) ("T" for "Terminal")



### Miscellaneous goodness



- Use control + - (dash) to split iTerm2 panes horizontally

- Use control + | (pipe) split iTerm2 panes vertically

- Use control + h / j / k / l to move left/down/up/right by one pane in iTerm2

- Use control + u to delete to the start of the line

- Use control + ; to delete to the end of the line

- Use option + h / l to delete the previous/next word



## Dependencies



This setup is honed and tested with the following dependencies.



- macOS Sonoma, 14.4

- [Karabiner-Elements 14.3.0][karabiner]

- [Hammerspoon 0.9.100][hammerspoon]



## Installation



1. Grab the bits



    ```sh

    git clone https://github.com/jasonrudolph/keyboard.git ~/.keyboard



    cd ~/.keyboard



    script/setup

    ```



2. Enable accessibility to allow Hammerspoon to do its thing [[screenshot]](screenshots/accessibility-permissions-for-hammerspoon.png)



3. You'll be [prompted to allow Karabiner-Elements to load its kernel extension](https://karabiner-elements.pqrs.org/docs/getting-started/installation/#open-karabiner-elements-preferences), followed by a [flurry of prompts related to input monitoring](https://karabiner-elements.pqrs.org/docs/getting-started/installation/#grant-input-monitoring-to-karabiner-elements-processes). Follow the prompts to upgrade your life.



[customize]: http://dictionary.reference.com/browse/customize

[don't-make-me-think]: http://en.wikipedia.org/wiki/Don't_Make_Me_Think

[karabiner]: https://github.com/tekezo/Karabiner-Elements

[hammerspoon]: http://www.hammerspoon.org

[hammerspoon-releases]: https://github.com/Hammerspoon/hammerspoon/releases

[modern-space-cadet]: http://stevelosh.com/blog/2012/10/a-modern-space-cadet

[modern-space-cadet-key-repeat]: http://stevelosh.com/blog/2012/10/a-modern-space-cadet/#controlescape