Plugin.peek API Reference

Index Peek.nvim commands and APIs from lua/plugins/peek.lua.

1|Updated Oct 26, 2025
One-click install
npx skills add https://github.com/NeKon69/nvim-dot --skill plugin-peek-api-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Plugin.peek API Reference
Source: https://github.com/NeKon69/nvim-dot/tree/main/.agents/skills/plugin.peek
Command: npx skills add https://github.com/NeKon69/nvim-dot --skill plugin-peek-api-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides quick access to commands and API references for the Peek.nvim plugin, streamlining navigation and understanding of its functionality.

Core Features & Use Cases

  • Command Indexing: Quickly find and use available Peek.nvim commands like :PeekClose and :PeekOpen.
  • API Reference: Understand the module's API for programmatic interaction.
  • Use Case: When you need to quickly close the Peek window or open it for a specific file, you can refer to this Skill to find the exact command.

Quick Start

Use the Plugin.peek skill to close the Peek window.

Frequently Asked Questions about Plugin.peek API Reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find available Peek.nvim commands for opening and closing windows?

You can discover Peek.nvim commands by performing a static analysis of the lua/plugins/peek.lua file, which indexes commands like :PeekOpen and :PeekClose for window control.

What is the Peek.nvim module API used for when integrating with Neovim?

The Peek.nvim module API facilitates programmatic interaction, allowing developers to integrate the plugin's window peeking functionality directly into their custom Neovim workflows.

How do I programmatically close the Peek window in Neovim?

To close the Peek window, you should reference the :PeekClose command found within the peek.lua configuration file to execute the window dismissal action.

Does the Peek API reference require external dependencies to discover commands?

No, discovering Peek commands requires no external dependencies, relying solely on static analysis of your local lua/plugins/peek.lua file for command and API discovery.

Why do I need to analyze peek.lua to find Peek.nvim API references?

Analyzing peek.lua is required because the Skill uses static analysis of this Lua file to discover the module APIs and command index, providing accurate references for developers.