Skip to content

First-party source

Desktop command contract: Obsidian CLI, retrieved 2026-08-29 EDT. See the dated source ledger.

Sync

Fresh

Pause and resume Obsidian Sync, show status, list and restore Sync version history. To run Sync without the desktop app, see Headless Sync.

Commands for Obsidian Sync.

Sync without the desktop app

These commands control Sync within the running Obsidian app. To sync vaults from the command line without the desktop app, see Headless Sync.

sync

Pause or resume sync.

bash
on                 # resume sync
off                # pause sync

sync:status

Show sync status and usage.

sync:history

List sync version history for a file (default: active file).

bash
file=<name>        # file name
path=<path>        # file path

total              # return version count

sync:read

Read a sync version (default: active file).

bash
file=<name>        # file name
path=<path>        # file path
version=<n>        # (required) version number

sync:restore

Restore a sync version (default: active file).

bash
file=<name>        # file name
path=<path>        # file path
version=<n>        # (required) version number

sync:open

Open sync history (default: active file).

bash
file=<name>        # file name
path=<path>        # file path

sync:deleted

List deleted files in sync.

bash
total              # return deleted file count

See also

Unofficial SOP mirror. Built for terminal-driven and agentic Obsidian workflows.