Repository files navigation

fzf is a general-purpose command-line fuzzy finder.

It's an interactive filter program for any kind of list; files, commandhistory, processes, hostnames, bookmarks, git commits, etc. It implementsa "fuzzy" matching algorithm, so you can quickly type in patterns with omittedcharacters and still get the results you want.

• Portable — Distributed as a single binary for easy installation
• Fast — Optimized to process millions of items instantly
• Versatile — Fully customizable through an event-action binding mechanism
• All-inclusive — Comes with integrations for Bash, Zsh, Fish, Vim, and Neovim

• Installation
  • Using Homebrew
  • Using Mise
  • Linux packages
  • Windows packages
  • Using git
  • Binary releases
  • Setting up shell integration
  • Vim/Neovim plugin
• Upgrading fzf
• Building fzf
• Usage
  • Using the finder
  • Display modes
    • --height mode
    • --tmux mode
  • Search syntax
  • Environment variables
  • Customizing the look
  • Options
  • Demo
• Examples
• Key bindings for command-line
• Fuzzy completion
  • Files and directories
  • Process IDs
  • Host names
  • Environment variables / Aliases
  • Customizing fuzzy completion for bash and zsh
    • Customizing fzf options for completion
    • Customizing completion source for paths and directories
    • Supported commands (bash)
    • Custom fuzzy completion
  • Fuzzy completion for fish
• Vim plugin
• Advanced topics
  • Customizing for different types of input
  • Performance
  • Executing external programs
  • Turning into a different process
  • Reloading the candidate list
    • 1. Update the list of processes by pressing CTRL-R
    • 2. Switch between sources by pressing CTRL-D or CTRL-F
    • 3. Interactive ripgrep integration
  • Preview window
  • Previewing an image
• Tips
  • Respecting.gitignore
  • Fish shell
  • fzf Theme Playground
• Related projects
• License
• Goods
• Sponsors ❤️

You can useHomebrew (on macOS or Linux) to install fzf.

brew install fzf

fzf is also availablevia MacPorts:sudo port install fzf

You can usemise to install fzf.

mise use -g fzf@latest

On Windows, fzf is available viaChocolatey,Scoop,Winget, andMSYS2:

Alternatively, you can "git clone" this repository to any directory and runinstall script.

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

The install script will add lines to your shell configuration file to modify$PATH and set up shell integration.

You can download the official fzf binaries from the releases page.

• https://github.com/junegunn/fzf/releases

Add the following line to your shell configuration file.

• bash

  # Set up fzf key bindings and fuzzy completioneval"$(fzf --bash)"

• zsh

  # Set up fzf key bindings and fuzzy completionsource<(fzf --zsh)

• fish

  # Set up fzf key bindingsfzf--fish| source

If you usevim-plug, add this toyour Vim configuration file:

