Obsidian Stats logoObsidian Stats

Curie

by datronizer
5
4
3
2
1
Score: 42/100
Install Code

Description

Template for Obsidian community plugins with build configuration and development best practices.

Reviews

No reviews yet.

Stats

0
stars
40
downloads
0
forks
12
days
3
days
3
days
2
total PRs
1
open PRs
0
closed PRs
1
merged PRs
0
total issues
0
open issues
0
closed issues
9
commits

Latest Version

0.4.0
4 days ago

Changelog

Release 0.4.0: Synchronization plugin for self-hosted Project Curie backend (https://github.com/Datronizer/project-curie).

See all version on GitHub

README file from

Github

Curie

Curie is a private, lightweight synchronization plugin designed to connect your vaults to your self-hosted Project Curie backend.

[!IMPORTANT] Prerequisite: Self-Hosted Server
This plugin is not a standalone sync service. It is designed specifically to synchronize notes and attachments with a self-hosted instance of Project Curie, an open-source, filesystem-based hybrid datalake and metadata server. You will need a running Curie server instance to use this plugin.

Key Features

  • Self-Hosted & Private: Your notes stay under your complete control on your own infrastructure.
  • Transparent Filesystem Storage: Notes on the server live as standard Markdown files and attachments in the filesystem—no database locks or proprietary formats.
  • Bidirectional Background Sync: Automatically tracks local modifications and synchronizes changes with the Curie server.
  • Side-by-Side Conflict Preservation: If concurrent edits collide across devices, Curie preserves both versions side-by-side (Note (Conflict from <Device> <Time>).md), preventing any data loss.
  • Full Desktop & Mobile Support: Runs natively on macOS, Windows, Linux, iOS, and Android.
  • Touch-Friendly Controls: Includes Mobile Quick Action and Mobile Toolbar commands (Curie: Sync Vault Now, Curie: Open Curie Dashboard).
  • Connection Dashboard: Inspect live connection status, account details, active vault association, and trigger manual syncs at any time.

Quick Start

1. Deploy Your Curie Server

Follow the setup instructions in the Project Curie repository to launch your Fastify and SQLite backend:

git clone https://github.com/Datronizer/project-curie.git
cd project-curie/server
npm install
npm run migrate
npm run start

2. Install the Plugin

  • From Community Plugins: Search for Curie and click Install, then Enable.
  • Manual Installation: Download main.js, manifest.json, and styles.css from the latest GitHub Release and place them in your vault at .obsidian/plugins/project-curie-sync/.

3. Connect to Your Server

On first launch, the Curie Onboarding screen will automatically open:

  1. Enter your Server URL (e.g. https://curie.yourdomain.com or http://localhost:3000).
  2. Enter your Curie account Email and Password.
  3. Curie will automatically discover your remote vaults and match your current local vault, or offer to create a new remote vault with a single click.
  4. An initial bidirectional sync will run and your notes will stay seamlessly synchronized!

Mobile Usage

On iOS and Android:

  • Open the left sidebar or pull down for Mobile Quick Actions to open the Curie Cloud Dashboard.
  • You can add the command Curie: Sync Vault Now directly to your Mobile Toolbar in Obsidian settings for one-tap synchronization.

Support & Issues

For issues, questions, or contributions regarding the client plugin, please visit the Curie Obsidian Plugin Issues page.

For server-side questions and architecture details, see Project Curie Server.

Sponsors