obsidianmd

obsidianmd / obsidian-headless

Public

Headless client for Obsidian Sync. Sync your vaults from the command line without the desktop app.

obsidian.mdsync
43
1
100% credibility
Found Mar 03, 2026 at 43 stars -- GitGems finds repos before they trend. Get early access to the next one.
Sign Up Free
AI Analysis
AI Summary

A tool for syncing Obsidian note collections from the command line without requiring the desktop application.

How It Works

1
🔍 Discover note syncing magic

You hear about a handy tool that keeps your Obsidian notes perfectly in sync across devices, even without opening the app.

2
📥 Prepare the sync helper

You add the simple sync program to your computer so it's ready to use anytime.

3
🔑 Connect your account

You sign in with your familiar Obsidian login to link everything securely.

4
📂 See your note collections

A list of all your personal note folders appears, making it easy to pick what to sync.

5
🔗 Match local to remote

You select a note folder online and connect it to a folder on your computer for seamless matching.

6
Choose sync style
🔄
Quick one-time sync

Your notes update right away between computer and cloud.

⏰
Ongoing watch mode

It keeps an eye on changes and syncs continuously in the background.

✅ Notes always fresh

Your notes stay up-to-date everywhere, safe and effortless, just like magic.

Sign up to see the full architecture

5 more

Sign Up Free

Star Growth

See how this repo grew from 43 to 43 stars Sign Up Free
Repurpose This Repo

Repurpose is a Pro feature

Generate ready-to-use prompts for X threads, LinkedIn posts, blog posts, YouTube scripts, and more -- with full repo context baked in.

Unlock Repurpose
AI-Generated Review

What is obsidian-headless?

Obsidian-headless is a Node.js CLI tool that acts as a headless client for Obsidian Sync, letting you sync Markdown vaults from the command line without the desktop app. It handles authentication, vault listing, setup, and one-time or continuous bidirectional sync over WebSocket to Obsidian's servers. Users get full control over E2EE passwords, sync modes like pull-only or mirror-remote, conflict merging, and filters for file types or folders.

Why is it gaining traction?

Unlike Obsidian's GUI-only Sync, this delivers obsidian headless sync for servers or scripts, with commands like `ob sync --continuous` that watch for changes and preserve file timestamps. It supports shared vaults, config syncing, and device naming in history, making it a drop-in for automated workflows without browser hacks or github headless chrome workarounds. Devs dig the zero-config setup after login and detailed status reporting.

Who should use this?

Sysadmins running Obsidian vaults on headless servers or in Docker containers for obsidian headless mode. Automation enthusiasts scripting backups or CI/CD pipelines for note syncing. Remote teams needing obsidian headless sync without desktop clients on Linux VMs.

Verdict

Try it if you need CLI-driven Obsidian Sync—solid docs and official obsidianmd backing make setup straightforward despite 43 stars and 1.0% credibility score signaling early maturity. Lacks broad testing, so validate on non-prod vaults first.

(198 words)

Sign up to read the full AI review Sign Up Free

Similar repos coming soon.