Obsidian Sync for Openclaw

A secure file synchronization server that enables two-way communication and note sharing between Obsidian and your AI agent workspace.

andybold
v1.0.0
Feb 2, 2026
6
4.8k
0

Install & Download

1. ClawHub CLI

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

npx clawhub@latest install obsidian-sync

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 obsidian-sync 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 Obsidian Sync?

The Obsidian Sync skill functions as a secure bridge between your AI agent's environment and your Obsidian vault. It allows users to run a local sync server that facilitates two-way file synchronization, making it easier for Openclaw Skills to interact with your personal markdown files and knowledge base. This integration enables a seamless workflow where your agent can read from and write to specific directories, ensuring your notes and the agent's workspace stay perfectly aligned. By using this skill, you leverage the power of an AI-driven workspace while maintaining full control over your data within the Obsidian ecosystem. It is designed to be part of the obsidian-openclaw project, providing the critical server-side logic required for the Obsidian plugin to function correctly.

Obsidian Sync Use Cases

  • Synchronizing research notes and project documentation between an Obsidian vault and an active AI workspace.
  • Allowing an AI agent to read context from specific note folders to improve response accuracy.
  • Enabling the agent to write meeting summaries or code snippets directly into your personal vault.
  • Managing agent memory and long-term storage within the familiar Obsidian interface.
  • Securely accessing local markdown files from a remote agent via encrypted tunnels.

How Obsidian Sync Works

  1. The sync server is initialized on a local machine using Node.js, targeting a specific workspace directory.
  2. Security is established by setting a mandatory SYNC_TOKEN, which must be provided in the Authorization header of every request.
  3. The server exposes a REST API that allows for listing files, reading content, and writing updates with built-in conflict detection.
  4. When connected to the Obsidian plugin, users can trigger sync actions or chat with the agent directly from the Obsidian sidebar.
  5. The server enforces strict path validation to prevent unauthorized access outside of designated Openclaw Skills directories.

Obsidian Sync Setup

To get started with the sync server, ensure you have Node.js installed and set your environment variables:

SYNC_TOKEN="your-gateway-token" node scripts/sync-server.mjs

For persistent background operation on Linux, you can set up a systemd service:

mkdir -p ~/.config/systemd/user
cat > ~/.config/systemd/user/openclaw-sync.service << 'EOF'
[Unit]
Description=OpenClaw Sync Server

[Service]
Type=simple
Environment=SYNC_TOKEN=your-token-here
Environment=SYNC_WORKSPACE=/data/clawdbot
ExecStart=/usr/bin/node /path/to/sync-server.mjs
Restart=on-failure

[Install]
WantedBy=default.target
EOF

systemctl --user enable --now openclaw-sync

Obsidian Sync Data Schema & Taxonomy

The skill manages files within a structured workspace, specifically filtering by allowed subdirectories to ensure data privacy for Openclaw Skills users.

Directory Data Type Description
notes/ Markdown Primary user notes and documentation files.
memory/ Markdown/Text Persistent storage used by the agent to remember context.
status Metadata Health check and server connectivity status.

All file writes include conflict detection to prevent overwriting newer changes made in the Obsidian vault.

Obsidian Sync Advanced Features

  • Path traversal protection ensures the agent cannot access files outside of the defined SYNC_WORKSPACE.
  • Seamless integration with Tailscale for secure, zero-config HTTPS access to your local sync server from anywhere.
  • Support for custom subdirectories via the SYNC_ALLOWED_PATHS environment variable.
  • Full audit logging provided by the companion Obsidian plugin to track every file modification made by the agent.
  • Linger-enabled systemd support allowing the sync server to start automatically on system boot without user login.

SKILL.md


Loading

Related Openclaw Skills

METADATA

Github Stars: 0
forks: 0

Featured*