https://github.com/mikker/LeaderKey.app
Faster than your launcher
https://github.com/mikker/LeaderKey.app
Last synced: 25 days ago
JSON representation
Faster than your launcher
- Host: GitHub
- URL: https://github.com/mikker/LeaderKey.app
- Owner: mikker
- License: mit
- Created: 2024-08-12T08:58:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-28T09:36:46.000Z (9 months ago)
- Last Synced: 2025-01-28T10:28:48.002Z (9 months ago)
- Language: Swift
- Homepage:
- Size: 4.24 MB
- Stars: 452
- Watchers: 11
- Forks: 15
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- definitive-opensource - LeaderKey
README
**The \*faster than your launcher\* launcher**
A riff on [Raycast](https://www.raycast.com), [@mxstbr's multi-key Karabiner setup](https://www.youtube.com/watch?v=m5MDv9qwhU8&t=540s), and Vim's `` key.
Watch the intro video on YouTube:
*Yes, I only have that one thumbnail face.*
## Install
**Download**
📦 [Download latest version](https://github.com/mikker/LeaderKey.app/releases)
or
**Homebrew**
```sh
$ brew install leader-key
```
### Post-Install setup
- Open the settings menu with the menu bar icon 
- Choose your [`leader`](#what-do-i-set-as-my-leader-key) (`Shortcut` that will open the app)
- Add your [shortcuts](#example-shortcuts) to the `Config` settings
## Why Leader Key?
### Problems with traditional launchers:
1. Typing the name of the thing can be slow and give unpredictable results.
2. Global shortcuts have limited combinations.
3. Leader Key offers predictable, nested shortcuts -- like combos in a fighting game.
### Example Shortcuts:
- leaderom → Launch Messages (`open messages`)
- leadermm → Mute audio (`media mute`)
- leaderwm → Maximize current window (`window maximize`)
## FAQ
#### What do I set as my Leader Key?
Any key can be your leader key, but **only modifiers will not work**.
**Examples:**
- F12
- ⌘ + space
- ⌘⌥ + space
- ⌘⌥⌃⇧ + L (hyper key)
**Advanced examples:**
Using [Karabiner](https://karabiner-elements.pqrs.org/) you can do more fancy things like:
- right ⌘ + left ⌘ at once (bound to F12) my personal favorite
- caps lock (bound to hyper when held, F12 when pressed)
See [@mikker's config](https://github.com/mikker/LeaderKey.app/wiki/@mikker's-config) in the wiki for akimbo cmds example.
#### I disabled the menubar item, how can I get Leader Key back?
Activate Leader Key, then cmd + ,.
#### Command action is failing with "Command not found"
You need to make sure your shell environment is correctly set up for non-interactive mode, and exports the `PATH` variable.
**For zsh** make sure you have your `PATH` variable exported in `~/.zshenv`
**For bash** make sure you have your `PATH` variable exported in `~/.bash_profile`
## License
MIT