简体中文 • Documentation • Plugin Store • License
Sync Engine is a revolutionary solution for vault syncing. Its not only a syncing plugin, it is a modular platform that everyone can build upon.
The core ships the infrastructure, and all backends (WebDAV, S3, GDrive) and features (i18n, optimization, sync strategy) come from composable modules. You and your AI agents can build your own modules via convenient SDK, extend the plugin, contribute to community, all without modifying the source code.
Access Sync Engine documentation at sync.consensia.cc, which contains usage guides, existing modules, permission claims, benchmarking, and documentation on how to build a module.
There's already a lot of plugins to sync your notes between devices:
- Remotely Save supports many backends (S3, Dropbox, OneDrive, WebDAV). But is optionally paid, development paused for years with stability issues
- Self-hosted LiveSync and Fast Note Sync offer real-time, server-based sync. They work well if you are comfortable setting up your own server.
- Relay is a managed relay service. Convenient, but your notes pass through infrastructure you don't control.
Sync Engine fits the gap: you want to choose your own storage, you want the plugin to stay small because unused features aren't bundled in, and you want a highly optimized syncing that is no slower than a self-hosted server.
- Bidirectional syncing.
- Startup / periodic / save-on-change syncing.
- Conflict resolution strategies (keep both / latest survive / keep remote / keep local / skip).
- Rate / memory control options.
- Custom headers.
- You can extend most above features by writing modules.
- Backends: WebDAV, S3
- Features: Encryption, Smart Merge Conflict Resolution
- You can add backends, optimizers, sync triggers, i18n resources, decision strategies, conflict strategies, setting entries, custom file processing, and invoke all possible operations in custom modules.
- Documentation, AI agent skills, and SDK with debug and testing kit are provided.
- Plugin provides dedicated module discovery and management UI.
- Repo accepts any module contribution as long as it respects contribution guide.
- Incremental syncing never uploads the full vault each time.
- Anchored Asymmetric Storage technology substantially accelerates syncing.
- Real-time sync uses cached remote states, allowing it to complete within milliseconds.
- Benchmarking shows around 100x faster than Remotely Save in daily syncing.
- Handles vaults with thousands of files smoothly.
- No slower than a self-hosted server
- Detailed performance comparison can be found in performance benchmark.
- Download and enable
Sync Enginefrom Obsidian plugin store. - Open "Module management" panel, install needed translations, backends and optional features.
- Fill the necessary information about your cloud service in the settings interface.
- Start your first sync from command palette or ribbon button.
- Review the sync tasks that will be performed.
- Click "Confirm", and your files will arrive the configured backend at the speed of light.
Sync Engine welcomes everyone that would like to develop and contribute a module. The detailed module development documentation can be found in Sync Engine website. Module contribution standard see CONTRIBUTING.
What should I do if I get an error during syncing?
You can simply retry the sync. An error does not block later syncs nor corrupt your files.
If the error persists after retrying, please open an issue, describing the error, your setup, with the support log attached.
How should I manage my WebDAV storage when using this plugin?
According to this plugin's file handling strategy, all remote changes will be propagated to all vaults. So it's generally not recommended to manually manage your WebDAV storage unless you intend to add / remove these files. Manual management is more discouraged when you have encryption or asymmetric storage enabled.
Below is a list of planned features and improvements, the faster this plugin is adopted and the star ⭐ grows, the faster the development will be. Also, we welcome contributors that would like to help us with the development of either modules or core.
- v3.0: Rewrite entirely, dynamic module loading, module store, asymmetric storage, and rebrand
- v3.1: Migrate settings to Obsidian v1.13 API
The source code of Sync Engine and modules in this repository are licensed under the MIT License.
Documents in the documentation website are licensed under CC BY 4.0 license.
Copyright ©️ 2026 Hēsperus and All Contributors