Skip to content

LunarVim

LunarVim (LVIM) Quickstart & Cheat Sheet.

Update

LunarVim is no longer actively maintained by its primary creator, who has moved on to other configurations like AstroNvim and LazyVim. The project is largely abandoned by its main lead, though some community contributions still exist. I thought to leave the page here in the event someone is looking for information or any form of help and if anyone want's to transition to LazyVim there is a comprehensive page here

Recent update 16/10/2026

  • Official Domain Lapsed: Note that lunarvim.org is completely dead and yields a 404 error.

  • Installation Scripts Broken: Explicitly warn users that the universal curl installation script (bash <(curl -s https://lunarvim.org/install.sh)) is broken and will fail immediately because the source file no longer exists.

  • LunarVim now points to GitHub & the Official LunarVim Documentation — The core manual for custom configuration profiles can be found at theInternet Archive WayBack Machine At the following URL. Internet Archive WayBack Machine — Snapshot of LunarVim. Under the Useful Documentation Links section, I have also modified the dead lunarvim.org links to point directly to the LunarVim snapshot on the Internet Archive Wayback Machineso people can still read the original docs if they are stuck.

LunarVim

🧭 LunarVim⚓︎

LunarVim is a pre-configured IDE layer built on top of Neovim. It brings the power and speed of a terminal editor while providing modern features like code completion, file trees, and language analysis right out of the box.

The Golden Rule of LVIM Configuration

Never modify files in ~/.local/share/lunarvim.
Always make your custom tweaks inside ~/.config/lvim/config.lua.

🧭 Essential Core Shortcuts⚓︎

Essential Core Shortcuts

LunarVim relies heavily on the <Space> key as the "Leader" key. Pressing space opens up a quick interactive menu at the bottom of your screen.

📁 General Navigation & UI⚓︎

Keystrokes Action Description
<Space> + e Toggle File Explorer Opens/closes the NvimTree side panel
<Space> + f Find File Search files globally using Telescope fuzzy finder
<Space> + t Find Text Search for specific words across your entire project
<Space> + c Close Buffer Safely closes the current open file tab
j + k Exit Insert Mode The custom shortcut we set to leave typing mode quickly

🛠️ Code Editing & LSP Power Actions⚓︎

Keystrokes Action Description
K Hover Info Shows documentation/types for the word under cursor
g + d Go to Definition Jumps straight to where a variable/function is defined
<Space> + l + r Rename Variable Renames a variable safely across your whole project
<Space> + l + f Format File Manually trigger your formatter (Black/Prettier)

📝 Markdown & HTML Workflow Pointers⚓︎

Markdown & HTML

Now that your configuration is running silently, here is exactly how to utilize your new IDE features for web development and note-taking.

Automatic Formatting

Every time you type :w to save, python-black handles your Python spacing, while prettier automatically cleans up and indents your HTML tags and Markdown columns.

🌐 Working with HTML⚓︎

Working with HTML

  • Auto-Closing Tags: Type an HTML tag like <div> and hit enter. The editor automatically generates </div> and balances your cursor in the middle.

  • Tag Renaming: If you change an opening tag from <div> to <section>, the matching closing tag will dynamically update itself.

📉 Working with Markdown⚓︎

Working with Markdown

  • Live Browser Preview: When you have a .md file active, open the command line and run the plugin we added:
:MarkdownPreview

This spins up a localized server and launches a live-scrolling preview in your default web browser.

  • Stop Preview: When done, type:
:MarkdownPreviewStop

Useful Documentation Links

The original two links [Official LunarVim Documentation] and [LunarVim Keybindings Guide] below have been changed to point to the WayBack Machinesnapshot of LunarVim, as the old LunarVim.org links are all DEAD! The project has been fully terminated.

Wayback Machine Internet Archive WayBack Machine — Snapshot of LunarVim

  • Lazy.nvim GitHub Profile — Understand how your newly installed plugin architecture coordinates packages.

  • Marksman LSP Manual — Learn about the advanced Markdown link, reference, and header completions active in your workspace.

🌐 Extra Settings/Configurations⚓︎

Linux built in conveniance

There is a standard Linux desktop feature called .desktop. Once it is (It's an application launcher), created, it can be dragged or pinned from one of your file app managers Like ArcMenu or from Gnome's Apps onto your GNOME taskbar/dock exactly like Chrome, Firefox, or any of those others that you want quick acess to.

How to create it

Below, how to do it , step by step.

Creating a Custom Desktop Launcher to streamline terminal access for lvim LunarVim. You can also checkout their GitHub instance.

Step 1 — create the launcher file itself:

nano ~/.local/share/applications/lvim-afridyne.desktop

Paste this content in:

[Desktop Entry]
Name=LVim Afridyne
Comment=Open LunarVim in the Afridyne Systems project
Exec=tilix -e bash -c "cd /home/johnpc/AfridyneSystems && lvim"
Icon=utilities-terminal
Terminal=false
Type=Application
Categories=Development;

Save and exit (Ctrl+O, Enter, Ctrl+X).

Step 2 — System need to recognise the application:

One needs to make sure the system recognizes it as a proper application. (Sometimes needed for it to show up cleanly in search/menus):

update-desktop-database ~/.local/share/applications/

Step 3 — Create the launcher file itself:

  • Now to find it and pin it. This short tutorial is for Arch Linux using Gnome Shell. The basic procedure is the same for most of the popular distros out there. It's pretty much the same and if you struggle, there are a host of AI clients out there!

  • If you're on Gnome press the Super Key (Windows key) to open Activities/search, then (This is what I chose for my Tilix terminal.) and type:

LVim Afridyne