Helm is an Emacs framework for incremental completions and narrowing selections. It helps to rapidly complete file names, buffer names, or any other Emacs interactions requiring selecting an item from a list of possible choices. Helm is a fork of anything.el, which was originally written by Tamas Patrovic and can be considered to be its successor. Helm cleans the legacy code that is leaner, modular, and unchained from constraints of backward compatibility.
Maintainance of Helm is a Lot of work
I have done freely since 2011.
As it is taking a lot of my time it starts to be more and more difficult
maintaining it without financial help.
If you feel Helm is making your daily work easier,
please consider making a donation.
Thank you! — Thierry Volpiatto
|Support via Paypal||Support via Liberapay|
Helm wiki | FAQ
Table of Contents
- Getting Started
- Helm Applications
- Recommended Helm extensions
- Other emacs extensions recommended with helm
- External programs recommended with helm
- Known issues
- Bugs & Improvements
- Getting help
Helm is an Emacs framework for incremental completions and narrowing
selections. It helps to rapidly complete file names, buffer names, or
any other Emacs interactions requiring selecting an item from a list of
Helm is a fork of
anything.el, which was originally written by Tamas
Patrovic and can be considered to be its successor.
Helm cleans the
legacy code that is leaner, modular, and unchained from constraints of
In addition of its framework where you can build your own
Helm provides preconfigured commands to browse and
search incrementally in files, buffers, bookmarks etc… and much
more. Helm allows displaying different sources in same session. Helm
displays its candidates in a window or a frame, keeping the minibuffer for
user input. Helm provides a full set of actions for each of its
sources, each action apply on a single candidate or a set of marked
Note: You will find many helm extensions providing diverse features sometimes already implemented in
prefer generally the ones that are natively in
Helm support natively most grep implementations as backend (ack, ag, rg),
no need to install 3rd party packages for this, same for managing projects etc…
There are several alternatives to Helm nowaday, they are all providing incremental completion but they lack all the Helm features due to their wrong implementation abusing minibuffer.
Helm requires Emacs-25.1 or later versions.
Helm installs async and popup-el package as dependencies when Helm is installed using MELPA.
Install from Straight
See Install from straight package manager
Quick install from git
See Install Helm from Git
NOTE: Installing helm using git and make is the safest way.
Install from Emacs packaging system
See Install Helm from Melpa
NOTE: This is not the recommended way to install packages.
Installing just the helm-core package
helm-core package is available on MELPA for
third party packages that depend on helm libraries. These packages
should require helm as follows:
Requiring helm builds and runs helm code necessary for multiple regexp and fuzzy matching. See helm wiki for details.
Warning about alternate installation methods
Installation methods that circumvent
helm-config are known to fail
if the careful safeguards are not implemented in the hacks.
For minimal helm configuration, run the start-up script
and then see the file
The full configuration I (the helm maintainer) use is here.
Also see helm customizable variables with the customize interface.
helm-mode will enable helm for many features of emacs
requiring completions, see below how to enable
When you have problems like Helm beeing slow or something not working, always fallback to default settings.
Configure Helm yourself, don’t use preconfigured Emacs that configure wrongly Helm for you.
Refrain installing all Helm packages you find in Melpa, check first if the feature you are looking for is available in Helm.
Nowaday, there is dozen of completion UI available for Emacs, refrain using many of those in addition with Helm unless you know what you are doing.
M-x helm-M-x RET helm- lists helm commands ready for narrowing and selecting.
To bind to
(global-set-key (kbd "M-x") 'helm-M-x)
In any helm session,
C-h m pops an org buffer with detailed documentation about current command and more generalized infos about helm.
Use it with no moderation!
Use these embedded Info screens first before reporting bugs.
M-x helm-mode to enable helm completion for common Emacs
commands. Note that the helm functionality enabled through helm-mode
comes from a generic implementation and does not include all helm
features available through equivalent helm-specific commands.
To make helm-mode start with Emacs init file:
helm-mode is using Emacs
completion-styles by default, you may want to configure your
completion-styles for a better experience.
The recommended setting is to use
(setq completion-styles '(flex)) if flex is available in your Emacs (27+ only) otherwhise use the helm-flex style (emacs-26).
To discover basic helm commands, look at helm menu item in Emacs menu.
Another way to discover helm commands: run the shell script:
./emacs-helm.sh from helm directory and then look in the scratch
emacs-helm.sh accepts emacs command line
emacs-helm.sh -h opens an Info screen with more details.
Note: When helm is installed with “make install” you will have a shell command named helm that you can run from any places i.e. not only from the helm directory
Windows and frames configuration
Helm allows displaying its candidates in several ways, side windows, frames, one window etc…
You will find the documentation with
C-h m as usual or on wiki, use as well
C-h c to see the relevant variables you can set.
Here helm started from emacs-helm.sh script and displaying its candidates in a separate frame:
Helm support by default multi pattern matching, it is the standard way of matching in helm. E.g You can use a pattern like “foo bar” to match a line containing “foo” and “bar” or “bar” and “foo”. Each pattern can be a regexp.
In addition helm support fuzzy matching.
Creating custom helm sources
(helm :sources (helm-build-sync-source "test" :candidates '(foo foa fob bar baz) :fuzzy-match t) :buffer "*helm test*")
The candidates list may be replaced by a function that produces a list. See (helm wiki) for details.
These are popular applications developed using helm completion and narrowing framework. They are available for individual installs through the Emacs package manager. This list is not exhaustive.
helm-mode: turns on helm completions for most standard emacs completions. Helm provides even more optimized helm completions for some commands in helm-mode. Prefer these natively optimized versions over the ones in helm-mode.
helm-find-files: one command that handles all the files related commands (bind to
helm-buffers-list: provides enhanced buffers listing.
helm-browse-project: handles project files and buffers; defaults to current directory; works with
helm-find-files; recommended with helm-ls-git, helm-ls-hg and
helm-ls-svnfor a better handling of version control files. Each time a project under version control is visited it is added to
helm-browse-project-historyand can be visted with
helm-dabbrev: enhanced dabbrev implementation with helm completion; does not use emacs code.
helm-occur: enhanced occur for one or more buffers; launch from
execute-extended-command(bind it to
helm-imenu-in-all-buffers: provide imenus for current or all buffers.
helm-etags-select: enhanced etags with helm-completion; usable everywhere with
helm-apropos: enhanced apropos for functions and variables that
Grep: launch from any helm file commands; supports back-ends
agand custom implementation of
helm-gid: Helm interface for
helm-show-kill-ring: A helm browser for kill ring.
helm-all-mark-rings: A helm browser for mark ring; retrieves last positions in buffers.
helm-filtered-bookmarks: enhanced browser for bookmarks.
helm-list-elisp-packages: enhanced browser for elisp package management.
Recommended Helm extensions
Normally all Helm modules coming from Emacs-helm organisation are safe to use otherwise it is mentioned in their README if they are broken or unmaintained. Here some of them I am using:
Warning Helm development has sparked quite a few extensions, many
of which duplicate features already included in helm. Some of these
packages (about 20 at last count in the MELPA repository) are either
deprecated or unmaintained. Moreover, many remain out-of-sync with
helm core development cycles causing incompatibilities. To avoid
helm problems or unstable emacs, please look for comparable features
within helm and
emacs-helm before installing such
extensions e.g. helm-swoop vs helm-occur which is part of Helm.
Other emacs extensions recommended with helm
External programs recommended with helm
The Helm project has a current unresolved issue list. Please feel free to fix any of them; send a pull request.
Most issues come from a wrong configuration or a use of Helm modified externally by third party package e.g. Spacemacs. Some other Helm packages that are no more maintained (or badly maintained) and use deprecated Helm code will clash also with recent Helm be aware.
The Helm project maintains a list of contributors.
Bugs & Improvements
The Helm Team welcomes bug reports and suggestions. Note that not all bugs when using Helm are due to Helm. Because of the way Helm interacts with many Emacs features, bugs may be related to Emacs itself.
One way to ascertain that the bugs are helm-related, recreate the
error either by using
Emacs -Q or by running the included package
./emacs-helm.sh located in the helm directory.
Helm comes now with a template for filling bugs, when reporting issues, be sure to fill all sections and to run helm from a minimal install as described above to reproduce your bug.
Or ask directly on Helm discussions
The Helm Team