syq

Fast, programmable file transfer.

Syq (pronounced "sick") copies, reorganizes, and removes files across local filesystems, remote machines, and S3-compatible storage. It aims to perform well across file sizes, directory sizes, and network speeds.

Documentation · Benchmarks · Changelog

Quick links to docs for common tasks:

• Send files to your laptop from a server you’re SSHed into. Your laptop needs no SSH server or incoming network port.
• Run commands on your laptop from a server
• Copy directly between servers without forwarding your SSH agent
• Copy to, from, and between S3-compatible buckets
• Rename and reorganize files during a copy
• Script syq using structured results or the Python SDK.

Install

On Linux or macOS (x86-64 or ARM64):

curl --proto '=https' --tlsv1.2 -LsSf https://dl.syq.christmas/latest/install.sh | sh

Installs into ~/.local/bin without sudo; make sure it is on your PATH. Or install with Homebrew:

brew install greaber/tap/syq

See installation details for updates and shell completion.

Try a copy

Replace server with an SSH hostname or alias you normally connect to, and project with a local directory:

syq cp project --to server --into backup

This creates or updates backup/project in your home directory on the server. Add --dry-run to preview the copy. If interrupted, rerun with --resume to reuse completed files and recoverable partials. See Copy files for more examples.

Developing syq

In a fresh clone, run scripts/setup.sh to install the Rust toolchain and the pinned development tools. See CONTRIBUTING.md for details, source builds, and contribution checks.

License

MIT. See LICENSE.