Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Clone this wiki locally
You may want to check the
gui_vimr flag to apply these settings only to VimR:
if has("gui_vimr") " Here goes some VimR specific settings like color xyz endif
- Pinch to zoom in or out.
- Two-finger scrolling.
- Ligatures are turned off by default. Turn it on in the Appearance Preferences:
$PATH in VimR
Make sure that the environment variable
SHELL is set to a reasonable value: VimR uses
SHELL to launch the Neovim background process.
Command Line Tool
VimR comes with a command line tool
$ 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 --nvim file1 file2 ... # forwards file1, file2, ... to the nvim process. $ vimr --wait # vimr tool waits till the corresponding GUI window gets closed. $ vimr --cwd /some/path # set the working directory to /some/path $ vimr -h # show help usage: vimr [-h] [--dry-run] [--cwd CWD] [--wait] [--nvim] [-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: file optional arguments: -h, --help show this help message and exit --dry-run Just print the 'open' command. --cwd CWD Set the working directory. --wait This command line tool will exit when the corresponding UI window is closed. --nvim All other arguments (except --dry-run and --wait) will be passed over to nvim. -n Open files in tabs in a new window. -s Open files in separate windows.
For example to use VimR as
git difftool, add the following to your
[difftool "vimrdiff"] cmd = vimr --wait --nvim -d $LOCAL $REMOTE [diff] tool = vimrdiff
It can be installed via Preferences ➝ General ➝ "Copy 'vimr' CLI tool..." button:
If you want to be notified for snapshot builds, you can turn on Snapshot Update Channel in the Advanced preferences pane:
The old wiki about the MacVim-based vimR can be found in VimR MacVim.