Top Related Projects
Neovim config for the lazy
AstroNvim is an aesthetic and feature-rich neovim config that is extensible and easy to use with a great set of plugins
🌙 LunarVim is an IDE layer for Neovim. Completely free and community driven.
Blazing fast Neovim config providing solid defaults and a beautiful UI, enhancing your neovim experience.
💤 A modern plugin manager for Neovim
A use-package inspired plugin manager for Neovim. Uses native packages, supports Luarocks dependencies, written in Lua, allows for expressive config
Quick Overview
Kickstart.nvim is a starter template for Neovim configuration using Lua. It provides a well-structured, modular setup with sensible defaults and a curated selection of popular plugins, aiming to offer a solid foundation for users to build their own customized Neovim environment.
Pros
- Easy to set up and use, especially for those new to Neovim or Lua configurations
- Includes a carefully selected set of plugins for essential features like syntax highlighting, autocompletion, and file navigation
- Modular structure allows for easy customization and extension
- Actively maintained and community-driven project
Cons
- May include more plugins or features than some users need, potentially leading to bloat
- Requires some Lua knowledge for deeper customization
- Could be overwhelming for absolute beginners due to the number of included plugins and options
Getting Started
-
Backup your existing Neovim configuration:
mv ~/.config/nvim ~/.config/nvim.bak
-
Clone the repository:
git clone https://github.com/nvim-lua/kickstart.nvim.git ~/.config/nvim
-
Start Neovim:
nvim
-
Wait for the initial plugin installation to complete.
-
Restart Neovim to apply all changes.
To customize the configuration, edit the init.lua
file in your Neovim config directory. You can add or remove plugins, change keybindings, and adjust settings to suit your preferences.
Competitor Comparisons
Neovim config for the lazy
Pros of LazyVim
- More comprehensive and feature-rich out-of-the-box configuration
- Includes a wider range of pre-configured plugins and settings
- Offers a modular structure for easier customization and extension
Cons of LazyVim
- Steeper learning curve due to its more complex structure
- May include unnecessary features for users seeking a minimal setup
- Potentially slower startup time due to the larger number of plugins
Code Comparison
LazyVim:
-- LazyVim custom configuration
return {
colorscheme = "tokyonight",
plugins = {
{ "folke/tokyonight.nvim" },
},
}
kickstart.nvim:
-- kickstart.nvim basic setup
require('packer').startup(function(use)
use 'wbthomason/packer.nvim'
use 'neovim/nvim-lspconfig'
end)
LazyVim provides a more structured approach to configuration, while kickstart.nvim offers a simpler, more straightforward setup. LazyVim's code demonstrates its modular nature, allowing easy addition of plugins and settings. In contrast, kickstart.nvim's code shows a basic plugin setup using Packer, which is more minimal but requires more manual configuration for advanced features.
AstroNvim is an aesthetic and feature-rich neovim config that is extensible and easy to use with a great set of plugins
Pros of AstroNvim
- More comprehensive and feature-rich out-of-the-box configuration
- Includes a wider range of pre-configured plugins for enhanced functionality
- Offers a user-friendly UI with dashboard and status line
Cons of AstroNvim
- Steeper learning curve due to its complexity
- May include unnecessary features for some users, potentially impacting performance
- Less customizable compared to the minimal approach of kickstart.nvim
Code Comparison
AstroNvim configuration example:
return {
colorscheme = "astrodark",
lsp = {
formatting = {
format_on_save = true,
},
},
}
kickstart.nvim configuration example:
require('kickstart.plugins.autoformat')
vim.cmd.colorscheme 'habamax'
AstroNvim provides a more structured configuration approach, while kickstart.nvim offers a simpler, more minimal setup. AstroNvim includes more pre-configured options, whereas kickstart.nvim requires manual configuration for advanced features.
🌙 LunarVim is an IDE layer for Neovim. Completely free and community driven.
Pros of LunarVim
- More comprehensive and feature-rich out-of-the-box configuration
- Includes a wider range of pre-configured plugins and settings
- Offers a more polished and cohesive user experience
Cons of LunarVim
- Heavier and potentially slower startup time due to more pre-configured features
- Less customizable and may require more effort to modify or remove unwanted features
- Steeper learning curve for users who prefer a minimal starting point
Code Comparison
LunarVim configuration example:
lvim.colorscheme = "lunar"
lvim.format_on_save.enabled = true
lvim.builtin.terminal.active = true
lvim.builtin.nvimtree.setup.view.side = "left"
lvim.builtin.nvimtree.setup.renderer.icons.show.git = false
kickstart.nvim configuration example:
vim.opt.colorscheme = "habamax"
vim.opt.completeopt = { "menuone", "noselect" }
vim.opt.termguicolors = true
vim.opt.number = true
vim.opt.relativenumber = true
LunarVim provides a more opinionated and feature-rich configuration, while kickstart.nvim offers a minimal starting point for users to build upon. LunarVim includes more pre-configured plugins and settings, making it easier for beginners to get started with a fully-featured setup. However, kickstart.nvim allows for more customization and a lighter initial configuration, which may be preferred by users who want more control over their Neovim setup.
Blazing fast Neovim config providing solid defaults and a beautiful UI, enhancing your neovim experience.
Pros of NvChad
- More comprehensive and feature-rich out-of-the-box configuration
- Includes a custom UI with themes and status line
- Offers a plugin management system with lazy loading
Cons of NvChad
- Steeper learning curve due to its complexity
- May include unnecessary features for some users
- Requires more system resources due to its extensive setup
Code Comparison
NvChad configuration example:
local custom_init_path = vim.api.nvim_get_runtime_file("lua/custom/init.lua", false)[1]
if custom_init_path then
dofile(custom_init_path)
end
kickstart.nvim configuration example:
require('kickstart.plugins.autoformat')
require('kickstart.plugins.debug')
vim.o.hlsearch = false
NvChad provides a more structured approach to customization, while kickstart.nvim offers a simpler, more straightforward configuration process. NvChad's code demonstrates its focus on user customization, whereas kickstart.nvim's code shows its emphasis on core functionality and simplicity.
💤 A modern plugin manager for Neovim
Pros of lazy.nvim
- Faster startup time due to lazy loading of plugins
- More granular control over plugin loading conditions
- Built-in profiling and debugging tools for optimizing performance
Cons of lazy.nvim
- Steeper learning curve for configuration compared to kickstart.nvim
- Requires more manual setup for plugin management
- May introduce complexity for users who prefer a simpler setup
Code Comparison
kickstart.nvim:
require('packer').startup(function(use)
use 'wbthomason/packer.nvim'
use 'neovim/nvim-lspconfig'
use 'hrsh7th/nvim-cmp'
end)
lazy.nvim:
require("lazy").setup({
"neovim/nvim-lspconfig",
{ "hrsh7th/nvim-cmp", event = "InsertEnter" },
{ "folke/which-key.nvim", event = "VeryLazy" },
})
Summary
kickstart.nvim provides a simpler, more straightforward setup for Neovim users, while lazy.nvim offers advanced plugin management features with lazy loading capabilities. kickstart.nvim is better suited for beginners or those who prefer a pre-configured setup, whereas lazy.nvim caters to users who want fine-grained control over their Neovim environment and are willing to invest time in configuration for improved performance.
A use-package inspired plugin manager for Neovim. Uses native packages, supports Luarocks dependencies, written in Lua, allows for expressive config
Pros of packer.nvim
- More mature and established plugin manager with a larger user base
- Offers advanced features like lazy loading and compilation for faster startup
- Provides a rich API for custom plugin management workflows
Cons of packer.nvim
- Steeper learning curve for beginners due to its extensive feature set
- Requires more configuration and setup compared to kickstart.nvim
- May be considered overkill for users with simpler plugin management needs
Code Comparison
kickstart.nvim:
require('lazy').setup({
'tpope/vim-fugitive',
'tpope/vim-rhubarb',
-- Add more plugins here
})
packer.nvim:
require('packer').startup(function(use)
use 'tpope/vim-fugitive'
use 'tpope/vim-rhubarb'
-- Add more plugins here
end)
Summary
kickstart.nvim is a streamlined, beginner-friendly Neovim configuration that uses lazy.nvim as its plugin manager. It provides a solid starting point for users new to Neovim or those who prefer a simpler setup.
packer.nvim, on the other hand, is a more powerful and flexible plugin manager that offers advanced features for experienced users. It allows for more granular control over plugin loading and management but requires more setup and configuration.
Choose kickstart.nvim for a quick start and simpler management, or packer.nvim for more advanced plugin handling capabilities.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
kickstart.nvim
Introduction
A starting point for Neovim that is:
- Small
- Single-file
- Completely Documented
NOT a Neovim distribution, but instead a starting point for your configuration.
Installation
Install Neovim
Kickstart.nvim targets only the latest 'stable' and latest 'nightly' of Neovim. If you are experiencing issues, please make sure you have the latest versions.
Install External Dependencies
External Requirements:
- Basic utils:
git
,make
,unzip
, C Compiler (gcc
) - ripgrep
- Clipboard tool (xclip/xsel/win32yank or other depending on platform)
- A Nerd Font: optional, provides various icons
- if you have it set
vim.g.have_nerd_font
ininit.lua
to true
- if you have it set
- Language Setup:
- If you want to write Typescript, you need
npm
- If you want to write Golang, you will need
go
- etc.
- If you want to write Typescript, you need
NOTE See Install Recipes for additional Windows and Linux specific notes and quick install snippets
Install Kickstart
NOTE Backup your previous configuration (if any exists)
Neovim's configurations are located under the following paths, depending on your OS:
OS | PATH |
---|---|
Linux, MacOS | $XDG_CONFIG_HOME/nvim , ~/.config/nvim |
Windows (cmd) | %localappdata%\nvim\ |
Windows (powershell) | $env:LOCALAPPDATA\nvim\ |
Recommended Step
Fork this repo so that you have your own copy that you can modify, then install by cloning the fork to your machine using one of the commands below, depending on your OS.
NOTE Your fork's url will be something like this:
https://github.com/<your_github_username>/kickstart.nvim.git
You likely want to remove lazy-lock.json
from your fork's .gitignore
file
too - it's ignored in the kickstart repo to make maintenance easier, but it's
recommmended to track it in version control.
Clone kickstart.nvim
NOTE If following the recommended step above (i.e., forking the repo), replace
nvim-lua
with<your_github_username>
in the commands below
Linux and Mac
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
Windows
If you're using cmd.exe
:
git clone https://github.com/nvim-lua/kickstart.nvim.git "%localappdata%\nvim"
If you're using powershell.exe
git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim"
Post Installation
Start Neovim
nvim
That's it! Lazy will install all the plugins you have. Use :Lazy
to view
current plugin status. Hit q
to close the window.
Read through the init.lua
file in your configuration folder for more
information about extending and exploring Neovim. That also includes
examples of adding popularly requested plugins.
Getting Started
The Only Video You Need to Get Started with Neovim
FAQ
- What should I do if I already have a pre-existing neovim configuration?
- You should back it up and then delete all associated files.
- This includes your existing init.lua and the neovim files in
~/.local
which can be deleted withrm -rf ~/.local/share/nvim/
- Can I keep my existing configuration in parallel to kickstart?
- Yes! You can use NVIM_APPNAME
=nvim-NAME
to maintain multiple configurations. For example, you can install the kickstart configuration in~/.config/nvim-kickstart
and create an alias:
When you run Neovim usingalias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
nvim-kickstart
alias it will use the alternative config directory and the matching local directory~/.local/share/nvim-kickstart
. You can apply this approach to any Neovim distribution that you would like to try out.
- Yes! You can use NVIM_APPNAME
- What if I want to "uninstall" this configuration:
- See lazy.nvim uninstall information
- Why is the kickstart
init.lua
a single file? Wouldn't it make sense to split it into multiple files?- The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily use to
git clone
as a basis for their own. As you progress in learning Neovim and Lua, you might consider splittinginit.lua
into smaller parts. A fork of kickstart that does this while maintaining the same functionality is available here: - Discussions on this topic can be found here:
- The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily use to
Install Recipes
Below you can find OS specific install instructions for Neovim and dependencies.
After installing all the dependencies continue with the Install Kickstart step.
Windows Installation
Windows with Microsoft C++ Build Tools and CMake
Installation may require installing build tools and updating the run command for `telescope-fzf-native`See telescope-fzf-native
documentation for more details
This requires:
- Install CMake and the Microsoft C++ Build Tools on Windows
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
Windows with gcc/make using chocolatey
Alternatively, one can install gcc and make which don't require changing the config, the easiest way is to use choco:- install chocolatey either follow the instructions on the page or use winget, run in cmd as admin:
winget install --accept-source-agreements chocolatey.chocolatey
- install all requirements using choco, exit previous cmd and open a new one so that choco path is set, and run in cmd as admin:
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
WSL (Windows Subsystem for Linux)
wsl --install
wsl
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
Linux Install
Ubuntu Install Steps
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
Debian Install Steps
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip curl
# Now we install nvim
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz
sudo rm -rf /opt/nvim-linux64
sudo mkdir -p /opt/nvim-linux64
sudo chmod a+rX /opt/nvim-linux64
sudo tar -C /opt -xzf nvim-linux64.tar.gz
# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
Fedora Install Steps
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
Arch Install Steps
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
Top Related Projects
Neovim config for the lazy
AstroNvim is an aesthetic and feature-rich neovim config that is extensible and easy to use with a great set of plugins
🌙 LunarVim is an IDE layer for Neovim. Completely free and community driven.
Blazing fast Neovim config providing solid defaults and a beautiful UI, enhancing your neovim experience.
💤 A modern plugin manager for Neovim
A use-package inspired plugin manager for Neovim. Uses native packages, supports Luarocks dependencies, written in Lua, allows for expressive config
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot