Syq Tool Offers Fast, Programmable File Operations and Cross-Machine Transfers

Introduction to Syq

Syq is a new utility designed for file operations, including copying, reorganizing, and removing files. It functions both locally and across different machines, emphasizing speed in its transfers. The tool aims to provide a more programmable and efficient alternative to existing file transfer methods.

Key Features and Capabilities

Syq allows users to resume interrupted file transfers, send files to remote machines without requiring an SSH server or incoming network port on the destination, and execute commands remotely from a server's shell. It also offers a JSON API and a Python SDK, enabling users to script and automate file operations.

For example, a command like 'syq cp project --to server --into backup' creates or updates a project backup on a specified server. The '--srcs-in' option allows copying contents directly into a destination directory.

Preview and Pruning Options

Users can preview planned changes before execution using '--dry-run' for a summary or '--dry-run -v' for a detailed path-by-path list. Syq updates existing destination files as needed and keeps unrelated files unless the '--prune' option is specified to remove them.

Rsync Compatibility and Differences

While Syq can be prefixed to rsync commands (e.g., 'syq rsync -av project/ server:backup/project/'), it uses its own protocol rather than rsync's. This means certain rsync features, such as filter rules, hard links, ACLs, xattrs, sparse files, and rolling-checksum deltas, are not supported. Users are advised to check rsync compatibility before substituting Syq in existing scripts.