- Emacs Lisp 100%
| docs | ||
| .dir-locals.el | ||
| .gitignore | ||
| .gitmodules | ||
| CHANGELOG.org | ||
| hel-commands.el | ||
| hel-core.el | ||
| hel-integration.el | ||
| hel-keybindings.el | ||
| hel-lib.el | ||
| hel-macros.el | ||
| hel-multiple-cursors-core.el | ||
| hel-scrolling.el | ||
| hel-search.el | ||
| hel-vars.el | ||
| hel.el | ||
| LICENSE | ||
| README.org | ||
Hel — Helix Emulation Layer for Emacs
https://github.com/user-attachments/assets/09d1a77d-2a3e-4cae-a005-e69ae03e5a7e
Key features
- Multiple cursors based modal editing inside Emacs!
- Undo/redo that plays well with multiple cursors.
- PCRE regexps by default (thanks to pcre2el).
- Smooth scrolling commands out of the box.
Can I use Hel without knowing Emacs keys?
[!IMPORTANT] What Vim, Helix, and other modal editors call Normal and Insert modes, Hel refers to as states. This is because the word "mode" in Emacs is already used for its major and minor modes.
When several years ago I came to Emacs from Neovim, I was in love with Vim editing model, found Emacs native keybindings ugly and had zero interest in learning them. I want Emacs not as text editor (which it obviously lacks of) but as an operation system with Lisp and all its power. So the first question I asked myself was "Can I use Evil without learning Emacs keys?"
The answer is yes. I have never used — and still don't know — most Emacs keys. I know only a few that you need when something breaks early during Emacs startup and you don't have your Hel keys available. They are:
M-x— Command palette. The main key you need; all other commands can be invoked from it.M-w— Copy the selected text to google the error message or feed it to LLM.C-x C-s— Save current buffer.C-x C-c— Exit Emacs.
That's it.
Hel and Emacs do not interfere much, because Emacs is not a modal editor:
letters and numbers are self-inserting, and most command key chords begin
with C-x or C-c (e.g. C-x n d). Due to this, Hel works as a layer on top
of Emacs.
In Normal state you have selection-based editing, multiple cursors, and all
the other Hel features. In Insert state, Hel steps aside and standard Emacs
keys work as usual. Also Hel doesn't touch C-x and C-c so they are always
available. This allows you to mix Hel and Emacs in any proportion.
Kakoune vs Helix
The main difference between Kakoune and Helix, in terms of text editing, is
how they handle expanding selections: Kakoune uses Shift + motions, while Helix
uses a separate state on the v key. Since I originally came from Vim, I prefer
Helix's v key, so I chose Helix. However, Kakoune (as far as I know) was the
original inventor of this keyboard-driven multiple-selections approach, and it
deserves credit.
Installation
[!TIP] If you want a Spacemacs / Doom like configuration framework but for Hel try Helheim Emacs.
Hel is not yet on MELPA. You can install it directly from Github.
Emacs built-in package manager
This is the most minimal example of the init.el file:
;;; init.el -*- lexical-binding: t; no-byte-compile: t; -*-
(setq package-archives '(("melpa" . "https://melpa.org/packages/")
("gnu" . "https://elpa.gnu.org/packages/")
("nongnu" . "https://elpa.nongnu.org/nongnu/")))
;; Dependencies
(use-package dash :ensure t)
(use-package avy :ensure t)
(use-package pcre2el :ensure t)
(use-package hel
:vc (:url "https://github.com/anuvyklack/hel.git" :rev "main")
:custom (inhibit-startup-screen t)
:config (hel-mode))
;;; init.el ends here
Elpaca
(elpaca 'dash)
(elpaca 'avy)
(elpaca 'pcre2el)
(elpaca '(hel :host github :repo "anuvyklack/hel")
(setopt inhibit-startup-screen t)
(hel-mode))
Straight
(straight-use-package 'dash)
(straight-use-package 'avy)
(straight-use-package 'pcre2el)
(straight-use-package '(hel :host github :repo "anuvyklack/hel"))
(setopt inhibit-startup-screen t)
(hel-mode)
Documentation
Differences from Helix text editor
This package is not a one-to-one emulation. Some commands are implemented in a slightly different way (improved from the author's point of view), and some features like keyboard macros, registers, and jumplists already have their alternatives in Emacs.
-
In Emacs the cursor ("point" in Emacs terms) is located between two characters rather than on a character like in Helix or Vim. I decided to keep this behavior, instead of emulating original one, as Evil does, because the primary object of interaction in Helix approach is a selection, not the cursor itself. This has consequences. In Helix, the cursor is a one-character selection, so Helix always operates on a selection. Hel does not. It has two distinct states: either selection exists, or not. Hel provides some DWIM ("do what I mean"):
-
d/D- When there is a selection, both
dandDremove it from the buffer:dcopies the deleted text to the clipboard,Ddoes not (Vim taught me that you don't always want to copy deleted text to the clipboard). - When there is no selection, common text editors provide two keys for
deleting a character:
Backspacedeletes the character before the cursor,Delete— after it. Hel adopts this idea:ddeletes the character before the cursor,D— after. None of them touches the clipboard, since it makes no sense to copy a single character into it.
- When there is a selection, both
-
r/R- When there is a selection they behave the same as in Helix.
- With no selection
rreplaces character before cursor,R— after.
-
xandXcommands expand or contract line-wise selections down when the cursor is at the end of the selection, or up when the cursor is at the beginning of the selection.- Inner objects are additionally available directly under
mprefix to reduce keystrokes:mwis the same asmiw— select word. - Mark commands accept numeric arguments:
m2ipor2mip— select 2 paragraphs. - You can restore last multiple selections with
gv. gs,gh, andglcreate selections. This is for consistency, since all other motions also create selections. In Helix they only move the cursor without creating a selection.- Keys that are relevant only when multiple cursors are present will be active
only in that case (e.g.
K,&,,— full list is inhel-multiple-cursors-mode-mapkeymap). This allows you to reuse, for example,Kfor documentation lookup or,for localleader while there is only one cursor in the buffer. - Scrolling keybindings are taken from Vim instead of Helix.
-
ggandGare taken from Vim. With numeric argument:gg— goes to N/10 of the way from the beginning of the buffer;G— goes to line N.
-
Six easymotion commands are provided:
gw/gb— choose and mark word forward/backward.gW/gB— choose and mark WORD forward/backward.gj/gk— go to line down/up.
Helix provides only
gwto place 2-char hints at the beginning of each word. f,F,t,Tcommands to move to char are enhanced: they show hints for targets, and while hints are active, they can be repeated withn/Nkeys.- When you search backward with
?command, while hints are activenandNkeys are swapped:nwill repeat search backward andN— forward, like in Vim.
Commands that are not implemented
M-u,M-U— traverse undo treeq,Q— record keyboard macros
Extensions
- hel-leader — use
Spaceas a leader key - hel-org — for Org-mode
- hel-paredit — structural editing for S-expressions
- hel-ghostel — for ghostel terminal
- hel-vterm — for vterm terminal emulator
- hel-agent-shell — for agent-shell
Tips
[!TIP] By default, Hel uses a bar cursor for Normal state and a box cursor for Insert state — the opposite of what Vim does. Your first instinct may be to switch them back to what you're used to, but I recommend not doing so. This was the first I done myself, and went through all the stages of acceptance, give default settings a try — the bar cursor is better suited for Normal state.
[!TIP] You can set localleader keymap to
,. It will act as the local leader while there is only one cursor in the buffer, and will delete all secondary cursors when there are multiple cursors.
[!TIP] Bind
Caps LocktoEsc, and configureSpaceto tap+hold behavior:Spaceon tap andCtrlon hold. You can use any of the these tools: kanata, kmonad, keyd (Linux), Karabiner-Elements (Mac).
Acknowledgments
Contributing
Share
A quick post about this package on your blog or social network could bring new users to Emacs, which would be great!
Support the development
Hel was developed on an old laptop with a cracked screen, and I worked on it instead of grinding LeetCode. If you'd like to support Hel's development, you can do so with a donation:
Every contribution is greatly appreciated.