# CloudBrain Sync

Push your notes — and, from the folders you choose, PDFs, images and Office files — to
**[CloudBrain](https://cloudbrain.it)**, so your vault becomes searchable from
**WhatsApp, Telegram and the web** through a chat that answers with citations to your notes.
Your files stay on your device: the plugin sends copies, and CloudBrain never writes back
into your vault.

## Disclosures

- **Network use.** The plugin sends the content of your Markdown notes to the CloudBrain
  server you configure (default `https://cloudbrain.it`), over HTTPS. If you turn on
  documents, it also sends the files of the folders you chose. It sends nothing else and
  has no telemetry.
- **Account required.** You need a CloudBrain account and an API key from its dashboard.
- **Paid service.** CloudBrain is a paid service with a free trial.

## What it does

- **Notes.** A full sync hashes every Markdown note and uploads only what changed. On
  create / modify / rename / delete it pushes just that note (modify is debounced ~1.5 s).
  Re-syncing without changes uploads nothing.
- **Documents (off by default).** PDF, Word/Excel/PowerPoint and OpenDocument, RTF, HTML,
  EML/MSG, EPUB, JSON/XML and images (JPG, PNG, TIFF, HEIC…), **only from the folders you
  choose**. Text in images and scanned PDFs is read with OCR on the CloudBrain server.
  The server rejects files that look like credentials (keys, tokens, 2FA codes).
- **Exclusions.** Your Obsidian configuration folder is never sent. You can add your own
  ignore patterns, and the exclusion rules set in the CloudBrain dashboard are applied
  before anything leaves your device.

## Requirements

- A CloudBrain account (the trial works).
- An **API key**: **https://cloudbrain.it/app → Sync → “Connetti Obsidian (push diretto)”
  → Genera chiave**. The key is shown once — copy it.

## Installation

### From the community store
**Settings → Community plugins → Browse** → search **CloudBrain Sync** → Install → Enable.

### Manual
1. Download `manifest.json` and `main.js` from the latest
   [release](https://github.com/ferrantealberto69/obsidian-cloudbrain-sync/releases).
2. Put them in `<your-vault>/<config-folder>/plugins/cloudbrain-sync/`
   (the config folder is `.obsidian` unless you changed it).
3. **Settings → Community plugins** → reload → enable **CloudBrain Sync**.

## Configuration

Open **Settings → CloudBrain Sync** (the interface is in Italian):

| Field | Value |
|-------|-------|
| CloudBrain endpoint | `https://cloudbrain.it` |
| API key | your `cbk_…` key |
| Ignora | glob patterns to skip, comma separated (defaults cover `.trash/`, `Templates/`, code folders) |
| Includi documenti | turn on to send documents |
| Cartelle | the folders documents are read from — also from the folder context menu: **Includi documenti in CloudBrain** |
| Anche su mobile | documents on phones too (off by default: files up to 25 MB on mobile data) |

Then run **Sincronizza tutto adesso** (button in settings, or the command palette).

## Privacy & isolation

Your key only ever accesses **your own** space on CloudBrain; it can never touch another
user's data.

## Development

```bash
npm ci
npm test          # vitest
npm run build     # main.js
```

## License

[MIT](LICENSE) © WeblabFactory