To install this package, run in Emacs:
M-x package-install RET corfu RET
Corfu enhances the default completion in region function with a completion
overlay. The current candidates are shown in a popup below or above the point.
Corfu is the minimalistic
completion-in-region counterpart of the Vertico
Corfu is a minimal package, which relies on the Emacs completion facilities and
concentrates on providing a polished completion UI. Completions are either
provided by commands like
dabbrev-completion or by pluggable backends
completion-at-point-functions, Capfs). Most programming language major modes
implement a Capf. Furthermore the language server packages, Eglot and Lsp-mode,
both use Capfs which talk to the LSP server to retrieve the completions.
Corfu does not include custom completion backends. In contrast, the complex Company package includes custom completion backends, which deviate from the Emacs completion infrastructure.
NOTE: Corfu uses child frames to show the popup; on non-graphical displays it
will fall back to the default setting of the
TABat any time.
TABand selected with
corfu-quit-at-boundaryis nil. This is needed when filtering with the Orderless completion style.
Corfu is available from GNU ELPA, such that it can be installed directly via
package-install. After installation, the local minor mode can be enabled with
M-x corfu-mode. In order to configure Corfu and other packages in your
init.el, you may want to use
use-package. I recommend to give Orderless
completion a try, which is different from the familiar prefix TAB completion.
However Corfu works well with the default completion styles, the use of
Orderless is not a necessity. Here is an example configuration:
(use-package corfu ;; Optional customizations ;; :custom ;; (corfu-cycle t) ;; Enable cycling for `corfu-next/previous' ;; (corfu-auto t) ;; Enable auto completion ;; (corfu-commit-predicate nil) ;; Do not commit selected candidates on next input ;; (corfu-quit-at-boundary t) ;; Automatically quit at word boundary ;; (corfu-quit-no-match t) ;; Automatically quit if there is no match ;; (corfu-echo-documentation nil) ;; Do not show documentation in the echo area ;; Optionally use TAB for cycling, default is `corfu-complete'. ;; :bind (:map corfu-map ;; ("TAB" . corfu-next) ;; ([tab] . corfu-next) ;; ("S-TAB" . corfu-previous) ;; ([backtab] . corfu-previous)) ;; You may want to enable Corfu only for certain modes. ;; :hook ((prog-mode . corfu-mode) ;; (shell-mode . corfu-mode) ;; (eshell-mode . corfu-mode)) ;; Recommended: Enable Corfu globally. ;; This is recommended since dabbrev can be used globally (M-/). :init (corfu-global-mode)) ;; Optionally use the `orderless' completion style. See `+orderless-dispatch' ;; in the Consult wiki for an advanced Orderless style dispatcher. ;; Enable `partial-completion' for files to allow path expansion. ;; You may prefer to use `initials' instead of `partial-completion'. (use-package orderless :init ;; Configure a custom style dispatcher (see the Consult wiki) ;; (setq orderless-style-dispatchers '(+orderless-dispatch)) (setq completion-styles '(orderless) completion-category-defaults nil completion-category-overrides '((file (styles . (partial-completion)))))) ;; Dabbrev works with Corfu (use-package dabbrev ;; Swap M-/ and C-M-/ :bind (("M-/" . dabbrev-completion) ("C-M-/" . dabbrev-expand))) ;; A few more useful configurations... (use-package emacs :init ;; TAB cycle if there are only few candidates (setq completion-cycle-threshold 3) ;; Emacs 28: Hide commands in M-x which do not work in the current mode. ;; Corfu commands are hidden, since they are not supposed to be used via M-x. ;; (setq read-extended-command-predicate ;; #'command-completion-default-include-p) ;; Enable indentation+completion using the TAB key. ;; `completion-at-point' is often bound to M-TAB. (setq tab-always-indent 'complete))
Corfu uses a transient keymap
corfu-map which is active while the popup is shown.
The keymap defines the following remappings and bindings:
ESC ESC ESC->
Corfu works well together with all packages providing code completion via the
completion-at-point-functions. Furthermore it supports completion styles,
including the advanced Orderless completion style, where the filtering
expressions are separated by spaces (see
You may also want to look into my Vertico package. Vertico is the minibuffer counterpart of Corfu.
Corfu works well in most scenarios. However there are a few known technical caveats.
completion-at-pointdoes not maintain a history (See branch
historyfor a possible solution).
Since this package is part of GNU ELPA contributions require a copyright assignment to the FSF.