Nvim-Tree-Remote.nvim

A set of Nvim-Tree and Neo-Tree actions to open files on another remote neovim, including opening in Tmux splits.

Unlike the name suggests, this plugin works with both Nvim-Tree and Neo-Tree.

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 lazy.nvim:

For Nvim-Tree,

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

local function nvim_tree_on_attach(bufnr)
  local nt_remote = require "nvim_tree_remote"

  local function opts(desc)
    return { desc = "nvim-tree: " .. desc, buffer = bufnr, noremap = true, silent = true, nowait = true }
  end

  api.config.mappings.default_on_attach(bufnr)

  vim.keymap.set("n", "l", nt_remote.tabnew, opts "Open in tmux")
  vim.keymap.set("n", "<CR>", nt_remote.tabnew, opts "Open in tmux")
  vim.keymap.set("n", "<C-t>", nt_remote.tabnew, opts "Open in tmux")
  vim.keymap.set("n", "<2-LeftMouse>", nt_remote.tabnew, opts "Open in tmux")
  vim.keymap.set("n", "v", nt_remote.vsplit, opts "Vsplit in tmux")
  vim.keymap.set("n", "<C-v>", nt_remote.vsplit, opts "Vsplit in tmux")
  vim.keymap.set("n", "<C-x>", nt_remote.split, opts "Split in tmux")
  vim.keymap.set("n", "o", nt_remote.tabnew_main_pane, opts "Open in tmux without split")
end

require("lazy").setup({
  {
    "nvim-tree/nvim-tree.lua",
    dependencies = {
      "kiyoon/nvim-tree-remote.nvim",
    },
    config = function()
      require("nvim-tree").setup({
        on_attach = nvim_tree_on_attach,
      }
    end,
  }
})

For Neo-Tree, make sure you don't use Nvim-Tree functions like split, vsplit, tabnew etc. Use remote_nvim_open instead.

require("lazy").setup({
  {
    "nvim-neo-tree/neo-tree.nvim",
    branch = "v3.x",
    dependencies = {
      "nvim-lua/plenary.nvim",
      "nvim-tree/nvim-web-devicons",
      "MunifTanjim/nui.nvim",
      "kiyoon/nvim-tree-remote.nvim",
    },
    config = function()
      require("neo-tree").setup({
        event_handlers = {
          {
            event = "file_open_requested",
            handler = function(args)
              local nt_remote = require("nvim_tree_remote")
              -- customise the socket_path and tmux options as you like.
              nt_remote.remote_nvim_open('/tmp/nvim_tree_remote_socket', args.open_cmd, args.path, nt_remote.tmux_defaults())

              -- stop default open; we already did it remotely
              return { handled = true }
            end,
          },
        },
      })
    end,
  },
})

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

local function nvim_tree_on_attach(bufnr)
  local nt_remote = require "nvim_tree_remote"

  local function opts(desc)
    return { desc = "nvim-tree: " .. desc, buffer = bufnr, noremap = true, silent = true, nowait = true }
  end

  api.config.mappings.default_on_attach(bufnr)

  vim.keymap.set("n", "v", vsplit_focus, opts "Open in tmux split")
  vim.keymap.set("n", "o", tabnew_main_pane_no_split, opts "Open in tmux without split")
end

require("lazy").setup({
  {
    "nvim-tree/nvim-tree.lua",
    config = function()
      require("nvim-tree").setup({
        on_attach = nvim_tree_on_attach,
      }
    end,
  }
})