README.md

May 7, 2026 ยท View on GitHub

License Discord

Sync-in

Welcome to the Sync-in desktop client repository!

Sync-in provides a desktop and CLI client for file synchronization, management, and interaction with Sync-in servers. It enables seamless file sync across devices, along with full access to server features from a local environment.

Available on Windows, macOS, and Linux, it adapts to different workflows โ€” from personal workstations to automation and headless environments.

Sync-in

This project is supported by the Docker-Sponsored Open Source Program.


๐Ÿš€ Features

๐Ÿ’ป Desktop Application

  • ๐ŸŒ Multi-server support: connect and manage multiple Sync-in servers from a single client
  • ๐Ÿ” Flexible file synchronization
    • โฌ†๏ธโฌ‡๏ธ One-way sync (push or pull)
    • ๐Ÿ”„ Two-way sync
  • ๐Ÿ›ก๏ธ Multiple sync strategies
    • โœ… Secure mode: checksum-based verification for maximum integrity
    • โšก Fast mode: metadata-based detection (date, size) for improved performance
  • ๐Ÿ“† Scheduled synchronization: automate sync tasks
  • ๐ŸŽฏ Custom filters: include or exclude files and folders
  • ๐Ÿงช Sync preview: simulate operations before applying changes
  • ๐Ÿ“ฅ Integrated download and transfer manager
  • ๐Ÿ‘€ Transfer monitoring: real-time logs and synchronization tracking
  • ๐Ÿค– Guided configuration wizard: simplified setup and onboarding
  • ๐Ÿ” Modern authentication support compatible with Sync-in server identity flows
  • ๐Ÿ”„ Automatic updates: background update system

๐Ÿ“Ÿ Command Line Interface (CLI)

  • ๐Ÿงฉ Runs in any environment supporting Node.js
  • ๐Ÿ” Synchronize files to and from any Sync-in server
  • โš™๏ธ Ideal for automation, scripting, cron jobs, CI/CD pipelines, and headless environments
  • ๐Ÿ” Compatible with Sync-in authentication and identity flows

๐Ÿ’› Support

Sync-in is an independent open source project.
If you find it useful, you can:


๐Ÿค Contributing

Before submitting your pull request, please confirm the following:

  • โœ… I have read and followed the contribution guide.
  • โœ… I am submitting this pull request in good faith and to help improve Sync-in.

๐Ÿ“œ License

This project is licensed under the GNU Affero General Public License (AGPL-3.0-or-later).
See LICENSE for the full text.

Sync-inยฎ is a registered trademark, see our Trademark Policy.


Thank you for using Sync-in ! ๐Ÿš€