Plug'junegunn/fzf', {'do': {->fzf#install() } }Plug'junegunn/fzf.vim'

• junegunn/fzf provides the basic library functions
  • fzf#install() makes sure that you have the latest binary
• junegunn/fzf.vim isa separate projectthat provides a variety of useful commands

To learn more about the Vim integration, seeREADME-VIM.md.

fzf is being actively developed, and you might want to upgrade it once in awhile. Please follow the instruction below depending on the installationmethod used.

• git:cd ~/.fzf && git pull && ./install
• brew:brew update; brew upgrade fzf
• macports:sudo port upgrade fzf
• chocolatey:choco upgrade fzf
• vim-plug::PlugUpdate fzf

SeeBUILD.md.

fzf will launch interactive finder, read the list from STDIN, and write theselected item to STDOUT.

find* -type f| fzf> selected

Without STDIN pipe, fzf will traverse the file system under the currentdirectory to get the list of files.

vim$(fzf)

fzf --print0| xargs -0 -o vim

fzf --bind'enter:become(vim {})'

• CTRL-K /CTRL-J (orCTRL-P /CTRL-N) 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 andShift-TAB to mark multiple items
• Emacs style key bindings
• Mouse: scroll, click, double-click; shift-click and shift-scroll onmulti-select mode

fzf by default runs in fullscreen mode, but there are other display modes.

With--height HEIGHT[%], fzf will start below the cursor with the given height.

fzf --height 40%

reverse layout and--border goes well with this option.

fzf --height 40% --layout reverse --border

By prepending~ to the height, you're setting the maximum height.

# Will take as few lines as possible to display the listseq 3| fzf --height~100%seq 3000| fzf --height~100%

Height value can be a negative number.

# Screen height - 3fzf --height -3

With--tmux option, fzf will start in a tmux popup.

# --tmux [center|top|bottom|left|right][,SIZE[%]][,SIZE[%][,border-native]]fzf --tmux center# Center, 50% width and heightfzf --tmux 80%# Center, 80% width and heightfzf --tmux 100%,50%# Center, 100% width and 50% heightfzf --tmux left,40%# Left, 40% widthfzf --tmux left,40%,90%# Left, 40% width, 90% heightfzf --tmux top,40%# Top, 40% heightfzf --tmux bottom,80%,40%# Bottom, 80% width, 40% height

--tmux is silently ignored when you're not on tmux.

# Open in tmux popup if on tmux, otherwise use --height modeexport FZF_DEFAULT_OPTS='--height 40% --tmux bottom,40% --layout reverse --border top'

Unless otherwise specified, fzf starts in "extended-search mode" where you cantype in multiple search terms delimited by spaces. e.g.^music .mp3$ sbtrkt !fire

If you don't prefer fuzzy matching and do not wish to "quote" every word,start fzf with-e or--exact option. Note that when--exact is set,'-prefix "unquotes" the term.

A single bar character term acts as an OR operator. For example, the followingquery matches entries that start withcore and end with eithergo,rb,orpy.

^core go$ | rb$ | py$

• FZF_DEFAULT_COMMAND
  • Default command to use when input is tty
  • e.g.export FZF_DEFAULT_COMMAND='fd --type f'
• FZF_DEFAULT_OPTS
  • Default options
  • e.g.export FZF_DEFAULT_OPTS="--layout=reverse --inline-info"
• FZF_DEFAULT_OPTS_FILE
  • If you prefer to manage default options in a file, set this variable topoint to the location of the file
  • e.g.export FZF_DEFAULT_OPTS_FILE=~/.fzfrc

The user interface of fzf is fully customizable with a large number ofconfiguration options. For a quick setup, you can start with one of the stylepresets —default,full, orminimal — using the--style option.

fzf --style full \    --preview'fzf-preview.sh {}' --bind'focus:transform-header:file --brief {}'

Preset	Screenshot
default
full
minimal

Here's an example based on thefull preset:

git ls-files| fzf --style full \    --border --padding 1,2 \    --border-label' Demo' --input-label' Input' --header-label' File Type' \    --preview'fzf-preview.sh {}' \    --bind'result:transform-list-label:        if [[ -z $FZF_QUERY ]]; then          echo " $FZF_MATCH_COUNT items "        else          echo " $FZF_MATCH_COUNT matches for [$FZF_QUERY] "        fi' \    --bind'focus:transform-preview-label:[[ -n {} ]] && printf " Previewing [%s] " {}' \    --bind'focus:+transform-header:file --brief {} || echo "No file selected"' \    --bind'ctrl-r:change-list-label( Reloading the list )+reload(sleep 2; git ls-files)' \    --color'border:#aaaaaa,label:#cccccc' \    --color'preview-border:#9999cc,preview-label:#ccccff' \    --color'list-border:#669966,list-label:#99cc99' \    --color'input-border:#996666,input-label:#ffcccc' \    --color'header-border:#6699cc,header-label:#99ccff'

See the man page (fzf --man orman fzf) for the full list of options.

If you learn by watching videos, check out this screencast by@samoshkin to explorefzf features.

• Wiki page of examples
  • Disclaimer: The examples on this page are maintained by the communityand are not thoroughly tested
• Advanced fzf examples

Bysetting up shell integration, you can usethe following key bindings in bash, zsh, and fish.

• CTRL-T - Paste the selected files and directories onto the command-line
  • The list is generated using--walker file,dir,follow,hidden option
    • You can override the behavior by settingFZF_CTRL_T_COMMAND to a custom command that generates the desired list
    • Or you can set--walker* options inFZF_CTRL_T_OPTS
  • SetFZF_CTRL_T_OPTS to pass additional options to fzf

    # Preview file content using bat (https://github.com/sharkdp/bat)export FZF_CTRL_T_OPTS="  --walker-skip .git,node_modules,target  --preview 'bat -n --color=always {}'  --bind 'ctrl-/:change-preview-window(down|hidden|)'"

  • Can be disabled by settingFZF_CTRL_T_COMMAND to an empty string whensourcing the script
• CTRL-R - Paste the selected command from history onto the command-line
  • If you want to see the commands in chronological order, pressCTRL-Ragain which toggles sorting by relevance
  • PressALT-R to toggle "raw" mode where you can see the surrounding itemsof a match. In this mode, you can pressCTRL-N andCTRL-P to movebetween the matching items only.
  • PressCTRL-/ orALT-/ to toggle line wrapping
  • SetFZF_CTRL_R_OPTS to pass additional options to fzf

    # CTRL-Y to copy the command into clipboard using pbcopyexport FZF_CTRL_R_OPTS="  --bind 'ctrl-y:execute-silent(echo -n {2..} | pbcopy)+abort'  --color header:italic  --header 'Press CTRL-Y to copy command into clipboard'"

  • Can be disabled by settingFZF_CTRL_R_COMMAND to an empty string whensourcing the script
  • Custom override via a non-emptyFZF_CTRL_R_COMMAND is not yet supported and will emit a warning
• ALT-C - cd into the selected directory
  • The list is generated using--walker dir,follow,hidden option
  • SetFZF_ALT_C_COMMAND to override the default command
    • Or you can set--walker-* options inFZF_ALT_C_OPTS
  • SetFZF_ALT_C_OPTS to pass additional options to fzf

    # Print tree structure in the preview windowexport FZF_ALT_C_OPTS="  --walker-skip .git,node_modules,target  --preview 'tree -C {}'"

  • Can be disabled by settingFZF_ALT_C_COMMAND to an empty string whensourcing the script

Display modes for these bindings can be separately configured viaFZF_{CTRL_T,CTRL_R,ALT_C}_OPTS or globally viaFZF_DEFAULT_OPTS.(e.g.FZF_CTRL_R_OPTS='--tmux bottom,60% --height 60% --border top')

More tips can be found onthe wiki page.

Shell integration also provides fuzzy completion for bash, zsh, and fish.

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

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

# Files under the current directory# - You can select multiple items with TAB keyvim**<TAB># Files under parent directoryvim ../**<TAB># Files under parent directory that match `fzf`vim ../fzf**<TAB># Files under your home directoryvim~/**<TAB># Directories under current directory (single-selection)cd**<TAB># Directories under ~/github that match `fzf`cd~/github/fzf**<TAB>

Fuzzy completion for PIDs is provided for kill command.

# Can select multiple processes with <TAB> or <Shift-TAB> keyskill -9**<TAB>

For ssh command, fuzzy completion for hostnames is provided. The names areextracted from /etc/hosts and ~/.ssh/config.

ssh**<TAB>

# bash and zshunset**<TAB>export**<TAB>unalias**<TAB># fishset<SHIFT-TAB>

# Use ~~ as the trigger sequence instead of the default **export FZF_COMPLETION_TRIGGER='~~'# Options to fzf commandexport FZF_COMPLETION_OPTS='--border --info=inline'# Options for path completion (e.g. vim **<TAB>)export FZF_COMPLETION_PATH_OPTS='--walker file,dir,follow,hidden'# Options for directory completion (e.g. cd **<TAB>)export FZF_COMPLETION_DIR_OPTS='--walker dir,follow'# Advanced customization of fzf options via _fzf_comprun function# - The first argument to the function is the name of the command.# - You should make sure to pass the rest of the arguments ($@) to fzf._fzf_comprun() {local command=$1shiftcase"$command"in    cd)           fzf --preview'tree -C {} | head -200'"$@" ;;    export|unset) fzf --preview"eval 'echo\$'{}""$@" ;;    ssh)          fzf --preview'dig {}'"$@" ;;*)            fzf --preview'bat -n --color=always {}'"$@" ;;esac}

# Use fd (https://github.com/sharkdp/fd) for listing path candidates.# - The first argument to the function ($1) is the base path to start traversal# - See the source code (completion.{bash,zsh}) for the details._fzf_compgen_path() {  fd --hidden --follow --exclude".git"."$1"}# Use fd to generate the list for directory completion_fzf_compgen_dir() {  fd --type d --hidden --follow --exclude".git"."$1"}

On bash, fuzzy completion is enabled only for a predefined set of commands(complete | grep _fzf to see the list). But you can enable it for othercommands as well by using_fzf_setup_completion helper function.

# usage: _fzf_setup_completion path|dir|var|alias|host COMMANDS..._fzf_setup_completion path ag git kubectl_fzf_setup_completion dir tree

(Custom completion API is experimental and subject to change)

For a command named"COMMAND", define_fzf_complete_COMMAND function using_fzf_complete helper.

# Custom fuzzy completion for "doge" command#   e.g. doge **<TAB>_fzf_complete_doge() {  _fzf_complete --multi --reverse --prompt="doge>" --"$@"<<(echo veryecho wowecho suchecho doge)}

• The arguments before-- are the options to fzf.
• After--, simply pass the original completion arguments unchanged ("$@").
• Then, write a set of commands that generates the completion candidates andfeed its output to the function using process substitution (< <(...)).

zsh will automatically pick up the function using the naming convention but inbash you have to manually associate the function with the command using thecomplete command.

[-n"$BASH" ]&&complete -F _fzf_complete_doge -o default -o bashdefault doge

If you need to post-process the output from fzf, define_fzf_complete_COMMAND_post as follows.

_fzf_complete_foo() {  _fzf_complete --multi --reverse --header-lines=3 --"$@"<<(    ls -al)}_fzf_complete_foo_post() {  awk'{print $NF}'}[-n"$BASH" ]&&complete -F _fzf_complete_foo -o default -o bashdefault foo

(Available in 0.68.0 or later)

Fuzzy completion for fish differs from bash and zsh in that:

• It doesn't require a trigger sequence like**. Instead, if activatesonShift-TAB, whileTAB preserves fish's native completion behavior.
• It relies on fish's native completion system to populate the candidate list,rather than performing a recursive file system traversal. For recursivesearching, use theCTRL-T binding instead.
• The only supported configuration variable isFZF_COMPLETION_OPTS.

That said, just like in bash and zsh, you can implement custom completion fora specific command by defining an_fzf_complete_COMMAND function. For example:

function _fzf_complete_foofunction _fzf_complete_foo_postawk'{print$NF}'end  _fzf_complete--multi--reverse--header-lines=3 --$argv< (ls-al|psub)functions-e _fzf_complete_foo_postend

And here's a more complex example for customizinggit

function _fzf_complete_gitswitch$argv[2]case checkoutswitch      _fzf_complete--reverse--no-preview --$argv< (git branch--all--format='%(refname:short)'|psub)case addfunction _fzf_complete_git_postawk'{print$NF}'end      _fzf_complete--multi--reverse --$argv< (gitstatus--short|psub)case show logdifffunction _fzf_complete_git_postawk'{print $1}'end      _fzf_complete--reverse--no-sort--preview='git show --color=always {1}' --$argv< (git log--oneline|psub)case''      __fzf_complete_native"$argv[1]"--query=(commandline-t| string escape)case'*'set-l -- current_token (commandline-t)      __fzf_complete_native"$argv$current_token"--query=(string escape --$current_token)--multiendfunctions-e _fzf_complete_git_postend

SeeREADME-VIM.md.

Since fzf is a general-purpose text filter, its algorithm was designed to"generally" work well with any kind of input. However, admittedly, there is notrue one-size-fits-all solution, and you may want to tweak the algorithm andsome of the settings depending on the type of the input. To make this processeasier, fzf provides a set of "scheme"s for some common input types.

(Seefzf --man for the details)

fzf is fast. Performance should not be a problem in most use cases. However,you might want to be aware of the options that can affect performance.

• --ansi tells fzf to extract and parse ANSI color codes in the input, and itmakes the initial scanning slower. So it's not recommended that you add itto your$FZF_DEFAULT_OPTS.
• --nth makes fzf slower because it has to tokenize each line.
• A plain string--delimiter should be preferred over a regular expressiondelimiter.
• --with-nth makes fzf slower as fzf has to tokenize and reassemble eachline.

You can set up key bindings for starting external processes without leavingfzf (execute,execute-silent).

# Press F1 to open the file with less without leaving fzf# Press CTRL-Y to copy the line to clipboard and aborts fzf (requires pbcopy)fzf --bind'f1:execute(less -f {}),ctrl-y:execute-silent(echo {} | pbcopy)+abort'

SeeKEY/EVENT BINDINGS section of the man page for details.

become(...) is similar toexecute(...)/execute-silent(...) describedabove, but instead of executing the command and coming back to fzf oncomplete, it turns fzf into a new process for the command.

fzf --bind'enter:become(vim {})'

Compared to the seemingly equivalent command substitutionvim "$(fzf)", thisapproach has several advantages:

• Vim will not open an empty file when you terminate fzf withCTRL-C
• Vim will not open an empty file when you pressENTER on an emptyresult
• Can handle multiple selections even when they have whitespaces

  fzf --multi --bind'enter:become(vim {+})'

To be fair, runningfzf --print0 | xargs -0 -o vim instead ofvim "$(fzf)"resolves all of the issues mentioned. Nonetheless,become(...) still offersadditional benefits in different scenarios.

• You can set up multiple bindings to handle the result in different wayswithout any wrapping script

  fzf --bind'enter:become(vim {}),ctrl-e:become(emacs {})'

  • Previously, you would have to use--expect=ctrl-e and check the firstline of the output of fzf
• You can easily build the subsequent command using the field indexexpressions of fzf

  # Open the file in Vim and go to the linegit grep --line-number.|    fzf --delimiter: --nth 3.. --bind'enter:become(vim {1} +{2})'

By bindingreload action to a key or an event, you can make fzf dynamicallyreload the candidate list. See#1750 formore details.

ps -ef|  fzf --bind'ctrl-r:reload(ps -ef)' \      --header'Press CTRL-R to reload' --header-lines=1 \      --height=50% --layout=reverse

FZF_DEFAULT_COMMAND='find . -type f' \  fzf --bind'ctrl-d:reload(find . -type d),ctrl-f:reload(eval "$FZF_DEFAULT_COMMAND")' \      --height=50% --layout=reverse

The following example uses fzf as the selector interface for ripgrep. We boundreload action tochange event, so every time you type on fzf, the ripgrepprocess will restart with the updated query string denoted by the placeholderexpression{q}. Also, note that we used--disabled option so that fzfdoesn't perform any secondary filtering.

:| rg_prefix='rg --column --line-number --no-heading --color=always --smart-case' \    fzf --bind'start:reload:$rg_prefix ""' \        --bind'change:reload:$rg_prefix {q} || true' \        --bind'enter:become(vim {1} +{2})' \        --ansi --disabled \        --height=50% --layout=reverse

If ripgrep doesn't find any matches, it will exit with a non-zero exit status,and fzf will warn you about it. To suppress the warning message, we added|| true to the command, so that it always exits with 0.

See"Using fzf as interactive Ripgrep launcher"for more sophisticated examples.

When the--preview option is set, fzf automatically starts an external processwith the current line as the argument and shows the result in the split window.Your$SHELL is used to execute the command with$SHELL -c COMMAND.The window can be scrolled using the mouse or custom key bindings.

# {} is replaced with the single-quoted string of the focused linefzf --preview'cat {}'

Preview window supports ANSI colors, so you can use any program thatsyntax-highlights the content of a file, such asBat orHighlight:

fzf --preview'bat --color=always {}' --preview-window'~3'

You can customize the size, position, and border of the preview window using--preview-window option, and the foreground and background color of it with--color option. For example,

fzf --height 40% --layout reverse --info inline --border \    --preview'file {}' --preview-window up,1,border-horizontal \    --bind'ctrl-/:change-preview-window(50%|hidden|)' \    --color'fg:#bbccdd,fg+:#ddeeff,bg:#334455,preview-bg:#223344,border:#778899'

See the man page (man fzf) for the full list of options.

More advanced examples can be foundhere.

# *********************# ** DO NOT DO THIS! **# *********************export FZF_DEFAULT_OPTS='--preview "bat --style=numbers --color=always --line-range :500 {}"'# bat doesn't work with any input other than the list of filesps -ef| fzfseq 100| fzfhistory| fzf

fzf can display images in the preview window using one of the following protocols:

• Kitty graphics protocol
• iTerm2 inline images protocol
• Sixel

Seebin/fzf-preview.sh script for more information.

fzf --preview'fzf-preview.sh {}'

You can usefd,ripgrep, orthe silversearcher to traverse the filesystem while respecting.gitignore.

# Feed the output of fd into fzffd --type f --strip-cwd-prefix| fzf# Setting fd as the default source for fzfexport FZF_DEFAULT_COMMAND='fd --type f --strip-cwd-prefix'# Now fzf (w/o pipe) will use the fd command to generate the listfzf# To apply the command to CTRL-T as wellexport FZF_CTRL_T_COMMAND="$FZF_DEFAULT_COMMAND"

If you want the command to follow symbolic links and don't want it to excludehidden files, use the following command:

export FZF_DEFAULT_COMMAND='fd --type f --strip-cwd-prefix --hidden --follow --exclude .git'

CTRL-T key binding of fish, unlike those of bash and zsh, will use the lasttoken on the command-line as the root directory for the recursive search. Forinstance, hittingCTRL-T at the end of the following command-line

ls /var/

will list all files and directories under/var/.

When using a customFZF_CTRL_T_COMMAND, use the unexpanded$dir variable tomake use of this feature.$dir defaults to. when the last token is not avalid directory. Example:

set -g FZF_CTRL_T_COMMAND"command find -L\$dir -type f 2> /dev/null | sed '1d; s#^\./##'"

fzf Theme Playground created byVitor Mello is a webpage where you caninteractively create fzf themes.

https://github.com/junegunn/fzf/wiki/Related-projects

The MIT License (MIT)

Copyright (c) 2013-2026 Junegunn Choi

Grab fzf T-shirts, mugs, and stickers here:https://commitgoods.com/collections/fzf

I would like to thank all the sponsors of this project who make it possible for me to continue to improve fzf.

If you'd like to sponsor this project, please visithttps://github.com/sponsors/junegunn.