git clone 'git://github.com/emacs-helm/helm.git'

License GPL 3 MELPA MELPA Stable



You can Support via Gratipay or Donate to help this project.

Table of Contents


Helm is incremental completion and selection narrowing framework for Emacs. It will help steer you in the right direction when you're looking for stuff in Emacs (like buffers, files, etc).

Helm is a fork of anything.el originally written by Tamas Patrovic and can be considered to be its successor. Helm sets out to clean up the legacy code in anything.el and provide a cleaner, leaner and more modular tool, that's not tied in the trap of backward compatibility.


You need a recent Emacs to use latest helm, at least Emacs-24.3.

async will be installed as dependency when installing from melpa but is facultative when installing from git (recommended though as it may fix installation of all packages from (m)elpa and will allow you to copy/rename asynchronously your files from helm and/or dired if needed).

Getting Started

Quick install from git

  1. Clone the helm repository to some directory:

    $ git clone https://github.com/emacs-helm/helm.git /path/to/helm/directory
  2. Clone the async repository to some directory (facultative)

    $ git clone https://github.com/jwiegley/emacs-async.git /path/to/async/directory
  3. Run make from the helm directory.

  4. Add to .emacs.el (or equivalent):

    ;; [Facultative] Only if you have installed async.
    (add-to-list 'load-path "/path/to/async/directory")
    (add-to-list 'load-path "/path/to/helm/directory")
    (require 'helm-config)

NOTE: Installing helm like this (i.e from git+make) is the safest way.

You can have a quick try to helm by launching from the helm directory:


It is also recommended to use this when reporting bug.

NOTE: That this will not work on Windows systems.

Install from Emacs packaging system

Helm is now available on Melpa at http://melpa.org/ You will find there instructions to install. See also https://github.com/milkypostman/melpa#usage to startup correctly with the emacs packaging system. Then you should need only in your init file:

(require 'helm-config)

WARNING: Due to a bad concept of package.el which is in charge of fetching helm files and compiling them, users had errors most of the time when upgrading from melpa and list-package. To avoid this Async have been added as dependency to helm to force package.el compiling its files in a clean environment. People installing from git and using the make file will not suffer from this problem and don't need Async though it is recommended as it fix installation of all other packages you may install with package.el from (m)elpa. See FAQ for more infos.

Note: After upgrading from the emacs packaging system you should restart emacs for the changes take effect.

Note to Linux Distributions Maintainers

Only the extensions present in the github emacs-helm organisation are supported.

Install and use only helm-core package

Third party helm packages can use only helm-core package if they don't need more helm libraries for their packages. It is available at http://melpa.org/.

All you need to add in your packages is

 (require 'helm)

This will provide the necessary code to build and run helm sources with multiple regexp matching or fuzzy matching.

See wiki for more infos.

Alternate install warning

Some people are installing helm with their own config using diverses require, autoload and other hacks, not using helm-config. Expect failures and slowdown at startup unless you really know what you are doing when you do so.


For a minimal helm configuration, run the startup script ./emacs-helm.sh and look at the file /tmp/helm-cfg.el.

The full configuration I use (helm maintainer) can be found here.

Don't hesitate also to visit all helm customizable variables with the customize interface. Enabling helm-mode will give you completion in the diverse customize commands.

Also you will find some packages like Emacs Prelude that have Helm built-in and properly set-up.

Basic usage

Just type M-x helm-M-x RET helm-, you will have completion on all helm commands.

You can bind this to M-x like this:

(global-set-key (kbd "M-x") 'helm-M-x)

Once you are in the helm session (of helm-M-x or any one else) you can hit either C-h m or C-c ?, the former is will popup a general info buffer about helm while the second will popup a specialized info of the current source you are into. Sometime C-c ? is not available, in this case you will see in mode-line C-h m instead of C-c ?. PLEASE USE and ABUSE of these helm embeded infos before reporting a bug about how to do things in helm, you will find also useful infos in mode-line.

You can also start with M-x helm-mode and enjoy helm completion in your favourites Emacs commands (e.g M-x, C-x C-f, etc…). You can enable this by adding in your init file:

(helm-mode 1)

As a startup point you can also look at the helm section in Emacs menu to discover some of the commands provided by helm.

For those who have a system able to run shell scripts, a convenient way to discover helm is to run ./emacs-helm.sh from the helm directory, you will find interesting infos in your scratch buffer. emacs-helm.sh accept all emacs command line options, see emacs-helm.sh -h for more infos.

Advanced usage

Helm is capable of a lot. Here is a demo of helm-buffers-list used with helm-moccur:


The demo starts when you see Eval: START in the minibuffer.

As you can see, as you filtered out, the number of candidates decreases, as displayed in the modeline. At the end, there were 12 buffers remained as the result of filtering, down from the total 253 buffers.

You can read this guide to quickly get started with Helm.

You can find all the gory details on the Helm Wiki.

Create your own helm source (overview)

Here a quick example using sync method with candidates generated by a simple list, a function can be used instead of course (see helm wiki for more infos).

(helm :sources (helm-build-sync-source "test"
                 :candidates '(foo foa fob bar baz)
                 :fuzzy-match t)
      :buffer "*helm test*")

Fuzzy matching

Helm has a built-in fuzzy matcher that is activated for some commands. Fuzzy matching is disabled by default. Currently these commands supports fuzzy matching:

You can also enable fuzzy matching globally in all functions helmized by helm-mode with helm-mode-fuzzy-match and helm-completion-in-region-fuzzy-match.

IMPORTANT: To make fuzzy-matching fast, you must not set helm-candidate-number-limit too high. It is recommended that you leave the variable with its default value 100. The higher you set helm-candidate-number-limit, the slower fuzzy-matching will be.


Helm can now resize according to the number of candidates with helm-autoresize-mode:

(helm-autoresize-mode 1)

You can customize the minimum and maximum height that Helm can resize with these two variables:

By default, helm-autoresize-max-height is set to 40, which makes Helm candidate buffer has the maximum height of 40% of current frame height. Similarly, helm-autoresize-min-height specifies the minimum height that Helm candidate buffer cannot be smaller.

If you don't want the Helm window to be resized, but a smaller Helm window, you can set helm-autoresize-max-height equal to helm-autoresize-max-height.


Applications (not exhaustive)

Helm extensions you should install

Warning You will find many extensions outside of emacs-helm that provide nothing more than what is provided natively by helm and may not be in sync will helm core. So generally prefer what is provided natively in helm instead of its counterpart provided externally.

Known issues

Check out the project's issue list a list of unresolved issues. By the way - feel free to fix any of them and send us a pull request. :-)


Here's a list of all the people who have contributed to the development of Helm.

Bugs & Improvements

Bug reports and suggestions for improvements are always welcome, be sure though they are related to helm, many bugs are coming from emacs itself or other packages. GitHub pull requests are even better! :-)

NOTE: When trying if something is working or not, be sure to start helm from Emacs -Q or even better Start it from your helm directory with ./emacs-helm.sh.

Getting help

If Helm Wiki is not enough, you can ask for help on emacs-helm google group.

The Helm Team