About this project
telescope.nvim is a highly extendable fuzzy finder over lists, built on Neovim core features and written in Lua. It is centered on modularity, allowing customization either globally through setup() or per picker via options passed to builtin functions.
Requirements include Neovim with LuaJIT and plenary.nvim. Recommended dependencies are ripgrep (needed for live_grep and grep_string), fd, and nvim-web-devicons for icons. Native sorters such as telescope-fzf-native.nvim or telescope-fzy-native.nvim are suggested to improve sorting performance. Installation is typically done by pinning a release tag, for example with lazy.nvim, and users are advised to run :checkhealth telescope after setup.
The plugin provides a large set of builtin pickers. File pickers include find_files, git_files, grep_string and live_grep. Vim pickers cover buffers, oldfiles, commands, tags, command_history, search_history, help_tags, man_pages, marks, colorscheme, quickfix, loclist, jumplist, vim_options, registers, autocommands, spell_suggest, keymaps, filetypes, highlights, current_buffer_fuzzy_find, current_buffer_tags, resume and pickers. Neovim LSP pickers include lsp_references, lsp_incoming_calls, lsp_outgoing_calls, lsp_document_symbols, lsp_workspace_symbols, lsp_dynamic_workspace_symbols, diagnostics, lsp_implementations, lsp_definitions and lsp_type_definitions. Git pickers include git_commits, git_bcommits, git_bcommits_range, git_branches, git_status and git_stash. There is also a treesitter picker and list pickers such as planets, builtin, reloader and symbols.
Previewers are provided for files, grep results and quickfix lists, with vim_buffer_ variants using Neovim buffers and tree-sitter or regex highlighting, and terminal variants using cat or bat. The default previewers use vim.filetype to guess filetypes by inspecting filename, shebang and modeline. A TelescopePreviewerLoaded autocmd allows per-filetype preview window configuration.
Sorters, layouts and themes are configurable, and mappings are fully customizable with a documented default set covering navigation, selection, opening files in splits or tabs, scrolling previews, toggling multi-selection, sending results to the quickfix list, and inserting words from the original window into the prompt. Actions can be remapped or custom actions created via transform_mod. Extensions are supported through a dedicated configuration table, and the project maintains a wiki with showcases, configuration recipes and extension information.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.