SyncFlow (同步流)

A Modern, Real-time Bidirectional File Synchronization Tool
现代化、实时的文件双向同步工具

English • 中文

SyncFlow is a powerful file synchronization tool designed for seamless developer workflows. While supporting standard local-to-local synchronization, its core strength lies in Local-to-Remote (SSH/SFTP) synchronization with real-time capabilities.

Unlike traditional tools that rely heavily on slow polling, SyncFlow integrates Remote Inotify support. It runs a lightweight listener on your remote Linux server to push file change events instantly, ensuring your local and remote environments are always in sync with millisecond latency.

• 🔄 Bidirectional & One-way Sync: Flexible synchronization modes to fit your workflow.
• ⚡ Real-time Detection:
  • Local: Uses watchdog to monitor file system events.
  • Remote: Uses inotifywait (via SSH) for instant updates on Linux servers.
  • Smart Polling: Automatic fallback to optimized polling (1.5s interval) if inotify is unavailable.
• 🚀 High Performance:
  • Batch Processing: Aggregates rapid file changes to prevent sync storms.
  • Concurrent Sync: Multi-threaded transfer engine handles multiple files simultaneously.
• 🖥️ Modern Desktop App:
  • Packaged as a native Windows application (no Python installation required).
  • System Tray support for background running.
  • Beautiful, responsive user interface built with Vue 3 and Element Plus.
• 🛡️ Robustness:
  • Trash can & Backup support.
  • Intelligent conflict resolution.
  • Automatic network reconnection.

1. Download the latest release package.
2. Unzip and run SyncFlow.exe.
3. The app will minimize to the system tray. Click the tray icon to open the UI.

1. Prerequisites: Python 3.10+, Node.js (optional, for frontend dev).
2. Install Dependencies:

   pip install -r requirements.txt

3. Run the GUI:

   python gui_app.py

   Or run the backend server only (Headless mode):

   python backend/app.py

To package the application into a standalone .exe file:

pip install pyinstaller pywebview pystray Pillow
python -m PyInstaller --clean -y SyncFlow.spec

The output file will be in dist/SyncFlow/.

For the best experience, install inotify-tools on your remote Linux server to enable real-time pushing:

• Ubuntu/Debian: sudo apt-get install inotify-tools
• CentOS/RHEL: sudo yum install inotify-tools

SyncFlow (同步流) 是一款专为开发者打造的现代化文件同步工具。它不仅支持本地文件夹之间的同步，更专注于高效的 本地 <-> 远程 (SSH/SFTP) 开发场景。

与传统依赖低效轮询的工具不同，SyncFlow 实现了 远程 Inotify 集成。它通过 SSH 在远程 Linux 服务器上运行轻量级监听器，实时推送文件变更事件，实现了毫秒级的双向同步体验。

• 🔄 双向与单向同步: 支持镜像备份或双向实时协作模式。
• ⚡ 极致实时性:
  • 本地监控: 基于 watchdog 系统级文件监控。
  • 远程监控: 优先使用 inotifywait (SSH) 实时捕获远程变更。
  • 智能兜底: 若远程不支持 inotify，自动降级为高频轮询（1.5秒间隔，同步时自动避让）。
• 🚀 高性能引擎:
  • 批量处理: 智能合并短时间内的多次修改，避免重复同步。
  • 并发传输: 多线程传输引擎，海量小文件同步更迅速。
• 🖥️ 原生桌面体验:
  • 提供独立的 Windows 桌面应用 (无需安装 Python)。
  • 支持 系统托盘 最小化，后台静默运行。
  • 基于 Vue 3 + Element Plus 的现代化管理界面。
• 🛡️ 安全可靠:
  • 支持回收站和版本备份，防止误删。
  • 断网自动重连与错误重试机制。

1. 下载最新发布的压缩包。
2. 解压后直接双击运行 SyncFlow.exe。
3. 程序启动后会显示 Loading 动画，并在系统托盘显示图标。

1. 环境准备: Python 3.10+。
2. 安装依赖:

   pip install -r requirements.txt

3. 启动应用:

   # 启动桌面版 (带独立窗口)
   python gui_app.py
   
   # 或仅启动 Web 后端 (浏览器访问 http://localhost:8888)
   python backend/app.py

如果您想自己构建 Windows 可执行文件：

# 安装打包工具
pip install pyinstaller pywebview pystray Pillow

# 执行打包
python -m PyInstaller --clean -y SyncFlow.spec

构建完成后，可执行文件位于 dist/SyncFlow/ 目录下。

为了获得最佳的远程同步体验，建议在您的 Linux 服务器上安装 inotify-tools：

• Ubuntu/Debian: sudo apt-get install inotify-tools
• CentOS/RHEL: sudo yum install inotify-tools
• 如果未安装，软件会自动回退到轮询模式，依然可用，但延迟稍高 (约 1-2 秒)。

This project is licensed under the MIT License.