Skip to content
Sync Vault Docs

Getting started

IMPORTANT

Note:

  1. Please disable other synchronization plugins when using Sync Vault, including the official Obsidian Sync.
  2. Do not place your vault in synchronization directories such as iCloud Sync Folder or Baidu Sync Space while using Sync Vault; otherwise, unpredictable errors may occur.
  3. It is recommended to disable proxies during cloud disk synchronization, as proxies may cause abnormal cloud disk access.

Installation

Section titled “Installation”

Install Sync Vault from the Obsidian community plugin market: click here for one-click install, or search Sync Vault in Settings → Community plugins → Browse to install and enable it.

Quick Setup

Section titled “Quick Setup”

Authorize a Cloud Disk

Section titled “Authorize a Cloud Disk”
  1. Open Settings → Sync Vault; the plugin opens on the Get Started tab by default.
  2. In the Select Cloud Disk section, choose your cloud disk (Alibaba Cloud Disk, Baidu Cloud Disk, Quark Cloud Disk, OneDrive, etc.; disks marked PRO require the premium edition).
  3. Click Click to Authorize and follow the on-screen instructions to finish authorization (most cloud disks open a browser window for login).
TIP

The Welcome Page After successful authorization, you will be redirected to the Welcome Page. Follow the steps described there or as detailed below.

Once authorization completes, the button changes to Revoke Authorization; click it to revoke at any time.

NOTE

Free vs. Premium The free edition covers manual sync with Alibaba Cloud Disk, InfiniCloud, Nutstore, Tencent COS, and other cloud disks. Disks marked PRO (Baidu Cloud Disk, Quark Cloud Disk, OneDrive), along with features such as auto sync, real-time collaboration, and the cloud drive browser, require the premium edition: bind an activation code and email under Get Started → Premium to unlock them, see the pricing page for details.

Open the Workbench

Section titled “Open the Workbench”

Click the ☁️ icon in the left sidebar (on mobile: tap ☰ in the bottom menu bar and find the ☁️ icon inside) to open the Sync Vault Dashboard. The unified search bar at the top searches local and cloud files at the same time; below it is the Cloud Service Workbench, built from cards — the workbench starts out empty, so click a quick preset such as Sync Flow, or click ➕ in the bottom-right corner to add cards from the Widget Library:

NOTE

Workbench at a Glance

  • Top bar: switch cloud disks, check the sync status (Ready / Pending / Syncing / Offline) and cloud quota.
  • Search bar: search local and cloud files; click the folder button to open the Cloud Drive Browser (premium).
  • Cards: full-width cards on top, half-width cards below; the buttons in a card’s top-right corner move up / move down / refresh / remove it; click ➕ in the bottom-right corner to open Add Widget and pick cards from the Widget Library or the quick presets (Sync Flow / AI Flow).
  • Pending Sync: sync status and the latest sync record; in Auto Mode you can start/stop sync, plus actions like Dry Run and Reset Sync Baseline.
  • Overview: cloud files, space saved, local files, video annotations, and cloud quota.
  • AI Data Engine: run status and toggle for the built-in MCP Server.
  • The Widget Library also includes cards such as Video Notes, Live Activity, Cloud Links, Collaboration, Connectors, and Agent Sessions.

Manual Sync and Cloud Browsing

Section titled “Manual Sync and Cloud Browsing”

The workbench has two kinds of “browsers” for different purposes:

  • Sync Browser: in Controlled Mode, click the Sync Browser button in the Pending Sync card to manually check files for upload to the cloud or download to your device — ideal when you need precise control over what syncs.
  • Cloud Drive Browser (premium): click the Open Cloud Drive Browser button in the search bar to browse cloud folders like a file manager; you can also right-click a file and choose Open in Cloud Disk, or use the command Open Cloud Drive Explorer.

The three sync modes can be used alone or combined; see Sync for details:

  • Controlled Mode: manually select files to upload or download, for precise control over sync content.
  • Auto Mode: the plugin keeps your local vault in sync with the cloud on a set interval, with no manual intervention (premium).
  • Real-Time Sync: WebRTC-based direct connections between devices for millisecond-level collaboration across devices (premium).

MCP Configuration

Section titled “MCP Configuration”

The AI Data Engine card on the workbench starts the built-in MCP Server with one click; for detailed configuration steps, see the MCP Server Configuration Guide (Claude, Cursor, Trae, and others).

DONE

Congratulations, enjoy your Sync Vault journey! 🍻