Obsidian Stats logoObsidian Stats

Brains Sync

by Brains
5
4
3
2
1
Score: 46/100
Install Code

Description

Bidirectional sync between your Obsidian vault and a Brains wiki — pull pages in, push edits back.

Reviews

No reviews yet.

Stats

0
stars
281
downloads
0
forks
127
days
22
days
127
days
18
total PRs
2
open PRs
1
closed PRs
15
merged PRs
16
total issues
2
open issues
14
closed issues
26
commits

Latest Version

1.1.2
4 months ago

Changelog

Obsidian plugin review fixes.

  • Remove the plugin name from the settings heading (the settings tab already shows it).
  • Scope file access to the configured sync folder and drop whole-vault enumeration, so the plugin only touches paths inside its own folder.

Requires Obsidian 1.11.4 or later. Works on desktop and mobile.

See all version on GitHub

README file from

Github

Brains Sync — Obsidian Plugin

Bidirectional sync between your Obsidian vault and a Brains wiki instance.

Features

  • Pull from Brains — fetches all wiki pages via the Brains API and writes them into a configurable vault subfolder (brains/ by default).
  • Push to Brains — scans the vault subfolder for markdown files and syncs each one back (updates existing pages, creates new ones).
  • Remote-wins on pull (V1): pulling always overwrites local copies with the server version.
  • Sync log — a sidebar Notice summarises every operation and logs details to the developer console.

Requirements

  • Obsidian ≥ 1.11.4 (desktop and mobile)
  • A Brains account (sign in with Connect to Brains — no manual token needed)

Installation

Manual (developer install)

  1. Build the plugin: 
    npm install
npm run build
  2. Copy main.js and manifest.json to your vault's plugin folder: 
    <vault>/.obsidian/plugins/brains-sync/
  3. Enable the plugin in Settings → Community Plugins.

Community Plugin Registry

Once listed, search for Brains Sync in Settings → Community Plugins → Browse.

Configuration

Open Settings → Brains Sync:

Field Description Default
Brains instance URL Base URL of your Brains deployment https://lets.usebrains.app
Account Connect to Brains — one-click OAuth2 sign-in —
Vault folder Subfolder where pages are synced brains
API token (Advanced) Optional Personal Access Token fallback for self-hosters —

Click Connect to Brains to sign in: your browser opens the Brains login, you approve, and Obsidian receives the access token automatically. Tokens (and any fallback PAT) are stored via Obsidian's SecretStorage and are never written to data.json or the vault.

Usage

Pull from Brains

  • Click the download ribbon icon, or
  • Open the Command Palette (Cmd/Ctrl+P) → Brains Sync: Pull from Brains

The first pull bootstraps from GET /api/v1/export/download. Later pulls use GET /api/v1/pages (name + revision index) and fetch only changed pages, writing them to <vault-folder>/<page-name>.md.

Push to Brains

  • Open the Command Palette → Brains Sync: Push to Brains

Every .md file under <vault-folder>/ is read and synced back: existing pages are updated with a full-rewrite PUT /api/v1/page, and new pages are created with POST /api/v1/pages.

Auth

Sign-in uses OAuth 2.0 with PKCE (authorization-code flow). Click Connect to Brains, approve in the browser, and the plugin exchanges the code for an access token + refresh token; the access token is refreshed automatically before it expires. All API requests send Authorization: Bearer <token>.

For self-hosted servers or non-OAuth setups, an optional Personal Access Token can be entered under Settings → Brains Sync → Advanced.

License

MIT — see LICENSE.

Sponsors