which-key.nvim API Reference

Look up which-key.nvim Lua API functions and key mappings.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps Neovim users quickly discover available keybindings and commands within their editor, reducing the need to memorize complex shortcuts.

Core Features & Use Cases

  • Command Indexing: Provides a searchable index of commands and Lua API functions.
  • Mapping Assistance: Helps in understanding and utilizing custom key mappings.
  • Use Case: When you forget a specific command or mapping for a plugin, you can use this Skill to quickly look it up without leaving your editor.

Quick Start

Use the which-key.nvim skill to show available mappings for the 'w' key.

Frequently Asked Questions about which-key.nvim API Reference

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

FAQPage Schema
How do I look up available which-key.nvim commands and Lua API functions in Neovim?

To look up which-key.nvim commands and Lua API functions in Neovim, use this Skill to query a searchable index of plugin mappings and hard-to-wire calls without leaving your editor.

What is the best way to discover custom key mappings for Neovim plugins?

The best way to discover custom key mappings for Neovim plugins is to use this reference Skill to quickly search for specific commands and Lua API functions, reducing the need to memorize complex shortcuts.

Do I need to know Lua to use the which-key.nvim plugin API?

Yes, you need knowledge of Lua and Neovim plugin architecture for advanced usage of the which-key.nvim API, such as wiring custom mappings and calling module functions programmatically.

How does which-key help find a forgotten Neovim keybinding?

which-key helps find a forgotten Neovim keybinding by providing a quick lookup mechanism that shows available mappings for specific keys, allowing you to easily retrieve plugin commands on demand.

Can I show available mappings for a specific key prefix in Neovim?

Yes, you can show available mappings for a specific key prefix in Neovim by using this Skill to index and retrieve commands associated with that trigger key, such as the 'w' key.