Skip to main content

Setup

Pre-requisites#

Some NeoVim installation options

NeoVim installation options#

Note: This is a summary of NeoVim's installation page

With an appimage#

This should work across all Linux distros.

curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim.appimagechmod u+x nvim.appimage./nvim.appimage

Then consider moving this to your local/user bin & adding an alias to this

mv ./nvim.appimage ~/.local/bin/echo "alias vim='/home/<YOUR USERNAME>/.local/bin/nvim.appimage'" >>~/.<bashrc or zshrc>

Using PACMAN on Arch#

sudo pacman -S neovim

Using APT on Ubuntu#

Note: This doesn't work with Debian

sudo add-apt-repository ppa:neovim-ppa/stablesudo apt-get updatesudo apt-get install neovim
  • Use a Nerd Font in your terminal emulator.
  • git & other basic Linux CLI tools

Semi-optional dependencies#

  • node Node.js is required for many Language Servers (LSPs)
  • ripgrep is required for grep searching with Telescope

Install#

Installation is as easy as cloning the NvChad repository into your NeoVim configuration folder.

Next, clone the NvChad repository to ~/.config/nvim & install plugins with:

Linux & MacOS:#

If you already have a ~/.config/nvim folder, make a backup with:

mv ~/.config/nvim ~/.config/NVIM.BAK

Then install NvChad & it's plugins with:

git clone https://github.com/NvChad/NvChad ~/.config/nvimnvim +'hi NormalFloat guibg=#1e222a' +PackerSync

Update#

NvChad has an update mechanism built-in, which will pull any new updates to the git repository.

Activate it by running <leader> + uu.

  • Note: by NvChad default, <leader> is the <space> key

This will open a prompt in NeoVim warning you that it is about to do a git reset --hard and you will lose any customisations you've made to NvChad that are not in designated customisation folders.

Uninstall#

Uninstalling is as simple as removing the nvim configuration directories.

Note: it's suggested to backup your config first, consider mv ~/.config/nvim ~/.config/NVIM.BAK

rm -rf ~/.config/nvimrm -rf ~/.local/share/nvimrm -rf ~/.cache/nvim