A status/progress bar for rsync.
I love rsync but I always felt it was either too chatty when transferring lots of small files or did not show enough information for the large files in between. rsyncy is a wrapper to change this without having to modify rsync.
[########################::::::] 80% | 19.17G | 86.65MB/s | 0:03:18 | #306 | scan 46% (2410)\
The status bar shows the following information:
| Description | Sample |
|---|---|
| Progress bar with percentage of the total transfer | [########################::::::] 80% |
| Bytes transferred | 19.17G |
| Transfer speed | 86.65MB/s |
| Elapsed time since starting rsync | 0:03:18 |
| Number of files transferred | #306 |
| Files to scan/check - percentage completed - (number of files) - spinner |
scan 46% (2410)\ |
The spinner indicates that rsync is still checking if files need to be updated. Until this process completes the progress bar may decrease as new files are found.
Interactive ssh questions (host key, password) are happening outside of the piped content. That means that rsyncy does not know that ssh is waiting for input and will draw the status bar over it. If you have an idea on how to handle this case please let me know.
Workaround: connect once to your server via ssh to add it to the known_hosts file.
pip3 install --user rsyncy
# or if you have pipx
pipx install rsyncy
Minimum Python version is 3.6.
On macOS you also need to brew install rsync because it ships with an rsync from 2006.
rsyncy is a wrapper around rsync.
- You run
rsyncywith the same arguments as it will pass them torsyncinternally. - Do not specify any
--infoarguments, rsyncy will automatically add--info=progress2and-hvinternally.
# simple example
$ rsyncy -a FROM/ TO
Alternatively you can pipe the output from rsync to rsyncy (in which case you need to specify --info=progress2 -hv yourself).
$ rsync -a --info=progress2 -hv FROM/ TO | rsyncy
At the moment rsyncy itself has no options and only supports my preferred way of viewing rsync progress.
rsyncy-stat can be used to view only the status output on lf (or similar terminal file managers).
Example:
cmd paste-rsync %{{
opt="$@"
set -- $(cat ~/.local/share/lf/files)
mode="$1"; shift
case "$mode" in
copy) rsyncy-stat -rltphv $opt "$@" . ;;
move) mv -- "$@" .; lf -remote "send clear" ;;
esac
}}
This shows the copy progress in the > line while rsync is running.
First record an rsync transfer with pipevcr, then replay it to rsyncy when debugging.