Skip to content
Get packs

Guide · Open source

How to use kickstart.nvim: install and set up Neovim

Updated · written with AI from the project's own documentation and checked against our catalogue data

Kickstart.nvim is a starter configuration for Neovim, a text editor used mostly by programmers. It is a single, heavily commented init.lua file that you copy into your Neovim config folder and then edit to suit yourself. This guide shows you how to install it, what it needs first, and how to get it running so you can start changing it.

kickstart.nvimnvim-lua/kickstart.nvim · ★ 31.6k · MIT

Quick start

  1. 1Check your Neovim version. Run nvim --version and confirm you have the latest stable release, or nightly, of Neovim.
  2. 2Install the external dependencies. Install git, make, unzip, a C compiler such as gcc, ripgrep, fd-find and the tree-sitter CLI.
  3. 3Back up any existing config. Save your current init.lua and Neovim data folders before you replace them.
  4. 4Create your own copy of the repo. Use the Use this template button or fork the repo on GitHub so you have a copy you can change.
  5. 5Clone into your config folder. Run the git clone command for your OS so the repo lands in your Neovim config directory.
  6. 6Start Neovim. Run nvim so vim.pack installs the plugins, then edit init.lua to suit yourself.

Check what kickstart.nvim requires

Kickstart.nvim targets only the latest stable and latest nightly releases of Neovim. To check your version, run nvim --version and make sure it is not below the latest stable version. If your package manager only offers an older Neovim, the README lists alternative installation methods.

  • Basic utilities: git, make, unzip and a C compiler (gcc)
  • ripgrep and fd-find
  • tree-sitter CLI
  • A clipboard tool such as xclip, xsel or win32yank, depending on your platform
  • A Nerd Font (optional, for icons; set vim.g.have_nerd_font to true in init.lua if you have one)
  • npm if you want to write TypeScript, or go if you want to write Go

Back up your existing Neovim configuration

If you already have a Neovim configuration, the README recommends backing it up and deleting its associated files before installing. This includes your existing init.lua and the Neovim data in ~/.local. You can also keep both setups side by side, as described in the FAQ below.

Clone kickstart.nvim into your Neovim config folder

Neovim reads its configuration from a fixed folder: $XDG_CONFIG_HOME/nvim or ~/.config/nvim on Linux and macOS, and %localappdata%\nvim on Windows. The README recommends first creating your own copy of the repo with GitHub's Use this template button, or forking it, and then cloning your copy. If you do that, replace nvim-lua with your GitHub username in the commands.

On Linux and macOS, clone the repo with the command below. On Windows, the README gives separate commands for cmd.exe and PowerShell.

  • Keep a copy of your own repo so you can modify it freely
  • Consider removing nvim-pack-lock.json from your repo's .gitignore so you can track it in version control (see :help vim.pack-lockfile)
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim

Start Neovim and let it install plugins

Start Neovim with the command below. According to the README, vim.pack installs all the plugins from your config on first launch. To inspect plugin state, run :lua vim.pack.update(nil, { offline = true }). To fetch updates, run :lua vim.pack.update(). Then :write applies the updates and :quit cancels them.

nvim

Read and modify init.lua

Open init.lua in your configuration folder. The README says it explains how to extend and explore Neovim and includes examples of adding popular plugins. For details about a particular plugin, check that plugin's own repository documentation.

Because the whole config lives in one file, changes are easy to find and undo. Make small edits, restart Neovim and check the result.

Fix Windows and Linux setup issues with the install recipes

The README includes install recipes for Windows and WSL. Its Windows notes say the default config only builds telescope-fzf-native.nvim with make, and the plugin is skipped if make is missing. The README also shows a CMake-only option that requires editing init.lua in two places. The chocolatey route installs gcc and make without changing the config.

What people use it for

  • Learning Neovim and Lua by reading a heavily commented config
  • Building a small personal setup instead of a large preset distribution
  • Keeping a Git-tracked editor config that you understand line by line
  • Trying a second, separate Neovim config alongside your main one using NVIM_APPNAME

Frequently asked questions

Is kickstart.nvim free to use?

Yes. The repository is licensed under MIT. The source does not state any price, and you can clone and modify it for your own use.

What do I need before installing kickstart.nvim?

You need the latest stable or nightly Neovim, plus git, make, unzip and a C compiler such as gcc. The README also lists ripgrep, fd-find, the tree-sitter CLI and a clipboard tool.

Can I run kickstart.nvim alongside my existing Neovim config?

Yes. The FAQ says you can use NVIM_APPNAME to maintain multiple configurations, for example by installing kickstart in ~/.config/nvim-kickstart and creating an alias that sets NVIM_APPNAME.

How do I uninstall kickstart.nvim?

Remove your config directory and local data directory, for example ~/.config/nvim and ~/.local/share/nvim.

Why is kickstart.nvim a single file?

The README says it is meant as a teaching tool and reference config that you clone as a base. It suggests splitting init.lua into smaller parts as you learn more, and links to kickstart-modular.nvim, a fork that uses a multi-file layout.

How does kickstart.nvim compare to LazyVim, AstroNvim or NvChad?

Kickstart is a minimal starting point you own and extend, while LazyVim, AstroNvim and NvChad are larger preset setups. The README states kickstart is not a distribution, so choose it if you want to understand every line, and a preset if you want a ready-made setup.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Kickstart.nvim suits people learning Neovim and Lua, and developers who want a small, commented base they fully control. It is a poor fit if you want a feature-rich ready-made setup, need an older Neovim version, or want a multi-file layout by default.

Install options & downloads