Fzf

Integrate fzf functionality into fish! Includes handy functions to do the following using

fzf

• command tab completion
• search command history
• find and cd into sub-directories
• find and open files

All functions

• are lazily-loaded to keep shell startup time down
• have preset but configurable key bindings

Installation

With fisher

fisher add jethrokuan/fzf

With oh-my-fish

omf install https://github.com/jethrokuan/fzf

Requirements

• fish

  >=2.4.0

• fzf

  >0.11.3

About the fzf binary

This package will fail if the

fzf

PATH

See the fzf documentation for instructions to install

fzf

Usage

| Legacy | New Keybindings | Remarks | | ----------- | --------------- | ----------------------------------------------- | | Ctrl-t | Ctrl-o | Find a file. | | Ctrl-r | Ctrl-r | Search through command history. | | Alt-c | Alt-c | cd into sub-directories (recursively searched). | | Alt-Shift-c | Alt-Shift-c | cd into sub-directories, including hidden ones. | | Ctrl-o | Alt-o | Open a file/dir using default editor ($EDITOR) | | Ctrl-g | Alt-Shift-o | Open a file/dir using xdg-open or open command |

Legacy keybindings are kept by default, but these have conflict with keybindings in fish 2.4.0. If you want to use the new keybindings, enter the following into your terminal:

set -U FZF_LEGACY_KEYBINDINGS 0

You can disable default keybindings altogether by running:

set -U FZF_DISABLE_KEYBINDINGS 1

NOTE: On OS X, Alt-c (Option-c) types ç by default. In iTerm2, you can send the right escape sequence with Esc-c. If you configure the option key to act as +Esc (iTerm2 Preferences > Profiles > Default > Keys > Left option (⌥) acts as: > +Esc), then alt-c will work for fzf as documented.

Commands

| Variable | Remarks | Example | | ------------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------- | |

FZF_FIND_FILE_COMMAND

set -U FZF_FIND_FILE_COMMAND "ag -l --hidden --ignore .git . \$dir 2> /dev/null"

set -U FZF_FIND_FILE_COMMAND "fd --type f . \$dir"

$dir

FZF_CD_COMMAND

FZF_CD_WITH_HIDDEN_COMMAND

FZF_OPEN_COMMAND

FZF_PREVIEW_FILE_CMD

set -U FZF_PREVIEW_FILE_CMD "head -n 10"

FZF_PREVIEW_DIR_CMD

set -U FZF_PREVIEW_DIR_CMD "ls"

Variables

| Variable | Remarks | Example | | --------------------------- | ------------------------------------------------------------- | ----------------------------------------------------- | |

FZF_DEFAULT_OPTS

set -U FZF_DEFAULT_OPTS "--height 40"

FZF_FIND_FILE_OPTS

set -U FZF_FIND_FILE_OPTS "--reverse --inline-info"

FZF_CD_OPTS

FZF_CD_WITH_HIDDEN_OPTS

FZF_REVERSE_ISEARCH_OPTS

FZF_OPEN_OPTS

FZF_COMPLETE_OPTS

FZF_TMUX

set -U FZF_TMUX 1

FZF_ENABLE_OPEN_PREVIEW

set -U FZF_ENABLE_OPEN_PREVIEW 1

FZF Tab Completions

This package ships with a

fzf

Alternatives

• fzf-fish-integration is a newer fzf plugin with very similar features. It lacks Tmux support and fzf tab completion but includes functions for searching git log and browsing shell variables using fzf. Additionally, it is more likely to be maintained going forward. You can read more about the differences between it and this plugin in the readme of

  fzf-fish-integration

  here.
• The

  fzf

  utility ships with its own out-of-the-box fish integration. What sets this package apart is that it has a couple more integrations, most notably tab completion. They are not compatible so use one or the other.

License

fzf is MIT licensed. See the LICENSE for details.