RemoteSync

A Sublime Text 4 plugin for syncing files to remote servers via SFTP, FTP, FTPS, and SCP.

Features

• Upload on save — files sync automatically when you hit Ctrl+S
• Batch upload/download entire folders with parallel connections
• Interactive remote file browser
• Diff local vs remote file before overwriting
• Multiple configs — one per subfolder, each with its own server
• Run commands on the server after each upload (e.g. sudo systemctl reload nginx)
• Run local commands before upload (e.g. npm run build)
• Connection pooling with keepalive — no reconnect on every save
• Output panel with animated progress, auto-hides after operations finish
• JSON config with comment support (// comments allowed)
• Auto-converts PuTTY .ppk keys to OpenSSH format

Installation

Via Package Control (recommended)

1. Open the Command Palette: Ctrl+Shift+P
2. Run Package Control: Install Package
3. Search for RemoteSync and install

Manual

Clone or download this repo into your Sublime Text Packages/ folder:

Packages/RemoteSync/

Requirements

• Sublime Text 4
• OpenSSH (sftp, scp, ssh) — included on macOS/Linux; on Windows install Git for Windows or enable the optional OpenSSH feature

Setup

Right-click any folder in the sidebar and select RemoteSync → Setup Remote Server…

A remote-sync-config.json file will be created. Fill in your server details:

{
    "type": "sftp",
    "host": "your-server.com",
    "user": "username",
    "password": "password",
    "remote_path": "/var/www/mysite/",
    "upload_on_save": true
}

Multiple servers

Place a separate remote-sync-config.json in each subfolder. Files automatically use the nearest config (walking up the tree) when saved.

When the project has more than one config, RemoteSync: - Logs a one-time notice listing every config and which folders they cover. - Shows the absolute remote path in the output panel for every upload/download, so you can see exactly where each file lands.

To verify which config applies to a file, right-click it → RemoteSync → Show Effective Config (also in the command palette). It shows the resolved config, the local→remote mapping, and any nested configs.

Single destination? Set "inherit_root_only": true in the root config to ignore all nested configs and always use the root.

Config inheritance

A nested config can share the parent's server and override only what changes. Set "inherit_parent": true and define just the differing keys:

// root: full credentials
{ "host": "h", "user": "u", "password": "p", "remote_path": "/var/www/site" }

// themes/custom/remote-sync-config.json — same server, different folder
{ "inherit_parent": true, "remote_path": "/var/www/site/themes/custom" }

The nested config inherits host, user, password, etc. from the nearest config above it. Change the password once in the root and every inheriting config follows.

Without inherit_parent, a nested config is fully independent — use this when the subfolder targets a completely different server.

Configuration

Plugin Settings

Open via Preferences → Package Settings → RemoteSync → Settings:

{
    "show_panel_on_error": true,
    "auto_hide_panel": 4,
    "log_operations": true
}

• auto_hide_panel — seconds before the output panel closes after success (0 = never hide)

Commands

All commands are available via: - Right-click on files/folders in the sidebar - Command Palette (Ctrl+Shift+P) — search “RemoteSync”

Disabling the context menu

To disable or customize the context menu:

• Create a RemoteSync directory inside your Packages directory (find it via Preferences → Browse Packages)
• In that directory place a Context.sublime-menu file. You can use this package's original menu as a starting point

This copy overrides the original. You can remove the entries you don't want, or use just [] to disable the menu completely.

The same applies to the sidebar menu — use Side Bar.sublime-menu instead.

License

MIT