1.9 KiB

corfu-terminal - Corfu popup on terminal

Corfu uses child frames to display candidates. This makes Corfu unusable on terminal. This package replaces that with popup/popon, which works everywhere.

GUI Terminal (Colorterm) TTY (with face customizations)
/akib/emacs-corfu-terminal/src/branch/master/demo-gui.png /akib/emacs-corfu-terminal/src/branch/master/demo-colorterm.png /akib/emacs-corfu-terminal/src/branch/master/demo-tty.png

Note: The above screenshots were taken with kind-icon enabled. And the TTY screenshot isn't a screenshot of a real TTY, it was emulated on a terminal emulator with TERM=linux and COLORTERM=, and the Corfu faces were modified to make the popup/popon visible on TTY.



Install from NonGNU ELPA.


(quelpa '(corfu-terminal
          :fetcher git
          :url "https://codeberg.org/akib/emacs-corfu-terminal.git"))


   :type git
   :repo "https://codeberg.org/akib/emacs-corfu-terminal.git"))


Download the corfu-terminal.el file and put it in your load-path.


Enable the global minor mode M-x corfu-terminal-mode to enable it. You'll probably want to enable it only on terminal. In that case, put the following in your init file:

(unless (display-graphic-p)
  (corfu-terminal-mode +1))

Complementary Packages

  • kind-icon: kind-icon adds an icon in front of each candidate describing the kind of the candidate.
  • corfu-doc and corfu-doc-terminal: corfu-doc show a documentation popup for the current candidate. corfu-doc-terminal provides a Popon (overlay) based display, so that you can use it on terminal.