Evil is an extensible vi layerfor Emacs. It emulates the main featuresof Vim, and provides facilities for writing customextensions. Also see our page on EmacsWiki.

Installation

See theofficial documentationfor installation instructions. We recommend using package.el.

As a quickstart, you can add the following code to your Emacs initfile.

;; Set up package.el to work with MELPA
(require 'package)
(add-to-list 'package-archives
             '("melpa" . "https://melpa.org/packages/"))
(package-initialize)
(package-refresh-contents)

;; Download Evil
(unless (package-installed-p 'evil)
  (package-install 'evil))

;; Enable Evil
(require 'evil)
(evil-mode 1)

Dependencies

• Evil requires Emacs 24.1 or later.

• Evil requires any of the following for C-r:

  • undo-redo from Emacs 28
  • The undo-tree package(available via GNU ELPA)
  • The undo-fu package(available via MELPA)

• For the motions g; g, and for the last-change-register ., Evilrequires the goto-chg.elpackage (available via MELPA and NonGNU ELPA), which provides thefunctions goto-last-change and goto-last-change-reverse.

• For Emacs 24.1 and 24.2 Evil also requirescl-lib.

Documentation

The latest version of the documentation is readable onlinehere. It is alsoavailable asPDF andas EPUB.

Mailing list

Evil is discussed at thegmane.emacs.vim-emulationmailing list.

IRC

Visit us on irc.libera.chat #evil-mode.

Contribution

SeeCONTRIBUTING.mdfor guidelines for issues and pull requests.