https://github.com/mfussenegger/nvim-fzy

Fuzzy picker & vim.ui.select implementation via fzy for neovim
https://github.com/mfussenegger/nvim-fzy

fuzzy fzy neovim neovim-plugin

Last synced: 9 days ago
JSON representation

Fuzzy picker & vim.ui.select implementation via fzy for neovim

• Host: GitHub
• URL: https://github.com/mfussenegger/nvim-fzy
• Owner: mfussenegger
• License: gpl-3.0
• Created: 2020-10-14T17:08:09.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-27T16:50:13.000Z (6 months ago)
• Last Synced: 2024-08-02T13:33:55.758Z (3 months ago)
• Topics: fuzzy, fzy, neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 511 KB
• Stars: 53
• Watchers: 4
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nvim-fzy

A `vim.ui.select` implementation for the [fzy][2] CLI.

## Installation

- Requires Neovim (latest stable or nightly)

- Install [fzy][2] and make sure it is in your `$PATH`.

- nvim-fzy is a plugin. Install it like any other plugin:

  - If using [vim-plug][5]: `Plug 'mfussenegger/nvim-fzy'`

  - If using [packer.nvim][6]: `use 'mfussenegger/nvim-fzy'`

## Usage

`nvim-fzy` provides the `vim.ui.select` implementation and a `execute` function

to feed the output of commands to `fzy`.

Create some mappings like this:

```vimL

lua fzy = require('fzy')

nnoremap ff :lua fzy.execute('fd', fzy.sinks.edit_file)

nnoremap fg :lua fzy.execute('git ls-files', fzy.sinks.edit_file)

nnoremap fl :lua fzy.execute('ag --nobreak --noheading .', fzy.sinks.edit_live_grep)

```

See `:help fzy` for more information

![demo](demo/demo.gif)

To get additional pickers to jump to tags and other stuff, you can use it in combination with [nvim-qwahl](https://github.com/mfussenegger/nvim-qwahl)

Enjoy

## Customize

- You can override the `new_pop` function if you want to customize the floating window.

- You can override the `command` function if you want to customize the `fzy` shell command.

Take a look at the source to see the default implementations.

## Goals

- Have a simple API so people can create their custom actions.

- Include the essentials, but not much more than that.

This plugin is pretty much *done* and won't see feature additions, unless there

is a convincing case to be made.

## Alternatives

- [fzf.vim][1]

- [telescope.nvim][4]

[1]: https://github.com/junegunn/fzf.vim

[2]: https://github.com/jhawthorn/fzy

[4]: https://github.com/nvim-lua/telescope.nvim

[5]: https://github.com/junegunn/vim-plug

[6]: https://github.com/wbthomason/packer.nvim