Kadima Sync

by kadima-tech
5
4
3
2
1
Score: 50/100

Description

The official Kadima sync plugin for Obsidian. Features robust conflict handling, binary blob support, and a comprehensive integration test suite for guaranteed data integrity

Reviews

No reviews yet.

Stats

0
stars
52
downloads
0
forks
54
days
0
days
54
days
5
total PRs
0
open PRs
0
closed PRs
5
merged PRs
0
total issues
0
open issues
0
closed issues
12
commits

Latest Version

2 months ago

Changelog

Fixes for the findings raised by the Obsidian Community automated review of 0.2.0.

Requires Obsidian 1.6.6 or later (was 1.6.0). Remote deletions now always go through FileManager.trashFile, so they follow the vault's own "Deleted files" preference instead of sometimes bypassing it — that API landed in 1.6.6, and the runtime fallback that used to cover older builds has been removed.

Also in this release: platform detection uses Obsidian's Platform API rather than the user agent, the vault configuration folder is read from Vault#configDir rather than assumed to be .obsidian, and JSON responses are narrowed from unknown rather than flowing through as any.

Release assets now carry GitHub build-provenance attestations. Verify with:

gh attestation verify main.js --repo kadima-tech/kadima-obsidian-sync

Installation: copy manifest.json, main.js and styles.css into <vault>/.obsidian/plugins/kadima-sync/, then enable Kadima Sync under Settings → Community plugins.

README file from

Github

Kadima Sync

Kadima Sync connects an Obsidian vault to Kadima and keeps notes and files in sync across devices through Kadima's hosted sync service. Once a vault is synced, it is also readable from the Kadima apps — Draggen and Talebuddy — without exporting or copying anything by hand.

Features

  • Connect an Obsidian vault to a Kadima account with a browser approval flow
  • Sync notes and larger vault files through Kadima's sync API
  • Keep local edits local-first and synchronize changes with per-file revisions
  • Preserve conflicts as separate files instead of silently overwriting local work
  • Support create, edit, rename, and delete operations

Works with Draggen and Talebuddy

A synced vault lives in your Kadima account, and the other Kadima apps read from that same copy:

  • Draggen — the visual canvas and moodboard app. Its dashboard has a Vault tab that browses your synced vault, previews notes, and renders Obsidian Canvas (.canvas) files, so worldbuilding notes you already wrote in Obsidian can sit beside the board you are building.
  • Talebuddy — the long-form writing app. The writing desk's sidebar has an Obsidian tab next to the Creative Ledger, so research, lore, and character notes stay one click from the manuscript instead of in another window.

Both apps read the vault; they never write back into it. Obsidian stays the place your notes are edited, and this plugin stays the only thing that changes them.

Vault sync is part of a paid Kadima subscription and covers the same account across Draggen and Talebuddy.

Installation

Community Plugins

Once the plugin is approved, install Kadima Sync from Settings -> Community plugins.

Manual Installation

  1. Download the latest release assets.
  2. Create the folder <vault>/.obsidian/plugins/kadima-sync/.
  3. Copy manifest.json, main.js, and styles.css into that folder.
  4. In Obsidian, open Settings -> Community plugins and enable Kadima Sync.

Usage

  1. Open Settings -> Kadima Sync.
  2. Click Connect Kadima.
  3. Complete the approval flow in your browser.
  4. Return to Obsidian and run Sync now.

Conflicted local changes are preserved in .kadima-conflicts by default.

Disclosures

  • Requires a Kadima account and an active paid Kadima subscription.
  • Requires network access to Kadima services for authentication and synchronization.
  • Opens an external browser window or tab during account connection.
  • Stores Kadima authentication tokens and sync state in Obsidian's local plugin data on the device.
  • Reads every file path in the vault. Working out what changed requires enumerating the whole vault, so the plugin sees all paths, including those it will not sync.
  • Syncs vault content to Kadima's hosted service. Hidden files are excluded by default, but users can enable syncing hidden files, which may include vault configuration content.
  • Deletes arriving from the sync service go through Obsidian's FileManager.trashFile, so they follow the vault's own "Deleted files" preference rather than bypassing it.
  • Does not include ads or client-side telemetry.
  • Source code is available in this repository.

Development

npm install
npm run build

For local development:

OBSIDIAN_VAULT_PATH="/absolute/path/to/YourVault" npm run dev