Setup

Try NvChad in a Docker container

This will leave your current Neovim configuration untouched. Once you exit Neovim, the image is deleted.

  docker run -w /root -it --rm alpine:edge sh -uelic '
    apk add git nodejs neovim ripgrep alpine-sdk --update
    git clone https://github.com/NvChad/NvChad ~/.config/nvim
    nvim
    '

Pre-requisites

• Neovim 0.7.0 install page
• If neovim’s very old for your OS then consider trying this neovim version manager
• Use a Nerd Font in your terminal emulator.

Semi-optional

• ripgrep is required for grep searching with Telescope

Install

Linux / macos (UNIX)

git clone https://github.com/NvChad/NvChad ~/.config/nvim --depth 1 ; nvim

Windows

git clone https://github.com/NvChad/NvChad $HOME\AppData\Local\nvim --depth 1 ; nvim

(Note: windows users must have mingw installed & set on path))

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.

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