telescope.nvim vs fzf-lua: which should I use?

Telescope.nvim is deeply integrated with Neovim's Lua ecosystem, offering more built-in pickers and customization, while fzf-lua wraps the external fzf tool for potentially faster searches but less native integration. Choose Telescope for extensibility within Neovim, or fzf-lua if you prefer fzf's algorithm and have it installed.

How to set up telescope.nvim to ignore certain files in searches?

Customize the 'file_ignore_patterns' option in your configuration. For example, in setup(): defaults = { file_ignore_patterns = { 'node_modules', '.git' } }. This applies to find_files and similar pickers, as per the README's customization section.

Why is my telescope.nvim preview window not showing syntax highlighting?

Telescope uses vim.filetype for detection and may require treesitter or syntax plugins. Check the Previewers section in the README; you can use autocmds like 'TelescopePreviewerLoaded' to adjust settings like filetype detection or wrapping.

How do I map a custom key to open telescope find files?

Use vim.keymap.set in Lua: vim.keymap.set('n', ' ff', require('telescope.builtin').find_files, {}). Refer to the Usage section in the README for more examples, including desc for descriptions.

telescope.nvim slow with live_grep, how to speed it up?

Install ripgrep and the telescope-fzf-native extension. Ripgrep is required for live_grep, and the native sorter improves sorting performance. Also, ensure your .gitignore is configured to limit search scope.

Can I use telescope.nvim without installing ripgrep?

Yes, but live_grep and grep_string pickers won't work, as they depend on ripgrep. find_files can use fd or fallback methods, but functionality is limited, so it's strongly recommended in the README.

Best way to install telescope.nvim with lazy.nvim?

Use a spec like: { 'nvim-telescope/telescope.nvim', version = '*', dependencies = { 'nvim-lua/plenary.nvim' } }. Add telescope-fzf-native as an optional dependency for better performance, as shown in the README's Installation section.

telescope.nvim — Extendable Neovim Fuzzy Finder

What is telescope.nvim?

Telescope.nvim is a powerful, community-driven fuzzy finder built specifically for Neovim. It provides a unified interface for searching, filtering, previewing, and selecting items across files, buffers, git commits, LSP symbols, and more, leveraging Neovim's latest Lua capabilities. It solves the problem of navigating and managing codebases efficiently within Neovim by offering a highly customizable and extensible fuzzy-finding experience.

Target Audience

Neovim users, particularly developers who want a modern, Lua-based fuzzy finder integrated into their editor for navigating codebases, files, buffers, and LSP data. It's ideal for those who prefer a highly configurable and extensible tool tailored to Neovim's ecosystem.

Value Proposition

Developers choose Telescope.nvim for its deep integration with Neovim's Lua API, modular architecture allowing extensive customization, and a rich ecosystem of built-in pickers and community extensions. Its unique selling point is its community-driven development, focus on modern Neovim features, and unified interface that consolidates multiple navigation tasks into one tool.

Find, Filter, Preview, Pick. All lua, all the time.

Use Cases

Best For

Fuzzy finding files, text, buffers, and LSP symbols within Neovim with live previews.
Navigating git repositories with pickers for commits, branches, status, and stashes.
Searching and filtering through Neovim's built-in elements like commands, help tags, keymaps, and colorschemes.
Integrating with Neovim's LSP for features like finding references, definitions, implementations, and workspace symbols.
Customizing and extending fuzzy-finding behavior with themes, layout strategies, and community extensions.
Performing live grep searches across a codebase using tools like ripgrep, with real-time results as you type.

Not Ideal For

Developers using Neovim versions older than v0.11.7 or on stable release cycles who avoid nightly builds.
Users who prefer minimal editor setups without external command-line dependencies like ripgrep or fd.
Teams looking for a plug-and-play fuzzy finder that works out of the box with zero Lua configuration.
Environments where installing native C extensions for performance is not feasible.

Pros & Cons

Pros

Extensive Built-in Pickers

Offers a wide range of ready-to-use pickers for files, git, LSP, buffers, and more, as detailed in the README's Pickers section, covering most common navigation needs in Neovim.

