GNU ELPA - corfu

• Timer-based auto-completions (off by default).
• Popup display with scrollbar indicator and arrow key navigation.
• The popup can be summoned explicitly by pressing TAB at any time.
• The current candidate is inserted with TAB and selected with RET.
• Sorting by prefix, string length and alphabetically, optionally by history.
• The selected candidate is previewed (configurable via corfu-preview-current).
• The selected candidate is automatically committed on further input by default. (configurable via corfu-preview-current).
• Supports the Orderless completion style. The filter string can contain arbitrary characters, after inserting a space via M-SPC (configurable via corfu-quit-at-boundary and corfu-separator).
• Lazy candidate highlighting for performance.
• Support for candidate annotations (annotation-function, affixation-function).
• Deprecated candidates are displayed as crossed out.
• Icons are provided by external packages via margin formatter functions.
• Rich set of extensions: Quick keys, Index keys, Sorting by history, Candidate documentation in echo area, popup or separate buffer.

Corfu is available from GNU ELPA. You can install it directly via M-x package-install RET corfu RET. After installation, activate the global minor mode with M-x global-corfu-mode RET. For completion press M-TAB (or TAB) within a buffer. Auto completion is disabled by default for safety and unobtrusiveness.

Corfu uses a transient keymap corfu-map which is active while the popup is shown. The keymap defines the following remappings of fundamental commands and bindings:

In order to configure Corfu and other packages in your init.el, you may want to use use-package. Corfu is flexibly customizable via corfu-* customization variables, such that you can adapt it precisely to your requirements. However in order to quickly try out the Corfu completion package, it should be sufficient to activate global-corfu-mode. You can experiment with manual completion for example in an Elisp buffer or in an Eshell or Shell buffer.

Auto completion is disabled by default in Corfu. Note that completion can be vulnerable to arbitrary code execution in untrusted files. In particular the elisp-completion-at-point completion function performs macro expansion and code evaluation. Auto completion can be enabled by setting corfu-auto to t locally or globally before enabling the local corfu-mode or the global-corfu-mode.

Here is an example configuration:

