obsync for Openclaw

A CLI tool for syncing Obsidian vaults on headless Linux servers with full end-to-end encryption support.

bpauli
v0.1.2
Mar 6, 2026
0
879
0

Install & Download

1. ClawHub CLI

The fastest way to install a skill directly from the registry.

npx clawhub@latest install obsync

2. Manual Installation

Copy the skill folder to one of these locations

Global
~/.openclaw/skills/
Workspace
<project>/skills/

Priority: Workspace > Local > Bundled

3. Prompt Installation

Copy this prompt to OpenClaw to install it automatically.

Help me install obsync using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).

Prefer to download?

Get the raw skill files in a ZIP archive.

What is obsync?

obsync is a dedicated command-line interface designed to facilitate the synchronization of Obsidian vaults in environments where a graphical user interface is unavailable. By integrating this tool via Openclaw Skills, users can bridge the gap between their personal knowledge management system and remote Linux servers, ensuring their notes are always accessible and up to date.

The utility prioritizes security by supporting Obsidian's native end-to-end encryption (E2E), using AES-256-GCM. It is particularly valuable for developers and power users who need to maintain mirrors of their vaults on homelabs, VPS instances, or development machines without the overhead of the full Obsidian electron application.

obsync Use Cases

  • Synchronizing Obsidian notes to a headless Linux server for automated backups.
  • Managing Obsidian configuration, plugins, and themes across multiple remote development environments.
  • Setting up a continuous synchronization service on a Raspberry Pi or home server.
  • Integrating Obsidian content into server-side automation workflows using JSON output flags.

How obsync Works

  1. The user authenticates with their Obsidian Sync account using the login command, handling MFA if required.
  2. The skill identifies available remote vaults and maps them to local directory paths.
  3. File integrity is verified using SHA-256 hashes to determine which files need to be pushed or pulled.
  4. Real-time synchronization is maintained through WebSockets for remote changes and fsnotify for local file system events.
  5. Data is transferred in 2MB chunks to ensure stability even with larger attachments or slow connections.

obsync Setup

To get started with this skill, install the binary and configure your environment:

# Install via Homebrew
brew tap bpauli/tap
brew install obsync

# Configure keyring for headless environments
export OBSYNC_KEYRING_BACKEND=file
export OBSYNC_KEYRING_PASSWORD=your_secure_password

# Log in to Obsidian Sync
obsync login

# Pull your first vault
obsync pull "My Notes" ~/notes -p "your-e2e-password" -s

obsync Data Schema & Taxonomy

The skill manages configuration and vault metadata to ensure consistent sync states. Key data structures include:

Component Description
~/.config/obsync/config.json Stores vault IDs, local paths, and user preferences.
SHA-256 Hashes Used to compare local and remote file states without downloading full content.
.obsidian/ The skill fully synchronizes the hidden configuration folder, including workspace and plugin settings.
Keyring Securely stores E2E encryption passwords when the -s flag is used.

obsync Advanced Features

  • Continuous background sync using the watch command with a 500ms debounce period.
  • Native systemd service integration for automatic startup and persistent background operation on Linux.
  • JSON output mode enabled via --json for seamless integration with other Openclaw Skills or shell scripts.
  • Robust error handling with exponential backoff (1s to 60s) for automatic reconnection during network instability.

SKILL.md


Loading

Related Openclaw Skills

METADATA

Github Stars: 0
forks: 0

Featured*