yaos README

The project's README from github.com/kavinsood/yaos. As one markdown file: README.md.

YAOS

Deploy to Cloudflare

A zero-terminal, real-time sync engine for Obsidian, powered by your own Cloudflare Worker.

Your notes sync live across devices, with CRDT merge semantics instead of conflicted-copy workflows, delayed file sync, or database-heavy hosted services.

YAOS syncing a note across desktop and mobile in real time

No terminal, no .env files, no database setup required.

License: 0-BSD

How it compares

YAOS chooses live Markdown CRDT sync on infrastructure you deploy in your Cloudflare account. That gives fast cross-device editing, with explicit limits around durability receipts, attachments, empty folders, and non-Markdown plugin files.

Conflicts Real-time Deployment No terminal Free
iCloud / Dropbox Conflicted copies No No Yes Yes
Obsidian Sync Rare Delayed No Yes $96/yr
Git / LiveSync Manual Varies Self-hosted / self-deployed No Yes
Relay / Screengarden No Yes No Yes Freemium
YAOS CRDT merge Yes Self-deployed Cloudflare Yes $0

YAOS uses Yjs CRDTs to keep one live vault state moving across devices instead of asking them to take polite turns uploading files and hoping nothing collides.

If you want the official, fully managed experience, pay for Obsidian Sync and support the team. If you want a fast, self-deployed, local-first alternative on your own Cloudflare account, welcome to YAOS!

Get started

YAOS has two parts: an Obsidian plugin and a small Cloudflare server you deploy to your own account. The Worker setup page walks you through the remaining steps, so you don't need to memorize this.

Watch the setup walkthrough

1. Deploy your server Click Deploy to Cloudflare above. Cloudflare creates a Worker in your account.

2. Claim your server Open the Worker URL. Click Claim to lock the server to you and generate your setup token.

3. Install the plugin Install YAOS from the Obsidian Marketplace.

4. Connect your vault From the claim page, open the setup link or scan the QR code. YAOS fills in the connection details automatically.

That's it. Your vault is syncing.

Attachments and snapshots

Text sync works out of the box. To sync images, PDFs, and other attachments, add a Cloudflare R2 bucket — it takes about a minute.

Watch the R2 setup video

R2 also enables daily automatic snapshots and on-demand point-in-time backups. You can browse snapshots, diff against current state, and selectively restore individual files. If you skip R2, text sync still works — you just won't have attachment sync or snapshots.

Works with AI agents

Because Obsidian vaults are just local Markdown files, YAOS plays unusually well with scripts, CLI tools, and AI agents that edit files directly on disk. The CRDT state stays aligned with the filesystem, so changes from any source — git, shell scripts, agents writing to disk — propagate cleanly across devices instead of falling back to conflicted-copy workflows.

If you're building agentic workflows on top of Obsidian vaults, YAOS gives you the sync infrastructure so you don't have to wire up your own.

Troubleshooting

"Unauthorized" errors: Token mismatch between plugin and server. Check both match exactly.

"R2 not configured": The server doesn't have a YAOS_BUCKET binding yet. See the R2 setup video.

Cloudflare deploy/dashboard issues: If build queue or dashboard behavior is flaky, see operations, including the wrangler.toml R2-binding fallback.

Sync stops on mobile: Use "Reconnect to sync server" command. Check you have network connectivity.

Files not syncing: Check exclude patterns. Files over max size are skipped. Use debug logging to see what's happening, and then raise an issue on GitHub.

Diagnostics: Use Show sync debug info for local inspection. Safe diagnostics exports redact server URL, vault ID, device name, and vault paths.

License

0-BSD

yaos (kavinsood/yaos)

Searching Database…

1.1K ·GitHub
Что это такое?YAOS — это движок синхронизации заметок Obsidian в реальном времени, работающий на Cloudflare Worker, который вы разворачиваете в своём аккаунте. Заметки синхронизируются между устройствами вживую с помощью CRDT-слияния вместо работы с конфликтными копиями.
Это плагин для Obsidian или отдельное приложение, которое мне нужно запускать?И то и другое, но запускать ничего не нужно: плагин для Obsidian плюс небольшой сервер, который вы разворачиваете в своём аккаунте Cloudflare. Терминал вам не понадобится, и локально, кроме Obsidian, ничего хостить не нужно.
Как настроить синхронизацию моего хранилища?Четыре шага: нажмите Deploy to Cloudflare, чтобы создать Worker в своём аккаунте, откройте его URL и нажмите Claim, чтобы получить токен настройки, установите YAOS из Obsidian Marketplace, затем подключитесь по ссылке настройки или QR-коду — данные подключения подставятся автоматически.
Мне нужно уметь пользоваться терминалом или сначала настроить базу данных?Нет. В этом и главная идея: никаких терминалов, файлов .env или настройки базы данных — кнопка деплоя, страница Claim и QR-код покрывают весь процесс.
Всё содержимое моего хранилища синхронизируется сразу?Обычный текст в Markdown синхронизируется из коробки; для изображений, PDF и других вложений сначала нужно добавить бакет Cloudflare R2. Файлы больше максимального размера пропускаются, а для пустых папок и файлов плагинов не из Markdown есть свои явные ограничения.
Работает ли это на телефоне или только на компьютере?Мобильный Obsidian поддерживается. Если синхронизация на мобильном устройстве прерывается, в документации рекомендуется команда 'Reconnect to sync server' плюс проверка сети.
Где на самом деле хранятся мои заметки?На инфраструктуре, которую вы разворачиваете в собственном аккаунте Cloudflare, а не на хостинговом сервисе какой-то компании — в этом и состоит идея проекта: self-deployed и local-first.
Это действительно бесплатно или есть подвох?Бесплатно — в сравнительной таблице YAOS стоит $0 против $96 в год у Obsidian Sync, а лицензия — максимально свободная 0-BSD. Нужен только собственный аккаунт Cloudflare.
Что будет, если два устройства одновременно редактируют одну заметку?Никаких конфликтных копий: YAOS использует CRDT-библиотеку Yjs, чтобы единое актуальное состояние хранилища непрерывно двигалось между устройствами, поэтому правки сливаются автоматически — вместо того чтобы устройства по очереди вежливо загружали файлы в надежде, что ничего не столкнётся.
Могу ли я вернуть старые версии своих заметок?Да, если подключить бакет R2: это включает ежедневные автоматические снапшоты и резервные копии на нужный момент времени по запросу. Можно просматривать снапшоты, сравнивать их с текущим состоянием и выборочно восстанавливать отдельные файлы.
Почему автор говорит, что проект хорошо работает с AI-агентами?Хранилище Obsidian — это просто локальные файлы Markdown, и CRDT-состояние остаётся согласованным с файловой системой. Изменения из любого источника — git, shell-скрипты, агенты, пишущие на диск, — корректно распространяются между устройствами, а не превращаются в конфликтные копии.
Чем это отличается от обычной синхронизации хранилища через iCloud или Dropbox?Они дают отложенную синхронизацию файлов и конфликтные копии при столкновении правок, а YAOS сливает изменения вживую через CRDT. Git или LiveSync ближе по смыслу, но требуют работы с терминалом; YAOS разворачивается от начала до конца без него.
Creator
kavinsood
Size
14 MB
Stars
1.1K
Age
8mo
Commits · 90 Days