A Neovim config you can actually read.
kickstart.nvim is a documented starting point for your own Neovim setup — not a distro, not a framework. One file, real comments, and just enough LSP, fuzzy-finding, and syntax highlighting to start building the editor you actually want.
Everything a modern setup needs. Nothing you have to reverse-engineer.
Every plugin in kickstart.nvim is chosen deliberately and documented inline — you're meant to open the file and read it, not just install it.
Language servers, pre-wired
Mason installs and manages language servers automatically, with sane defaults for diagnostics, go-to-definition, and formatting.
Telescope fuzzy finder
Search files, live grep your project, jump between buffers — all through one consistent, fast fuzzy-matching interface.
Built-in plugin manager
Plugins install through vim.pack, Neovim's native package manager — no third-party plugin manager to bootstrap or keep updated separately.
Which-Key
Forget a keymap mid-command and a popup shows you what's available — no need to memorize the whole config on day one.
Treesitter highlighting
Structural, syntax-aware highlighting and indentation for dozens of languages, instead of regex-based guesswork.
Git integration
Inline git signs, hunk staging, and blame built in via gitsigns — see what changed without leaving the buffer.
Up and running in about two minutes
Back up any existing config first, then clone kickstart.nvim straight into Neovim's config directory for your OS.
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
nvim
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
nvim
git clone https://github.com/nvim-lua/kickstart.nvim.git "$env:LOCALAPPDATA\nvim"
nvim
Installing kickstart.nvim from scratch
A full walkthrough — from checking prerequisites to your first successful launch. Follow these in order.
Check your Neovim version
kickstart.nvim only supports the latest stable or nightly release of Neovim. Open a terminal and run:
nvim --version
If the version printed is older than the current stable release, update Neovim through your package manager (Homebrew on macOS, apt/dnf/pacman on Linux, winget/scoop on Windows) before continuing.
Install the required tools
kickstart.nvim leans on a few external programs for search, formatting, and compiling plugins:
Install these with your system's package manager before moving on — Mason will refuse to build some language servers without a C compiler present.
Back up any existing configuration
If you already have a Neovim setup, rename it first so nothing is overwritten:
mv ~/.local/share/nvim ~/.local/share/nvim.bak
On Windows PowerShell, use Rename-Item on %LOCALAPPDATA%\nvim instead.
Clone the repository
Pick the tab for your operating system and run the matching command:
Prefer not to use the command line? Use the Download button at the top of this page, unzip it, and place the contents in the same config folder.
Launch Neovim for the first time
Simply run:
On first launch, vim.pack.add calls in init.lua install every plugin automatically using Neovim's built-in package manager. This can take a minute — let it finish before typing anything, then quit and reopen once it's done.
Verify everything is healthy
Inside Neovim, run the built-in diagnostic check:
Look for any red ERROR lines — these usually point to a missing dependency from step 2. Fix those, restart Neovim, and you're ready to start editing your config.
kickstart.nvim vs. a full distribution
Distros like LazyVim or NvChad give you a finished editor. kickstart.nvim gives you a foundation and expects you to build on it.
| kickstart.nvim | Full distro (LazyVim / NvChad) | |
|---|---|---|
| Config size | Single file, ~1000 lines | Dozens of files |
| Plugins preinstalled | Minimal, core-only | Extensive, opinionated |
| Best for | Learning & customizing from zero | Getting a full IDE fast |
| Read the whole config in a sitting | Yes | Rarely |
| Update model | You own your fork | Tracks upstream releases |
Questions people search alongside "kickstart nvim"
No. Its author is explicit that it's not a framework — it's a small, documented base meant to be forked and edited, not installed and left alone.
The latest stable or nightly release. Run nvim --version to check, and update via your package manager if you're behind.
Yes. Set NVIM_APPNAME=nvim-kickstart before launching Neovim to use a separate config and data directory, so nothing overwrites your existing setup.
It's intentional. A single, heavily commented file is easier to read top-to-bottom as a teaching reference than a config split across many modules.
Delete your config directory and its local data folder — typically ~/.config/nvim and ~/.local/share/nvim — then reinstall whatever you used before.
init.vim used Vimscript, while init.lua is written in Lua — Neovim's native scripting language. Lua is generally faster and gives plugins a cleaner, more structured API to work with.
Open init.lua and add a new entry to the vim.pack.add() call, following the same pattern as the existing plugins. Neovim installs it automatically on the next launch.
Find the colorscheme plugin block in init.lua, swap the plugin name for the one you want, and update the line that calls vim.cmd.colorscheme(...) with its name.
The leader key is set to space by default. Press it and wait — the Which-Key popup will show every available keymap grouped by category, so you don't need to memorize them upfront.
Yes, through native PowerShell or WSL. Native Windows needs a C compiler such as MinGW or the Visual Studio Build Tools on your PATH for Treesitter and Mason to build correctly.
Run :Mason inside Neovim to open the installer UI, or add the server's name to the ensure_installed list in init.lua so it installs automatically.
Since it lives in your own config folder as a git repository, run git pull inside it to fetch upstream changes, then review the diff before merging into your fork.
It's approachable if you're willing to read the comments in the file, but it assumes basic familiarity with Neovim and the command line. Complete newcomers may prefer a full distro first.
Fork it. Read it. Make it yours.
The best way to understand Neovim configuration is to start from something small enough to finish reading.