README

telescope.nvim



Gaze deeply into unknown regions using the power of the moon.

 What Is Telescope?

telescope.nvim is a highly extendable fuzzy finder over lists. Built on the
latest awesome features from neovim core. Telescope is centered around
modularity, allowing for easy customization.

Community driven builtin pickers, sorters and
previewers.

!Preview
For more showcases of Telescope, please visit the Showcase
section in the
Telescope Wiki

 Telescope Table of Contents

- Getting Started
- Usage
- Customization
- Default Mappings
- Pickers
- Previewers
- Sorters
- Layout
- Themes
- Commands
- Autocmds
- Extensions
- API
- Media
- Contributing
- Changelog

 Getting Started

This section should guide you to run your first builtin pickers.

 Requirements

 Neovim =v0.11.7 built with LuaJIT (check :version).
 nvim-lua/plenary.nvim.

[!IMPORTANT]
 Only the latest version (stable) and the latest commit of HEAD (nightly) are tested and supported; before opening an issue, download the latest available release and confirm that the problem persists.

 Recommended dependencies

 BurntSushi/ripgrep is required for
  live_grep and grep_string and is the first priority for find_files.
 sharkdp/fd (finder)
 devicons (icons)

We also strongly suggest installing a native telescope sorter to significantly improve
sorting performance:
 telescope-fzf-native.nvim
or
 telescope-fzy-native.nvim.
For more information and a performance benchmark take a look at the
Extensions
wiki.

 Installation

We recommend pinning to the latest release
tag,
e.g. using lazy.nvim

lua
{
    'nvim-telescope/telescope.nvim', version = '',
    dependencies = {
        'nvim-lua/plenary.nvim',
        -- optional but recommended
        { 'nvim-telescope/telescope-fzf-native.nvim', build = 'make' },
    }
}


 Checkhealth

Make sure you call :checkhealth telescope after installing telescope to ensure
everything is set up correctly.

After this setup you can continue reading here or switch to :help telescope
to get an understanding of how to use Telescope and how to configure it.

 Usage

Try the command :Telescope find_files
to see if telescope.nvim is installed correctly.

lua
local builtin = require('telescope.builtin')
vim.keymap.set('n', 'ff', builtin.find_files, { desc = 'Telescope find files' })
vim.keymap.set('n', 'fg', builtin.live_grep, { desc = 'Telescope live grep' })
vim.keymap.set('n', 'fb', builtin.buffers, { desc = 'Telescope buffers' })
vim.keymap.set('n', 'fh', builtin.help_tags, { desc = 'Telescope help tags' })


See builtin pickers for a list of all builtin functions.

 Customization

This section should help you explore available options to configure and
customize your telescope.nvim.

Unlike most vim plugins, telescope.nvim can be customized by either applying
customizations globally, or individually per picker.

- Global Customization affecting all pickers can be done through the main
  setup() method (see defaults below)
- Individual Customization affecting a