Home

Awesome

An extensible vi layer for Emacs

Build status MELPA MELPA Stable NonGNU ELPA Documentation Status License: GPL v3

Evil is an extensible vi layer for Emacs. It emulates the main features of Vim, and provides facilities for writing custom extensions. Also see our page on EmacsWiki.

Installation

See the official documentation for installation instructions. We recommend using package.el.

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

;; 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

Documentation

The latest version of the documentation is readable online here. It is also available as PDF and as EPUB.

Mailing list

Evil is discussed at the gmane.emacs.vim-emulation mailing list.

IRC

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

Contribution

See CONTRIBUTING.md for guidelines for issues and pull requests.