Guide · Open source

How to use vimrc: install amix/vimrc and set up Vim

Updated 2026-10-29 · written with AI from the project's own documentation and checked against our catalogue data

amix/vimrc is a pre-built configuration for Vim, the text editor that runs in a terminal. Instead of writing your own settings from scratch, you install this collection and get common settings, a file finder, a file tree, Git integration and several color schemes. This guide shows you how to install the Awesome or Basic version, customise it and keep it updated.

amix/vimrcamix/vimrc · ★ 31.8k · MIT Install options & downloads

Quick start

1Check prerequisites. Make sure Vim (8 or later for some plugins) and Git are installed on your machine.
2Clone the repository. Run the git clone command with --depth=1 into ~/.vim_runtime.
3Run the installer. Run the Awesome installer script, or the Basic one if you want a smaller setup.
4Create my_configs.vim. Make an empty ~/.vim_runtime/my_configs.vim file for your own vimrc lines.
5Try a color scheme. Type :colorscheme and press Tab to preview the included color schemes.
6Update when needed. Run the update commands from the README and then update_plugins.py.

What you need before installing

The README lists Vim and Git as the prerequisites. Vim 8 or later is needed for some of the plugins, according to the README.

If you run Vim as vi instead of vim on Linux, the README suggests adding an alias so the setup works as expected.

Vim (8 or later for some plugins)
Git, used to clone the repository
A terminal, since Vim runs inside it

Install the Awesome version for your own user

The Awesome version includes the plugins, configurations and color schemes. To install it for your own user only, clone the repository into ~/.vim_runtime and run the installer script from your terminal.

git clone --depth=1 https://github.com/amix/vimrc.git ~/.vim_runtime
sh ~/.vim_runtime/install_awesome_vimrc.sh

Install the Basic version on a remote server

The Basic version is a single file with no plugins. The README says it suits remote servers where you do not need many plugins and do not do many edits. You can also copy basic.vim from the repository into your ~/.vimrc by hand.

To install the Basic version with the repository, use the commands below.

git clone --depth=1 https://github.com/amix/vimrc.git ~/.vim_runtime
sh ~/.vim_runtime/install_basic_vimrc.sh

Install for multiple users on one machine

To install for several users, clone the repository to a location every intended user can read, such as /opt/vim_runtime. The README notes that the directory can be any path, as long as all the users have read access.

You can list user names after the path, or use --all to install for all users with home directories. The README says root is not included with --all.

git clone --depth=1 https://github.com/amix/vimrc.git /opt/vim_runtime
sh /opt/vim_runtime/install_awesome_parameterized.sh /opt/vim_runtime user0 user1 user2
sh /opt/vim_runtime/install_awesome_parameterized.sh /opt/vim_runtime --all

Add your own settings in my_configs.vim

After installing, create an empty ~/.vim_runtime/my_configs.vim file for your own changes. Its syntax matches vimrc, so you can add lines such as set number. The README also shows that you can put a color scheme command here, for example colorscheme pyte.

To change colors on the fly, type :colorscheme and press Tab to cycle through the options.

Create ~/.vim_runtime/my_configs.vim
Add vimrc lines such as set number
Add colorscheme pyte to change the color scheme

Update to the latest version

The README says the update is done with a git rebase. Note that the commands below reset local changes inside ~/.vim_runtime, so keep your customisations in my_configs.vim rather than editing the repository files. The last command updates the plugins.

cd ~/.vim_runtime
git reset --hard
git clean -d --force
git pull --rebase
python update_plugins.py  # use python3 if python is unavailable

Use the included features and key mappings

The README says the leader key is a comma, so whenever you see <leader> in the documentation, press comma. Some included features are ctrlp.vim, which is a fuzzy file finder mapped to Ctrl+F, and NERD Tree, a tree explorer. Bufexplorer opens with <leader+o>.

The included Git wrapper is vim-fugitive, and vim-commentary adds comments with gcc for a line.

ctrlp.vim: fuzzy file, buffer, mru and tag finder, mapped to Ctrl+F
NERD Tree: tree explorer plugin
vim-fugitive: Git wrapper
vim-commentary: gcc comments out a line, gc comments out a motion
ack.vim: search with the_silver_searcher (ag) or ack
copilot.vim: GitHub Copilot plugin

Install on Windows

The README suggests Git for Windows to check out the repository, then running the same installation steps as above. It says no special instructions are needed.

What people use it for

Setting up Vim on a new laptop with a working config and no manual work.
Installing the single-file Basic version on a remote server where you edit rarely.
Editing Python, Ruby, JavaScript or TypeScript with syntax support from the included modes.
Learning Vim by reading a documented, plugin-rich configuration.

Frequently asked questions

What do I need to install amix/vimrc?

The README lists Vim and Git as prerequisites. Vim 8 or later is needed for some of the plugins. You then clone the repository and run one of the installer scripts.

Is amix/vimrc free to use?

The project is licensed under MIT, as listed on its page. Check the LICENSE file in the repository for the full terms.

What is the difference between the Awesome and Basic versions?

The Awesome version includes many plugins, color schemes and configurations. The Basic version is one file, basic.vim, with no plugins. The README recommends the Awesome version for most users.

How do I update amix/vimrc?

The README says to run a git rebase in ~/.vim_runtime, then run python update_plugins.py. Use python3 if python is not available. The reset command discards local changes to the repository, so keep your own settings in my_configs.vim.

Does amix/vimrc work on Windows?

The README says to use Git for Windows to check out the repository and then follow the same installation steps. It says no special instructions are needed.

How does amix/vimrc compare to LazyVim or Neovim starter configs?

This page does not compare them in detail. The source names Spf13-vim, LazyVim, SpaceVim and Neovim-based starter configs as comparable projects. amix/vimrc runs in classic Vim, and the README describes its own plugin update process, so check the latest state of each project before choosing.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

amix/vimrc suits Vim users who want a working, documented setup without writing their own config, and people who need a minimal single-file option on a remote server. It is not a good fit if you want a graphical editor, already have a tuned Vim setup you want to keep, or want a configuration that follows newer plugin managers, since the README describes its own update process.

Install options & downloads