fzf - Fuzzy finder for your shell

fzf is a general-purpose fuzzy finder for your shell.

It was heavily inspired by ctrlp.vim and the likes.

Installation

fzf project consists of the followings:

• fzf executable
• fzf-tmux script for launching fzf in a tmux pane
• Shell extensions
  • Key bindings (CTRL-T, CTRL-R, and ALT-C) (bash, zsh, fish)
  • Fuzzy auto-completion (bash only)

You can download fzf executable alone, but it's recommended that you install the extra stuff using the attached install script.

Using git (recommended)

Clone this repository and run install script.

git clone https://github.com/junegunn/fzf.git ~/.fzf
~/.fzf/install

Using curl

In case you don't have git installed:

mkdir -p ~/.fzf
curl -L https://github.com/junegunn/fzf/archive/master.tar.gz |
    tar xz --strip-components 1 -C ~/.fzf
~/.fzf/install

Using Homebrew

On OS X, you can use Homebrew to install fzf.

brew install fzf

# Install shell extensions - this should be done whenever fzf is updated
/usr/local/Cellar/fzf/$(fzf --version)/install

Install as Vim plugin

Once you have cloned the repository, add the following line to your .vimrc.

set rtp+=~/.fzf

Or you can have vim-plug manage fzf (recommended):

Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': 'yes \| ./install' }

Usage

fzf will launch curses-based finder, read the list from STDIN, and write the selected item to STDOUT.

find * -type f | fzf > selected

Without STDIN pipe, fzf will use find command to fetch the list of files excluding hidden ones. (You can override the default command with FZF_DEFAULT_COMMAND)

vim $(fzf)

Using the finder

• CTRL-J / CTRL-K (or CTRL-N / CTRL-P) to move cursor up and down
• Enter key to select the item, CTRL-C / CTRL-G / ESC to exit
• On multi-select mode (-m), TAB and Shift-TAB to mark multiple items
• Emacs style key bindings
• Mouse: scroll, click, double-click; shift-click and shift-scroll on multi-select mode

Extended-search mode

With -x or --extended option, fzf will start in "extended-search mode".

In this mode, you can specify multiple patterns delimited by spaces, such as: ^music .mp3$ sbtrkt !rmx

Token	Description	Match type
^music	Items that start with music	prefix-exact-match
.mp3$	Items that end with .mp3	suffix-exact-match
sbtrkt	Items that match sbtrkt	fuzzy-match
!rmx	Items that do not match rmx	inverse-fuzzy-match
'wild	Items that include wild	exact-match (quoted)
!'fire	Items that do not include fire	inverse-exact-match

If you don't need fuzzy matching and do not wish to "quote" every word, start fzf with -e or --extended-exact option.

Examples

Many useful examples can be found on the wiki page. Feel free to add your own as well.

Key bindings for command line

The install script will setup the following key bindings for bash, zsh, and fish.

• CTRL-T - Paste the selected file path(s) into the command line
• CTRL-R - Paste the selected command from history into the command line
• ALT-C - cd into the selected directory

If you're on a tmux session, CTRL-T will launch fzf in a new split-window. You may disable this tmux integration by setting FZF_TMUX to 0, or change the height of the window with FZF_TMUX_HEIGHT (e.g. 20, 50%).

If you use vi mode on bash, you need to add set -o vi before source ~/.fzf.bash in your .bashrc, so that it correctly sets up key bindings for vi mode.

If you want to customize the key bindings, consider editing the installer-generated source code: ~/.fzf.bash, ~/.fzf.zsh, and ~/.config/fish/functions/fzf_key_bindings.fish.

fzf-tmux script

fzf-tmux is a bash script that opens fzf in a tmux pane.

# usage: fzf-tmux [-h [HEIGHT[%]]] [-w [WIDTH[%]]] [--] [FZF OPTIONS]

# select git branches in horizontal split (15 lines)
git branch | fzf-tmux -h 15

# select multiple words in vertical split (20% of screen width)
cat /usr/share/dict/words | fzf-tmux -w 20% --multi

It will still work even when you're not on tmux, silently ignoring -h and -w options, so you can invariably use fzf-tmux in your scripts.

