Skip to content

Install Crate

Crate is an Obsidian plugin for sync, reminders, and reading. You need Obsidian 1.13.0 or newer on each device where you install the plugin.

The beta is not in Obsidian’s community plugin catalog yet. BRAT can install it and help you keep it updated. Start with a non-critical vault and keep a separate backup of your notes.

  1. In Obsidian, open Settings → Community plugins. Enable community plugins if needed, then select Browse.
  2. Search for BRAT, install it, and enable it.
  3. Open Settings → BRAT and select Add beta plugin.
  4. Enter the repository below, select the latest release, and add the plugin.
  5. Return to Settings → Community plugins and enable Crate.
kaanbiryol/obsidian-crate

Open Settings → Crate to finish setup. For help with BRAT itself, see BRAT’s installation guide.

For vault sync and the web app, choose a host. You can deploy into your Cloudflare account or run Crate on your own computer with Docker.

To try local features first, use Crate: Add link to reading list or Crate: Create reminder from Obsidian’s command palette. They start enabled and use the Reading and Reminders folders. A server is needed for vault sync, the web app, and notifications; the current settings screen also shows feature controls after connection.

Follow Reading or Reminders for everyday use, and Choose and manage features when you are ready to adjust the setup.

Download main.js, manifest.json, and styles.css from the same Crate release. Place them in this folder inside your vault:

.obsidian/plugins/crate/

Reload Obsidian, then enable Crate under Settings → Community plugins. If you use a custom vault configuration folder, use that folder in place of .obsidian.

To work on the plugin itself, follow the repository’s build-from-source instructions.