Skip to content

Latest commit

 

History

History
220 lines (148 loc) · 9.94 KB

README.md

File metadata and controls

220 lines (148 loc) · 9.94 KB
Raw

fzf.fish 🔍🐟

latest release badge build status badge awesome badge

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

demo.mov

Search commands

Use fzf.fish to interactively find and insert file paths, git commit hashes, and other entities into your command line. Tab to select multiple entries. If you trigger a search while your cursor is on a word, that word will be used to seed the fzf query and will be replaced by your selection. All searches include a preview of the entity hovered over to help you find what you're looking for.

📁 Search Directory

Search Directory example

  • Fzf input: recursive listing of current directory's non-hidden files
  • Output: relative paths of selected files
  • Key binding and mnemonic: Ctrl+Alt+F (F for file)
  • Preview window: file with syntax highlighting, directory contents, or file type
  • Remarks
    • directories are inserted with a trailing /, so if you select exactly one directory, you can immediately hit ENTER to cd into it
    • if the current token is a directory with a trailing slash (e.g. .config/<CURSOR>), then that directory is searched instead
    • ignores files that are also ignored by git

🪵 Search Git Log

Search Git Log example

  • Fzf input: the current repository's formatted git log
  • Output: hashes of selected commits
  • Key binding and mnemonic: Ctrl+Alt+L (L for log)
  • Preview window: commit message and diff

📝 Search Git Status

Search Git Status example

  • Fzf input: the current repository's git status
  • Output: relative paths of selected lines
  • Key binding and mnemonic: Ctrl+Alt+S (S for status)
  • Preview window: the git diff of the file

📜 Search History

Search History example

  • Fzf input: Fish's command history
  • Output: selected commands
  • Key binding and mnemonic: Ctrl+R (R for reverse-i-search)
  • Preview window: the entire command with Fish syntax highlighting

🖥️ Search Processes

Search Processes example

  • Fzf input: the pid and command of all running processes, outputted by ps
  • Output: pids of selected processes
  • Key binding and mnemonic: Ctrl+Alt+P (P for process)
  • Preview window: the CPU usage, memory usage, start time, and other information about the process

💲 Search Variables

Search Variables example

  • Fzf input: all the shell variables currently in scope
  • Output: selected shell variables
  • Key binding and mnemonic: Ctrl+V (V for variable)
  • Preview window: the variable's scope info and values
  • $history is excluded for technical reasons so use Search History instead to inspect it

Installation

First, install a proper version of these CLI dependencies:

CLI Minimum version required Description
fish 3.4.0 a modern shell
fzf 0.33.0 fuzzy finder that powers this plugin
fd 8.5.0 faster, colorized alternative to find
bat 0.16.0 smarter cat with syntax highlighting

fd and bat only need to be installed if you will use Search Directory.

Next, because fzf.fish is incompatible with other fzf plugins, check for and remove these two common alternatives.

Finally, 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 key bindings

fzf.fish includes an ergonomic function for configuring its key bindings. Read its documentation:

fzf_configure_bindings --help

Call fzf_configure_bindings in your config.fish in order to persist your custom bindings.

Change fzf options for all commands

fzf supports global default options via the FZF_DEFAULT_OPTS and FZF_DEFAULT_OPTS_FILE environment variables. If neither are set, fzf.fish sets its own default opts whenever it executes fzf.

Change fzf options for a specific command

Each command's fzf options can be configured via a variable:

Command Variable
Search Directory fzf_directory_opts
Search Git Log fzf_git_log_opts
Search Git Status fzf_git_status_opts
Search History fzf_history_opts
Search Processes fzf_processes_opts
Search Variables fzf_variables_opts

The value of each variable is appended last to fzf's options list. Because fzf uses the last instance of an option if it is specified multiple times, custom options take precedence. Custom fzf options unlock a variety of augmentations:

Find more ideas and tips in the Cookbook.

Change how Search Directory previews directories and regular files

Search Directory, by default, executes ls to preview directories and bat to preview regular files.

To use your own directory preview command, set it in fzf_preview_dir_cmd:

set fzf_preview_dir_cmd eza --all --color=always

And to use your own file preview command, set it in fzf_preview_file_cmd:

set fzf_preview_file_cmd cat -n

Omit the target path for both variables as fzf.fish will itself specify the argument to preview.

Change what files are listed by Search Directory

To pass custom options to fd when Search Directory executes it to populate the list of files, set them in fzf_fd_opts:

set fzf_fd_opts --hidden --max-depth 5

By default, fd hides files listed in .gitignore. You can disable this behavior by adding the --no-ignore flag to fzf_fd_opts.

Change Search Git Log's commit formatting

Search Git Log executes git log --format to format the list of commits. To use your own commit log format, set it in fzf_git_log_format. For example, this shows the hash and subject for each commit:

set fzf_git_log_format "%H %s"

The format must be one line per commit and the hash must be the first field, or else Search Git Log will fail to determine which commits you selected.

Integrate with a diff highlighter

To pipe the git diff previews from Search Git Log and Search Git Status through a highlighter tool (e.g. delta or diff-so-fancy), set a command invoking the highlighter in fzf_diff_highlighter. It should not pipe its output to a pager:

# width=20 so delta decorations don't wrap around small fzf preview pane
set fzf_diff_highlighter delta --paging=never --width=20
# Or, if using DFS
set fzf_diff_highlighter diff-so-fancy

Change Search History's date time format

Search History shows the date time each command was executed. To change how its formatted, set your strftime format string in fzf_history_time_format. For example, this shows the date time as DD-MM-YY:

set fzf_history_time_format %d-%m-%y

Do not to include the vertical box-drawing character │ (not to be confused with the pipe character |) as it is relied on to delineate the date time from the command.

Further reading

Find answers to these questions and more in the project Wiki: