# nvim-fzy

**Repository Path**: yesuu/nvim-fzy

## Basic Information

- **Project Name**: nvim-fzy
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-19
- **Last Updated**: 2022-04-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# nvim-fzy

Like [fzf.vim][1] but for [fzy][2] and neovim with Lua API.


## Installation

- Requires Neovim >= 0.5
- 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

Create some mappings like this:

```vimL
lua fzy = require('fzy')
nnoremap <silent><leader>ff :lua fzy.execute('fd', fzy.sinks.edit_file)<CR>
nnoremap <silent><leader>fb :lua fzy.actions.buffers()<CR>
nnoremap <silent><leader>ft :lua fzy.try(fzy.actions.lsp_tags, fzy.actions.buf_tags)<CR>
nnoremap <silent><leader>fg :lua fzy.execute('git ls-files', fzy.sinks.edit_file)<CR>
nnoremap <silent><leader>fq :lua fzy.actions.quickfix()<CR>
nnoremap <silent><leader>f/ :lua fzy.actions.buf_lines()<CR>
nnoremap <silent><leader>fl :lua fzy.execute('ag --nobreak --noheading .', fzy.sinks.edit_live_grep)<CR>
```


See `:help fzy` for more information

![demo](demo/demo.gif)

Enjoy


## 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