Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexherbo2/krabby
A keyboard interface to the web, inspired by Kakoune
https://github.com/alexherbo2/krabby
kakoune keyboard-interface krabby link-hints multiple-selections subject-object-verb tab-search webextension
Last synced: 14 days ago
JSON representation
A keyboard interface to the web, inspired by Kakoune
- Host: GitHub
- URL: https://github.com/alexherbo2/krabby
- Owner: alexherbo2
- License: unlicense
- Created: 2019-10-03T16:54:15.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-21T17:47:43.000Z (about 1 year ago)
- Last Synced: 2024-08-01T15:08:24.492Z (3 months ago)
- Topics: kakoune, keyboard-interface, krabby, link-hints, multiple-selections, subject-object-verb, tab-search, webextension
- Language: HTML
- Homepage: https://krabby.netlify.app
- Size: 274 KB
- Stars: 307
- Watchers: 10
- Forks: 20
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# [Krabby]
[](#supported-platforms)
[](#browser-compatibility)
[](https://discord.gg/CXF2P8w)
[](https://webchat.freenode.net/#krabby)
[](https://github.com/search?q=topic:krabby+topic:plugin)
###### [Installation](#installation) | [Configuration](docs/configuration.md) | [Documentation](docs) | [Supported platforms](#supported-platforms) | [Browser compatibility](#browser-compatibility) | [Troubleshooting](docs/troubleshooting.md) | [Contributing](CONTRIBUTING)
Krabby is a browser extension (for [Chrome] and [Firefox]) for keyboard-based navigation, inspired by [Kakoune].
The main differences with [existing extensions](docs/alternatives.md) are:
multiple selections,
keyboard layout agnostic,
SOV ([subject–object–verb]) constructs and
simple interaction with external programs.
It is also quite usable with the mouse.
[](https://youtube.com/playlist?list=PLdr-HcjEDx_kOnqvLcE5T1tq9rAVwmths)
[](https://youtube.com/playlist?list=PLdr-HcjEDx_kOnqvLcE5T1tq9rAVwmths)
See [YouTube · Krabby] and [krabby-resources] for all available demos.
[YouTube · Krabby]: https://youtube.com/playlist?list=PLdr-HcjEDx_kOnqvLcE5T1tq9rAVwmths
[krabby-resources]: https://github.com/alexherbo2/krabby-resources
## TL;DR
**WebExtension** — **Keyboard interface** — **Subject–object–verb order** — **Multiple selections** — **Kakoune-inspired**
Run the following in your terminal, then follow the onscreen instructions.
``` sh
git clone https://github.com/alexherbo2/krabby
cd krabby
make install [static=no] [interactive=yes]
```
After installing, try to accomplish the following examples:
Opening links in a paragraph
Navigate to and type:
```
f{hint}s[alt+a][alt+I][ctrl+enter][alt+x]
```
**Explanation**
- f enters hint mode,
- `{hint}` is a placeholder for you to select a link,
- s creates a selection out of the active element,
- Alt + a expands the region,
- Alt + I selects all links,
- Control + Enter opens selected links in the background.
- Optionally, Alt + x will undo the operation (closing right tabs).
Play videos with mpv
Navigate to and type:
```
F{hint}{hint}{hint}m
```
**Explanation**
- F enters hint mode (lock),
- `{hint}` is a placeholder for you to select 2 links,
- Page Down scrolls one page down,
- `{hint}` is a placeholder for you to select another link,
- Escape leaves hint mode.
- Finally, m opens the selection with [mpv].
If you want to play around without installing, a live demo is available [here][Live demo].
## Features
- [Subject–object–verb] order. Learn more at [Differences with Vi(m)][A linguistic twist].
- Keyboard layout agnostic. Maps to physical keys, but displays with the [US layout][QWERTY].
- Multiple selections as a central way of interacting
- Powerful selection manipulation primitives
- Link hints
- External editor support. Open your favorite editor on text inputs.
- Tab search
- Contextual commands
- Contextual help
- Simple interaction with external programs
- Usable with the mouse. You can for example create a selection by grabbing a
link with the mouse and s to create the selection. Or create multiple
selections by clicking on hints with F. If you hold Control
or Command, you can even make selections with the mouse selection area.
- Limited scope. Krabby is not [Vim], nor [Kakoune]. Krabby is trying to be a
navigation tool and some concepts from code editors don’t translate well. For
example, there is no concept of mode in Krabby, but a system of contexts.
- Composability. Composability is better than extensibility. Krabby tries hard
to provide features that interact well with each other. For example, f
and y are two building blocks to focus a link and yank its URL. Depending
on the context, y will yank the page or a link URL.
- Modular (think [Emacs]). Krabby is divided into multiple small projects. At
its core Krabby just holds the configuration and grabs its functionalities from
other projects.
- [Chrome] and [Firefox] support. It has also been tested on [Opera],
[Vivaldi] and [Brave].
## Dependencies
- [Crystal]
- [jq]
- [wl-clipboard] for [Wayland] _or_ [xclip] for [X11] (Optional, for [plumbing](bin/plumb))
- [mpv] (Optional, for playing videos)
- [dmenu] (Optional, for tab search and [plumbing](bin/plumb))
- [Pandoc] (Optional, for HTML filtering)
### Extensions
- [Commands] ([WebExtension] API to perform browser actions)
- [Shell] ([WebExtension] API to execute external commands)
- [Editor] (Open an external editor to edit text inputs)
- [dmenu][webextension-dmenu] (Tab search, selection and beyond with a [dmenu] filter program)
[WebExtension]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions
## Installation
Run the following in your terminal, then follow the onscreen instructions.
``` sh
make install [static=no] [extensions=yes] [interactive=yes]
```
## Supported platforms
- [Linux]
- [FreeBSD]
- [OpenBSD]
- [macOS]
## Browser compatibility
| Web browser | Support | Engine | Notes |
| ----------- |:-------:|:-------------------------------:| ------------------------------------------------------------------------ |
| [Chrome] | ✓ | [![Blink][chrome.svg]][Blink] | |
| [Chromium] | ✓ | [![Blink][chrome.svg]][Blink] | |
| [Firefox] | ✓ | [![Gecko][firefox.svg]][Gecko] | [Only developer or unbranded version][Firefox – Extension Signing – FAQ] |
| [Edge] | ? | [![Blink][chrome.svg]][Blink] | |
| [Opera] | ✓ | [![Blink][chrome.svg]][Blink] | |
| [Safari] | ✗ | [![WebKit][safari.svg]][WebKit] | |
| [Vivaldi] | ✓ | [![Blink][chrome.svg]][Blink] | |
| [Brave] | ✓ | [![Blink][chrome.svg]][Blink] | |
## Credits
- [Kakoune] ([@mawww]) for [ideas][Why Kakoune] and [selection.cc].
- [Saka Key] ([@eejdoowad]) was a reference, for implementation and its code quality.
- [@ul], for his advice and proofreading, especially in the early stages.
- [@GeoGavilanes] for the [Krabby icon].
- [@occivink], for his work on [phantom selections][kakoune-phantom-selection], from which the “save and restore selections” feature is inspired.
- [mpv] and [Kakoune] for their website, from which [Krabby] is inspired.
- [@AdamWagner] for his work to unify scrolling mechanisms.
## References
- [Create a keyboard interface to the web]
[Krabby]: https://krabby.netlify.app
[Live demo]: https://krabby.netlify.app#live-demo
[Krabby icon]: https://iconfinder.com/icons/877852/kanto_krabby_pokemon_water_icon
[A linguistic twist]: https://github.com/alexherbo2/krabby/blob/master/docs/differences-with-vim.md#a-linguistic-twist
[WebExtension]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions
[QWERTY]: https://en.wikipedia.org/wiki/QWERTY
[Subject–object–verb]: https://en.wikipedia.org/wiki/Subject–object–verb
[Chrome]: https://google.com/chrome/
[Chrome Web Store]: https://chrome.google.com/webstore
[Firefox]: https://mozilla.org/firefox/
[Firefox Add-ons]: https://addons.mozilla.org
[Firefox – Extension Signing – FAQ]: https://wiki.mozilla.org/Add-ons/Extension_Signing#FAQ
[Linux]: https://kernel.org
[FreeBSD]: https://freebsd.org
[OpenBSD]: https://openbsd.org
[macOS]: https://apple.com/macos/
[Wayland]: https://wayland.freedesktop.org
[X11]: https://x.org
[Chrome]: https://google.com/chrome/
[Chromium]: https://chromium.org
[Firefox]: https://mozilla.org/firefox/
[Edge]: https://microsoft.com/en-us/windows/microsoft-edge
[Opera]: https://opera.com
[Safari]: https://apple.com/safari/
[Vivaldi]: https://vivaldi.com
[Brave]: https://brave.com
[Blink]: https://chromium.org/blink
[Gecko]: https://developer.mozilla.org/en-US/docs/Mozilla/Gecko
[WebKit]: https://webkit.org
[chrome.svg]: https://developer.mozilla.org/static/browsers/chrome.b49946f7739f.svg
[firefox.svg]: https://developer.mozilla.org/static/browsers/firefox.1c9f202ae696.svg
[safari.svg]: https://developer.mozilla.org/static/browsers/safari.aca6ae03b671.svg
[Kakoune]: https://kakoune.org
[Vim]: https://vim.org
[Emacs]: https://gnu.org/software/emacs/
[Crystal]: https://crystal-lang.org
[jq]: https://stedolan.github.io/jq/
[wl-clipboard]: https://github.com/bugaevc/wl-clipboard
[xclip]: https://github.com/astrand/xclip
[mpv]: https://mpv.io
[dmenu]: https://tools.suckless.org/dmenu/
[Pandoc]: https://pandoc.org
[Commands]: https://github.com/alexherbo2/webextension-commands
[Shell]: https://github.com/alexherbo2/webextension-shell
[Editor]: https://github.com/alexherbo2/webextension-editor
[webextension-dmenu]: https://github.com/alexherbo2/webextension-dmenu
[Kakoune]: https://kakoune.org
[Why Kakoune]: https://kakoune.org/why-kakoune/why-kakoune.html
[selection.cc]: https://github.com/mawww/kakoune/blob/master/src/selection.cc
[kakoune-phantom-selection]: https://github.com/occivink/kakoune-phantom-selection
[Saka Key]: https://key.saka.io
[@mawww]: https://github.com/mawww
[@eejdoowad]: https://github.com/eejdoowad
[@ul]: https://github.com/ul
[@GeoGavilanes]: https://iconfinder.com/GeoGavilanes
[@occivink]: https://github.com/occivink
[@AdamWagner]: https://github.com/AdamWagner
[Native messaging]: https://developer.chrome.com/extensions/nativeMessaging
[Regular Expressions]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[Create a keyboard interface to the web]: https://alexherbo2.github.io/blog/chrome/create-a-keyboard-interface-to-the-web/