neovim-remote/README.md

neovim-remote

• Use case
• Installation
• Usage
• Demos
• FAQ

---

This package provides an executable called nvr which solves these cases:

• Controlling nvim processes from the shell. E.g. opening files in another terminal window.
• Opening files from within :terminal without starting a nested nvim process.

---

Nvim always starts a server. Get its address via :echo $NVIM_LISTEN_ADDRESS or :echo v:servername. Or specify an address at startup: NVIM_LISTEN_ADDRESS=/tmp/nvimsocket nvim.

nvr will use $NVIM_LISTEN_ADDRESS or any address given to it via --servername.

If the targeted address does not exist, nvr starts a new process by running "nvim". You can change the command by setting $NVR_CMD. (This requires forking, so it won't work on Windows.)

Use case

Imagine Neovim is set as your default editor: EDITOR=nvim.

Now run git commit. In a regular shell, a new nvim process starts. In a terminal buffer (:terminal), a new nvim process starts as well. Now you have one nvim nested within another. You don't want that. Put this in your vimrc:

if has('nvim')
  let $VISUAL = 'nvr -cc split --remote-wait'
endif

That way, you get a new window for entering the commit message instead of a nested nvim process.

Alternatively, you can make git always using nvr. In a regular shell, nvr will create a new nvim process. In a terminal buffer, nvr will open a new buffer.

$ git config --global core.editor 'nvr --remote-wait-silent'

Installation

See INSTALLATION.md

Usage

Start a nvim process (which acts as a server) in one shell:

$ NVIM_LISTEN_ADDRESS=/tmp/nvimsocket nvim

And do this in another shell:

$ # Spares us from using --servername all the time:
$ export NVIM_LISTEN_ADDRESS=/tmp/nvimsocket
$ # This is optional, since nvr assumes /tmp/nvimsocket by default.

$ # Open two files:
$ nvr --remote file1 file2

$ # Send keys to the current buffer:
$ nvr --remote-send 'iabc<esc>'
$ # Enter insert mode, insert 'abc', and go back to normal mode again.

$ # Evaluate any VimL expression, e.g. get all listed buffers:
$ nvr --remote-expr "join(sort(map(filter(range(bufnr('$')), 'buflisted(v:val)'), 'bufname(v:val)')), "\""\n"\"")"
.config/git/config
vim/vimrc
zsh/.zprofile

See nvr -h for all options.

Demos

(Click on the GIFs to watch them full-size.)

Using nvr from another shell:

Using nvr from within :terminal:

FAQ

• How to open directories?

  :e /tmp opens a directory view via netrw. Netrw works by hooking into certain events, BufEnter in this case (see :au FileExplorer for all of them).

  Unfortunately Neovim's API doesn't trigger any autocmds on its own, so simply nvr /tmp won't work. Meanwhile you can work around it like this:

    $ nvr /tmp -c 'doautocmd BufEnter'
  

• Reading from stdin?

  Yes! E.g. echo "foo\nbar" | nvr -o - and cat file | nvr --remote - work just as you would expect them to work.

• Exit code?

  If you use a recent enough Neovim, nvr will use the same exit code as the linked nvim.

  E.g. nvr --remote-wait <file> and then :cquit in the linked nvim will make nvr return with 1.

• How to send a message to all waiting clients?

  If you open a buffer with any of the wait options, that buffer will get a variable b:nvr. The variable contains a list of channels wheres each channel is a waiting nvr client.

  Currently nvr only understands the Exit message. You could use it to disconnect all waiting nvr clients at once:

  command! DisconnectClients
      \  if exists('b:nvr')
      \|   for client in b:nvr
      \|     silent! call rpcnotify(client, 'Exit', 1)
      \|   endfor
      \| endif