RSync for Sublime Text 3

UPDATE:

I haven't touched this in ages, mostly due to not using it anymore (also: new kid) and there aren't that many people using it for me to invest in support. If you still feel that this is really useful for you, feel free to fork or use one of the forks done by others. BTW: For my flow, having a build command that rsyncs on ctrl/cmd-B is simpler, faster and less error-prone.

This is a Sublime Text plugin to synchronise files with a remote server using rsync. RSync is a whole lot faster and more eficient than copying everything, since it tries to identify the diferences and synchronise only these diferences.

This plugin has been in daily use for about 3 months, but keep in mind it has a small user base and there might be hidden bugs. This cannot be emphasized enough.

I use it for my daily work, but I have tested it very little outside of my workflow. If this plugins erases all your files, breaks your heart and elopes with you pet cactus, though luck. I'll now accept some crying, but the responsability will still be yours. However, I'm now open for bug reports and requests for improvements, for which there are no promises of me even looking at them.

Let me make this quite clear: I'M NOT RESPONSIBLE IN ANY WAY WHATSOEVER FOR CONSEQUENCES OF USING THIS CODE. Any problems caused by it are the full responsability of whoever decided to download, install and use it.

Also: some features are clearly focused on my work environment's context, such as using git hashes both local and remote to check for changes. I'll try to add more general use features and am open to requests, but keep in mind this is something I do when work, family and my small child let me have some free time, which is not often.

In time, I'll add to this document better instructions, but for now this is what you get.

Features

• Uses rsync (kinda obvious) over ssh (optionally)
• Suports multiple hosts
• Supports excludiing certain file patterns
• (new) Now supports comparing local and remote git hashes to avoid overwriting remote files. This assumes:
  • You have git installed locally
  • You have git installed remotelly
  • You can ssh over to the remote server

Dependencies

• You must have rsync installed, somewhere that “which rsync” will find it
• You must have ssh setup, if you want to use it
• You must have git if you want to run checks to compare local vs remote

WINDOWS USERS: Sorry guys, this was written in a day and I haven't had a chance to even try to get it working on windows. Feel free to take a shot at getting it to work on windows and sending me the pull request.

Installing it

There are 2 ways install this plugin, none of which I'll explain, but I'll list them:

1. Just use Package Manager
2. Clone this repository into the Packages folder of your Sublime Text instalation.

You can find the Packages folder by having a look at your preferences menu.

Configuration

Have a look at the example settings. I recomend you do them in the project file for your work, rather then the general settings file.

Using it

After configuration is done, go to the Tools menu => RSync => Synchronise the whole tree. This will take a while, if your project is very big. Don't worry, it will be a lot faster after this first time.

Now change a file and save it. If properly setup (and if you didn't stumble on an unknown bug), it should show up on your remote host.

To do

• Lots
• (new) add some more checks to try and stop you from overwriting changes that you want to keep, WHICH DON'T NEED GIT :)
• add hooks for running commands before/after sync
• add more settings to be both general and by host
• sync tree on project open
• some sort of configuration wizard would be nice…
• get it working in Windows
• get it working in Sublime Text 2, if enough people request it
• Improve documentation
• Seriously, lots more…

Done

• (update: will now check local vs remote git hashes, assuming you have git isntaled) add some more checks to try and stop you from overwriting changes that you want to keep
• (update: much improved) improve eficiency: we're calling rsync –way– too aften
• (update: now pops up a warning which you can ignore) add a “don't bug me for now” on error. When away from a network, saving gets annoying…