This script integrates the FZF "fuzzy finder" with the Clink command line editing enhancements for CMD.exe on Windows.

This also includes key bindings for git objects, powered by fzf (ported from fzf-git.sh).

1. Copy the fzf.lua file into your Clink scripts directory (you can run clink info to find it, or see Location of Lua Scripts in the Clink docs for more info).

   • You can also copy the fzf_git*.* files into your Clink scripts directory, to enable using fzf to browse git objects.
   • You can also copy the fzf_rg.lua file into your Clink scripts directory, to enable using ripgrep and fzf together to search files and do fuzzy filtering on the results.

2. Either put fzf.exe in a directory listed in the system PATH environment variable, or run clink set fzf.exe_location to tell Clink where to find the FZF program.

3. Set up key bindings.

   • To use the default key bindings, run clink set fzf.default_bindings true.
   • To use custom key bindings, add them to your .inputrc file (see Key Bindings).

4. Optionally install ripgrep for searching files.

5. Optionally install bat for fancy previewing of files.

For detailed information on using FZF, please refer to the FZF documentation.

Here are the default key bindings for fzf powered completions in Clink, if you've enabled the fzf.default_bindings setting:

You can use **Tab to list files recursively under the directory.

For example:

• notepad ** lists files recursively under the current directory.
• notepad foo** lists files recursively under the current directory, and uses foo as the search phrase.
• notepad bar\foo** lists files recursively under the bar directory, and uses foo as the search phrase.

Here are the default key bindings for git objects in Clink, unless you've disabled the fzf_git.default_bindings setting:

Here are the default key bindings for ripgrep/fzf searches:

You can also run the fzf_rg.cmd script to invoke searching files with ripgrep and fzf from the command line, instead of using a key binding.

You can use your own custom key bindings if you prefer.

Run clink set fzf.default_bindings false and add key bindings to your .inputrc file manually.

Run clink echo to find key bindings strings. See Key Bindings in the Clink documentation for more information on how to set key bindings.

The default key bindings for FZF are listed here in .inputrc file format for convenience:

# Default key bindings for fzf with Clink.
"\C-t":        "luafunc:fzf_file"               # Ctrl-T lists files recursively; choose one or multiple to insert them.
"\C-r":        "luafunc:fzf_history"            # Ctrl-R lists history entries; choose one to insert it.
"\M-c":        "luafunc:fzf_directory"          # Alt-C lists subdirectories; choose one to 'cd /d' to it.
"\M-b":        "luafunc:fzf_bindings"           # Alt-B lists key bindings; choose one to invoke it.
"\t":          "luafunc:fzf_complete"           # Tab uses fzf to filter match completions, but only when preceded by '**' (recursive).
"\e[27;5;32~": "luafunc:fzf_complete_force"     # Ctrl-Space uses fzf to filter match completions (and supports '**' for recursive).

The default key bindings for git objects are listed here in .inputrc file format for convenience:

# Default key bindings for fzf_git with Clink.
"\C-g?":       "luafunc:fzf_git_help"           # Ctrl-G,? shows key bindings for fzf_git.
"\C-g\C-f":    "luafunc:fzf_git_files"          # Ctrl-G,Ctrl-F uses fzf for Files.
"\C-g\C-b":    "luafunc:fzf_git_branches"       # Ctrl-G,Ctrl-B uses fzf for Branches.
"\C-g\C-t":    "luafunc:fzf_git_tags"           # Ctrl-G,Ctrl-T uses fzf for Tags.
"\C-g\C-r":    "luafunc:fzf_git_remotes"        # Ctrl-G,Ctrl-R uses fzf for Remotes.
"\C-g\C-h":    "luafunc:fzf_git_commit_hashes"  # Ctrl-G,Ctrl-H uses fzf for commit Hashes.
"\C-g\C-s":    "luafunc:fzf_git_stashes"        # Ctrl-G,Ctrl-S uses fzf for Stashes.
"\C-g\C-l":    "luafunc:fzf_git_reflogs"        # Ctrl-G,Ctrl-L uses fzf for reflogs.
"\C-g\C-w":    "luafunc:fzf_git_worktrees"      # Ctrl-G,Ctrl-W uses fzf for Worktrees.
"\C-g\C-e":    "luafunc:fzf_git_eachref"        # Ctrl-G,Ctrl-E uses fzf for Eachref (git for-each-ref).

