Tae Won Ha edited this page Nov 10, 2016 · 32 revisions


We recently, June 2016, started to migrate the MacVim backend (VimR-MacVim) to a NeoVim backend (VimR-NeoVim). The old wiki can be found in VimR MacVim.


Don't forget to

  • set termguicolors: Otherwise vim-airline will look strange. However, there's still a small rendering issue: GH-269
  • set title: This will set the title of the window correctly.

You may want to check the gui_vimr flag to apply these settings only to VimR:

if has("gui_vimr")
" VimR specific settings like
"   color xyz

Supported Gestures

  • Pinch to zoom in or out.
  • Two-finger scrolling.


  • Ligatures are turned off by default. You can turn it on in the Appearance Preferences: Activate ligatures checkbox

$PATH in VimR

We first $SHELL from NSProcessInfo, then use the shell to launch the NeoVim binary in the background. More description TBD.

Command Line Tool

VimR comes with a command line tool vimr:

$ vimr file1 file2 ...     # opens file1, file2, ... in tabs in the front most window.
$ vimr -n file1 file2 ...  # opens file1, file2, ... in tabs in a new window.
$ vimr -s file1 file2 ...  # opens file1, file2, ... in separate new windows
$ vimr --cwd /some/path    # set the working directory to /some/path
$ vimr -h                  # show help
usage: vimr [-h] [--dry-run] [--cwd CWD] [-n | -s] [file [file ...]]

Open files in VimR: By default all files are open in tabs in the front most
window or in a new window if there is none. The working directory will be set
to the current directory.

positional arguments:

optional arguments:
  -h, --help  show this help message and exit
  --dry-run   Just print the 'open' command.
  --cwd CWD   Set the working directory.
  -n          Open files in tabs in a new window.
  -s          Open files in separate windows.

It can be installed via Preferences ➝ General ➝ "Copy 'vimr' CLI tool..." button:

Copy CLI tool button

Automatic Update

If you want to be notified for snapshot builds, you can turn on Snapshot Update Channel in the Advanced preferences pane:

Use Snapshot Update Channel