AstroNvim README

The project's README from github.com/AstroNvim/AstroNvim. As one markdown file: README.md.

AstroNvim

Install · Configure · Community Plugins · Website · Discord



AstroNvim is an aesthetically pleasing and feature-rich neovim config that is extensible and easy to use with a great set of plugins

🌟 Preview

Preview Image

✨ Features

⚡ Requirements

[!NOTE] [1] All downloadable Nerd Fonts contain icons which are used by AstroNvim. Install the Nerd Font of your choice to your system and in your terminal emulator settings, set its font face to that Nerd Font. If you are using AstroNvim on a remote system via SSH, you do not need to install the font on the remote system.

[!NOTE] [2] Note when using default theme: For macOS, the default terminal does not have true color support. You will need to use iTerm2, Kitty, WezTerm, or another terminal emulator that has true color support.

🛠️ Installation

AstroNvim is provided as a plugin that can be installed with the lazy.nvim plugin manager and then used to import all of the plugin configurations that AstroNvim provides. To quickly get started it is recommended to start with the official AstroNvim Template which provides a great starting point for a new AstroNvim based configuration.

Linux/Mac OS (Unix)

Make a backup of your current nvim and shared folder

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

Clone the template repository

git clone --depth 1 https://github.com/AstroNvim/template ~/.config/nvim
rm -rf ~/.config/nvim/.git
nvim

Windows (Powershell)

Make a backup of your current nvim and nvim-data folder

Rename-Item -Path $env:LOCALAPPDATA\nvim -NewName $env:LOCALAPPDATA\nvim.bak
Rename-Item -Path $env:LOCALAPPDATA\nvim-data -NewName $env:LOCALAPPDATA\nvim-data.bak

Clone the repository

git clone --depth 1 https://github.com/AstroNvim/template $env:LOCALAPPDATA\nvim
Remove-Item $env:LOCALAPPDATA\nvim\.git -Recurse -Force
nvim

Minimal ~/.config/nvim/init.lua

Some users might not want to use an entire template or do any customization. Here is a minimal ~/.config/nvim/init.lua file that simply sets up a base AstroNvim installation:

local lazypath = vim.fn.stdpath "data" .. "/lazy/lazy.nvim"
if not vim.uv.fs_stat(lazypath) then
  -- stylua: ignore
  vim.fn.system({ "git", "clone", "--filter=blob:none", "https://github.com/folke/lazy.nvim.git", "--branch=stable", lazypath })
end
vim.opt.rtp:prepend(lazypath)

require("lazy").setup { "AstroNvim/AstroNvim", version = "^6", import = "astronvim.plugins" }

📦 Basic Setup

Install LSP

Enter :LspInstall followed by the name of the server you want to install
Example: :LspInstall pyright

Install language parser

Enter :TSInstall followed by the name of the language you want to install
Example: :TSInstall python

Install Debugger

Enter :DapInstall followed by the name of the debugger you want to install
Example: :DapInstall python

Manage plugins

Run :Lazy check to check for plugin updates

Run :Lazy update to apply any pending plugin updates

Run :Lazy clean to remove any disabled or unused plugins

Run :Lazy sync to update and clean plugins

Update AstroNvim Packages

Run :AstroUpdate (<leader>pa) to update both Neovim plugins and Mason packages

📹 Videos

There have been some great review videos released by members of the community! Here are a few:

🚀 Contributing

If you plan to contribute, please check the contribution guidelines first.

⭐ Credits

Sincere appreciation to the following repositories, plugin authors and the entire neovim community out there that made the development of AstroNvim possible.

Lua

AstroNvim (AstroNvim/AstroNvim)

Searching Database…

14.5K ·GitHub
AstroNvim
What is this?AstroNvim is a pre-built Neovim configuration that is aesthetically pleasing, feature-rich, extensible, and easy to use, bundling a curated set of plugins for an IDE-like editing experience.
Is this a standalone editor or a config for Neovim?It's a Neovim configuration distributed as a plugin, installed via the lazy.nvim plugin manager on top of an existing Neovim install.
How do I get it running?Back up your existing ~/.config/nvim and data folders, then clone the official AstroNvim Template repository into ~/.config/nvim (on Windows, the equivalent PowerShell steps are given); you can also write a minimal init.lua yourself to bootstrap a base AstroNvim install.
What do I need installed before trying AstroNvim?You need Neovim 0.11+ (not nightly), a C compiler on your PATH, a clipboard tool for system clipboard integration, a true-color terminal, and ideally a Nerd Font for icons; Tree-sitter CLI will auto-install via Mason if missing.
Any install pitfalls I should know about?macOS's default Terminal.app lacks true-color support needed for the default theme, so you'll need iTerm2, Kitty, WezTerm or similar; Nerd Font icons also require manual setup of your terminal emulator's font.
How do I install a language server or debugger after setup?Use the built-in commands: :LspInstall followed by the server name (e.g. pyright), :TSInstall for a Treesitter language parser (e.g. python), and :DapInstall for a debugger.
How do I update AstroNvim and its plugins?Run :AstroUpdate (mapped to pa) to update both Neovim plugins and Mason packages, or use :Lazy check/update/sync to manage plugins directly.
What's included out of the box?AstroNvim ships with Neo-tree file explorer, Blink.cmp autocompletion, Gitsigns git integration, a Heirline statusline/winbar/bufferline, Toggleterm terminal, Snacks fuzzy picker, Treesitter syntax highlighting, None-ls formatting/linting, native LSP, and nvim-dap debugging.
What optional tools unlock extra toggle-terminal features?Installing ripgrep, lazygit, bottom, Python, or Node enables extra toggle terminals for live grep, a git UI, a process viewer, a Python REPL, and a Node REPL respectively.
What are similar projects?NvChad, LunarVim, LazyVim, telescope.nvim, SpaceVim, neovim, lazy.nvim, coc.nvim
Which topics is it in?neovim-config, neovim-plugin, nvim, lsp, neovim, lua, vim, ide, customization, hacktoberfest, gplv3, productivity
Creator
AstroNvim
Size
3.8 MB
Stars
14.5K
Updated
CommitOct 16Releasev6.1.1Oct 16
Age
4y
Commits · 90 Days