Neovim kickstart.nvim

Updated: 10 May 2024

LSP key maps

-- Jump to the definition of the word under your cursor.
--  This is where a variable was first declared, or where a function is defined, etc.
--  To jump back, press .
map('gd', require('telescope.builtin').lsp_definitions, '[G]oto [D]efinition')

-- Find references for the word under your cursor.
map('gr', require('telescope.builtin').lsp_references, '[G]oto [R]eferences')

-- Jump to the implementation of the word under your cursor.
--  Useful when your language has ways of declaring types without an actual implementation.
map('gI', require('telescope.builtin').lsp_implementations, '[G]oto [I]mplementation')

-- Jump to the type of the word under your cursor.
--  Useful when you're not sure what type a variable is and you want to see
--  the definition of its *type*, not where it was *defined*.
map('D', require('telescope.builtin').lsp_type_definitions, 'Type [D]efinition')

-- Fuzzy find all the symbols in your current document.
--  Symbols are things like variables, functions, types, etc.
map('ds', require('telescope.builtin').lsp_document_symbols, '[D]ocument [S]ymbols')

-- Fuzzy find all the symbols in your current workspace.
--  Similar to document symbols, except searches over your entire project.
map('ws', require('telescope.builtin').lsp_dynamic_workspace_symbols, '[W]orkspace [S]ymbols')

-- Rename the variable under your cursor.
--  Most Language Servers support renaming across files, etc.
map('rn', vim.lsp.buf.rename, '[R]e[n]ame')

-- Execute a code action, usually your cursor needs to be on top of an error
-- or a suggestion from your LSP for this to activate.
map('ca', vim.lsp.buf.code_action, '[C]ode [A]ction')

-- Opens a popup that displays documentation about the word under your cursor
--  See `:help K` for why this keymap.
map('K', vim.lsp.buf.hover, 'Hover Documentation')

-- WARN: This is not Goto Definition, this is Goto Declaration.
--  For example, in C this would take you to the header.
map('gD', vim.lsp.buf.declaration, '[G]oto [D]eclaration')

Neovim auto commands

Updated: 25 March 2024

Flash yanked text

autocmd("TextYankPost", {
    pattern = "*",
    desc = "Highlight text on yank.",
    callback = function ()
        vim.highlight.on_yank { higroup = "Search", timeout = 150 }


Updated: 08 April 2024

Light themes

Some popular themes with a light variant.

GitHub stars Feb 24 Repository

Error reading ShaDa

Resolution of Error while reading ShaDa file: there is an item at position …

Find all ShaDa related directories and files

find ~ -iname '*shada*'

Example list of folders returned by the find command above


Delete all shada files in these directories.

rm -rf ~/.local/state/lvim/shada
rm -rf ~/.local/state/nvim/shada
rm -rf ~/.local/share/nvim/shada
rm -rf ~/.cache/lvim

Swap files

Delete all swap files

rm -rf ~/.local/state/nvim/swap/*

Start cli arguments

Mimics a fresh install of Nvim

nvim --clean


Updated: 11 March 2024


  • Configuration ~/.config/lvim/config.lua
  • On my system, plugins directories are in ~/.local/share/lunarvim/site/pack/lazy/opt
  • To turn off ShellCheck warnings in .env files, place at the top # shellcheck disable=SC2034


Toggle spelling on/off with a function:

lvim.keys.normal_mode["<leader>sp"] = function()
    if (true == vim.opt.spell:get()) then
        vim.opt.spell = false
        print("spell = false")
        vim.opt.spell = true
        vim.opt.spelllang = "en_gb"
        print("spell = true")

Resize splits with number keys:

lvim.keys.normal_mode["<A-8>"] = ":resize -1<CR>"
lvim.keys.normal_mode["<A-9>"] = ":resize +1<CR>"
lvim.keys.normal_mode["<A-7>"] = ":vertical resize -1<CR>"
lvim.keys.normal_mode["<A-0>"] = ":vertical resize +1<CR>"

Quick reference

Toggle floating terminal <C-\>
Show definition K
Clear cache whilst running :LvimCacheReset
Clear cache at startup lvim +LvimCacheReset

Neovim app image

Updated: 21 March 2024

How to install Neovim, from the App Image, on Ubuntu.

  1. Pick a stable release
  2. Download the nvim.appimage asset.
  3. Run chmod u+x nvim.appimage to make the nvim.appimage file executable.
  4. Start the neovim editor with ./nvim.appimage.
  5. If your system indicates that FUSE is missing, it can be installed (for Ubuntu >= 22.04) with sudo apt install libfuse2.
  6. Rename the executable and put it in a location on your PATH e.g. mv nvim.appimage /home/chris/.local/bin/nvim or sudo mv nvim.appimage /usr/bin/nvim
  7. Now start the neovim editor with nvim