How do I set up yanky.nvim with Telescope?

Load the Telescope extension with `require('telescope').load_extension('yank_history')` and use `:Telescope yank_history` to open the picker. Configure mappings in the telescope section of the setup for custom actions like put or delete.

yanky.nvim vs vim-yoink: which is better for Neovim?

yanky.nvim is a Lua-native rewrite with more features like advanced put commands and better Neovim integration, while vim-yoink is Vimscript-based and lighter. Choose yanky.nvim if you want modern extensibility and don't mind Lua configuration.

Does yanky.nvim sync with the system clipboard?

Yes, it can sync with the system clipboard by setting `system_clipboard.sync_with_ring = true` in the configuration. This allows yanks from outside Neovim to be added to the yank history, though it depends on Neovim's focus events.

How to clear yank history in yanky.nvim?

Use the `:YankyClearHistory` command to clear all entries from the yank ring. This is documented in the commands section and helps manage storage or reset history for privacy.

Can I use yanky.nvim with nvim-cmp for autocompletion?

Yes, it integrates with nvim-cmp via the cmp_yanky plugin, providing yank history suggestions in insert mode. This requires an additional plugin installation and setup as shown in the integrations section.

What are the special put commands and how do I use them?

Special puts include linewise puts (e.g., ]p), indent-aware puts (e.g., >p), and filter puts (e.g., =p), which adjust formatting based on context. Map them using Plug mappings like ` (YankyPutIndentAfterLinewise)` for precise control.

How to configure yanky.nvim for Windows WSL to fix ^M characters?

Use the `permanent_wrapper` option with `require('yanky.wrappers').remove_carriage_return` in the ring configuration. This wrapper removes carriage returns when pasting from Windows clipboard, as detailed in the integrations section.

yanky.nvim — Enhanced Yank Operations Plugin

What is yanky.nvim?

yanky.nvim is a Neovim plugin that enhances the editor's native copy (yank) and paste (put) capabilities. It solves the problem of limited clipboard history and basic paste operations by introducing a persistent yank-ring, visual history picker, and advanced put commands for more efficient text editing.

Target Audience

Neovim users, particularly developers and writers who frequently copy and paste text within the editor and want more control and history over their clipboard operations.

Value Proposition

Developers choose yanky.nvim for its comprehensive feature set that goes beyond basic clipboard functionality, its seamless integration with popular Neovim tools like Telescope, and its Lua-native implementation that offers better performance and configurability within the modern Neovim ecosystem.

Improved Yank and Put functionalities for Neovim

Use Cases

Best For

Neovim users wanting Emacs-style kill-ring functionality
Developers who need to frequently paste from a history of copied snippets
Users looking for visual feedback when yanking and putting text
Those who want advanced paste operations like linewise or indent-aware pasting
Users who integrate with Telescope for a visual yank history browser
Anyone frustrated with the cursor jumping when yanking large text objects

Not Ideal For

Neovim users who prioritize a minimal plugin setup and prefer stock yank/put behavior
Projects requiring cross-editor clipboard synchronization, as yanky.nvim is confined to Neovim instances
Teams that avoid complex configuration and desire out-of-the-box functionality without manual keybinding setup

Pros & Cons

Pros

Robust Yank History

Maintains a persistent yank-ring with up to 100 entries, allowing cycling through previous yanks using <c-n> and <c-p>, inspired by Emacs' kill-ring, as detailed in the ring configuration.

Visual History Picker

Integrates seamlessly with Telescope and Snacks for a graphical interface to browse and select from yank history, enhancing usability with picker options like dynamic preview titles.

Advanced Put Operations

Offers special put commands like linewise puts, indent-aware puts, and filter puts, providing fine-grained control over paste behavior, with over 70 plug mappings for customization.

Cursor Position Preservation

Prevents the cursor from jumping to the start of yanked text by default, a feature enabled in preserve_cursor_position settings to maintain editing flow for large text objects.

Cons

Configuration Overhead

Requires extensive manual keybinding setup with no default mappings, and the README admits users must define mappings for basic functionality, which can be daunting and error-prone.

Dependency on External Plugins

For persistent SQLite storage, it necessitates additional dependencies like sqlite.lua, adding complexity and potential installation issues to the plugin ecosystem.

Limited to Modern Neovim

Only works with Neovim > 0.9.0, excluding users on older versions or those using standard Vim, and lacks support for other editors or cross-platform clipboard tools.

Frequently Asked Questions

What is yanky.nvim?

Target Audience

Neovim users, particularly developers and writers who frequently copy and paste text within the editor and want more control and history over their clipboard operations.

Value Proposition

Use Cases

Best For

Neovim users wanting Emacs-style kill-ring functionality
Developers who need to frequently paste from a history of copied snippets
Users looking for visual feedback when yanking and putting text
Those who want advanced paste operations like linewise or indent-aware pasting
Users who integrate with Telescope for a visual yank history browser
Anyone frustrated with the cursor jumping when yanking large text objects

Not Ideal For

Neovim users who prioritize a minimal plugin setup and prefer stock yank/put behavior
Projects requiring cross-editor clipboard synchronization, as yanky.nvim is confined to Neovim instances
Teams that avoid complex configuration and desire out-of-the-box functionality without manual keybinding setup

Pros & Cons

Pros

Robust Yank History

Maintains a persistent yank-ring with up to 100 entries, allowing cycling through previous yanks using <c-n> and <c-p>, inspired by Emacs' kill-ring, as detailed in the ring configuration.

Visual History Picker

Integrates seamlessly with Telescope and Snacks for a graphical interface to browse and select from yank history, enhancing usability with picker options like dynamic preview titles.

Advanced Put Operations

Offers special put commands like linewise puts, indent-aware puts, and filter puts, providing fine-grained control over paste behavior, with over 70 plug mappings for customization.

Cursor Position Preservation

Prevents the cursor from jumping to the start of yanked text by default, a feature enabled in preserve_cursor_position settings to maintain editing flow for large text objects.

Cons

Configuration Overhead

Requires extensive manual keybinding setup with no default mappings, and the README admits users must define mappings for basic functionality, which can be daunting and error-prone.

Dependency on External Plugins

For persistent SQLite storage, it necessitates additional dependencies like sqlite.lua, adding complexity and potential installation issues to the plugin ecosystem.

Limited to Modern Neovim

Only works with Neovim > 0.9.0, excluding users on older versions or those using standard Vim, and lacks support for other editors or cross-platform clipboard tools.

Frequently Asked Questions

yanky.nvim

What is yanky.nvim?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

yanky.nvim

What is yanky.nvim?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?