Logo: Relish

  1. Sign in

Project: Vim-flavor

Typical usage


As a skilled Vim user, it is an exciting time to start using a new plugin,
but installation is not so, because there are several steps to do like the

  1. Get a package of the plugin.
  2. Copy source tree in the package into ~/.vim etc.
  3. Generate the help tags file for the plugin.

It is also exciting to update favorite Vim plugins to the latest version,
but I don't want to repeat the steps for each plugin. It's boring.

Some plugins depend on other plugins, so that I have to install also
dependencies, but it is easy to forget about dependencies.
It's sad to see error messages like "E117: Unknown function: foo#bar".

It would be better to automate these routine works with a declarative way,
and vim-flavor does it.

Typical workflow


# Add, delete or change declarations which versions of Vim plugins to use.
vim Flavorfile

# Install Vim plugins according to Flavorfile.
vim-flavor install

# Record changes to the declarations and locked status.
git add Flavorfile Flavorfile.lock
git commit -m '...'

Flavorfile (Flavorfile)

vim-flavor reads a file Flavorfile in the current working directory.
The file is called a flavorfile. A flavorfile contains zero or more
declarations about Vim plugins and which versions of Vim plugins to use.

See also more details about flavorfile.

Lockfile (Flavorfile.lock)

vim-flavor creates a file Flavorfile.lock in the current working directory.
The file is called a lockfile. A lockfile contains details about installed
Vim plugins to use the same configuration on every machine.

You don't have to care about the content of a lockfile.


  1. Install Vim plugins
  2. Update Vim plugins
  3. Uninstall Vim plugins
  4. Deploy Vim plugins to a non-standard directory

Last published about 3 years ago by kana.