The default key bindings for ripgrep/fzf searches are listed here in .inputrc file format for convenience:

# Default key bindings for fzf_ripgrep with Clink.
"\C-xf":       "luafunc:fzf_ripgrep"            # Ctrl-X,F shows a FZF filtered view with files matching search term.
"\C-x\C-f":    "luafunc:fzf_ripgrep"            # Ctrl-X,Ctrl-F shows a FZF filtered view with files matching search term.

The following commands are also available for binding to keys:

You can specify FZF options for each of the different commands:

You can specify FZF options for the git object browsing commands:

You can specify options for ripgrep and FZF when searching files:

The editor to launch is chosen from the following, in priority order:

1. The fzf_rg.editor Clink setting (this expands placeholders; see below).
2. The FZF_RG_EDITOR environment variable (this expands placeholders; see below).
3. The EDITOR environment variable (this does not support placeholders).
4. If none of the above are set, then notepad.exe is used.

For all of these, the string is a command line and may contain flags (for example, myeditor.exe --flag1 --flag2). The filename is automatically appended to the end of the command line, with quotes when appropriate.

The fzf_rg.editor setting and FZF_RG_EDITOR environment variable supporting expanding certain placeholders:

You can specify commands to run for collecting files or directories:

You can optionally have file icons show up in FZF completion lists in Clink (but not for the git object fzf commands).

Requirements:

• Install and use a Nerd Font.
• Clink v1.6.5 or newer.
• DirX v0.9 or newer.
• FZF.

Configure the following environment variables:

• set FZF_CTRL_T_COMMAND=dirx.exe /b /s /X:d /a:-s-h --bare-relative --icons=always --utf8 -- $dir
• set FZF_ALT_C_COMMAND=dirx.exe /b /s /X:d /a:d-s-h --bare-relative --icons=always --utf8 -- $dir
• set FZF_ICON_WIDTH=2

If you want it to recurse into hidden directories, then remove the /X:d part from the commands in the environment variables.

If you want it to list hidden files and directories, then remove the -h part at the end of the /a: flags in the environment variables.

You can specify a preview command for FZF.

If you have enabled icons, then replace each {} with {2..}.

The examples also let you toggle between different preview window sizes with Ctrl-/.

The command will show the contents of files with the Ctrl-T hotkey; it assumes you have bat installed and available in the %PATH% environment variable.

set FZF_CTRL_T_OPTS=--preview-window "right:40%,border-left" --bind "ctrl-/:change-preview-window(right:70%|hidden|)" --preview "bat --force-colorization --style=numbers,changes --line-range=:500 -- {}"

This command will show the contents of folders with the Alt-C hotkey; it assumes you have dirx installed and available in the %PATH% environment variable.

set FZF_ALT_C_OPTS=--preview-window "right:40%,border-left" --bind "ctrl-/:change-preview-window(right:70%|hidden|)" --preview "dirx -b -s --bare-relative --utf8 --level=3 --tree --icons=always -- {}"

The sample script fzf-preview.cmd can be used to preview image files. It assumes you have both chafa and bat installed and available in the %PATH% environment variable.

To use the sample script for previewing image files, replace the --preview "..." part of the examples above with either:

• --preview "fzf-preview.cmd {}" if you're not using icons, or
• --preview "fzf-preview.cmd {2..}" if you're using icons.

If your terminal supports sixels, you can also run set CLINK_FZF_PREVIEW_SIXELS=1 to tell the fzf-preview.cmd script to tell chafa to use sixels.

If you want to customize the flags for chafa and bat:

1. Make a copy of the script.
2. Customize the copy instead of the original. That way, your changes won't get overwritten when you update clink-fzf (or clink-gizmos).
3. Replace fzf-preview.cmd in the examples above with the filename of your customized copy.

FZF assumes UTF8 stdin, but native Windows programs assume stdin and stdout are in the console's current codepage, which is not UTF8 by default.

The fzf.lua and fzf_git.lua scripts automatically save the current codepage and switch to UTF8 before invoking FZF, and then restore the original codepage after FZF exits. This should ensure that users don't need to apply any custom workarounds to get Unicode text to show up in FZF.

For curious readers, here are related issues in FZF:

• fzf/4065 tracks the stdin encoding issue in FZF on Windows.
• fzf/3799 tracks the Unicode keyboard input issue in FZF on Windows.