README.md
May 7, 2026 ยท View on GitHub
Welcome to the Sync-in desktop client repository!
- ๐ Website
- ๐ Documentation
- ๐ฅ Download the desktop app
- ๐๏ธ GitHub Server Repository
- ๐ป GitHub Desktop & CLI 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.
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:
- โญ Star the repositories
- ๐ Report issues and suggest improvements
- ๐ค Contribute code, translations, or documentation
- ๐ฌ Join the community on :
- ๐ Support the project !
๐ค 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 ! ๐