neovimcraft github

plugins configs about

alexcloudstar/cheatsheet.nvim

github github
utility
stars 1
issues 0
subscribers 0
forks 0
CREATED

UPDATED

cheatsheet.nvim

A keybinding cheatsheet for Neovim, built on Telescope. Look up a key by task or keyword without leaving the editor to search the web. You can add your own keys to it.

Open it and you get a short list of tasks: move around, edit text, search and replace, and so on. Pick one and you see only the keys for that task. Or just start typing: search covers every key, whichever step you are on. Every key also has hidden search words, so typing delete or rename finds the right keys even when the description says something else.

Screenshots

Step 1: pick what you want to do.

Task picker listing categories like Move around, Edit text and Search and replace

Step 2: browse only the keys for that task. Your own keys are marked with a star.

Keys for the Edit text category, with mode, key and description columns

Not sure what <C-x> or <leader> means? There's a category for that.

The key notation category explaining Ctrl, Shift, Alt, leader and mode letters

Features

  • Two steps: pick a task first, then browse its keys. <C-b> goes back.
  • Search works on every key at any step. Type in the task list or inside a task and results come from all tasks, each showing its task name. Clear the prompt to return to browsing. <C-a> jumps to the full list.
  • A legend for <leader>, <C-x>, <S-x>, <A-x> and <CR> stays pinned at the top while the picker is open (pinned = false hides it).
  • Built-in reference for Vim motions, operators, text objects, registers, macros, windows, and key notation (what <C-x> or <leader> means).
  • Your own maps live next to the built-in ones, marked with ★, and also collect under "My maps".
  • Sync check: maps set in your config that you forgot to add show up under "Unlisted maps".
  • Enter on a key copies it to your clipboard.

Requirements

Install

With lazy.nvim:

{
    "alexcloudstar/cheatsheet.nvim",
    dependencies = { "nvim-telescope/telescope.nvim" },
    opts = {},
}

Then run :Cheatsheet or press <leader>cc.

Add your own keys

Pass categories to setup. Entries in a category with an existing id are added to it. A new id creates a new category. Entries you add are marked as yours (★) unless you set custom = false.

{
    "alexcloudstar/cheatsheet.nvim",
    dependencies = { "nvim-telescope/telescope.nvim" },
    opts = {
        aliases = { "Cc" },
        categories = {
            {
                id = "files",
                entries = {
                    { key = "<leader>pf", desc = "Find files", tags = "open fuzzy telescope" },
                    { key = "<C-p>", desc = "Git files" },
                },
            },
            {
                id = "docker",
                label = "Docker",
                desc = "container shortcuts",
                tags = "container compose",
                entries = {
                    { key = "<leader>dd", desc = "Docker compose up" },
                },
            },
        },
    },
}

Entry fields:

Field Meaning
key The key as you'd write it in a mapping, like <leader>pf or <C-d>
desc What it does
tags Extra words that should find this key (optional)
modes Mode letters, like "n", "nv" or "i". Defaults to "n"
custom false to show it as a built-in key instead of one of yours

If you add a key that matches a built-in entry (same key and mode), yours replaces it.

Options

{
    open_key = "<leader>cc",
    aliases = {},
    categories = {},
    detect_unlisted = true,
    config_dir = nil,
    copy_register = "+",
    back_key = "<C-b>",
    all_key = "<C-a>",
    pinned = true,
}
Option Meaning
open_key Normal-mode key that opens the cheatsheet. false to skip the mapping
aliases Extra command names, like { "Cc" }. :Cheatsheet always exists
categories Your categories and entries, see above
detect_unlisted Show maps from your config that aren't in the cheatsheet
config_dir Directory that counts as "your config" for the sync check. Defaults to stdpath("config")
copy_register Register that Enter copies the key into
back_key, all_key Keys inside the picker
pinned Keep a one-line legend (<leader>, <C-x>, <S-x>, <A-x>, <CR>) pinned at the top of the screen while the picker is open. false to hide it

How the sync check works

When the cheatsheet opens, it reads the live mappings and keeps the ones defined in a file under config_dir. Any that aren't in your cheatsheet entries are listed under "Unlisted maps". Maps from plugins and Neovim defaults are ignored. Buffer-local maps only show up when you open the cheatsheet from a buffer that has them.

Commands and keys

Command or key Action
:Cheatsheet Open the cheatsheet
:Cc Same as :Cheatsheet. Not defined by default, add aliases = { "Cc" } to enable it
<leader>cc Open the cheatsheet from normal mode. Change it with open_key, or set open_key = false to skip the mapping

Browsing stays in two steps (tasks, then keys), but typing always searches every key, whichever step you are on. With an empty prompt you see the tasks or the keys of the task you picked; as soon as you type, matching keys from all tasks appear, with their task shown in a column.

Inside the picker, <C-b> goes back to the task list and <C-a> searches all keys. Both keys can be changed with back_key and all_key.

License

MIT