Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laktak/rsyncy
A status/progress bar for rsync
https://github.com/laktak/rsyncy
cli devops rsync tui
Last synced: about 5 hours ago
JSON representation
A status/progress bar for rsync
- Host: GitHub
- URL: https://github.com/laktak/rsyncy
- Owner: laktak
- License: mit
- Created: 2020-11-13T20:48:43.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T21:33:50.000Z (5 months ago)
- Last Synced: 2024-08-15T10:08:09.704Z (3 months ago)
- Topics: cli, devops, rsync, tui
- Language: Python
- Homepage: https://pypi.org/project/rsyncy
- Size: 20.5 MB
- Stars: 122
- Watchers: 4
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rsyncy
A status/progress bar for [rsync](https://github.com/WayneD/rsync).
- [Status Bar](#status-bar)
- [Installation](#installation)
- [Usage](#usage)
- [Known Issues when using ssh behind rsync](#known-issues-when-using-ssh-behind-rsync)
- [lf support](#lf-support)
- [Development](#development)
## Status Bar
```
[########################::::::] 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.
## Installation
- macOS and Linux [Homebrew](https://formulae.brew.sh/formula/rsyncy): `brew install rsyncy`
- Download for [Linux or macOS](https://github.com/laktak/rsyncy/releases).
- Get it with [pipx](https://pipx.pypa.io/latest/installation/): `pipx install rsyncy`
## Usage
`rsyncy` is a wrapper around `rsync`.
- You run `rsyncy` with the same arguments as it will pass them to `rsync` internally.
- Do not specify any `--info` arguments, rsyncy will automatically add `--info=progress2` and `-hv` internally.
```
# 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 only one option, you can turn off colors via the `NO_COLOR=1` environment variable.
## Known Issue when using ssh behind rsync
ssh uses direct TTY access to make sure that the input is indeed issued by an interactive keyboard user (for host keys and passwords). That means that rsyncy does not know that ssh is waiting for input and will draw the status bar over it. You can still enter your password and press enter to continue.
Workaround: connect once to your server via ssh to add it to the known_hosts file.
## lf support
`rsyncy-stat` can be used to view only the status output on [lf](https://github.com/gokcehan/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.
If you have downloaded the binary version you can create it with `ln -s rsyncy rsyncy-stat`.
## Development
First record an rsync transfer with [pipevcr](https://github.com/laktak/pipevcr), then replay it to rsyncy when debugging.