Migration Guides

Don't like the new changes? Don't have enough time to migrate? Freeze your plugin at its current version and update when you're ready. See the Cookbook.

v7

Search directory's key binding changed

The default key binding for search directory has been changed from Ctrl+F to Ctrl+Alt+F. To revert to the original binding, add this to your config.fish:

fzf_configure_bindings --directory=\cf

Custom key binding mechanism completely replaced

The former method of customizing your key bindings by setting fzf_fish_custom_keybindings and then installing all the bindings yourself has been replaced with fzf_configure_bindings.

• Users who customize their bindings must migrate to this method because all the private function names have been renamed. Thankfully, it should only take one line--one invocation of fzf_configure_bindings--to port over all your custom bindings.
• Users who did not customize their bindings (probably because doing so was tedious and hacky) are encouraged to use this to customize their bindings to their hearts' content now that this is a much smoother process.

Here's how I would migrate:.

1. Read fzf_configure_bindings --help
2. Play around with it on your command line until you've achieve your desired set of key bindings. There are no side effects of repeatedly executing it in the same session.
3. Add your fzf_configure_bindings command to your config.fish: it is safe to do so and it is expected to live there if you want your changes to persist.

v5

If you do not use custom key bindings, there is nothing you need to do to upgrade to v5. However, if you do, you need to update your key binding to call __fzf_search_current_dir with two new arguments:

# If you use custom key bindings, change this...
bind \cv '__fzf_search_current_dir'
bind --mode insert \cv '__fzf_search_current_dir'

# ...to this...
set --local search_vars_cmd '__fzf_search_shell_variables (set --show | psub) (set --names | psub)'
bind \cv $search_vars_cmd
bind --mode insert \cv $search_vars_cmd

See conf.d/fzf.fish for more details.

v2

After much feedback around Search Git Log's Ctrl+L key binding conflicting with clear screen, I have decided to change its key binding to Ctrl+Alt+L. An alternative option I considered was just Alt+L, which is shorter but I realized conflicts with __fish_list_current_token, which is actually quite useful.