(use-package corfu
  ;; Optional customizations
  ;; :custom
  ;; (corfu-cycle t)                ;; Enable cycling for `corfu-next/previous'
  ;; (corfu-quit-at-boundary nil)   ;; Never quit at completion boundary
  ;; (corfu-quit-no-match nil)      ;; Never quit, even if there is no match
  ;; (corfu-preview-current nil)    ;; Disable current candidate preview
  ;; (corfu-preselect 'prompt)      ;; Preselect the prompt
  ;; (corfu-on-exact-match nil)     ;; Configure handling of exact matches

  ;; Enable Corfu only for certain modes. See also `global-corfu-modes'.
  ;; :hook ((prog-mode . corfu-mode)
  ;;        (shell-mode . corfu-mode)
  ;;        (eshell-mode . corfu-mode))

  :init

  ;; Recommended: Enable Corfu globally.  Recommended since many modes provide
  ;; Capfs and Dabbrev can be used globally (M-/).  See also the customization
  ;; variable `global-corfu-modes' to exclude certain modes.
  (global-corfu-mode)

  ;; Enable optional extension modes:
  ;; (corfu-history-mode)
  ;; (corfu-popupinfo-mode)
  )

;; A few more useful configurations...
(use-package emacs
  :custom
  ;; TAB cycle if there are only few candidates
  ;; (completion-cycle-threshold 3)

  ;; Enable indentation+completion using the TAB key.
  ;; `completion-at-point' is often bound to M-TAB.
  (tab-always-indent 'complete)

  ;; Emacs 30 and newer: Disable Ispell completion function.
  ;; Try `cape-dict' as an alternative.
  (text-mode-ispell-word-completion nil)

  ;; Hide commands in M-x which do not apply to the current mode.  Corfu
  ;; commands are hidden, since they are not used via M-x. This setting is
  ;; useful beyond Corfu.
  (read-extended-command-predicate #'command-completion-default-include-p))

Dabbrev completion is based on completion-in-region and can be used with Corfu. You may want to swap the dabbrev-completion with the dabbrev-expand key for easier access, if you prefer completion. Also take a look at the cape-dabbrev completion at point function provided by my Cape package.

;; Use Dabbrev with Corfu!
(use-package dabbrev
  ;; Swap M-/ and C-M-/
  :bind (("M-/" . dabbrev-completion)
	 ("C-M-/" . dabbrev-expand))
  :config
  (add-to-list 'dabbrev-ignored-buffer-regexps "\\` ")
  ;; Available since Emacs 29 (Use `dabbrev-ignored-buffer-regexps' on older Emacs)
  (add-to-list 'dabbrev-ignored-buffer-modes 'authinfo-mode)
  (add-to-list 'dabbrev-ignored-buffer-modes 'doc-view-mode)
  (add-to-list 'dabbrev-ignored-buffer-modes 'pdf-view-mode)
  (add-to-list 'dabbrev-ignored-buffer-modes 'tags-table-mode))

If you start to configure Corfu more thoroughly, I recommend to give the Orderless completion style a try for filtering. Orderless completion offers more flexible filtering than the default completion styles. Note that Orderless is not a necessity; Corfu can be used just as well with the default completion styles.

;; Optionally use the `orderless' completion style.
(use-package orderless
  :custom
  ;; (orderless-style-dispatchers '(orderless-affix-dispatch))
  ;; (orderless-component-separator #'orderless-escapable-split-on-space)
  (completion-styles '(orderless basic))
  (completion-category-defaults nil)
  (completion-category-overrides '((file (styles partial-completion)))))

The basic completion style is specified as fallback in addition to orderless in order to ensure that completion commands which rely on dynamic completion tables, e.g., completion-table-dynamic or completion-table-in-turn, work correctly. Additionally enable partial-completion for file path expansion. partial-completion is important for file wildcard support. Multiple files can be opened at once with find-file if you enter a wildcard. You may also give the initials completion style a try.

See also the Corfu Wiki and the Cape manual for additional Capf configuration tips. For more general documentation read the chapter about completion in the Emacs manual. If you want to create your own Capfs, you can find documentation about completion in the Elisp manual.

We maintain small extension packages to Corfu in this repository in the subdirectory extensions/. The extensions are installed together with Corfu if you pull the package from ELPA. The extensions are inactive by default and can be enabled manually if desired. Furthermore it is possible to install all of the files separately, both corfu.el and the corfu-*.el extensions. Currently the following extensions come with the Corfu ELPA package:

• corfu-echo: corfu-echo-mode displays a brief candidate documentation in the echo area.
• corfu-history: corfu-history-mode remembers selected candidates and sorts the candidates by their history position and frequency.
• corfu-indexed: corfu-indexed-mode allows you to select indexed candidates with prefix arguments.
• corfu-info: Actions to access the candidate location and documentation.
• corfu-popupinfo: Display candidate documentation or source in a popup next to the candidate menu.
• corfu-quick: Commands to select using Avy-style quick keys.

See the Commentary of those files for configuration details.

Corfu works well together with all packages providing code completion via the completion-at-point-functions. Many modes and packages already provide a Capf out of the box. Nevertheless you may want to look into complementary packages to enhance your setup.

• corfu-candidate-overlay: Shows as-you-type auto-suggestion candidate overlay with a visual indication of whether there are many or exactly one candidate available (works only with corfu-auto disabled).
• corfu-terminal: Child frames are supported by terminal Emacs 31 out of the box. On older Emacs versions, this package provides an overlay-based popup display.
• Orderless: Corfu supports completion styles, including the advanced orderless completion style, where the filter expressions are separated by spaces or another character (see corfu-separator).
• Cape: Provides additional Capf backends and completion-in-region commands. Among others, the package supplies the file completion backend cape-file and the Dabbrev backend cape-dabbrev. Cape provides the cape-company-to-capf adapter to reuse Company backends in Corfu.
• kind-icon, nerd-icons-corfu: Icons are supported by Corfu via external packages. The nerd-icons-corfu package relies on the Nerd icon font, which is supported on terminal, while kind-icon uses SVGs from monochromatic icon sets, or colored-coded text badges for terminal or simpler appearance.
• Tempel: Tiny template/snippet package with templates in Lisp syntax, which can be used in conjunction with Corfu.
• Vertico: You may also want to look into my Vertico package. Vertico is the minibuffer completion counterpart of Corfu.

• Company: Company is a widely used and mature completion package, which implements a similar UI as Corfu. While Corfu relies exclusively on the standard Emacs completion API (Capfs), Company defines its own API for the backends. Company includes its own completion backends, following its own API, which are incompatible with the Emacs completion infrastructure. Company provides an adapter company-capf to handle Capfs as a Company backend. As a result of this design, Company is a more complex package than Corfu, three times as large, even without backends. Company by default uses overlays for the popup in contrast to the child frames used by Corfu. Overall both packages work well, but Company integrates less tightly with Emacs. The completion-styles support is more limited and the completion-at-point command and the completion-in-region function do not invoke Company.
• consult-completion-in-region: The Consult package provides the function consult-completion-in-region which can be set as completion-in-region-function such that it handles completion-at-point. The function works by transferring the in-buffer completion to the minibuffer. In the minibuffer, the minibuffer completion UI, for example Vertico takes over. If you prefer to perform all your completions in the minibuffer consult-completion-in-region is your best option.

When you observe an error in the corfu--post-command post command hook, you should install an advice to enforce debugging. This allows you to obtain a stack trace in order to narrow down the location of the error. The reason is that post command hooks are automatically disabled (and not debugged) by Emacs. Otherwise Emacs would become unusable, given that the hooks are executed after every command.

(setq debug-on-error t)

(defun force-debug (func &rest args)
  (condition-case e
      (apply func args)
    ((debug error) (signal (car e) (cdr e)))))

(advice-add #'corfu--post-command :around #'force-debug)

When Capfs do not yield the expected result you can use cape-capf-debug to add debug messages to a Capf. The Capf will then produce a completion log in the messages buffer.

(setq completion-at-point-functions (list (cape-capf-debug #'cape-dict)))

Note that you will sometimes find crashes inside Capfs. Such issues are bugs in the Capfs must be fixed there. They cannot be worked around in Corfu.

Since this package is part of GNU ELPA contributions require a copyright assignment to the FSF.