Quickstart •Installation • Usage • Commands • Customization • Wiki
fzf changed my command life, it can change yours too, if you allow it.
- Quickstart
- Rationale
- Why Fzf-lua
- Dependencies
- Installation
- Usage
- Commands
- Customization
- Insert-mode Completion
- Default Options
- Highlights
- Credits
To quickly test this plugin without changing your configuration run (will run in it's own sandbox with the default keybinds below):
sh -c "$(curl -s https://raw.githubusercontent.com/ibhagwan/fzf-lua/main/scripts/mini.sh)"Note: it's good practice to first read the script before running
sh -cdirectly from the web
| Key | Command | Key | Command |
|---|---|---|---|
<C-\> |
buffers | <C-p> |
files |
<C-g> |
grep | <C-l> |
live_grep |
<C-k> |
builtin commands | <F1> |
neovim help |
Easy! run :FzfLua setup_fzfvim_cmds and use the same familiar commands
used by fzf.vim, i.e. :Files, :Rg, etc.
Using the builtin
fzf-vimprofile will also create fzf.vim's user commands, i.e.require("fzf-lua").setup({ "fzf-vim" })
What more can be said about fzf? It is the single most impactful tool for my command line workflow, once I started using fzf I couldn’t see myself living without it.
To understand fzf properly I highly recommended fzf screencast by @samoshkin
This is my take on the original fzf.vim, written in lua for neovim 0.5, it builds on the elegant nvim-fzf as an async interface to create a performant and lightweight fzf client for neovim that rivals any of the new shiny fuzzy finders for neovim.
... and not telescope or any other vim/neovim household name?
As @junegunn himself put it, “because you can
and you love fzf”.
If you’re happy with your current setup there is absolutely no reason to switch.
That said, without taking anything away from the greatness of other plugins I
found it more efficient having a uniform experience between my shell and my
nvim. In addition fzf has been a rock for me since I started using it and
hadn’t failed me once, it never hangs and can handle almost anything you throw
at it. That, and colorful file icons and git indicators!.
neovimversion >0.5.0fzfversion >0.24orskimbinary installed- nvim-web-devicons (optional)
- fd - better
findutility - rg - better
greputility - bat - syntax highlighted previews when using fzf's native previewer
- delta - syntax highlighted git pager for git status previews
- nvim-dap - for Debug Adapter Protocol (DAP) support
Below are a few optional dependencies for viewing media files (which you need
to configure in previewer.builtin.extensions):
- chafa - terminal image previewer (recommended, supports most file formats)
- viu - terminal image previewer
- ueberzug - X11 image previewer
-
rg is required for
grepandtags -
git for Windows is required for
git(though installinggit-bash|shis not required). -
Installation of dependencies (fzf, rg, fd, etc) is possible via scoop, chocolatey or winget-cli
-
Although almost everything works on Windows exactly as the *NIX/OSX check out the Windows README for known issues and limitations.
Using vim-plug
Plug 'ibhagwan/fzf-lua', {'branch': 'main'}
" optional for icon support
Plug 'nvim-tree/nvim-web-devicons'Using packer.nvim
use { "ibhagwan/fzf-lua",
-- optional for icon support
requires = { "nvim-tree/nvim-web-devicons" }
}Using lazy.nvim
{
"ibhagwan/fzf-lua",
-- optional for icon support
dependencies = { "nvim-tree/nvim-web-devicons" },
config = function()
-- calling `setup` is optional for customization
require("fzf-lua").setup({})
end
}Note: if you already have fzf installed you do not need to install
fzforfzf.vim, however if you do not have it installed, you only need fzf which can be installed with (fzf.vim is not a requirement nor conflict):Plug "junegunn/fzf", { "do": { -> fzf#install() } }or with packer.nvim:
use = { "junegunn/fzf", run = "./install --bin" }or with lazy.nvim
{ "junegunn/fzf", build = "./install --bin" }
Fzf-lua aims to be as plug and play as possible with sane defaults, you can run any fzf-lua command like this:
:lua require('fzf-lua').files()
-- or using the `FzfLua` vim command:
:FzfLua filesor with arguments:
:lua require('fzf-lua').files({ cwd = '~/.config' })
-- or using the `FzfLua` vim command:
:FzfLua files cwd=~/.configwhich can be easily mapped to:
nnoremap <c-P> <cmd>lua require('fzf-lua').files()<CR>or if using init.lua:
vim.keymap.set("n", "<c-P>",
"<cmd>lua require('fzf-lua').files()<CR>", { silent = true })Resuming work from where you left off is as easy as:
:lua require('fzf-lua').resume()
-- or
:FzfLua resumeAlternatively, resuming work on a specific provider:
:lua require('fzf-lua').files({ resume = true })
-- or
:FzfLua files resume=true| Command | List |
|---|---|
buffers |
open buffers |
files |
find or fd on a path |
oldfiles |
opened files history |
quickfix |
quickfix list |
quickfix_stack |
quickfix stack |
loclist |
location list |
loclist_stack |
location stack |
lines |
open buffers lines |
blines |
current buffer lines |
tabs |
open tabs |
args |
argument list |
| Command | List |
|---|---|
grep |
search for a pattern with grep or rg |
grep_last |
run search again with the last pattern |
grep_cword |
search word under cursor |
grep_cWORD |
search WORD under cursor |
grep_visual |
search visual selection |
grep_project |
search all project lines (fzf.vim's :Rg) |
grep_curbuf |
search current buffer lines |
lgrep_curbuf |
live grep current buffer |
live_grep |
live grep current project |
live_grep_resume |
live grep continue last search |
live_grep_glob |
live_grep with rg --glob support |
live_grep_native |
performant version of live_grep |
| Command | List |
|---|---|
tags |
search project tags |
btags |
search buffer tags |
tags_grep |
grep project tags |
tags_grep_cword |
tags_grep word under cursor |
tags_grep_cWORD |
tags_grep WORD under cursor |
tags_grep_visual |
tags_grep visual selection |
tags_live_grep |
live grep project tags |
| Command | List |
|---|---|
git_files |
git ls-files |
git_status |
git status |
git_commits |
git commit log (project) |
git_bcommits |
git commit log (buffer) |
git_branches |
git branches |
git_tags |
git tags |
git_stash |
git stash |
| Command | List |
|---|---|
lsp_references |
References |
lsp_definitions |
Definitions |
lsp_declarations |
Declarations |
lsp_typedefs |
Type Definitions |
lsp_implementations |
Implementations |
lsp_document_symbols |
Document Symbols |
lsp_workspace_symbols |
Workspace Symbols |
lsp_live_workspace_symbols |
Workspace Symbols (live query) |
lsp_incoming_calls |
Incoming Calls |
lsp_outgoing_calls |
Outgoing Calls |
lsp_code_actions |
Code Actions |
lsp_finder |
All LSP locations, combined view |
diagnostics_document |
Document Diagnostics |
diagnostics_workspace |
Workspace Diagnostics |
lsp_document_diagnostics |
alias to diagnostics_document |
lsp_workspace_diagnostics |
alias to diagnostics_workspace |
| Command | List |
|---|---|
resume |
resume last command/query |
builtin |
fzf-lua builtin commands |
profiles |
fzf-lua configuration profiles |
help_tags |
help tags |
man_pages |
man pages |
colorschemes |
color schemes |
highlights |
highlight groups |
commands |
neovim commands |
command_history |
command history |
search_history |
search history |
marks |
:marks |
jumps |
:jumps |
changes |
:changes |
registers |
:registers |
tagstack |
:tags |
autocmds |
:autocmd |
keymaps |
key mappings |
filetypes |
filetypes |
menus |
menus |
spell_suggest |
spelling suggestions |
packadd |
:packadd |
:help vim.ui.selectfor more info
| Command | List |
|---|---|
register_ui_select |
register fzf-lua as the UI interface for vim.ui.select |
deregister_ui_select |
de-register fzf-lua with vim.ui.select |
Requires
nvim-dap
| Command | List |
|---|---|
dap_commands |
list,run nvim-dap builtin commands |
dap_configurations |
list,run debug configurations |
dap_breakpoints |
list,delete breakpoints |
dap_variables |
active session variables |
dap_frames |
active session jump to frame |
| Command | List |
|---|---|
tmux_buffers |
list tmux paste buffers |
| Command | List |
|---|---|
complete_path |
complete path under cursor (incl dirs) |
complete_file |
complete file under cursor (excl dirs) |
complete_line |
complete line (all open buffers) |
complete_bline |
complete line (current buffer only) |
ADVANCED CUSTOMIZATION : to create your own fzf-lua commands see Wiki/ADVANCED
Customization can be achieved by calling the setup() function (optional) or
individually sending parameters to a builtin command, A few examples below:
Different
fzflayout:
:lua require('fzf-lua').files({ fzf_opts = {['--layout'] = 'reverse-list'} })Using
fileswith a different command and working directory:
:lua require'fzf-lua'.files({ prompt="LS> ", cmd = "ls", cwd="~/<folder>" })Using
live_grepwithgit grep:
:lua require'fzf-lua'.live_grep({ cmd = "git grep --line-number --column --color=always" })
colorschemeswith non-default window size:
:lua require'fzf-lua'.colorschemes({ winopts = { height=0.33, width=0.33 } })Use setup() If you wish for a setting to persist and not have to send it using the call
arguments, e.g:
require('fzf-lua').setup{
winopts = {
...
}
}Can also be called from a .vim file:
lua << EOF
require('fzf-lua').setup{
...
}
EOFConveniently, fzf-lua comes with a set of preconfigured profiles, notably:
| Profile | Details |
|---|---|
default |
fzf-lua defaults, uses neovim "builtin" previewer and devicons (if available) for git/files/buffers |
fzf-native |
utilizes fzf's native previewing ability in the terminal where possible using bat for previews |
fzf-tmux |
similar to fzf-native and opens in a tmux popup (requires tmux > 3.2) |
fzf-vim |
closest to fzf.vim's defaults (+icons), also sets up user commands (:Files, :Rg, etc) |
max-perf |
similar to fzf-native and disables icons globally for max performance |
telescope |
closest match to telescope defaults in look and feel and keybinds |
skim |
uses skim as an fzf alternative, (requires the sk binary) |
Use :FzfLua profiles to experiment with the different profiles, once you've found what
you like and wish to make the profile persist, send a string argument at the first index
of the table sent to the setup function:
require('fzf-lua').setup({'fzf-native'})Note:
setupcan be called multiple times for profile "live" switching
You can also start with a profile as "baseline" and customize it, for example,
telescope defaults with bat previewer:
:lua require"fzf-lua".setup({"telescope",winopts={preview={default="bat"}}})See profiles for more info.
Fzf-lua comes with a set of completion functions for paths/files and lines from open buffers as
well as custom completion, for example, set path/completion using <C-x><C-f>:
inoremap <c-x><c-f> <cmd>lua require("fzf-lua").complete_path()<cr>Or in all modes using lua:
vim.keymap.set({ "n", "v", "i" }, "<C-x><C-f>",
function() require("fzf-lua").complete_path() end,
{ silent = true, desc = "Fuzzy complete path" })Or with a custom command and preview:
vim.keymap.set({ "i" }, "<C-x><C-f>",
function()
require("fzf-lua").complete_file({
cmd = "rg --files",
winopts = { preview = { hidden = "nohidden" } }
})
end, { silent = true, desc = "Fuzzy complete file" })Note: only
complete_filesupports a previewer
Every fzf-lua function can be easily converted to a completion function by sending
complete = true in the options:
By default fzf-lua will insert the entry at the cursor location as if you used
pto paste the selected entry.
require("fzf-lua").fzf_exec({"foo", "bar"}, {complete = true})Custom completion is possible using a custom completion callback, the example below will replace the text from the current cursor column with the selected entry:
require("fzf-lua").fzf_exec({"foo", "bar"}, {
-- @param selected: the selected entry or entries
-- @param opts: fzf-lua caller/provider options
-- @param line: originating buffer completed line
-- @param col: originating cursor column location
-- @return newline: will replace the current buffer line
-- @return newcol?: optional, sets the new cursor column
complete = function(selected, opts, line, col)
local newline = line:sub(1, col) .. selected[1]
-- set cursor to EOL, since `nvim_win_set_cursor`
-- is 0-based we have to lower the col value by 1
return newline, #newline - 1
end
})Below is a list of most (still, not all default settings), please also consult the issues if there's something you need and you can't find as there have been many obscure requests which have been fulfilled and are yet to be documented. If you're still having issues and/or questions do not hesitate to open an issue and I'll be more than happy to help.
CLICK HERE TO EXPLORE THE DEFAULT OPTIONS
local actions = require "fzf-lua.actions"
require'fzf-lua'.setup {
-- fzf_bin = 'sk', -- use skim instead of fzf?
-- https://github.com/lotabout/skim
-- can also be set to 'fzf-tmux'
winopts = {
-- split = "belowright new",-- open in a split instead?
-- "belowright new" : split below
-- "aboveleft new" : split above
-- "belowright vnew" : split right
-- "aboveleft vnew : split left
-- Only valid when using a float window
-- (i.e. when 'split' is not defined, default)
height = 0.85, -- window height
width = 0.80, -- window width
row = 0.35, -- window row position (0=top, 1=bottom)
col = 0.50, -- window col position (0=left, 1=right)
-- border argument passthrough to nvim_open_win(), also used
-- to manually draw the border characters around the preview
-- window, can be set to 'false' to remove all borders or to
-- 'none', 'single', 'double', 'thicc' (+cc) or 'rounded' (default)
border = { '╭', '─', '╮', '│', '╯', '─', '╰', '│' },
-- requires neovim > v0.9.0, passed as is to `nvim_open_win`
-- can be sent individually to any provider to set the win title
-- title = "Title",
-- title_pos = "center", -- 'left', 'center' or 'right'
fullscreen = false, -- start fullscreen?
preview = {
-- default = 'bat', -- override the default previewer?
-- default uses the 'builtin' previewer
border = 'border', -- border|noborder, applies only to
-- native fzf previewers (bat/cat/git/etc)
wrap = 'nowrap', -- wrap|nowrap
hidden = 'nohidden', -- hidden|nohidden
vertical = 'down:45%', -- up|down:size
horizontal = 'right:60%', -- right|left:size
layout = 'flex', -- horizontal|vertical|flex
flip_columns = 120, -- #cols to switch to horizontal on flex
-- Only used with the builtin previewer:
title = true, -- preview border title (file/buf)?
title_pos = "center", -- left|center|right, title alignment
scrollbar = 'float', -- `false` or string:'float|border'
-- float: in-window floating border
-- border: in-border chars (see below)
scrolloff = '-2', -- float scrollbar offset from right
-- applies only when scrollbar = 'float'
scrollchars = {'█', '' }, -- scrollbar chars ({ <full>, <empty> }
-- applies only when scrollbar = 'border'
delay = 100, -- delay(ms) displaying the preview
-- prevents lag on fast scrolling
winopts = { -- builtin previewer window options
number = true,
relativenumber = false,
cursorline = true,
cursorlineopt = 'both',
cursorcolumn = false,
signcolumn = 'no',
list = false,
foldenable = false,
foldmethod = 'manual',
},
},
on_create = function()
-- called once upon creation of the fzf main window
-- can be used to add custom fzf-lua mappings, e.g:
-- vim.keymap.set("t", "<C-j>", "<Down>", { silent = true, buffer = true })
end,
-- called once *after* the fzf interface is closed
-- on_close = function() ... end
},
keymap = {
-- These override the default tables completely
-- no need to set to `false` to disable a bind
-- delete or modify is sufficient
builtin = {
-- neovim `:tmap` mappings for the fzf win
["<F1>"] = "toggle-help",
["<F2>"] = "toggle-fullscreen",
-- Only valid with the 'builtin' previewer
["<F3>"] = "toggle-preview-wrap",
["<F4>"] = "toggle-preview",
-- Rotate preview clockwise/counter-clockwise
["<F5>"] = "toggle-preview-ccw",
["<F6>"] = "toggle-preview-cw",
["<S-down>"] = "preview-page-down",
["<S-up>"] = "preview-page-up",
["<S-left>"] = "preview-page-reset",
},
fzf = {
-- fzf '--bind=' options
["ctrl-z"] = "abort",
["ctrl-u"] = "unix-line-discard",
["ctrl-f"] = "half-page-down",
["ctrl-b"] = "half-page-up",
["ctrl-a"] = "beginning-of-line",
["ctrl-e"] = "end-of-line",
["alt-a"] = "toggle-all",
-- Only valid with fzf previewers (bat/cat/git/etc)
["f3"] = "toggle-preview-wrap",
["f4"] = "toggle-preview",
["shift-down"] = "preview-page-down",
["shift-up"] = "preview-page-up",
},
},
actions = {
-- These override the default tables completely
-- no need to set to `false` to disable an action
-- delete or modify is sufficient
files = {
-- providers that inherit these actions:
-- files, git_files, git_status, grep, lsp
-- oldfiles, quickfix, loclist, tags, btags
-- args
-- default action opens a single selection
-- or sends multiple selection to quickfix
-- replace the default action with the below
-- to open all files whether single or multiple
-- ["default"] = actions.file_edit,
["default"] = actions.file_edit_or_qf,
["ctrl-s"] = actions.file_split,
["ctrl-v"] = actions.file_vsplit,
["ctrl-t"] = actions.file_tabedit,
["alt-q"] = actions.file_sel_to_qf,
["alt-l"] = actions.file_sel_to_ll,
},
buffers = {
-- providers that inherit these actions:
-- buffers, tabs, lines, blines
["default"] = actions.buf_edit,
["ctrl-s"] = actions.buf_split,
["ctrl-v"] = actions.buf_vsplit,
["ctrl-t"] = actions.buf_tabedit,
}
},
fzf_opts = {
-- options are sent as `<left>=<right>`
-- set to `false` to remove a flag
-- set to `true` for a no-value flag
-- for raw args use `fzf_args` instead
["--ansi"] = true,
["--info"] = "inline",
["--height"] = "100%",
["--layout"] = "reverse",
["--border"] = "none",
},
-- Only used when fzf_bin = "fzf-tmux", by default opens as a
-- popup 80% width, 80% height (note `-p` requires tmux > 3.2)
-- and removes the sides margin added by `fzf-tmux` (fzf#3162)
-- for more options run `fzf-tmux --help`
fzf_tmux_opts = { ["-p"] = "80%,80%", ["--margin"] = "0,0" },
-- fzf '--color=' options (optional)
--[[ fzf_colors = {
["fg"] = { "fg", "CursorLine" },
["bg"] = { "bg", "Normal" },
["hl"] = { "fg", "Comment" },
["fg+"] = { "fg", "Normal" },
["bg+"] = { "bg", "CursorLine" },
["hl+"] = { "fg", "Statement" },
["info"] = { "fg", "PreProc" },
["prompt"] = { "fg", "Conditional" },
["pointer"] = { "fg", "Exception" },
["marker"] = { "fg", "Keyword" },
["spinner"] = { "fg", "Label" },
["header"] = { "fg", "Comment" },
["gutter"] = { "bg", "Normal" },
}, ]]
previewers = {
cat = {
cmd = "cat",
args = "-n",
},
bat = {
cmd = "bat",
args = "--color=always --style=numbers,changes",
-- uncomment to set a bat theme, `bat --list-themes`
-- theme = 'Coldark-Dark',
},
head = {
cmd = "head",
args = nil,
},
git_diff = {
-- if required, use `{file}` for argument positioning
-- e.g. `cmd_modified = "git diff --color HEAD {file} | cut -c -30"`
cmd_deleted = "git diff --color HEAD --",
cmd_modified = "git diff --color HEAD",
cmd_untracked = "git diff --color --no-index /dev/null",
-- git-delta is automatically detected as pager, set `pager=false`
-- to disable, can also be set under 'git.status.preview_pager'
},
man = {
-- NOTE: remove the `-c` flag when using man-db
-- replace with `man -P cat %s | col -bx` on OSX
cmd = "man -c %s | col -bx",
},
builtin = {
syntax = true, -- preview syntax highlight?
syntax_limit_l = 0, -- syntax limit (lines), 0=nolimit
syntax_limit_b = 1024*1024, -- syntax limit (bytes), 0=nolimit
limit_b = 1024*1024*10, -- preview limit (bytes), 0=nolimit
-- previewer treesitter options:
-- enable specific filetypes with: `{ enable = { "lua" } }
-- exclude specific filetypes with: `{ disable = { "lua" } }
-- disable fully with: `{ enable = false }`
treesitter = { enable = true, disable = {} },
-- By default, the main window dimensions are calculated as if the
-- preview is visible, when hidden the main window will extend to
-- full size. Set the below to "extend" to prevent the main window
-- from being modified when toggling the preview.
toggle_behavior = "default",
-- Title transform function, by default only displays the tail
-- title_fnamemodify = function(s) vim.fn.fnamemodify(s, ":t") end,
-- preview extensions using a custom shell command:
-- for example, use `viu` for image previews
-- will do nothing if `viu` isn't executable
extensions = {
-- neovim terminal only supports `viu` block output
["png"] = { "viu", "-b" },
-- by default the filename is added as last argument
-- if required, use `{file}` for argument positioning
["svg"] = { "chafa", "{file}" },
["jpg"] = { "ueberzug" },
},
-- if using `ueberzug` in the above extensions map
-- set the default image scaler, possible scalers:
-- false (none), "crop", "distort", "fit_contain",
-- "contain", "forced_cover", "cover"
-- https://github.com/seebye/ueberzug
ueberzug_scaler = "cover",
-- Custom filetype autocmds aren't triggered on
-- the preview buffer, define them here instead
-- ext_ft_override = { ["ksql"] = "sql", ... },
},
-- Code Action previewers, default is "codeaction" (set via `lsp.code_actions.previewer`)
-- "codeaction_native" uses fzf's native previewer, recommended when combined with git-delta
codeaction = {
-- options for vim.diff(): https://neovim.io/doc/user/lua.html#vim.diff()
diff_opts = { ctxlen = 3 },
},
codeaction_native = {
diff_opts = { ctxlen = 3 },
-- git-delta is automatically detected as pager, set `pager=false`
-- to disable, can also be set under 'lsp.code_actions.preview_pager'
-- recommended styling for delta
--pager = [[delta --width=$COLUMNS --hunk-header-style="omit" --file-style="omit"]],
},
},
-- PROVIDERS SETUP
-- use `defaults` (table or function) if you wish to set "global-provider" defaults
-- for example, disabling file icons globally and open the quickfix list at the top
-- defaults = {
-- file_icons = false,
-- copen = "topleft copen",
-- },
files = {
-- previewer = "bat", -- uncomment to override previewer
-- (name from 'previewers' table)
-- set to 'false' to disable
prompt = 'Files❯ ',
multiprocess = true, -- run command in a separate process
git_icons = true, -- show git icons?
file_icons = true, -- show file icons?
color_icons = true, -- colorize file|git icons
-- path_shorten = 1, -- 'true' or number, shorten path?
-- executed command priority is 'cmd' (if exists)
-- otherwise auto-detect prioritizes `fd`:`rg`:`find`
-- default options are controlled by 'fd|rg|find|_opts'
-- NOTE: 'find -printf' requires GNU find
-- cmd = "find . -type f -printf '%P\n'",
find_opts = [[-type f -not -path '*/\.git/*' -printf '%P\n']],
rg_opts = [[--color=never --files --hidden --follow -g "!.git"]],
fd_opts = [[--color=never --type f --hidden --follow --exclude .git]],
-- by default, cwd appears in the header only if {opts} contain a cwd
-- parameter to a different folder than the current working directory
-- uncomment if you wish to force display of the cwd as part of the
-- query prompt string (fzf.vim style), header line or both
-- cwd_header = true,
cwd_prompt = true,
cwd_prompt_shorten_len = 32, -- shorten prompt beyond this length
cwd_prompt_shorten_val = 1, -- shortened path parts length
toggle_ignore_flag = "--no-ignore", -- flag toggled in `actions.toggle_ignore`
actions = {
-- inherits from 'actions.files', here we can override
-- or set bind to 'false' to disable a default action
-- action to toggle `--no-ignore`, requires fd or rg installed
["ctrl-g"] = { actions.toggle_ignore },
-- uncomment to override `actions.file_edit_or_qf`
-- ["default"] = actions.file_edit,
-- custom actions are available too
-- ["ctrl-y"] = function(selected) print(selected[1]) end,
}
},
git = {
files = {
prompt = 'GitFiles❯ ',
cmd = 'git ls-files --exclude-standard',
multiprocess = true, -- run command in a separate process
git_icons = true, -- show git icons?
file_icons = true, -- show file icons?
color_icons = true, -- colorize file|git icons
-- force display the cwd header line regardless of your current working
-- directory can also be used to hide the header when not wanted
-- cwd_header = true
},
status = {
prompt = 'GitStatus❯ ',
cmd = "git -c color.status=false --no-optional-locks status --porcelain=v1 -u",
multiprocess = true, -- run command in a separate process
file_icons = true,
git_icons = true,
color_icons = true,
previewer = "git_diff",
-- git-delta is automatically detected as pager, uncomment to disable
-- preview_pager = false,
actions = {
-- actions inherit from 'actions.files' and merge
["right"] = { fn = actions.git_unstage, reload = true },
["left"] = { fn = actions.git_stage, reload = true },
["ctrl-x"] = { fn = actions.git_reset, reload = true },
},
-- If you wish to use a single stage|unstage toggle instead
-- using 'ctrl-s' modify the 'actions' table as shown below
-- actions = {
-- ["right"] = false,
-- ["left"] = false,
-- ["ctrl-x"] = { fn = actions.git_reset, reload = true },
-- ["ctrl-s"] = { fn = actions.git_stage_unstage, reload = true },
-- },
},
commits = {
prompt = 'Commits❯ ',
cmd = [[git log --color --pretty=format:"%C(yellow)%h%Creset ]]
.. [[%Cgreen(%><(12)%cr%><|(12))%Creset %s %C(blue)<%an>%Creset"]],
preview = "git show --color {1}",
-- git-delta is automatically detected as pager, uncomment to disable
-- preview_pager = false,
actions = {
["default"] = actions.git_checkout,
-- remove `exec_silent` or set to `false` to exit after yank
["ctrl-y"] = { fn = actions.git_yank_commit, exec_silent = true },
},
},
bcommits = {
prompt = 'BCommits❯ ',
-- default preview shows a git diff vs the previous commit
-- if you prefer to see the entire commit you can use:
-- git show --color {1} --rotate-to={file}
-- {1} : commit SHA (fzf field index expression)
-- {file} : filepath placement within the commands
cmd = [[git log --color --pretty=format:"%C(yellow)%h%Creset ]]
.. [[%Cgreen(%><(12)%cr%><|(12))%Creset %s %C(blue)<%an>%Creset" {file}]],
preview = "git show --color {1} -- {file}",
-- git-delta is automatically detected as pager, uncomment to disable
-- preview_pager = false,
actions = {
["default"] = actions.git_buf_edit,
["ctrl-s"] = actions.git_buf_split,
["ctrl-v"] = actions.git_buf_vsplit,
["ctrl-t"] = actions.git_buf_tabedit,
["ctrl-y"] = { fn = actions.git_yank_commit, exec_silent = true },
},
},
branches = {
prompt = 'Branches❯ ',
cmd = "git branch --all --color",
preview = "git log --graph --pretty=oneline --abbrev-commit --color {1}",
actions = {
["default"] = actions.git_switch,
},
},
tags = {
prompt = "Tags> ",
cmd = [[git for-each-ref --color --sort="-taggerdate" --format ]]
.. [["%(color:yellow)%(refname:short)%(color:reset) ]]
.. [[%(color:green)(%(taggerdate:relative))%(color:reset)]]
.. [[ %(subject) %(color:blue)%(taggername)%(color:reset)" refs/tags]],
preview = [[git log --graph --color --pretty=format:"%C(yellow)%h%Creset ]]
.. [[%Cgreen(%><(12)%cr%><|(12))%Creset %s %C(blue)<%an>%Creset" {1}]],
actions = { ["default"] = actions.git_checkout },
},
stash = {
prompt = 'Stash> ',
cmd = "git --no-pager stash list",
preview = "git --no-pager stash show --patch --color {1}",
actions = {
["default"] = actions.git_stash_apply,
["ctrl-x"] = { fn = actions.git_stash_drop, reload = true },
},
},
icons = {
["M"] = { icon = "M", color = "yellow" },
["D"] = { icon = "D", color = "red" },
["A"] = { icon = "A", color = "green" },
["R"] = { icon = "R", color = "yellow" },
["C"] = { icon = "C", color = "yellow" },
["T"] = { icon = "T", color = "magenta" },
["?"] = { icon = "?", color = "magenta" },
-- override git icons?
-- ["M"] = { icon = "★", color = "red" },
-- ["D"] = { icon = "✗", color = "red" },
-- ["A"] = { icon = "+", color = "green" },
},
},
grep = {
prompt = 'Rg❯ ',
input_prompt = 'Grep For❯ ',
multiprocess = true, -- run command in a separate process
git_icons = true, -- show git icons?
file_icons = true, -- show file icons?
color_icons = true, -- colorize file|git icons
-- executed command priority is 'cmd' (if exists)
-- otherwise auto-detect prioritizes `rg` over `grep`
-- default options are controlled by 'rg|grep_opts'
-- cmd = "rg --vimgrep",
grep_opts = "--binary-files=without-match --line-number --recursive --color=auto --perl-regexp -e",
rg_opts = "--column --line-number --no-heading --color=always --smart-case --max-columns=4096 -e",
-- set to 'true' to always parse globs in both 'grep' and 'live_grep'
-- search strings will be split using the 'glob_separator' and translated
-- to '--iglob=' arguments, requires 'rg'
-- can still be used when 'false' by calling 'live_grep_glob' directly
rg_glob = false, -- default to glob parsing?
glob_flag = "--iglob", -- for case sensitive globs use '--glob'
glob_separator = "%s%-%-", -- query separator pattern (lua): ' --'
-- advanced usage: for custom argument parsing define
-- 'rg_glob_fn' to return a pair:
-- first returned argument is the new search query
-- second returned argument are additional rg flags
-- rg_glob_fn = function(query, opts)
-- ...
-- return new_query, flags
-- end,
actions = {
-- actions inherit from 'actions.files' and merge
-- this action toggles between 'grep' and 'live_grep'
["ctrl-g"] = { actions.grep_lgrep }
-- uncomment to enable '.gitignore' toggle for grep
-- ["ctrl-r"] = { actions.toggle_ignore }
},
no_header = false, -- hide grep|cwd header?
no_header_i = false, -- hide interactive header?
},
args = {
prompt = 'Args❯ ',
files_only = true,
-- actions inherit from 'actions.files' and merge
actions = { ["ctrl-x"] = { fn = actions.arg_del, reload = true } },
},
oldfiles = {
prompt = 'History❯ ',
cwd_only = false,
stat_file = true, -- verify files exist on disk
include_current_session = false, -- include bufs from current session
},
buffers = {
prompt = 'Buffers❯ ',
file_icons = true, -- show file icons?
color_icons = true, -- colorize file|git icons
sort_lastused = true, -- sort buffers() by last used
show_unloaded = true, -- show unloaded buffers
cwd_only = false, -- buffers for the cwd only
cwd = nil, -- buffers list for a given dir
actions = {
-- actions inherit from 'actions.buffers' and merge
-- by supplying a table of functions we're telling
-- fzf-lua to not close the fzf window, this way we
-- can resume the buffers picker on the same window
-- eliminating an otherwise unaesthetic win "flash"
["ctrl-x"] = { fn = actions.buf_del, reload = true },
}
},
tabs = {
prompt = 'Tabs❯ ',
tab_title = "Tab",
tab_marker = "<<",
file_icons = true, -- show file icons?
color_icons = true, -- colorize file|git icons
actions = {
-- actions inherit from 'actions.buffers' and merge
["default"] = actions.buf_switch,
["ctrl-x"] = { fn = actions.buf_del, reload = true },
},
fzf_opts = {
-- hide tabnr
["--delimiter"] = "[\\):]",
["--with-nth"] = '2..',
},
},
lines = {
previewer = "builtin", -- set to 'false' to disable
prompt = 'Lines❯ ',
show_unloaded = true, -- show unloaded buffers
show_unlisted = false, -- exclude 'help' buffers
no_term_buffers = true, -- exclude 'term' buffers
fzf_opts = {
-- do not include bufnr in fuzzy matching
-- tiebreak by line no.
["--delimiter"] = "[\\]:]",
["--nth"] = '2..',
["--tiebreak"] = 'index',
["--tabstop"] = "1",
},
-- actions inherit from 'actions.buffers' and merge
actions = {
["default"] = actions.buf_edit_or_qf,
["alt-q"] = actions.buf_sel_to_qf,
["alt-l"] = actions.buf_sel_to_ll
},
},
blines = {
previewer = "builtin", -- set to 'false' to disable
prompt = 'BLines❯ ',
show_unlisted = true, -- include 'help' buffers
no_term_buffers = false, -- include 'term' buffers
-- start = "cursor" -- start display from cursor?
fzf_opts = {
-- hide filename, tiebreak by line no.
["--delimiter"] = "[:]",
["--with-nth"] = '2..',
["--tiebreak"] = 'index',
["--tabstop"] = "1",
},
-- actions inherit from 'actions.buffers' and merge
actions = {
["default"] = actions.buf_edit_or_qf,
["alt-q"] = actions.buf_sel_to_qf,
["alt-l"] = actions.buf_sel_to_ll
},
},
tags = {
prompt = 'Tags❯ ',
ctags_file = nil, -- auto-detect from tags-option
multiprocess = true,
file_icons = true,
git_icons = true,
color_icons = true,
-- 'tags_live_grep' options, `rg` prioritizes over `grep`
rg_opts = "--no-heading --color=always --smart-case",
grep_opts = "--color=auto --perl-regexp",
fzf_opts = { ["--info"] = "default", ["--tiebreak"] = "begin" },
actions = {
-- actions inherit from 'actions.files' and merge
-- this action toggles between 'grep' and 'live_grep'
["ctrl-g"] = { actions.grep_lgrep }
},
no_header = false, -- hide grep|cwd header?
no_header_i = false, -- hide interactive header?
},
btags = {
prompt = 'BTags❯ ',
ctags_file = nil, -- auto-detect from tags-option
ctags_autogen = true, -- dynamically generate ctags each call
multiprocess = true,
file_icons = false,
git_icons = false,
rg_opts = "--color=never --no-heading",
grep_opts = "--color=never --perl-regexp",
fzf_opts = { ["--info"] = "default", ["--tiebreak"] = "begin" },
-- actions inherit from 'actions.files'
},
colorschemes = {
prompt = 'Colorschemes❯ ',
live_preview = true, -- apply the colorscheme on preview?
actions = { ["default"] = actions.colorscheme, },
winopts = { height = 0.55, width = 0.30, },
-- uncomment to ignore colorschemes names (lua patterns)
-- ignore_patterns = { "^delek$", "^blue$" },
-- uncomment to execute a callback after interface is closed
-- e.g. a call to reset statusline highlights
-- post_reset_cb = function() ... end,
},
keymaps = {
prompt = "Keymaps> ",
winopts = { preview = { layout = "vertical" } },
fzf_opts = { ["--tiebreak"] = "index", },
-- by default, we ignore <Plug> and <SNR> mappings
-- set `ignore_patterns = false` to disable filtering
ignore_patterns = { "^<SNR>", "^<Plug>" },
actions = {
["default"] = actions.keymap_apply,
["ctrl-s"] = actions.keymap_split,
["ctrl-v"] = actions.keymap_vsplit,
["ctrl-t"] = actions.keymap_tabedit,
},
},
quickfix = {
file_icons = true,
git_icons = true,
},
quickfix_stack = {
prompt = "Quickfix Stack> ",
marker = ">", -- current list marker
},
lsp = {
prompt_postfix = '❯ ', -- will be appended to the LSP label
-- to override use 'prompt' instead
cwd_only = false, -- LSP/diagnostics for cwd only?
async_or_timeout = 5000, -- timeout(ms) or 'true' for async calls
file_icons = true,
git_icons = false,
-- The equivalent of using `includeDeclaration` in lsp buf calls, e.g:
-- :lua vim.lsp.buf.references({includeDeclaration = false})
includeDeclaration = true, -- include current declaration in LSP context
-- settings for 'lsp_{document|workspace|lsp_live_workspace}_symbols'
symbols = {
async_or_timeout = true, -- symbols are async by default
symbol_style = 1, -- style for document/workspace symbols
-- false: disable, 1: icon+kind
-- 2: icon only, 3: kind only
-- NOTE: icons are extracted from
-- vim.lsp.protocol.CompletionItemKind
-- icons for symbol kind
-- see https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#symbolKind
-- see https://github.com/neovim/neovim/blob/829d92eca3d72a701adc6e6aa17ccd9fe2082479/runtime/lua/vim/lsp/protocol.lua#L117
symbol_icons = {
File = "",
Module = "",
Namespace = "",
Package = "",
Class = "",
Method = "",
Property = "",
Field = "",
Constructor = "",
Enum = "",
Interface = "",
Function = "",
Variable = "",
Constant = "",
String = "",
Number = "",
Boolean = "",
Array = "",
Object = "",
Key = "",
Null = "",
EnumMember = "",
Struct = "",
Event = "",
Operator = "",
TypeParameter = "",
},
-- colorize using Treesitter '@' highlight groups ("@function", etc).
-- or 'false' to disable highlighting
symbol_hl = function(s) return "@" .. s:lower() end,
-- additional symbol formatting, works with or without style
symbol_fmt = function(s, opts) return "[" .. s .. "]" end,
-- prefix child symbols. set to any string or `false` to disable
child_prefix = true,
fzf_opts = {
["--tiebreak"] = "begin",
["--info"] = "default",
},
},
code_actions = {
prompt = 'Code Actions> ',
async_or_timeout = 5000,
-- when git-delta is installed use "codeaction_native" for beautiful diffs
-- try it out with `:FzfLua lsp_code_actions previewer=codeaction_native`
-- scroll up to `previewers.codeaction{_native}` for more previewer options
previewer = "codeaction",
},
finder = {
prompt = "LSP Finder> ",
fzf_opts = { ["--info"] = "default" },
file_icons = true,
color_icons = true,
git_icons = false,
async = true, -- async by default
silent = true, -- suppress "not found"
separator = "| ", -- separator after provider prefix, `false` to disable
includeDeclaration = true, -- include current declaration in LSP context
-- by default display all LSP locations
-- to customize, duplicate table and delete unwanted providers
providers = {
{ "references", prefix = require("fzf-lua").utils.ansi_codes.blue("ref ") },
{ "definitions", prefix = require("fzf-lua").utils.ansi_codes.green("def ") },
{ "declarations", prefix = require("fzf-lua").utils.ansi_codes.magenta("decl") },
{ "typedefs", prefix = require("fzf-lua").utils.ansi_codes.red("tdef") },
{ "implementations", prefix = require("fzf-lua").utils.ansi_codes.green("impl") },
{ "incoming_calls", prefix = require("fzf-lua").utils.ansi_codes.cyan("in ") },
{ "outgoing_calls", prefix = require("fzf-lua").utils.ansi_codes.yellow("out ") },
},
}
},
diagnostics ={
prompt = 'Diagnostics❯ ',
cwd_only = false,
file_icons = true,
git_icons = false,
diag_icons = true,
diag_source = true, -- display diag source (e.g. [pycodestyle])
icon_padding = '', -- add padding for wide diagnostics signs
multiline = true, -- concatenate multi-line diags into a single line
-- set to `false` to display the first line only
-- by default icons and highlights are extracted from 'DiagnosticSignXXX'
-- and highlighted by a highlight group of the same name (which is usually
-- set by your colorscheme, for more info see:
-- :help DiagnosticSignHint'
-- :help hl-DiagnosticSignHint'
-- only uncomment below if you wish to override the signs/highlights
-- define only text, texthl or both (':help sign_define()' for more info)
-- signs = {
-- ["Error"] = { text = "", texthl = "DiagnosticError" },
-- ["Warn"] = { text = "", texthl = "DiagnosticWarn" },
-- ["Info"] = { text = "", texthl = "DiagnosticInfo" },
-- ["Hint"] = { text = "", texthl = "DiagnosticHint" },
-- },
-- limit to specific severity, use either a string or num:
-- 1 or "hint"
-- 2 or "information"
-- 3 or "warning"
-- 4 or "error"
-- severity_only: keep any matching exact severity
-- severity_limit: keep any equal or more severe (lower)
-- severity_bound: keep any equal or less severe (higher)
},
complete_path = {
cmd = nil, -- default: auto detect fd|rg|find
complete = { ["default"] = actions.complete },
},
complete_file = {
cmd = nil, -- default: auto detect rg|fd|find
file_icons = true,
color_icons = true,
git_icons = false,
-- actions inherit from 'actions.files' and merge
actions = { ["default"] = actions.complete },
-- previewer hidden by default
winopts = { preview = { hidden = "hidden" } },
},
-- uncomment to use fzf native previewers
-- (instead of using a neovim floating window)
-- manpages = { previewer = "man_native" },
-- helptags = { previewer = "help_native" },
--
-- optional override of file extension icon colors
-- available colors (terminal):
-- clear, bold, black, red, green, yellow
-- blue, magenta, cyan, grey, dark_grey, white
file_icon_colors = {
["sh"] = "green",
},
-- padding can help kitty term users with
-- double-width icon rendering
file_icon_padding = '',
-- uncomment if your terminal/font does not support unicode character
-- 'EN SPACE' (U+2002), the below sets it to 'NBSP' (U+00A0) instead
-- nbsp = '\xc2\xa0',
}FzfLua conveniently creates the below highlights, each hlgroup can be
temporarily overridden by its corresponding winopts option:
| Highlight Group | Default | Override Via | Notes |
|---|---|---|---|
| FzfLuaNormal | Normal | hls.normal |
Main win fg/bg |
| FzfLuaBorder | Normal | hls.border |
Main win border |
| FzfLuaTitle | FzfLuaNormal | hls.title |
Main win title |
| FzfLuaPreviewNormal | FzfLuaNormal | hls.preview_normal |
Builtin preview fg/bg |
| FzfLuaPreviewBorder | FzfLuaBorder | hls.preview_border |
Builtin preview border |
| FzfLuaPreviewTitle | FzfLuaTitle | hls.preview_title |
Builtin preview title |
| FzfLuaCursor | Cursor | hls.cursor |
Builtin preview Cursor |
| FzfLuaCursorLine | CursorLine | hls.cursorline |
Builtin preview Cursorline |
| FzfLuaCursorLineNr | CursorLineNr | hls.cursorlinenr |
Builtin preview CursorLineNr |
| FzfLuaSearch | IncSearch | hls.search |
Builtin preview search matches |
| FzfLuaScrollBorderEmpty | FzfLuaBorder | hls.scrollborder_e |
Builtin preview border scroll empty |
| FzfLuaScrollBorderFull | FzfLuaBorder | hls.scrollborder_f |
Builtin preview border scroll full |
| FzfLuaScrollFloatEmpty | PmenuSbar | hls.scrollfloat_e |
Builtin preview float scroll empty |
| FzfLuaScrollFloatFull | PmenuThumb | hls.scrollfloat_f |
Builtin preview float scroll full |
| FzfLuaHelpNormal | FzfLuaNormal | hls.help_normal |
Help win fg/bg |
| FzfLuaHelpBorder | FzfLuaBorder | hls.help_border |
Help win border |
| FzfLuaHeaderBind | *BlanchedAlmond | hls.header_bind |
Header keybind |
| FzfLuaHeaderText | *Brown1 | hls.header_text |
Header text |
| FzfLuaBufName | *LightMagenta | hls.buf_name |
Buffer name (lines) |
| FzfLuaBufNr | *BlanchedAlmond | hls.buf_nr |
Buffer number (all buffers) |
| FzfLuaBufLineNr | *MediumSpringGreen | hls.buf_linenr |
Buffer line (lines) |
| FzfLuaBufFlagCur | *Brown1 | hls.buf_flag_cur |
Buffer line (buffers) |
| FzfLuaBufFlagAlt | *CadetBlue1 | hls.buf_flag_alt |
Buffer line (buffers) |
| FzfLuaTabTitle | *LightSkyBlue1 | hls.tab_title |
Tab title (tabs) |
| FzfLuaTabMarker | *BlanchedAlmond | hls.tab_marker |
Tab marker (tabs) |
| FzfLuaDirIcon | Directory | hls.dir_icon |
Paths directory icon |
*Not a highlight group, RGB color from nvim_get_color_map
These can be easily customized either via the lua API:
:lua vim.api.nvim_set_hl(0, "FzfLuaBorder", { link = "FloatBorder" })Or vimscript:
:hi! link FzfLuaBorder FloatBorderIf you wish to override a highlight without having to modify your
colorscheme highlights, set the corresponding hls override or
specify it directly via a call argument.
Temporary highlight override:
:lua require'fzf-lua'.files({ hls={preview_title="IncSearch"} })Permanent global override via setup:
require('fzf-lua').setup{
hls = { border = "FloatBorder" }
}Big thank you to all those I borrowed code/ideas from, I read so many configs and plugin codes that I probably forgot where I found some samples from so if I missed your name feel free to contact me and I'll add it below:
- @vijaymarupudi for his wonderful nvim-fzf plugin which is at the core of this plugin
- @tjdevries for too many great things to list here and for borrowing some of his nvim-telescope provider code
- @lukas-reineke for inspiring the solution after browsing his dotfiles and coming across his fuzzy.lua , and while we're, also here for his great lua plugin indent-blankline
- @sindrets for borrowing utilities from his fantastic lua plugin diffview.nvim
- @kevinhwang91 for using his previewer code as baseline for the builtin previewer and his must have plugin nvim-bqf