Sync-Rsync Extended

Enhanced sync using Rsync with additional features

About

This extension is an enhanced fork of the original Sync-Rsync extension by @thisboyiscrazy. While maintaining compatibility with the original extension's features, this version includes additional improvements and active maintenance.

Features

This extension syncs with a remote server using rsync, building upon the original Sync-Rsync extension with additional features and improvements.

With these commands:

• Sync-Rsync: Sync Local to Remote
• Sync-Rsync: Sync Local to Remote (Single)
• Sync-Rsync: Sync Remote to local
• Sync-Rsync: Sync Remote to local (Single)
• Sync-Rsync: Compare Local to Remote (dry run)
• Sync-Rsync: Compare Remote to local (dry run)
• Sync-Rsync: Kills the current sync
• Sync-Rsync: Select or Disconnect Site

If no sync is running clicking the status bar item will show the output

If a sync is running clicking the status bar item will kill the running sync, see Windows Notes

Requirements

Rsync installed both locally and remotely

If you are using wsl, wslpath maybe required. (Windows 10 1803 or higher). Or you can install this https://github.com/laurent22/wslpath/blob/master/wslpath which requires php.

If using cygwin, cygpath maybe required.

Extension Settings

Overall Settings (all optional):

• sync-rsync.notification: Show notifications for sync successes (failures always show notifications)
• sync-rsync.autoShowOutput: Auto show rsync output when rsync is working.
• sync-rsync.autoShowOutputOnError: Auto show rsync output on error.
• sync-rsync.autoHideOutput: Auto hide rsync output when rsync is done.
• sync-rsync.onSave: syncs entire local on save.
• sync-rsync.onSaveIndividual: syncs the changed file on save (onSave takes precedence). (note: rsync error 3 is ignored because it might be excluded).
• sync-rsync.onLoadIndividual: syncs the opened file on load. (note: rsync error 3 is ignored because it might be excluded).
• sync-rsync.executableShell: The executable shell to run rsync in (e.g. /bin/bash).
• sync-rsync.executable: The rsync executable (e.g. rsync, C:\cygwin64\bin\rsync.exe).
• sync-rsync.cygpath: If using cygwin, this is the path to cygpath (e.g. C:\cygwin64\bin\cygpath.exe) used to translate windows paths to cygwin.
• sync-rsync.watchGlobs: Enables file system watcher on given glob patterns (may cause high CPU usage - use carefully).
• sync-rsync.useWSL: Use WSL for executing rsync. See Windows Notes
• sync-rsync.templates: Array of site templates that can be inherited by sites. See Templates

Global site options (they will be used as the default for each site):

