Practicalli nvim-kickstart

A configuration built from scratch with ideas taken from the kickstart.nvim configuration.

Used with Neovim 0.11.x

Use NVIM_APPNAME to use the nvim-kickstart. It is not recommended to use this as your main configuration (yet) as its very minimal.

External Dependencies

• Basic cli tools: git, make, unzip, C Compiler (gcc)
• kitty terminal which has built-in Nerd Fonts (other terminal apps may work but not tested)
• ripgrep, fd-find
• Clipboard tool (xclip/xsel/win32yank or other depending on the platform)

Note

See Install Recipes for additional Windows and Linux specific notes and quick install snippets

Install

Fork the nvim-kickstarter repo and use your clone to create your own custom configuration.

OS	PATH
Linux, MacOS	$XDG_CONFIG_HOME/nvim, ~/.config/nvim

git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim

Post Installation

Start Neovim with the nvim-kickstart configuration.

 NVIM_APPNAME=nvim-kickstart nvim

The Lazy package manager install all the plugins in the configuration.

Use :Lazy to view the current plugin status. Hit q to close the window.

Shell alias

Create a shell alias to simplify calling nvim with the kickstart config

alias kickstart='NVIM_APPNAME="nvim-kickstart" nvim'

Understanding the config

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

• 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 splitting init.lua into smaller parts. A fork of kickstart that does this while maintaining the same functionality is available here:
  • kickstart-modular.nvim
• Discussions on this topic can be found here:
  • Restructure the configuration
  • Reorganize init.lua into a multi-file setup

Install Recipes

OS specific install instructions for Neovim and dependencies.

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-linux-x86_64.tar.gz
sudo rm -rf /opt/nvim-linux-x86_64
sudo mkdir -p /opt/nvim-linux-x86_64
sudo chmod a+rX /opt/nvim-linux-x86_64
sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz

# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/

Arch Install Steps

sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim