remosidian

Remote, read/write access to your Obsidian vault over WebSocket — from any device, on any network. Pair once with a QR code, then read, write, search, and subscribe to changes from phones, tablets, or other machines.

Install

npm i -g remosidian
# or
cd ~/Documents/MyVault
npx remosidian

User-facing commands should prefer the unscoped remosidian package.

Quick start

# 1. Create ~/.remosidian/config.json interactively
remosidian init

# 2. Start the daemon in the foreground
remosidian start

# 3. (from another terminal) inspect the running daemon
remosidian status

# Or just point it at a vault directly, no config file needed:
cd ~/Documents/MyVault
remosidian

When the daemon starts it prints a pairing QR code. Scan it from a Remosidian-aware client (e.g. the LifeOS mobile app) within 5 minutes to authorize the device. The pair token is stored in ~/.remosidian/pairings.json and reused on subsequent connections.

Commands

| Command | Purpose | | --------------------------- | --------------------------------------------------- | | remosidian | Run the current directory as a vault. | | remosidian start | Run the daemon in the foreground (Ctrl+C to stop). | | remosidian pair | Open a fresh pairing window and print a QR code. | | remosidian status | Print the running daemon's health snapshot. | | remosidian reset-pairings | Revoke every paired device (local request only). | | remosidian init | Generate ~/.remosidian/config.json interactively. | | remosidian --version | Print the installed version. |

Data directory

By default, Remosidian stores identity, pairings, and the QR PNG under ~/.remosidian/. Override with --data-dir <path> or the REMOSIDIAN_HOME environment variable.

Protocol

WebSocket + JSON messages defined in @lifeos/remosidian-protocol. Operations: vault.list, vault.read, vault.resolveLink, vault.backlinks, vault.search, vault.recent, vault.subscribe, vault.unsubscribe. Server pushes vault.changed events to subscribed clients.

License

MIT — see the LICENSE file in the repository root.