Your notes are precious. This plugin keeps them safe by syncing your entire Obsidian vault to a private Hugging Face Bucket on a schedule you control.
- Automatic periodic sync — push your vault to HF Buckets every N minutes
- Full vault backup — markdown, canvases, PDFs, images, everything
- Smart deduplication — only changed files are uploaded (powered by HF's Xet backend)
- Configurable vault path — sync any vault, not just the currently open one
- Auto-detects the
hfCLI — no hardcoded paths, works across machines - Status bar indicator — always know when you last synced
- Hugging Face CLI (
hf) installed and on yourPATH - A Hugging Face account with a write-access token
- An existing HF Bucket (create one with
hf buckets create username/my-vault --private)
- Download
main.jsandmanifest.jsonfrom the latest release - Copy them to
<your-vault>/.obsidian/plugins/obsidian-hf-sync/ - Reload Obsidian and enable the plugin under Settings → Community plugins
| Setting | Description |
|---|---|
| HF Token | Your HF access token (hf_...) with write permissions |
| Bucket ID | The target bucket, e.g. username/my-vault |
| Vault path | Absolute path to the vault. Leave empty to use the currently open vault |
| hf CLI path | Path to the hf binary. Leave empty to auto-detect from your shell |
| Sync interval | How often to sync, in minutes (1–60) |
Once configured, the plugin syncs automatically in the background. You'll see the status in Obsidian's bottom status bar:
| Status | Meaning |
|---|---|
HF ✓ 3m ago |
Last sync was 3 minutes ago |
HF ⟳ |
Sync in progress |
HF ✕ |
An error occurred (hover for details) |
To trigger an immediate sync: Command palette → HF Sync: Sync vault now
To pull your vault from the bucket onto a new machine:
hf buckets sync hf://buckets/username/my-vault ./my-vaultgit clone https://github.com/NathanHB/obsidian-hf-sync
cd obsidian-hf-sync
npm install
npm run dev # watch mode — auto-recompiles on saveSymlink the repo into a test vault's plugin folder and reload Obsidian to test changes.
Built with ❤️ for the open-source community · Learn more about HF Buckets