Fuzzy completion for bash

Files and directories

Fuzzy completion for files and directories can be triggered if the word before the cursor ends with the trigger sequence which is by default **.

• COMMAND [DIRECTORY/][FUZZY_PATTERN]**<TAB>

# Files under current directory
# - You can select multiple items with TAB key
vim **<TAB>

# Files under parent directory
vim ../**<TAB>

# Files under parent directory that match `fzf`
vim ../fzf**<TAB>

# Files under your home directory
vim ~/**<TAB>


# Directories under current directory (single-selection)
cd **<TAB>

# Directories under ~/github that match `fzf`
cd ~/github/fzf**<TAB>

Process IDs

Fuzzy completion for PIDs is provided for kill command. In this case there is no trigger sequence, just press tab key after kill command.

# Can select multiple processes with <TAB> or <Shift-TAB> keys
kill -9 <TAB>

Host names

For ssh and telnet commands, fuzzy completion for host names is provided. The names are extracted from /etc/hosts and ~/.ssh/config.

ssh **<TAB>
telnet **<TAB>

Environment variables / Aliases

unset **<TAB>
export **<TAB>
unalias **<TAB>

Settings

# Use ~~ as the trigger sequence instead of the default **
export FZF_COMPLETION_TRIGGER='~~'

# Options to fzf command
export FZF_COMPLETION_OPTS='+c -x'

Usage as Vim plugin

(Note: To use fzf in GVim, an external terminal emulator is required.)

:FZF[!]

If you have set up fzf for Vim, :FZF command will be added.

" Look for files under current directory
:FZF

" Look for files under your home directory
:FZF ~

" With options
:FZF --no-sort -m /tmp

Note that the environment variables FZF_DEFAULT_COMMAND and FZF_DEFAULT_OPTS also apply here.

If you're on a tmux session, :FZF will launch fzf in a new split-window whose height can be adjusted with g:fzf_tmux_height (default: '40%'). However, the bang version (:FZF!) will always start in fullscreen.

In GVim, you need an external terminal emulator to start fzf with. xterm command is used by default, but you can customize it with g:fzf_launcher.

" This is the default. %s is replaced with fzf command
let g:fzf_launcher = 'xterm -e bash -ic %s'

" Use urxvt instead
let g:fzf_launcher = 'urxvt -geometry 120x30 -e sh -c %s'

If you're running MacVim on OSX, I recommend you to use iTerm2 as the launcher. Refer to the this wiki page to see how to set up.

fzf#run([options])

For more advanced uses, you can call fzf#run() function which returns the list of the selected items.

fzf#run() may take an options-dictionary:

Option name	Type	Description
source	string	External command to generate input to fzf (e.g. find .)
source	list	Vim list as input to fzf
sink	string	Vim command to handle the selected item (e.g. e, tabe)
sink	funcref	Reference to function to process each selected item
options	string	Options to fzf
dir	string	Working directory
tmux_width	number/string	Use tmux vertical split with the given height (e.g. 20, 50%)
tmux_height	number/string	Use tmux horizontal split with the given height (e.g. 20, 50%)
launcher	string	External terminal emulator to start fzf with (Only used in GVim)

Examples

If sink option is not given, fzf#run will simply return the list.

let items = fzf#run({ 'options': '-m +c', 'dir': '~', 'source': 'ls' })

But if sink is given as a string, the command will be executed for each selected item.

" Each selected item will be opened in a new tab
let items = fzf#run({ 'sink': 'tabe', 'options': '-m +c', 'dir': '~', 'source': 'ls' })

We can also use a Vim list as the source as follows:

" Choose a color scheme with fzf
nnoremap <silent> <Leader>C :call fzf#run({
\   'source':
\     map(split(globpath(&rtp, "colors/*.vim"), "\n"),
\         "substitute(fnamemodify(v:val, ':t'), '\\..\\{-}$', '', '')"),
\   'sink':       'colo',
\   'options':    '+m',
\   'tmux_width': 20,
\   'launcher':   'xterm -geometry 20x30 -e bash -ic %s'
\ })<CR>

sink option can be a function reference. The following example creates a handy mapping that selects an open buffer.

" List of buffers
function! BufList()
  redir => ls
  silent ls
  redir END
  return split(ls, '\n')
endfunction

function! BufOpen(e)
  execute 'buffer '. matchstr(a:e, '^[ 0-9]*')
endfunction

nnoremap <silent> <Leader><Enter> :call fzf#run({
\   'source':      reverse(BufList()),
\   'sink':        function('BufOpen'),
\   'options':     '+m',
\   'tmux_height': '40%'
\ })<CR>

More examples can be found on the wiki page.

Articles

• fzf+vim+tmux

Tips

Rendering issues

If you have any rendering issues, check the followings:

1. Make sure $TERM is correctly set. fzf will use 256-color only if it contains 256 (e.g. xterm-256color)
2. If you're on screen or tmux, $TERM should be either screen or screen-256color
3. Some terminal emulators (e.g. mintty) have problem displaying default background color and make some text unable to read. In that case, try --black option. And if it solves your problem, I recommend including it in FZF_DEFAULT_OPTS for further convenience.
4. If you still have problem, try --no-256 option or even --no-color.

Respecting .gitignore, .hgignore, and svn:ignore

ag or pt will do the filtering:

# Feed the output of ag into fzf
ag -l -g "" | fzf

# Setting ag as the default source for fzf
export FZF_DEFAULT_COMMAND='ag -l -g ""'

# Now fzf (w/o pipe) will use ag instead of find
fzf

git ls-tree for fast traversal

If you're running fzf in a large git repository, git ls-tree can boost up the speed of the traversal.

# Copy the original fzf function to __fzf
declare -f __fzf > /dev/null ||
  eval "$(echo "__fzf() {"; declare -f fzf | \grep -v '^{' | tail -n +2)"

# Use git ls-tree when possible
fzf() {
  if [ -n "$(git rev-parse HEAD 2> /dev/null)" ]; then
    FZF_DEFAULT_COMMAND="git ls-tree -r --name-only HEAD" __fzf "$@"
  else
    __fzf "$@"
  fi
}

Using fzf with tmux panes

The supplied fzf-tmux script should suffice in most of the cases, but if you want to be able to update command line like the default CTRL-T key binding, you'll have to use send-keys command of tmux. The following example will show you how it can be done.

# This is a helper function that splits the current pane to start the given
# command ($1) and sends its output back to the original pane with any number of
# optional keys (shift; $*).
fzf_tmux_helper() {
  [ -n "$TMUX_PANE" ] || return
  local cmd=$1
  shift
  tmux split-window -p 40 \
    "bash -c \"\$(tmux send-keys -t $TMUX_PANE \"\$(source ~/.fzf.bash; $cmd)\" $*)\""
}

# This is the function we are going to run in the split pane.
# - "find" to list the directories
# - "sed" will escape spaces in the paths.
# - "paste" will join the selected paths into a single line
fzf_tmux_dir() {
  fzf_tmux_helper \
    'find * -path "*/\.*" -prune -o -type d -print 2> /dev/null |
     fzf --multi |
     sed "s/ /\\\\ /g" |
     paste -sd" " -' Space
}

# Bind CTRL-X-CTRL-D to fzf_tmux_dir
bind '"\C-x\C-d": "$(fzf_tmux_dir)\e\C-e"'

Fish shell

It's a known bug of fish that it doesn't allow reading from STDIN in command substitution, which means simple vim (fzf) won't work as expected. The workaround is to store the result of fzf to a temporary file.

function vimf
  if fzf > $TMPDIR/fzf.result
    vim (cat $TMPDIR/fzf.result)
  end
end

function fe
  set tmp $TMPDIR/fzf.result
  fzf --query="$argv[1]" --select-1 --exit-0 > $tmp
  if [ (cat $tmp | wc -l) -gt 0 ]
    vim (cat $tmp)
  end
end

Handling UTF-8 NFD paths on OSX

Use iconv to convert NFD paths to NFC:

find . | iconv -f utf-8-mac -t utf8//ignore | fzf

License

MIT

Author

Junegunn Choi