Highly Customizable Architecture

Built around modular pickers, sorters, and previewers, allowing both global and per-picker customization through Lua configuration, enabling deep tailoring to specific workflows.

Live Preview Capabilities

Integrates real-time previews of files and search results directly in the picker, using vim buffers or terminal previewers, enhancing usability without context switching.

Vibrant Extension Ecosystem

Supports community extensions for added functionality and performance boosts, such as telescope-fzf-native for faster sorting, as recommended in the README for optimal performance.

Modern Neovim Integration

Leverages Neovim's latest Lua API and features like vim.uv, ensuring compatibility and taking advantage of editor advancements for asynchronous operations.

Cons

Stringent Version Requirements

Only supports the latest stable or nightly Neovim releases (>=v0.11.7), explicitly stated in the README, which excludes users on older or LTS versions and may require frequent updates.

Dependency on External Tools

For full functionality, relies on external tools like ripgrep for live_grep and fd for find_files, adding setup overhead and system dependencies that aren't bundled.

Complex Configuration Overhead

The modular design and extensive options, such as layout strategies and mappings, require significant Lua knowledge and time to customize effectively, which can overwhelm beginners.

Performance Tied to Extensions

Optimal sorting speed depends on installing C-based extensions like telescope-fzf-native, as noted in the README; otherwise, it falls back to slower Lua sorters, impacting user experience.

Frequently Asked Questions

What is telescope.nvim?

Target Audience

Value Proposition

Use Cases

Best For

Fuzzy finding files, text, buffers, and LSP symbols within Neovim with live previews.
Navigating git repositories with pickers for commits, branches, status, and stashes.
Searching and filtering through Neovim's built-in elements like commands, help tags, keymaps, and colorschemes.
Integrating with Neovim's LSP for features like finding references, definitions, implementations, and workspace symbols.
Customizing and extending fuzzy-finding behavior with themes, layout strategies, and community extensions.
Performing live grep searches across a codebase using tools like ripgrep, with real-time results as you type.

Not Ideal For

Developers using Neovim versions older than v0.11.7 or on stable release cycles who avoid nightly builds.
Users who prefer minimal editor setups without external command-line dependencies like ripgrep or fd.
Teams looking for a plug-and-play fuzzy finder that works out of the box with zero Lua configuration.
Environments where installing native C extensions for performance is not feasible.

Pros & Cons

Pros

Extensive Built-in Pickers

Offers a wide range of ready-to-use pickers for files, git, LSP, buffers, and more, as detailed in the README's Pickers section, covering most common navigation needs in Neovim.

Highly Customizable Architecture

Built around modular pickers, sorters, and previewers, allowing both global and per-picker customization through Lua configuration, enabling deep tailoring to specific workflows.

Live Preview Capabilities

Integrates real-time previews of files and search results directly in the picker, using vim buffers or terminal previewers, enhancing usability without context switching.

Vibrant Extension Ecosystem

Supports community extensions for added functionality and performance boosts, such as telescope-fzf-native for faster sorting, as recommended in the README for optimal performance.

Modern Neovim Integration

Leverages Neovim's latest Lua API and features like vim.uv, ensuring compatibility and taking advantage of editor advancements for asynchronous operations.

Cons

Stringent Version Requirements

Only supports the latest stable or nightly Neovim releases (>=v0.11.7), explicitly stated in the README, which excludes users on older or LTS versions and may require frequent updates.

Dependency on External Tools

For full functionality, relies on external tools like ripgrep for live_grep and fd for find_files, adding setup overhead and system dependencies that aren't bundled.

Complex Configuration Overhead

The modular design and extensive options, such as layout strategies and mappings, require significant Lua knowledge and time to customize effectively, which can overwhelm beginners.

Performance Tied to Extensions

Optimal sorting speed depends on installing C-based extensions like telescope-fzf-native, as noted in the README; otherwise, it falls back to slower Lua sorters, impacting user experience.

Frequently Asked Questions

telescope.nvim

What is telescope.nvim?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

telescope.nvim

What is telescope.nvim?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?