neersighted / fzf.fish

Augment your fish command line with fzf key bindings.

fzf.fish 🔍🐟

Augment your Fish command line with mnemonic key bindings to efficiently find what you need using fzf.

Features

Use fzf.fish to interactively find and insert into the command line:

File paths

• Search input: recursive listing of current directory's non-hidden files
• Key binding and mnemonic: Ctrl+F (F for file)
• Preview window: file with syntax highlighting, directory contents, or file type
• Remarks
  • prepends ./ to the selection if only one selection is made and it becomes the only token on the command line, making it easy to execute if an executable, or cd into if a directory (see cd docs)
  • if the current token is a directory with a trailing slash (e.g. functions/<CURSOR>), then search will be scoped to that directory
  • ignores files that are also ignored by git
  • Tab to multi-select

Modified paths

• Search input: the current repository's git status
• Key binding and mnemonic: Ctrl+Alt+S (S for status, Alt to prevent overriding pager-toggle-search)
• Remarks: Tab to multi-select

A commit hash

• Search input: the current repository's formatted git log
• Key binding and mnemonic: Ctrl+Alt+L (L for log, Alt to prevent overriding clear screen)
• Preview window: commit message and diff

A previously run command

• Search input: the command history from all interactive sessions of Fish
• Key binding and mnemonic: Ctrl+R (R for reverse-i-search)
• Preview window: the entire command, wrapped

A shell variable

• Search input: all the variable names of the environment currently in scope
• Key binding and mnemonic: Ctrl+V (V for variable)
• Preview window: the scope info and values of the variable
• Remarks
  • $history is excluded for technical reasons so use the search command history feature instead to inspect it

The prompt used in the screencasts was created using IlanCosman/tide.

Installation

First, install a proper version of these CLIs:

CLI	Minimum version required	Description
fish	3.2.0	a modern shell
fzf	0.25	command-line fuzzy finder that powers this plugin
fd	7.5.0	much faster and friendlier alternative to find
bat	0.16.0	smarter cat with syntax highlighting

On certain distribution of Linux, you will need to alias fdfind to fd (see #93).

Next, install this plugin with Fisher.

fzf.fish can be installed manually or with other plugin managers but only Fisher is officially supported.

fisher install PatrickF1/fzf.fish

Configuration

Customize the key bindings

If you would like to customize the key bindings, first, prevent the default key bindings from executing by setting fzf_fish_custom_keybindings as an universal variable. You can do this with

set --universal fzf_fish_custom_keybindings

Do not try to set fzf_fish_custom_keybindings in your config.fish because the key binding configuration is sourced first on shell startup and so will not see it.

Next, set your own key bindings by following conf.d/fzf.fish as an example.

Pass fzf options to all commands

fzf supports setting default options via the FZF_DEFAULT_OPTS environment variable. If it is set, fzf will implicitly prepend it to the options passed in on every execution, scripted or interactive.

To make fzf's interface friendlier, fzf.fish takes the liberty of setting a sane FZF_DEFAULT_OPTS if it is not already set. See conf.d/fzf.fish for more details. This affects fzf even outside of this plugin. If you would like to remove this side effect or just want to customize fzf's default options, then set export your own FZF_DEFAULT_OPTS variable. For example:

set --export FZF_DEFAULT_OPTS --height 50% --no-extended +i

Pass fzf options to a specific command

The following variables can store custom options that will be passed to fzf by their respective feature:

Feature	Variable
Search directory	fzf_dir_opts
Search git status	fzf_git_status_opts
Search git log	fzf_git_log_opts
Search command history	fzf_history_opts
Search shell variables	fzf_shell_vars_opts

They are always appended last to fzf's argument list. Because fzf uses the option appearing last when options conflict, your custom options can override hardcoded options. Custom fzf options unlocks a variety of possibilities in customizing and augmenting each feature such as:

• add key bindings within fzf to operate on the selected line:
  • open file in Vim
  • preview image files
  • copy to clipboard
  • git checkout commit
  • git reset file
• adjust the preview command or window
• re-populate fzf's input list on demand
• change the search mode

Change the command used to preview folders

The search directory feature, by default, uses ls to preview the contents of a directory. To integrate with the variety of ls replacements available, the command used to preview directories is configurable through the fzf_preview_dir_cmd variable. For example, in your config.fish, you may put:

set fzf_preview_dir_cmd exa --all --color=always

Do not specify a target path in the command, as fzf.fish will prepend the directory to preview to the command itself.

Change the files searched

To pass custom options to fd when it is executed to populate the list of files for the search directory feature, set the fzf_fd_opts variable. For example, to include hidden files but not .git, put this in your config.fish:

set fzf_fd_opts --hidden --exclude=.git

Change the key binding for a single command

See the FAQ Wiki page.

Prior art

If fzf.fish is a useful plugin, it is by standing on the shoulder of giants. There are two other fzf integrations for Fish worth regarding: jethrokuan/fzf and fzf's out-of-the-box Fish extension. The Prior Art Wiki page explains how fzf.fish compares to and improves on them.

Troubleshooting & FAQ

Need help? These Wiki pages can guide you:

• Troubleshooting
• FAQ