easypick.nvim
A Neovim plugin that creates Telescope pickers from arbitrary console commands.
What is easypick.nvim?
Easypick.nvim is a Neovim plugin that converts the output of any shell command into an interactive Telescope picker. It solves the problem of manually parsing and acting on command-line output by allowing developers to navigate, preview, and execute actions on results directly within the editor.
Neovim users who frequently use command-line tools and want to integrate their output into a visual, interactive workflow within the editor.
Developers choose Easypick.nvim because it seamlessly bridges command-line tools and Neovim's UI, offering a flexible Lua API, built-in previewers for diffs and files, and the ability to create both pre-configured and one-off pickers without complex setup.
Overview
A neovim plugin that lets you easily create Telescope pickers from arbitrary console commands
Use Cases
Best For
- Quickly navigating and previewing files changed in a Git branch compared to a base branch.
- Listing and resolving Git merge conflicts with diff previews directly in Neovim.
- Creating custom Telescope pickers for frequently used shell commands like file listing or process inspection.
- Executing one-off shell commands and interactively selecting from their output without pre-configuration.
- Integrating command-line tool output into Neovim scripts or other plugins via the Lua API.
- Running custom actions on selected entries, such as executing make commands or opening files.
Not Ideal For
- Projects requiring real-time, streaming command output interaction, as pickers work on static snapshots.
- Developers needing to parse and interact with structured data like JSON or XML directly, since output must be plain text.
- Users who do not have Telescope.nvim installed or prefer other fuzzy finder plugins.
- Teams looking for a drag-and-drop configuration interface, as setup is Lua-based and code-heavy.
Pros & Cons
Pros
Allows defining named pickers for frequent commands, as shown in config examples like 'ls' or Git diff pickers, enhancing repeatable workflows.
Enables dynamic creation of pickers for single commands without pre-configuration using the `one_off` function, ideal for ad-hoc tasks.
Includes previewers for file diffs and branch comparisons, as seen in the 'changed_files' example, streamlining Git operations within Neovim.
Supports custom actions on selections, such as executing commands with `nvim_commandf`, allowing for automated workflows like running 'make %s'.
Provides a direct Lua API for programmatic use, facilitating integration into scripts or plugins, demonstrated with `require('easypick').ls()`.
Cons
Must have Telescope.nvim installed and configured, adding an extra layer of setup and potential compatibility issues for minimal setups.
Requires command output to be a list of plain text entries, restricting use with commands that produce structured or binary data, as noted in the README.
Setup involves writing Lua code, which can be a barrier for users not familiar with Neovim's Lua API or plugin configuration, despite examples.
Pickers operate on command output at a single point in time, lacking support for live updates or interactive command streams, limiting dynamic use cases.
Frequently Asked Questions
Related Projects
telescope.nvimFind, Filter, Preview, Pick. All lua, all the time.
fff.nvimThe fastest and the most accurate file search SDK for AI agents, Neovim, Rust, C, Python, Bun and NodeJS
folke/snacks.nvim#picker🍿 A collection of QoL plugins for Neovim
fzf-luaImproved fzf.vim written in lua
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.