Nvim-Tree-Remote.nvim

A set of Nvim-Tree actions to open files on another remote neovim.

Why? Sometimes you want to use Nvim-Tree as a standalone file browser. This way, you can make your own IDE with Tmux, for example.
The problem is that the Nvim-Tree doesn't interact with another Neovim which can get annoying.

With this tool, you can control a remote instance of Neovim which makes it possible to use Nvim-Tree as a seamless standalone file explorer!

Installation

Install using vim-plug:

Plug 'kiyoon/nvim-tree-remote.nvim'

Install using packer:

use {'kiyoon/nvim-tree-remote.nvim'}

Install pynvim.

pip3 install --user pynvim

Setup Nvim-Tree with remote actions in vimscript / lua:

" For lua users, delete the first and the last line.
lua << EOF

-- Remote nvim's --listen address
vim.g.nvim_tree_remote_socket_path = '/tmp/nvim_tree_remote_socket'

local nvim_tree = require('nvim-tree')
local nt_remote = require('nvim_tree_remote')

nvim_tree.setup {
  -- ...
  view = {
    mappings = {
      list = {
        { key = { "l", "<CR>", "<C-t>", "<2-LeftMouse>" }, action = "remote_tabnew", action_cb = nt_remote.tabnew },
        { key = { "v", "<C-v>" }, action = "remote_vsplit", action_cb = nt_remote.vsplit },
        { key = "<C-x>", action = "remote_split", action_cb = nt_remote.split },
        { key = "o", action = "remote_edit", action_cb = nt_remote.edit },
        { key = "h", action = "close_node" },
      },
    },
  },
  remove_keymaps = {
    'O',
  },
  -- ...
}
EOF

Usage

If you came here for Treemux, you don't have to worry about setting the variables because Treemux overrides them all!

Run neovim like

nvim --listen /tmp/nvim_tree_remote_socket

Then, run another nvim with Nvim-Tree.

nvim .

If you open files from the Nvim-Tree, the remote nvim will open the file.
Change g:nvim_tree_remote_socket_path to your Nvim-Tree to update the remote path to another Neovim host.

Tmux

Optionally, you can open an nvim instance as a new tmux split.

let g:nvim_tree_remote_tmux_pane = '.1'
let g:nvim_tree_remote_tmux_split_position = 'top'  " top / bottom / left / right
let g:nvim_tree_remote_tmux_editor_init_file = ''	" ~/.config/nvim/init.vim
let g:nvim_tree_remote_tmux_split_size = '70%'
let g:nvim_tree_remote_tmux_focus = 'editor'      " tree / editor

Treemux

This will make it possible to turn off the sidebar from the editor.
Again, you don't have to set this manually because Treemux will override it.

let g:nvim_tree_remote_treemux_path = '~/.tmux/plugins/treemux'

Advanced configuration

You can create your own functions with fine-tuned parameters.
WARNING! The plugin is currently experimental and the function might change in the future.

-- lua code
local nt_remote = require('nvim_tree_remote')

-- Change the arguments as you like.
-- i.e. You can choose to ignore some of the global variables and replace to what you want.
-- local function default_edit()
--   -- This is the same as nt_remote.edit
--   nt_remote.open_file_remote_and_folder_local(
--     vim.g.nvim_tree_remote_socket_path,
--     "edit",
--     nt_remote.tmux_defaults
--   )
-- end

local function vsplit_focus()
  local tmux_options = nt_remote.tmux_defaults()
  -- below are the default values
  -- tmux_options.pane = vim.g.nvim_tree_remote_tmux_pane
  -- tmux_options.split_position = vim.g.nvim_tree_remote_tmux_split_position
  -- tmux_options.split_size = vim.g.nvim_tree_remote_tmux_split_size
  -- tmux_options.focus = vim.g.nvim_tree_remote_tmux_focus
  tmux_options.focus = "editor"
  nt_remote.open_file_remote_and_folder_local(
    vim.g.nvim_tree_remote_socket_path,
    "vsplit",
    tmux_options
  )
end

local function tabnew_main_pane_no_split()
  local tmux_options = nt_remote.tmux_defaults()
  tmux_options.split_position = ""
  nt_remote.open_file_remote_and_folder_local(
    vim.g.nvim_tree_remote_socket_path,
    "tabnew",
    tmux_options
  )
end

nvim_tree.setup {
  -- ...
  view = {
    mappings = {
      list = {
        { key = "v", action = "vsplit_focus", action_cb = vsplit_focus },
        { key = "o", action = "tabnew_main_pane", action_cb = tabnew_main_pane_no_split },
      },
    },
  },
  -- ...
}