Skip to content
AstroNvim Docs

Managing User Configuration

One of the best parts of separating the user configuration of AstroNvim away from modifying the system files is the ability to manage and track your own user configuration while maintaining the ability to still get AstroNvim updates. The easiest process to do this would be as follows:

Setting up a user configuration

  1. Use our AstroNvim/user_example GitHub template to make a new personal user configuration repository. For these steps we will assume your repo is username/astronvim_config
  2. Clone AstroNvim (normal installation instructions)
git clone --depth 1 https://github.com/AstroNvim/AstroNvim ~/.config/nvim
  1. Clone your empty new repository to your ~/.config/nvim/lua folder
git clone https://github.com/username/astronvim_config.git ~/.config/nvim/lua/user
  1. Initlialize AstroNvim (this example is using the unattended installation as described above)
nvim --headless -c 'quitall'
  1. Modify the ~/.config/nvim/lua/user folder and user/init.lua file to your liking and push the changes you make to your repository

Installing from an existing User Configuration

If you have already created your user configuration and have it tracked in a repository, then the process of getting your system up and running is very easy:

  1. Clone AstroNvim (normal installation instructions)
git clone --depth 1 https://github.com/AstroNvim/AstroNvim ~/.config/nvim
  1. Clone your empty new repository to your ~/.config/nvim/lua folder
git clone https://github.com/username/astronvim_config.git ~/.config/nvim/lua/user
  1. Initialize AstroNvim
nvim --headless -c 'quitall'