• sync-rsync.local: the local location defaults to workspace.
• sync-rsync.remote: the rsync remote location e.g. user@remote:path.
• sync-rsync.delete: true or false if you want rsync to delete files.
• sync-rsync.flags: rsync flags.
• sync-rsync.showProgress: show progress during rsync, by adding --progress.
• sync-rsync.exclude: rsync exclude patterns e.g. [".git",".vscode"] (includes happen before excludes) See Includes / Excludes.
• sync-rsync.include: rsync include patterns e.g. ["/","**/.php] (includes happen before excludes) See Includes / Excludes.
• sync-rsync.shell: Rsync's -e option e.g. ssh -p 1234.
• sync-rsync.chmod: Rsync's --chmod option.
• sync-rsync.options: Array of extra rsync options, set each element using rsync.set. See Extra Options.
• sync-rsync.args: Array of extra arguments to append to rsync e.g. ["--exclude=venv/", "--include=*/", "--include=**/*.py", "--exclude=*"].

Sites (Completely Optional, If no sites are defined Sync Rsync creates one using defaults):

• sync-rsync.sites: Multiple Site Support Multiple Sites.

Templates

Templates allow you to define common configurations that can be inherited by sites. This is useful when you have multiple sites with similar configurations.

Example:

{
    "sync-rsync.templates": [
        {
            "name": "production",
            "remotePath": "user@prod:/var/www/",
            "deleteFiles": true,
            "exclude": [".git", ".vscode", "node_modules"]
        },
        {
            "name": "staging",
            "remotePath": "user@staging:/var/www/",
            "deleteFiles": false,
            "exclude": [".git", ".vscode", "node_modules"]
        }
    ],
    "sync-rsync.sites": [
        {
            "name": "prod-site1",
            "template": "production",
            "localPath": "/home/user/project1/"
        },
        {
            "name": "staging-site1",
            "template": "staging",
            "localPath": "/home/user/project1/"
        }
    ]
}

Workspaces

For workspaces you have to define localPath and remotePath for each folder you want synced. e.g.

{
	"folders": [
		{
			"path": "/home/user/project/s1"
		},
		{
			"path": "/home/user/projects/t2"
		}
	],
	"settings": {
		"sync-rsync.sites": [
			{
				"localPath": "/home/user/project/s1/",
				"remotePath": "user@server:/var/www/s1/"
			},
			{
				"localPath": "/home/user/projects/t2/",
				"remotePath": "user@server:/var/www/s2/"
			}
		]
	}
}

Multiple Sites

Sites have these options, they are all optional sync-rsync will use the defaults if they are not defined:

• name: a Nickname for single site sync.
• template: Name of the template to inherit from.
• upOnly: this site only sync Local to Remote.
• downOnly: this site only sync Remote to Local.
• localPath: the local location defaults to workspace.
• remotePath: the rsync remote location e.g. user@remote:path.
• deleteFiles: true or false if you want rsync to delete files.
• flags: rsync flags.
• exclude: rsync exclude patterns e.g. [".git",".vscode"] (includes happen before excludes) See Includes / Excludes.
• include: rsync include patterns e.g. ["/","**/.php] (includes happen before excludes) See Includes / Excludes.
• shell: Rsync's -e option e.g. ssh -p 1234.
• preSyncUp: a command to run before sync up (e.g. clear cache). First item in array is the command the rest are arguments. e.g. ['ssh','user@server','~/cr.sh'].
• postSyncUp: a command to run after successful sync up (e.g. clear cache). First item in array is the command the rest are arguments. e.g. ['ssh','user@server','~/cr.sh'].
• preSyncDown: a command to run before sync down (e.g. clear cache). First item in array is the command the rest are arguments. e.g. ['ssh','user@server','~/cr.sh'].
• postSyncDown: a command to run after successful sync down (e.g. clear cache). First item in array is the command the rest are arguments. e.g. ['ssh','user@server','~/cr.sh'].
• chmod: Rsync's --chmod option.
• options: Array of extra rsync options, set each element using rsync.set. See Extra Options.
• args: Array of extra arguments to append to rsync e.g. ["--exclude=venv/", "--include=*/", "--include=**/*.tpl", "--exclude=*"].

localPath and remotePath will replace ${workspaceRoot} with the current Workspace Path

Example :

{
    "sync-rsync.delete": true,
    "sync-rsync.sites": [
        {
            "remotePath":"user1@server1:/path1/",   // Sync sync-rsync.local to user1@server1:/path1/ using port 1234
            "shell":"ssh -p 1234"
        },
        {
            "remotePath":"user2@server2:/path2/",  // Sync sync-rsync.local to user2@server2:/path2/
        },
        {
            "localPath":"project/static/",
            "remotePath":"user3@server3:/static/", // Sync project/static/ to user3@server3:/static/
        }
    ]
}

Extra Options

The options array is an array of arrays where each array contains the option name and its value. For example:

"sync-rsync.options": [
    ['progress'],
    ['exclude-from', '/path/to/exclude-file'],
    ['delete'],
]

Each array element will be passed to rsync as an option. The first element is the option name, and any subsequent elements are the option values.

Includes / Excludes

Includes happen before Excludes, this is important because rsync handles a file based on first match, so for example to only upload php files:

{
    "sync-rsync.exclude":[
        "*"
    ],
    "sync-rsync.include": [
        "*/",
        "**/*.php"
    ],
}

if you need more control use sync-rsync.args

Windows Notes

If using cygwin, sync-rsync.cygpath is needed for things like onSaveIndividual to work because cygwin uses different paths as windows.

Here is an example config:

{
    "sync-rsync.executable": "/bin/rsync",
    "sync-rsync.shell": "/bin/ssh -p 2222",
    "sync-rsync.remote": "root@server:/root/test/",
    "sync-rsync.local": "c:\\Users\\root\\sync_test\\",
    "sync-rsync.onSaveIndividual": true,
    "sync-rsync.cygpath": "C:\\cygwin64\\bin\\cygpath.exe",
    "sync-rsync.executableShell": "C:\\cygwin64\\bin\\bash.exe"
}

Here is an example config for WSL:

{
    "sync-rsync.remote": "root@server:/root/folder/",
    "sync-rsync.local": "/mnt/c/Users/root/folder/",
    "sync-rsync.useWSL": true
}

Mac OS Notes

If you are using the shell option to do something like ssh -p 123 you will most likely have to set sync-rsync.executableShell to /bin/bash

Differences from Original Extension

This is an extended version of the original Sync-Rsync extension with the following improvements:

• Enhanced error handling and reporting
• Improved performance optimizations
• Additional configuration options
• Better Windows and WSL support
• Active maintenance and updates

License

This extension is licensed under the MIT License - see the LICENSE file for details.

Sync-Rsync Extended is a powerful VS Code extension that enhances your development workflow with advanced rsync synchronization capabilities. Built on the original Sync-Rsync, this extended version adds:

• Multi-site support with template inheritance • Pre/post sync commands for automated workflows • Automatic sync on save/load • Progress tracking and notifications • Windows, macOS, and Linux support • WSL and Cygwin integration • Advanced file filtering with include/exclude patterns • Customizable rsync flags and options

Perfect for developers working with remote servers, this extension provides seamless file synchronization with your development environment.