My personal Neovim configuration

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

• Easily Extendable and Configurable: Modular and simple directory structure.
• Intelligent Autocompletion: Powered by blink.cmp (Rust fuzzy matching) 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, Python, YAML, Docker, Terraform, etc.).
• Formatting and Linting: conform.nvim for formatters with LSP fallback and format-on-save, nvim-lint for additional linting (hadolint, shellcheck, yamllint, golangci-lint, ruff, tflint).
• File Management: Neo-tree as the file explorer and Telescope with fzf-native for fuzzy finding.
• Syntax Highlighting: Built-in Neovim 0.12 treesitter highlighting via vim.treesitter.start().
• Navigation: flash.nvim for labeled jump navigation, nvim-surround for surround operations.
• DevOps Tools: Kubernetes integration via kubectl.nvim and TUI access to Docker (lazydocker), SQL (lazysql), and API clients (posting).
• Modern UI: Catppuccin theme, lualine, trouble.nvim for diagnostics, and a modernized command palette/messaging system with noice.nvim.
• Session Management: auto-session persists sessions on exit; restore from the alpha dashboard's l button (no auto-restore on startup so the dashboard always shows first).

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

• Neovim (version 0.12 or higher)
• Git

Required for fuzzy finding, installation, and compiling plugins (telescope-fzf-native 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

Required for Language Server Protocols managed by Mason.

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

Managed by conform.nvim and nvim-lint. Install the ones relevant to your workflow:

# Formatters
brew install stylua shfmt
npm install -g prettier
pip install black

# Linters
brew install selene hadolint shellcheck yamllint tflint golangci-lint
pip install ruff

• 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

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).

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

1. Install Neovim 0.12+ (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

The nvim-install.sh script detects your platform and installs Neovim, build tools, runtimes (Node, Go), formatters, linters, TUI tools, and clones the configuration.

Supported platforms: macOS (Homebrew), Debian/Ubuntu (apt), Fedora/RHEL (dnf), Arch Linux (pacman), Alpine (apk).

git clone https://github.com/jkleinne/nvim ~/.config/nvim
cd ~/.config/nvim
./nvim-install.sh

The script will:

• Install Neovim 0.12+ (prefers your system package manager, falls back to the GitHub release tarball)
• Install build dependencies, runtimes, formatters, linters, and TUI tools
• Detect your shell and update PATH if needed (bash, zsh, fish)
• Skip anything already installed

Run ./nvim-install.sh --help for details.

Open Neovim. The lazy.nvim plugin manager will automatically start installing the plugins, including compiling telescope-fzf-native and LuaSnip components.

nvim

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

:checkhealth

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         # Bootstrap script (macOS, Linux)
└── ...

The leader key is set to Space.

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

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

• alpha-nvim: Startup screen.
• auto-session: Saves sessions on exit; restore on demand from the alpha dashboard (l).
• blink.cmp: Autocompletion engine with Rust fuzzy matcher.
• bufferline.nvim: Manage open buffers as tabs.
• catppuccin/nvim: Soothing pastel theme (Mocha flavor).
• conform.nvim: Formatter runner with LSP fallback and format-on-save.
• flash.nvim: Labeled jump navigation.
• gitsigns.nvim: Git decorations in the gutter.
• kubectl.nvim: Kubernetes integration.
• lazydev.nvim: Lazy-loaded Neovim API type information and completions for lua_ls.
• mason.nvim: Manage LSPs, linters, and formatters.
• neo-tree.nvim: File explorer.
• noice.nvim: Modernizes the UI for messages, cmdline, and popups.
• nvim-lint: Async linting for Dockerfile, shell, YAML, Go, Python, Terraform.
• nvim-surround: Surround operations (change, delete, add).
• telescope.nvim: Fuzzy finder with fzf-native sorting.
• todo-comments.nvim: Highlight and search TODO/FIXME/HACK comments.
• trouble.nvim: Diagnostics and quickfix UI.
• which-key.nvim: Displays a popup with possible keybindings.

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

• 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.
• Formatters: Configure formatters per filetype in lua/plugins/conform.lua.
• Linters: Configure linters per filetype in lua/plugins/lint.lua.

This project is licensed under the MIT License