Documentation

You can find all the documentation for LunarVim at lunarvim.org

Install In One Command!

Make sure you have the release version of Neovim (0.5).

bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/master/utils/installer/install.sh)

Install Language support

• Enter :LspInstall followed by <TAB> to see your options for LSP

• Enter :TSInstall followed by <TAB> to see your options for syntax highlighting

NOTE I recommend installing lua for autocomplete in config.lua

Configuration file

To install plugins configure LunarVim use the config.lua located here: ~/.config/lvim/config.lua

Example:

-- general
lvim.format_on_save = true
lvim.colorscheme = "onedarker"

lvim.leader = "space"
-- add your own keymapping
lvim.keys.normal_mode["<C-s>"] = ":w<cr>"
-- unmap a default keymapping
-- lvim.keys.normal_mode["<C-Up>"] = ""
-- edit a default keymapping
-- lvim.keys.normal_mode["<C-q>"] = ":q<cr>"
-- set keymap with custom opts
-- lvim.keys.insert_mode["po"] = {'<ESC>', { noremap = true }}

-- Use which-key to add extra bindings with the leader-key prefix
-- lvim.builtin.which_key.mappings["P"] = { "<cmd>Telescope projects<CR>", "Projects" }

-- Configure builtin plugins
lvim.builtin.dashboard.active = true
lvim.builtin.terminal.active = true

-- Treesitter parsers change this to a table of the languages you want i.e. {"java", "python", javascript}
lvim.builtin.treesitter.ensure_installed = "maintained"
lvim.builtin.treesitter.ignore_install = { "haskell" }

-- Disable virtual text
lvim.lsp.diagnostics.virtual_text = false

-- set a formatter if you want to override the default lsp one (if it exists)
lvim.lang.python.formatters = {
  {
    exe = "black",
    args = {}
  }
}
-- set an additional linter
lvim.lang.python.linters = {
  {
    exe = "flake8",
    args = {}
  }
}


-- Additional Plugins
lvim.plugins = {
    {"lunarvim/colorschemes"},
    {"folke/tokyonight.nvim"}, {
        "ray-x/lsp_signature.nvim",
        config = function() require"lsp_signature".on_attach() end,
        event = "BufRead"
    }
}

Updating LunarVim

• inside LunarVim :LvimUpdate
• from the command-line lvim +LvimUpdate +q

Update the plugins

• inside LunarVim :PackerUpdate

Breaking changes

• lvim.lang.FOO.lsp is no longer supported after #1584. You can either use :NlspConfig for most of the settings you might need, or override the setup by adding an entry to lvim.lsp.override = { "FOO" }.

Resources

• Documentation

• YouTube

• Discord

• Twitter

Testimonials

"I have the processing power of a potato with 4 gb of ram and LunarVim runs perfectly."

• @juanCortelezzi, LunarVim user.

"My minimal config with a good amount less code than LunarVim loads 40ms slower. Time to switch."

• @mvllow, Potential LunarVim user.