Sync

`ob sync-list-remote`

List remote vaults associated with the logged-in account.

ob sync-list-remote

List locally configured sync vaults.

ob sync-list-local

Create a remote sync vault with optional encryption.

ob sync-create-remote --name <name> [--encryption <mode>] [--password <password>] [--region <region>]

Flag	Default	Description
`--name`	(required)	Vault name
`--encryption`	`e2ee`	Encryption mode: `standard` or `e2ee`
`--password`		Encryption password (required for `e2ee`)
`--region`		Vault region

Encryption modes:

Attach a local folder to a remote vault.

ob sync-setup --vault <vault> [--path <path>] [--password <password>] [flags]

Flag	Default	Description
`--vault`	(required)	Vault ID or name
`--path`	`.`	Local vault path
`--password`		Encryption password (prompts for encrypted vaults)
`--device-name`		Device name
`--config-dir`	`.obsidian`	Config directory
`--state-path`		Custom state database path (default: `~/.config/obsidian-headless/sync/{vaultID}/state.db`)
`--periodic-scan`	`1h`	Periodic full rescan interval (e.g. `60s`, `5m`, `1h`); set to `0` to disable

View or update sync settings for a configured vault.

ob sync-config [--path <path>] [--mode <mode>] [--conflict-strategy <strategy>] [flags]

Flag	Default	Description
`--path`	`.`	Local vault path
`--mode`		Sync mode: `bidirectional`, `pull`, or `mirror`
`--conflict-strategy`	`merge`	Conflict resolution: `merge` or `conflict`
`--excluded-folders`		Comma-separated folder names to exclude
`--file-types`		Comma-separated file types to allow
`--configs`		Comma-separated config categories to allow
`--device-name`		Device name
`--config-dir`	`.obsidian`	Config directory
`--state-path`		Custom state database path (default: `~/.config/obsidian-headless/sync/{vaultID}/state.db`)
`--periodic-scan`		Periodic full rescan interval (e.g. `60s`, `5m`, `1h`); set to `0` to disable

When called without any update flags, displays the current configuration.

Show sync configuration for a vault.

ob sync-status [--path <path>]

Flag	Default	Description
`--path`	`.`	Local vault path

Remove local sync configuration for a vault.

ob sync-unlink [--path <path>]

Flag	Default	Description
`--path`	`.`	Local vault path

Run sync for a configured vault.

ob sync [--path <path>] [--continuous]

Flag	Default	Description
`--path`	`.`	Local vault path
`--continuous`	`false`	Run continuously (watch for changes)