fzf - Fuzzy finder for your shell ================================= fzf is a general-purpose fuzzy finder for your shell. ![](https://raw.github.com/junegunn/i/master/fzf.gif) It was heavily inspired by [ctrlp.vim](https://github.com/kien/ctrlp.vim) and the likes. Requirements ------------ fzf requires Ruby (>= 1.8.5). Installation ------------ Clone this repository and run [install](https://github.com/junegunn/fzf/blob/master/install) script. ```sh git clone https://github.com/junegunn/fzf.git ~/.fzf ~/.fzf/install ``` In case you don't have git installed: ```sh mkdir -p ~/.fzf curl -L https://github.com/junegunn/fzf/archive/master.tar.gz | tar xz --strip-components 1 -C ~/.fzf ~/.fzf/install ``` The script will setup: - `fzf` function (bash, zsh, fish) - Key bindings (`CTRL-T`, `CTRL-R`, and `ALT-C`) (bash, zsh, fish) - Fuzzy auto-completion (bash) If you don't use any of the aforementioned shells, you have to manually place fzf executable in a directory included in `$PATH`. Key bindings and auto-completion will not be available in that case. ### Install as Vim plugin Once you have cloned the repository, add the following line to your .vimrc. ```vim set rtp+=~/.fzf ``` Or you may use any Vim plugin manager, such as [vim-plug](https://github.com/junegunn/vim-plug). Usage ----- ``` usage: fzf [options] Search -x, --extended Extended-search mode -e, --extended-exact Extended-search mode (exact match) -i Case-insensitive match (default: smart-case match) +i Case-sensitive match -n, --nth=N[,..] Comma-separated list of field index expressions for limiting search scope. Each can be a non-zero integer or a range expression ([BEGIN]..[END]) -d, --delimiter=STR Field delimiter regex for --nth (default: AWK-style) Search result -s, --sort=MAX Maximum number of matched items to sort (default: 1000) +s, --no-sort Do not sort the result. Keep the sequence unchanged. Interface -m, --multi Enable multi-select with tab/shift-tab --no-mouse Disable mouse +c, --no-color Disable colors +2, --no-256 Disable 256-color --black Use black background --reverse Reverse orientation Scripting -q, --query=STR Start the finder with the given query -1, --select-1 Automatically select the only match -0, --exit-0 Exit immediately when there's no match -f, --filter=STR Filter mode. Do not start interactive finder. Environment variables FZF_DEFAULT_COMMAND Default command to use when input is tty FZF_DEFAULT_OPTS Defaults options. (e.g. "-x -m --sort 10000") ``` fzf will launch curses-based finder, read the list from STDIN, and write the selected item to STDOUT. ```sh 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`) ```sh vim $(fzf) ``` If you want to preserve the exact sequence of the input, provide `--no-sort` (or `+s`) option. ```sh history | fzf +s ``` ### Keys Use CTRL-J and CTRL-K (or CTRL-N and CTRL-P) to change the selection, press enter key to select the item. CTRL-C, CTRL-G, or ESC will terminate the finder. The following readline key bindings should also work as expected. - CTRL-A / CTRL-E - CTRL-B / CTRL-F - CTRL-H / CTRL-D - CTRL-W / CTRL-U / CTRL-Y - ALT-B / ALT-F If you enable multi-select mode with `-m` option, you can select multiple items with TAB or Shift-TAB key. You can also use mouse. Double-click on an item to select it or shift-click (or ctrl-click) to select multiple items. Use mouse wheel to move the cursor up and down. ### 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. Useful examples --------------- ```sh # fe [FUZZY PATTERN] - Open the selected file with the default editor # - Bypass fuzzy finder if there's only one match (--select-1) # - Exit if there's no match (--exit-0) fe() { local file file=$(fzf --query="$1" --select-1 --exit-0) [ -n "$file" ] && ${EDITOR:-vim} "$file" } # fd - cd to selected directory fd() { local dir dir=$(find ${1:-*} -path '*/\.*' -prune \ -o -type d -print 2> /dev/null | fzf +m) && cd "$dir" } # fh - repeat history fh() { eval $(([ -n "$ZSH_NAME" ] && fc -l 1 || history) | fzf +s | sed 's/ *[0-9]* *//') } # fkill - kill process fkill() { ps -ef | sed 1d | fzf -m | awk '{print $2}' | xargs kill -${1:-9} } ``` For more examples, see [the wiki page](https://github.com/junegunn/fzf/wiki/examples). 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`. Auto-completion --------------- Disclaimer: *Auto-completion feature is currently experimental, it can change over time* ### 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]**` ```sh # Files under current directory # - You can select multiple items with TAB key vim ** # Files under parent directory vim ../** # Files under parent directory that match `fzf` vim ../fzf** # Files under your home directory vim ~/** # Directories under current directory (single-selection) cd ** # Directories under ~/github that match `fzf` cd ~/github/fzf** ``` #### 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. ```sh # Can select multiple processes with or keys kill -9 ``` #### Host names For ssh and telnet commands, fuzzy completion for host names is provided. The names are extracted from /etc/hosts and ~/.ssh/config. ```sh ssh ** telnet ** ``` #### Settings ```sh # Use ~~ as the trigger sequence instead of the default ** export FZF_COMPLETION_TRIGGER='~~' # Options to fzf command export FZF_COMPLETION_OPTS='+c -x' ``` ### zsh TODO :smiley: (Pull requests are appreciated.) Usage as Vim plugin ------------------- (Note: To use fzf in GVim, bash and xterm are required.) ### `:FZF[!]` If you have set up fzf for Vim, `:FZF` command will be added. ```vim " 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, `xterm` command will be used to launch fzf. You can set options to `xterm` command with `g:fzf_xterm_options`. For example, ```vim let g:fzf_xterm_options = '-geometry 120x30' ``` ### `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%`) | | `xterm_options` | string | Options to `xterm` command (Only used in GVim) | #### Examples If `sink` option is not given, `fzf#run` will simply return the list. ```vim 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. ```vim " 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: ```vim " Choose a color scheme with fzf nnoremap C :call fzf#run({ \ 'source': \ map(split(globpath(&rtp, "colors/*.vim"), "\n"), \ "substitute(fnamemodify(v:val, ':t'), '\\..\\{-}$', '', '')"), \ 'sink': 'colo', \ 'options': '+m', \ 'tmux_width': 20, \ 'xterm_options': '-geometry 20x30' \ }) ``` `sink` option can be a function reference. The following example creates a handy mapping that selects an open buffer. ```vim " 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 :call fzf#run({ \ 'source': reverse(BufList()), \ 'sink': function('BufOpen'), \ 'options': '+m', \ 'tmux_height': '40%' \ }) ``` ### Articles - [fzf+vim+tmux](http://junegunn.kr/2014/04/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`. 5. Ruby 1.9 or above is required for correctly displaying unicode characters. ### Ranking algorithm fzf sorts the result first by the length of the matched substring, then by the length of the whole string. However it only does so when the number of matches is less than the limit which is by default 1000, in order to avoid the cost of sorting a large list and limit the response time of the query. This limit can be adjusted with `-s` option, or with the environment variable `FZF_DEFAULT_OPTS`. ```sh export FZF_DEFAULT_OPTS="--sort 20000" ``` ### Respecting `.gitignore`, `.hgignore`, and `svn:ignore` [ag](https://github.com/ggreer/the_silver_searcher) or [pt](https://github.com/monochromegane/the_platinum_searcher) will do the filtering: ```sh # 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. ```sh # 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 splits It isn't too hard to write your own fzf-tmux combo like the default CTRL-T key binding. (Or is it?) ```sh # 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](https://github.com/fish-shell/fish-shell/issues/1362) 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. ```sh 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 ``` ### Windows fzf works on [Cygwin](http://www.cygwin.com/) and [MSYS2](http://sourceforge.net/projects/msys2/). You may need to use `--black` option on MSYS2 to avoid rendering issues. ### Handling UTF-8 NFD paths on OSX Use iconv to convert NFD paths to NFC: ```sh find . | iconv -f utf-8-mac -t utf8//ignore | fzf ``` License ------- MIT Author ------ Junegunn Choi