Skip to content

Sync files from and to remote filesystems automatically while working in Sublime Text 3

License

Notifications You must be signed in to change notification settings

devaos/sublime-remote

Repository files navigation

#sublime-remote Build Status Coverage Status

Provides rsync facilities to automatically sync a remote host when editing files locally.

##Limitations

  • This plugin requires Sublime Text 3
  • This plugin is not Windows compatible

##Installation

You can install the plugin simply by cloning it into Sublime 3 plugin directory:

git clone https://github.com/devaos/sublime-remote.git ~/Library/Application Support/Sublime Text 3/Packages/Remote

##Use

###Map a remote directory to your local project directory

  • Right-click on a project folder in your side-bar and select Remote > Map to Remote...
  • Enter the remote host and path, as you would with rsync ("user@host:/path/to/dir").
  • If you entered "vagrant" as the host it will auto-select the vagrant VM if you only have 1, otherwise it will prompt you to select which vagrant VM you wish to map.

Once the project directory is mapped, anytime you save a file Sublime will attempt to rsync the file to the remote host.

###Sync a local directory from a remote host

  • IMPORTANT: The rsync is done with a --delete option so will remove files that do not exist on the remote host. Be careful!
  • Right-click on a project folder in your side-bar and select Remote > Rsync Local from Remote.
  • If you have not already mapped the project folder to a remote host, it will take you through the process described above.

###Override the default rsync options

  • Right-click on a project folder in your side-bar and select Remote > Set rsync options for Remote...
  • Set custom rsync options, such as if you need to sync through a bastion host e.g. -rlz --delete -e "ssh bastion.domain.com ssh"

The contents of the remote host will then be copied into the local project folder.

About

Sync files from and to remote filesystems automatically while working in Sublime Text 3

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published