README.md

sync-remote.nvim

Remote development plugin for Neovim.

Prerequisites

• rsync
• watchman

sudo apt install rsync
sudo apt install watchman

Installation

Using Lazy.nvim

-- plugins/sync-remote.lua:
return {
  "syednabilashraf/sync-remote.nvim",
  config = function()
    require("sync-remote"):setup()
  end
}

Using Packer.nvim

use {
'syednabilashraf/sync-remote.nvim',
  config = function()
    require("sync-remote"):setup()
  end
}

Configuration

Create a .nvim/config.txt file at the root of your project with the following content:

remote_root    [username@][hostname]:[remote_path]
local_root     ~/example_path/

Config fields summary:

• username username to connect with host
• hostname the host name or remote ip address
• remote_path the remote folder to be synced
• remote_root combination of username, hostname and remote_path. Example: [email protected]:/home/john.doe/remote/project
• local_root the local folder to be synced. Example: /home/john.doe/local/project

Commands

• :SyncRemoteStart loads the .nvim/config.txt file in local source directory
• :SyncRemoteFileUp syncs the active file from local to remote
• :SyncRemoteUp syncs all files from local_root to remote_root
• :SyncRemoteDown syncs all files from remote_root to local_root