Skip to content

Prerequisite

charliie-dev edited this page Mar 27, 2026 · 9 revisions

Requirements

  • Neovim nightly (built from main branch recommended)
  • Git
  • A Nerd Font installed and configured in your terminal
  • A terminal emulator with true color and undercurl support (e.g., WezTerm, Kitty, Alacritty, iTerm2)

External Tools

The following CLI tools are used by various plugins and should be available in your $PATH:

Tool Used by Install
ripgrep snacks.picker, blink-ripgrep, grug-far brew install ripgrep / cargo install ripgrep
fd snacks.picker brew install fd / cargo install fd-find
fzf nvim-bqf brew install fzf
delta advanced-git-search brew install git-delta
lazygit snacks.lazygit brew install lazygit
yazi yazi.nvim brew install yazi
btop Terminal keymap brew install btop
lazydocker Terminal keymap brew install lazydocker

Build Dependencies

Some plugins require build tools:

# For LuaSnip jsregexp support
# Requires make and a C compiler

LSP Servers, Formatters, Linters, and DAPs

These are managed by Mason and configured in lua/core/settings.lua. They will be installed automatically on first launch.

Default LSP servers: bashls, clangd, dockerls, gh_actions_ls, gitlab_ci_ls, gopls, harper_ls, html, jsonls, lua_ls, marksman, neocmake, ruff, systemd_lsp, tombi, terraformls, tflint, yamlls, zuban

External LSPs (not managed by Mason): nixd, nil_ls

Default formatters: clang-format, cmakelang, fixjson, mdsf, prettierd, shellharden, stylua

Default linters: actionlint, hadolint, markdownlint-cli2, oxlint, shellcheck, systemdlint

Default DAPs: codelldb (C/C++/Rust), delve (Go), python (debugpy)

You can customize all of these in lua/core/settings.lua or override them in lua/user/settings.lua.

LaTeX Support (Optional)

# For vimtex
sudo apt install latexmk texlive-fonts-extra texlive-fonts-recommended texlive-latex-extra --no-install-recommends

SSH Key Configuration for GitHub

If settings.use_ssh is true, make sure your SSH key is configured:

  1. Add your SSH key to GitHub
  2. Add to ~/.ssh/config:
Host github.com
    User git
    IdentityFile ~/.ssh/id_ed25519

Clone this wiki locally