My personal Neovim configuration

Table of Contents

• Features
• Requirements
• Installation
• Configuration
• Keybindings
• Plugins
• Customization
• License

Features

• Easily Extendable and Configurable: Modular and simple directory structure.
• Intelligent Autocompletion: Powered by nvim-cmp and LuaSnip.
• Git Integration: Visualize git changes with gitsigns and TUI access via lazygit.
• Language Support: Extensive LSP configuration with mason and nvim-lspconfig (Go, TypeScript, YAML, Docker, etc.).
• File Management: Neo-tree as the file explorer and Telescope for fuzzy finding.
• Syntax Highlighting: Treesitter integration for robust syntax awareness.
• DevOps Tools: Kubernetes integration via kubectl.nvim and TUI access to Docker (lazydocker), SQL (lazysql), and API clients (posting).
• Modern UI: Catppuccin theme, lualine, and a modernized command palette/messaging system with noice.nvim.

Requirements

To use this configuration, you must have the following installed.

Core Dependencies

• Neovim (version 0.10 or higher)
• Git

System Tools and Build Essentials

Required for fuzzy finding, installation, and compiling plugins (Treesitter parsers and LuaSnip components).

• ripgrep (rg): Required by Telescope for live grep.
• C Compiler (gcc or clang)
• make
• curl, tar, gzip

Installation examples:

# Debian/Ubuntu
sudo apt install build-essential curl tar gzip ripgrep

# macOS (requires Homebrew)
xcode-select --install # Installs git, gcc/clang, make
brew install ripgrep curl

Runtimes and LSPs

Required for Language Server Protocols managed by Mason.

• Node.js and npm (for ts_ls, jsonls, yamlls, etc.)
• Go (for gopls)

Visuals and UI

• Nerd Fonts: Required for displaying icons.
  • Recommended: JetBrainsMono Nerd Font.
  • Download and install the font on your system, then configure your terminal emulator to use it.
• fortune: Displays random quotes on the dashboard (alpha.nvim).

  # macOS/Linux via Homebrew
  brew install fortune
  # Debian/Ubuntu
  sudo apt install fortune-mod

Optional TUI Tools

These tools are integrated via key mappings but are not strictly required for Neovim to function.

• lazygit: Git TUI (<leader>gtt).
• lazydocker: Docker TUI (<leader>dc).
• lazysql: SQL client TUI (<leader>sq).
• posting: API development/testing TUI (<leader>po).

Installation

1. Backup Existing Configuration

Before proceeding, back up your existing Neovim configuration:

mv ~/.config/nvim ~/.config/nvim_backup
mv ~/.local/share/nvim ~/.local/share/nvim_backup
mv ~/.local/state/nvim ~/.local/state/nvim_backup
mv ~/.cache/nvim ~/.cache/nvim_backup

2. Setup the Configuration

Method A: Manual Installation

1. Ensure Neovim 0.10+ is installed (e.g., brew install neovim or via your OS package manager).
2. Clone the repository directly into your Neovim configuration directory:

   git clone https://github.com/jkleinne/nvim ~/.config/nvim

Method B: Using the Install Script (Recommended)

The nvim-install.sh script automates the installation of the latest Neovim binary and moves the configuration into place.

Warning: This script requires sudo privileges, installs Neovim to /opt/, and updates ~/.bashrc.

1. Clone the repository to a temporary location:

   git clone https://github.com/jkleinne/nvim 
   cd nvim

2. Run the installation script. You must source it (using .) so that the PATH updates apply to your current shell:

   . ./nvim-install.sh

   The script will download Neovim, install it, and move the configuration files from the temporary location to ~/.config/nvim.

Note: If you primarily use Zsh (which this configuration prefers in settings.lua), you will need to manually add the Neovim binary path (/opt/nvim-linux-x86_64/bin) to your ~/.zshrc.

3. First Launch and Verification

Open Neovim. The lazy.nvim plugin manager will automatically start installing the plugins, including compiling Treesitter parsers and LuaSnip components.

nvim

After the plugins are installed, run :checkhealth to ensure all dependencies are met and identify any issues.

:checkhealth

Configuration

The configuration files are organized as follows:

~/.config/nvim/
├── lua/                   # Lua configuration directory
│   ├── plugins/           # Individual plugin configurations
│   │   ├── lsp.lua
│   │   ├── telescope.lua
│   │   ├── ... (additional plugins)
│   │   └── init.lua       # Plugin loader initialization
│   ├── mappings.lua        # Key mappings and shortcuts
│   ├── settings.lua        # General settings and options
├── init.lua                # Main entry point
├── lazy-lock.json          # Lock file for lazy.nvim
├── nvim-install.sh         # Installation script (Linux)
└── ...

Keybindings

The leader key is set to Space.

General Navigation

Keybinding	Description
<C-e>	Toggle Neo-tree file explorer
<TAB>	Cycle to the next buffer
<S-TAB>	Cycle to the previous buffer
<leader>x	Close the current buffer (Bdelete)

Search (Telescope)

Keybinding	Description
<leader>tf	Find files in the current working directory
<leader>tg	Live grep (search text) in the current working directory
<leader>tb	List open buffers
<leader>th	Search help tags
<leader>ts	Search LuaSnip snippets

Tabs and Terminals

Keybinding	Description
<C-w>t	Open a new tab
<leader>ta	Open a new empty buffer (:enew)
<leader>h	Open a terminal in a horizontal split below
<leader>v	Open a terminal in a vertical split to the right

TUI & Tool Integrations

Keybinding	Description
<leader>k	Toggle Kubectl context viewer
<leader>gtt	Open LazyGit in a terminal buffer
<leader>dc	Open LazyDocker in a terminal buffer
<leader>sq	Open LazySQL in a terminal buffer
<leader>po	Open Posting (API tester) in a terminal buffer

LSP (Language Server Protocol)

These are active when an LSP server is attached to a buffer.

Keybinding	Description
gd	Go to definition
K	Hover documentation
gi	Go to implementation
gr	Go to references
<C-k>	Signature help
<leader>rn	Rename symbol
<leader>ca	Code actions
<leader>f	Format buffer (async)
gl	Open floating diagnostics
[d	Go to previous diagnostic
]d	Go to next diagnostic

Plugins

Here is a list of some of the key plugins included in this configuration:

• alpha-nvim: Startup screen.
• bufferline.nvim: Manage open buffers as tabs.
• catppuccin/nvim: Soothing pastel theme (Mocha flavor).
• nvim-cmp: Autocompletion engine.
• gitsigns.nvim: Git decorations in the gutter.
• kubectl.nvim: Kubernetes integration.
• mason.nvim: Manage LSPs, linters, and formatters.
• neo-tree.nvim: File explorer.
• noice.nvim: Modernizes the UI for messages, cmdline, and popups.
• telescope.nvim: Fuzzy finder.
• nvim-treesitter: Enhanced syntax highlighting.
• which-key.nvim: Displays a popup with possible keybindings.

For a complete list, refer to the lua/plugins folder in the repository.

Customization

• Themes: Change the colorscheme or flavor by modifying the lua/plugins/colorscheme.lua file.
• Keybindings: Update or add new keybindings in the lua/mappings.lua file.
• Plugins: Add or remove plugins in the lua/plugins/ directory. lazy.nvim will manage them automatically upon restart.
• Language Servers: Configure additional LSPs or change settings in lua/plugins/lsp.lua, or install interactively using :Mason.

License

This project is licensed under the MIT License