tilley/astrovim

AstroVim is an aesthetic and feature-rich neovim config that is extensible and easy to use with a great set of plugins

AstroNvim

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

REBRANDING NOTICE: AstroVim will now be known as AstroNvim to clear up any confusion surrounding this being a Neovim configuration vs a Vim configuration. If you have used AstroNvim before the rebranding please run the following command to update your installation repo:

git -C ~/.config/nvim remote set-url origin https://github.com/AstroNvim/AstroNvim.git

Pre-v1.0 Notice: If you were using AstroVim before the v1.0 release, please see the updated documentation because there were breaking changes.

🌟 Preview

✨ Features

• File explorer with Neo-tree
• Autocompletion with Cmp
• Git integration with Gitsigns
• Statusline with Lualine
• Terminal with Toggleterm
• Fuzzy finding with Telescope
• Syntax highlighting with Treesitter
• Formatting and linting with Null-ls
• Language Server Protocol with Native LSP

⚡ Requirements

• Nerd Fonts
• Neovim 0.7+
• Terminal with true color support (for the default theme, otherwise it is dependent on the theme you are using)
• Optional Requirements:
  • fzf - live grep telescope search (<leader>fw)
  • lazygit - git ui toggle terminal (<leader>tl or <leader>gg)
  • NCDU - disk usage toggle terminal (<leader>tu)
  • Htop - process viewer toggle terminal (<leader>tt)
  • Python - python repl toggle terminal (<leader>tp)
  • Node - node repl toggle terminal (<leader>tn)

Note when using default theme: For MacOS, the default terminal does not have true color support. You wil need to use iTerm2 or another terminal emulator that has true color support.

Note if you are still on Neovim v0.6: You can still install the previous version of AstroNvim that supported. After cloning the repository run git checkout nvim-0.6 to check out this version. This will no longer be receiving updates.

🛠️ Installation

Make a backup of your current nvim folder

mv ~/.config/nvim ~/.config/nvimbackup

Clone the repository

git clone https://github.com/AstroNvim/AstroNvim ~/.config/nvim
nvim +PackerSync

📦 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

Manage plugins

Run :PackerClean to remove any disabled or unused plugins
Run :PackerSync to update and clean plugins

Update AstroNvim

Run :AstroUpdate to get the latest updates from the repository

🗒️ Links

AstroNvim Documentation

• Basic Usage is given for basic usage
• Default Mappings more about the default key bindings
• Default Plugin Configuration more about the provided plugin defaults
• Advanced Configuration more about advanced configuration

Watch a review video to know about the out of the box experience

⭐ Credits

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

• Plugins
• NvChad
• LunarVim
• CosmicVim