Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/szhu/rsyncer

I sync, therefore I am.
https://github.com/szhu/rsyncer

Last synced: about 1 month ago
JSON representation

I sync, therefore I am.

Host: GitHub
URL: https://github.com/szhu/rsyncer
Owner: szhu
Created: 2013-09-02T03:58:50.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2014-09-07T05:28:08.000Z (over 10 years ago)
Last Synced: 2024-04-11T15:52:56.762Z (9 months ago)
Language: Python
Homepage:
Size: 184 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

rsyncer
=======

*I sync, therefore I am.*

what's this?
------------

`rsyncer` lets you make configurations for `ssh` and `rsync`. It's a little like ssh configs, except:

- **JSON**-based config file!
- **Variables:** define your own variables. Variables can be set in any order.
- **Inheritance:** configs can extend other configs.
- **Other programs:** send arguments to any program, not just `rsync` and `ssh` and other programs that support ssh configs.

quick start
-----------

Download `rsyncer` and move it into one of the directories in `PATH`.

mkdir ~/.config # if it doesn't already exist
mkdir ~/.config/rsyncer
cd ~/.config/rsyncer
touch main.json

Add a config "mysite", either in `main.json`:

{
"mysite": {
"host": "[email protected]",
"remote": "$host/www",
"local": "~/Sites/mysite"
}
}

or in `mysite.json`:

{
"host": "[email protected]",
"remote": "$host/www",
"local": "~/Sites/mysite"
}

Good to go!

$ rsyncer mysite pwd
/Users/User/Sites/mysite
$ rsyncer mysite ssh
ssh [email protected]
...
$ rsyncer mysite push
rsync -rvut /Users/Sean/Sites/mysite/ [email protected]/www
...
$ rsyncer mysite pull
rsync -rvut [email protected]/www/ /Users/Sean/Sites/mysite
...

setup
-----

Here's an example config at `~/.config/rsyncer/main.json`:

{
"server:example.com": {
"host": "username@$server",
"server": "example.com",
"rsync-path": "/home/username/opt/rsync/bin/rsync",
"rsync-args": ["--copy-unsafe-links"]
},
"myweb": {
"extends": "server:example.com",
"local": "~/Sites/MyWeb",
"remote": "$host:/home/username/public_html",
"#exclude-from": "$local/.exclude"
},
"project1": {
"extends": "server:example.com",
"local": "~/Sites/Personal",
"remote": "$host:~/subdomains/project1",
},

"server:cs.berkeley.edu": {
"exclude-from": "$local/.exclude",
"servername": "star",
"server": "$servername.cs.berkeley.edu",
"host": "$username@$server",
"remote": "$host:work",
"local": "~/Documents/School/cs/$username",
"rsync-args": ["--copy-unsafe-links"]
},
"cs61a": {
"extends": "server:cs.berkeley.edu",
"username": "cs61a-ab",
},
"cs61c": {
"extends": "server:cs.berkeley.edu",
"username": "cs61c-cd",
"servername": "hive15",
"remote": "$host:work/my",
"local": "~/Documents/School/cs/$username/my"
},
"ee20n": {
"extends": "server:cs.berkeley.edu",
"username": "ee20n-ef",
"local": "~/Documents/School/ee/$username",
}
}

You can also store each config in its own file. Example (`~/.config/rsyncer/testsite.json`)

{
"host": "username@$server",
"server": "test.example.com",
remote: "$host:www",
local: "~/Sites/Test",
"disable-pull": true
},