'stable' and latest 'nightly' of Neovim. If you are experiencing issues, please make sure you have the latest versions.
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_fontininit.luato true
- if you have it set
- Language Setup:
- If want to write Typescript, you need
npm - If want to write Golang, you will need
go - etc.
- If want to write Typescript, you need
- Mason
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) | %userprofile%\AppData\Local\nvim\ |
| Windows (powershell) | $env:USERPROFILE\AppData\Local\nvim\ |
NOTE If following the recommended step above (i.e., forking the repo), replace
nvim-luawith<your_github_username>in the commands below
Linux and Mac
git clone https://github.com/jmvanderpol/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvimWindows
If you're using cmd.exe:
git clone https://github.com/jmvanderpol/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
If you're using powershell.exe
git clone https://github.com/jmvanderpol/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
Start Neovim
nvimThat's it! Lazy will install all the plugins you have. Use :Lazy to view
current plugin status. Hit q to close the window.
Below you can find OS specific install instructions for Neovim and dependencies.
After installing all the dependencies continue with the Install Kickstart step.
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
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