README.md

rclone-sync

A bidirectional sync tool using rclone and implemented in shell. The sync algorithms reference from cjnaz/rclonesync-V2. which is a good choice in Python.

Table of Contents

• 🎨 Features
• 📏 Prerequisite
• 🚀 Installation
• 📝 Configuration
• 📓 Usage
• 🌺 Contributing
• 👦 Authors
• 📜 License

🎨 Features

• bidirectional sync

📏 Prerequisite

• bash
• rclone

🚀 Installation

$ git clone https://github.com/ishbguy/rclone-sync
$ cd rclone-sync
$ export PATH="$PATH:$(pwd)/bin"

or

$ curl -fLo /path/to/rclone-sync.sh \
        https://raw.githubusercontent.com/ishbguy/rclone-sync/master/bin/rclone-sync.sh
$ export PATH="$PATH:/path/to"

📝 Configuration

There is no configuration for rclone-sync, but you need to configure rclone if you want to use your cloud service. For detail rclone configuration, you can type man rclone in a shell or go to rclone homepage.

📓 Usage

Simply run:

rclone-sync.sh path1 path2

Just looking what will happen (dry run):

rclone-sync.sh -d path1 path2

For help:

rclone-sync.sh -h

🌺 Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

👦 Authors

• ishbguy

📜 License

Released under the terms of MIT License.