Skip to content
Lazy Docs

Which-key

Which-key is a plugin that helps you remember keybindings by showing a popup with possible keybindings of the key you just pressed.

What Problem Does It Solve?

Traditional keybinding management in Neovim can be:

  • Hard to remember all keybindings
  • No visual reminders
  • Missing keybinding organization
  • Lacks grouping functionality
  • Inefficient key discovery

How It Improves Productivity

  1. Better Interface:

    • Keybinding popup
    • Group organization
    • Custom labels
    • Timeout configuration

  2. Enhanced Features:

    • Prefix handling
    • Register support
    • Window customization
    • Performance optimization

  3. Advanced Features:

    • Custom groups
    • Custom labels
    • Timeout configuration
    • Register support

How to Use

Basic Usage

  • Press a key to see available keybindings
  • Wait for timeout to execute command
  • Press another key to see nested keybindings
  • Press Esc to cancel
  • Show space keybindings with Space
  • Show window keybindings with C-h/j/k/l
  • Show fold keybindings with z
  • Show goto keybindings with g
  • Show previous keybindings with [
  • Show next keybindings with ]

Configuration

  • Edit lua/config/which-key.lua
  • Set up custom groups
  • Configure keybindings
  • Customize appearance

Integration

  • Works with marks
  • Compatible with registers
  • Supports spelling
  • Works with other plugins