A command line tool used to simplify and run rsync commands from config files. Feedback helps safely build rsync commands before use.
Find a file
2026-02-13 02:32:10 +01:00
config_template Update config_template 2026-02-02 01:59:29 +01:00
README.md Update README.md 2026-02-08 19:17:45 +01:00
rtransfer Update rtransfer 2026-02-13 02:32:10 +01:00

rTransfer

A command line tool used to simplify and run rsync commands from config files
Feedback helps safely build rsync commands before use

Features:

  • POSIX Friendly to work on most shells
  • Create an easy to fill out config file
  • Uses rsync's dry run feature to preview transfers
  • Run multiple config files together
  • Support for SSH/remote transfers
  • Dry run only mode to quickly preview any changes
  • Quick run option to skip dry run mode
  • Reverse file transfer direction option
  • Print out the completed rsync command from a pre-filled config file
  • Feedback for common errors to reduce unexpected issues before using the rsync command

Usage Examples

Create a new template config file
rtransfer -c /path/to/new_config_file
Open the created file with your prefered text editor and enter information as needed

Run an individual file
rtransfer /home/example-user/example_config_file

Run an individual file (reverse transfer direction)
rtransfer -r /home/example-user/example_config_file

Run multiple files
rtransfer /home/example-user/example_config_file_1 /home/user/example_config_file_2
rtransfer /home/example-user/example_config_file_*

Dry run only mode
rtransfer -n /home/example-user/example_config_file

Dry run mode only (reverse transfer direction)
rtransfer -nr /home/example-user/example_config_file

Skip dry run mode
rtransfer -q /home/example-user/example_config_file

Skip dry run mode (reverse transfer direction)
rtransfer -qr /home/example-user/example_config_file

Print an rsync command created from a config file
rtransfer -p /home/example-user/example_config_file

Print an rsync command created from a config file (reverse transfer direction)
rtransfer -pr /home/example-user/example_config_file

Setup

Run the command chmod +x /home/example_user/rtransfer to make rTransfer executable.
Optional: Place the rtransfer file into /usr/local/bin/ directory to use the script as a shell command

Enable File Transfers

Since this script involves the transfer of files, there is the risk of data loss. By default transfers are disabled in the config file.
The script will run in dry run mode until file transfers are enabled by doing the following:

  • In the config file, change the variable ENABLE_TRANSFER=false to ENABLE_TRANSFER=true