Snapshot | Backup | Sync | Verify
Cross-platform backup and snapshot manager built for project folders, NAS workflows, and reliable restores.

Install | Features | Documentation | Download Stats | Roadmap | Changelog | Security | Contributing

---

Warning

VaultSync installers are currently unsigned.

Windows

• SmartScreen will flag the installer.
• Click More info -> Run anyway.

macOS

1. Open the downloaded .dmg.
2. Drag the app into Applications.
3. Close the disk image.
4. Open Applications.
5. Right-click VaultSync -> Open.

If Gatekeeper still blocks it:

Apple Silicon (ARM64)

xattr -dr com.apple.quarantine /Applications/VaultSync-macos-arm64.app

Intel (x64)

xattr -dr com.apple.quarantine /Applications/VaultSync-macos-x64.app

---

_{GitHub badge counters can lag due to third-party caching. For a persistent release-download history, use the download-stats branch.}

---

Project Activity

---

VaultSync

Snapshot | Backup | Sync | Verify - for Projects & Workspaces

VaultSync is a cross-platform backup and snapshot manager built for developers, creators, and power-users working with large project folders.
It provides fast snapshots, filtering via presets, and a modern desktop UI.

---

Docs & Links

• Documentation overview: DOCUMENTATION.md
• Wiki (how-to guides): docs/wiki/Home.md
• Roadmap: ROADMAP.md
• Changelog: CHANGELOG.md
• Updater details: docs/UPDATER.md
• Contributing: CONTRIBUTING.md
• Security: SECURITY.md
• Code of Conduct: CODE_OF_CONDUCT.md

App screenshots

Features

CLI

• Create snapshots of any project folder
• Sync using rsync (macOS/Linux) or robocopy (Windows)
• Hash-based file verification
• Watch mode for automatic syncing
• JSON output for scripting
• Customizable preset rules per project
• Works headless for servers or automation scripts

Desktop UI

• One-click snapshots and backups (manual + scheduled)
• Per-project destination routing (Auto, specific destination, multi-destination support)
• Global and per-project encryption policies with secure credential-store integration
• Password-gated encrypted backup open/restore flow with auto-lock timeout and manual Lock now
• Backup history with type and encryption context (Full, Incremental, Imported, Encrypted/Plain)
• Snapshot diff summaries (added, modified, deleted, net size, top changed paths) with export (text / JSON)
• Backup policy controls (bandwidth limit + quiet hours) with policy state shown in cards/tray/logs
• Metadata sync across machines (.vaultsync/meta) with source-machine tracking on imported backups
• Retention with protected (Keep) backups and integrated cleanup behavior
• Startup integrity scan, Doctor repair flow, metadata conflict review, and restore-readiness summaries
• Destination quota suggestions, retention simulation, and maintenance window jobs
• Update diagnostics, support-bundle export, and strict multi-base patch compatibility
• Cross-platform desktop support: macOS, Windows, Linux

Smart Presets

Presets define what gets included/excluded (like .gitignore).
Common presets included:

• Unity
• .NET / C#
• Game engines (Godot, Unreal, GameMaker)
• Common programming stacks (Node, Python, Rust, Java, Go)
• Creative tools (Blender, Video Editing, Music DAWs)
• General development presets (VSCode, JetBrains, Docker, etc.)

or choose No preset if no presets apply or you want no file exclusion.

Snapshot System

• Fast directory scanner with filtering
• Tracks added / modified / deleted / unchanged files
• Stores snapshots in SQLite
• View snapshot history per project

Backup System

• Backup any snapshot to local or external storage
• Timestamped folders (e.g., 2025-11-16_20-41-43)
• Per-project or "backup all"
• Automatic backups (optional)
• Progress, file count, and failure handling (NAS sleep detection)
• Adaptive archive compression policy for better speed/ratio balance by file type
• Retention: keep the newest N backups per project; protected ("Keep") backups are never pruned
• Integrated snapshot creation: every backup captures a fresh snapshot; orphan snapshots are cleaned up when backups are pruned
• Backup history terminology:
  • Full: complete backup payload
  • Incremental: backup created using incremental copy mode
  • Imported: history discovered/imported from metadata sync or destination scan
• Restore flow now shows a "What happens next" confirmation block before running restore.

Network shares (SMB/NFS)

• SMB auto-mount is supported on Windows and macOS using credential profiles.
• NFS auto-mount is not supported on macOS (requires admin privileges). Pre-mount the share and set the destination to the local mount path with Pre-mounted enabled and Auto-mount disabled.
• Example NFS destination on macOS:
  • Mount: sudo /sbin/mount_nfs -o rw,resvport 192.168.1.138:/export/Flavio_Share "/Users/flavio/Library/Application Support/VaultSync/mounts/nfs-share"
  • Destination path: /Users/flavio/Library/Application Support/VaultSync/mounts/nfs-share/Dev

---

Installation (CLI)

cd ~/Desktop/Dev/VaultSync
dotnet pack src/VaultSync.CLI -c Release
export PATH="$PATH:$HOME/.dotnet/tools"
dotnet tool install --global --add-source src/VaultSync.CLI/bin/ToolPackages vaultsync.cli

Update:

dotnet tool update --global vaultsync.cli

---

Updates & installers

VaultSync checks GitHub Releases according to the selected update channel and interval. Stable follows non-prerelease releases; the optional Beta channel can include prerelease builds from the Dev branch.

Desktop installers are published as assets on the repo's Releases page. Windows installers are produced with the installer/VaultSyncInstaller.iss Inno Setup script after publishing the win-x64 output. macOS builds are shipped as unsigned .dmg images containing the .app bundle; users may need to right-click -> Open or clear quarantine (xattr -dr com.apple.quarantine /Applications/VaultSync.app). macOS and Linux patches are delivered via platform-specific delta archives (see docs/UPDATER.md). The CLI follows the stable release line; run dotnet tool update --global vaultsync.cli after a release is published to stay in sync.

Patch updates are intentionally strict. A release manifest must explicitly list the installed version as an allowed base version before VaultSync offers the patch path. Unsupported or older versions fall back to the full installer instead of guessing compatibility.

VaultSync exposes a language selector under Settings -> Advanced; translations are loaded from the Localization/ folder. The same area now includes Doctor workflows, maintenance jobs, support-bundle export, strict patch diagnostics, and the Beta channel toggle for prerelease Dev builds.

Quick Start (CLI ONLY)

vaultsync init
vaultsync add-project Demo ~/Projects/Demo --preset unity
vaultsync snapshot Demo
vaultsync sync Demo ~/Backup/Demo
vaultsync verify Demo ~/Backup/Demo --full

---

Useful CLI Commands

Core

Command	Description
vaultsync init	Initialize config + database
vaultsync add-project <name> <path>	Register a new project
vaultsync list-projects	Show all tracked projects
vaultsync snapshot <name>	Create snapshot
vaultsync sync <name> <dest>	Mirror project to destination
vaultsync verify <name> <dest>	Hash-compare project vs backup
vaultsync history <name>	Show snapshots
vaultsync diff <name>	Compare two snapshots
vaultsync prune <name>	Remove old snapshots
vaultsync restore <name> <dest>	Restore a previous snapshot
vaultsync doctor	Check environment

Watch Mode

vaultsync watch Game --dest /Backups/Game --sync --verify --debounce-ms 2500

---

License

Licensed under the MIT License.
See the full license here: LICENSE.

Bundled helper tools may ship under their own licenses. See THIRD_PARTY_NOTICES.md.

Current stable desktop release line: 1.7.1.

Credits

Created by Flavio Giacchetti