/fzf.el

A front-end for fzf

Primary LanguageEmacs LispGNU General Public License v3.0GPL-3.0

fzf.el MELPA

An Emacs front-end for fzf.

demo

installation

fzf.el can be installed through MELPA.

usage

fzf.el comes with some example commands to try out

  • M-x fzf
  • M-x fzf-directory
  • M-x fzf-switch-buffer
  • M-x fzf-find-file
  • M-x fzf-find-file-in-dir
  • M-x fzf-git
  • M-x fzf-git-files
  • M-x fzf-hg
  • M-x fzf-projectile
  • M-x fzf-git-grep
  • M-x fzf-recentf
  • M-x fzf-grep

But the real action is writing your own.

fzf.el exposes three functions:

  • fzf-with-entries (entries action &optional directory): run fzf, passing in an elisp list and running the function action with the user's selected results
  • fzf-with-command (command action &optional directory): run a shell command and directly pass to fzf. An optimization on top of fzf-with-entries so that the output does not have to be stored in emacs before sending to fzf anyway.

Using these functions, it's easy to define your own commands that use fzf:

(defun fzf-example ()
  (fzf-with-entries
   (list "a" "b" "c")
   'print))

Or more exciting:

(defun fzf-find-file (&optional directory)
  (interactive)
  (let ((d (fzf/resolve-directory directory)))
    (fzf
    (lambda (x)
        (let ((f (expand-file-name x d)))
        (when (file-exists-p f)
            (find-file f))))
    d)))

license

GPL3