Note
This project is in the early stages of development, and its performance and behavior may change.
flf-vim is a Vim/Neovim plugin that integrates the Fluent Finder (flf) command to provide a Fuzzy Finder-like UI for vector search of code using an embedding model.
It enables developers to efficiently locate highly relevant code snippets within their projects based on vague keywords or conceptual queries.
Note
You need install flf.
To use this plugin, the following environment and packages are required, in addition to Vim/Neovim:
- Node.js:
- Required to execute the
flfpackage. You cannot use Bun as the runtime.
- Required to execute the
@sirasagi62/flf:- The core
flfcommand. It must be installed globally or locally using npm.
- The core
Install flf using the following command:
npm install -g @sirasagi62/flfPlease use your preferred Vim plugin manager for installation.
Add the following line to your .vimrc or init.vim, and then run PlugInstall from within Vim (:).
Plug 'your-github-username/flf-vim' " Replace 'your-github-username' with your actual GitHub usernameflf-vim provides commands corresponding to the two main search modes of the flf tool.
Executes a vector search across the entire root directory of your project and displays the results in a Fuzzy Finder-style window.
:FlfDirTip
Use Case: Best for finding where a specific feature or concept is implemented across the entire project.
Executes a vector search only within the content of the currently open buffer.
:FlfBufTip
Use Case: Useful for examining the context in which a specific variable or helper function is used within the file you are currently editing.
This project is licensed under the MIT License.
See the LICENSE file for more details.
Bug reports and feature suggestions are welcome on GitHub Issues. Pull requests are also encouraged.