verisync 1.0.0

Interactive directory/file transfer with SHA-256 checksum verification over SSH

verisync — Interactive Directory Transfer with Checksum Verification

A general-purpose interactive file/directory transfer utility with end-to-end SHA-256 checksum verification over SSH.
Transfer files or directories to a remote server via rsync or tar.gz, then automatically verify every file's integrity — all from a single command.

---

Table of Contents

• Features
• Requirements
• Installation
  • Via pip (recommended)
  • Via pipx (isolated)
  • Manual install
• Usage
  • Arguments
  • Examples
• Transfer Steps
• Modes: rsync vs zip
• Contributing
• License

---

Features

• 📁 File and directory — transfer a single file or an entire directory tree
• ✅ End-to-end SHA-256 verification — a checksum manifest is generated locally and re-verified remotely after transfer
• ♻️ rsync mode (default) — incremental, resumable, and bandwidth-efficient
• 🗜️ Zip mode (--zip) — packs source into a .tar.gz, uploads, and auto-extracts on the remote
• 🔌 SSH multiplexing — a single SSH control socket is reused across all remote operations, including 2FA/password auth flows
• 📏 Space checks — remote free disk space is measured before transfer; warns if source exceeds 100 GiB
• 🖥️ Interactive + CLI — all parameters can be supplied as CLI flags or entered interactively at runtime
• 🕒 Elapsed time — reports total transfer and verification duration

---

Requirements

Requirement	Notes
Bash >= 4.0	Required for string manipulations and set -euo pipefail
rsync	Used for incremental file transfer in default mode
ssh	SSH client with multiplexing (ControlMaster) support
sha256sum	Standard coreutils tool, available on all Linux/macOS systems
bc	Used for human-readable size arithmetic
tar	Only required when using --zip mode

Note: verisync only needs to be installed on the source machine. The remote side requires only sha256sum and standard POSIX shell tools — no remote installation needed.

---

Installation

Via pip (recommended)

pip install verisync

This places the verisync command on your PATH.

Via pipx (isolated)

pipx install verisync

Manual install

git clone https://github.com/whats2000/verisync.git
cd verisync
bash verisync.sh --help

---

Usage

verisync [OPTIONS]

Arguments

Flag	Description
-s, --src <path>	Local source file or directory to transfer
-u, --user <user>	Remote SSH username
-H, --host <host>	Remote SSH hostname or IP address
-d, --dest <path>	Remote destination directory
--zip	Pack source into tar.gz before transferring
-h, --help	Show usage and exit

Any flag not supplied on the command line will be prompted interactively.

Examples

Interactive mode (prompts for all parameters):

verisync

Fully specified via CLI:

verisync --src /data/project --user alice --host hpc.example.com --dest /scratch/alice/

Use zip mode for a single compressed upload:

verisync -s /data/project -u alice -H hpc.example.com -d /scratch/alice/ --zip

---

Transfer Steps

Step	Description
1	Collect source path, remote user, host, and destination
2	Measure local size; warn if > 100 GiB
3	Test SSH connectivity; check remote free disk space
4	Generate SHA-256 checksum manifest for every file in the source
5	Transfer files + manifest via rsync (or tar.gz); verify checksums remotely

---

Modes: rsync vs zip

Feature	rsync (default)	--zip mode
Resumable?	Yes	No
Incremental?	Yes	No
Single archive?	No	Yes
Compression	-z (inline)	gzip (pre-compressed)
Remote extraction	Not needed	Auto-extracted via tar

---

Contributing

Bug reports and pull requests are welcome at github.com/whats2000/verisync.

---

License

MIT — see LICENSE for details.