README file from
GithubMERCENAI Vault Sync
MERCENAI Vault Sync connects an Obsidian vault to a MERCENAI knowledge base. It reads Markdown notes through Obsidian's official Vault API and synchronizes them after the connection is started from the MERCENAI dashboard.
Requirements
- Obsidian 1.11.4 or newer
- An active MERCENAI account
- An internet connection
Install
Once the plugin is approved in the Obsidian Community Plugins directory:
- Open Settings in Obsidian.
- Select Community plugins, then Browse.
- Search for MERCENAI Vault Sync and select Install.
- Select Enable.
Connect a vault
- Open Knowledge in the MERCENAI dashboard.
- Select the knowledge base that should receive the vault notes.
- Select Connect Obsidian.
- Allow the browser to open Obsidian.
The plugin synchronizes immediately, then synchronizes again when a Markdown note is created, modified, renamed, or deleted.
Data and privacy
- Only non-empty Markdown files returned by Obsidian's Vault API are synchronized.
- The plugin sends each note's vault-relative path and Markdown content to the MERCENAI sync endpoint selected by the dashboard connection.
- The connection token is stored with Obsidian SecretStorage. It is not stored in the plugin's
data.jsonfile. - The plugin does not modify vault files, read hidden files, or collect telemetry.
- Large vaults are synchronized in server-safe batches. Each synchronized note is limited to 200,000 characters.
Development
npm ci
npm run typecheck
npm run build
The production bundle is written to main.js.
License
MIT