README file from
GithubRemarkable Synchronizer
An Obsidian plugin that connects to the reMarkable cloud to list, download, and sync notebook pages as images.
Features
- reMarkable cloud integration — connect with a one-time code, list all notebooks
- rmfakecloud support — connect to a self-hosted rmfakecloud server as an alternative to the official cloud
- Page rendering — render .rm v6 stroke data to PNG/JPEG images
- Sidebar panel — browse notebooks with foldable folder hierarchy, search, multi-select, and per-notebook download
- Folder hierarchy preservation — reMarkable folder structure mirrored in vault
- Local .rmdoc import — import .rmdoc files directly without cloud connection
Requirements
- Obsidian (desktop only, v1.4.0+)
- A reMarkable account with cloud sync enabled, or a rmfakecloud server (optional for local .rmdoc import)
Installation
Community plugins (recommended)
- In Obsidian, go to Settings → Community plugins.
- Disable Restricted mode if it's enabled.
- Select Browse, search for Remarkable Synchronizer, install it, then enable it.
You can also browse the catalog on the Obsidian Community website.
Manual installation
If the plugin isn't listed in the community catalog yet (or you want a specific version):
- Download
main.js,manifest.json, andstyles.cssfrom the latest release. - Copy them into
<Vault>/.obsidian/plugins/remarkable-synchronizer/. - Reload Obsidian and enable Remarkable Synchronizer in Settings → Community plugins.
BRAT (bleeding edge)
BRAT (Beta Reviewers Auto-update Tool) installs plugins straight from a GitHub repo and keeps them updated automatically. Use this if you want the latest commits — things might break.
- Install Obsidian42 - BRAT from Settings → Community plugins → Browse and enable it.
- Run BRAT: Add a beta plugin for testing from the command palette.
- Paste
https://github.com/dsebastien/obsidian-remarkable-sync. - Select the latest version and confirm.
- Enable Remarkable Synchronizer in Settings → Community plugins.
Quick Start
- Install the plugin (see Installation above).
- Run "Connect to reMarkable cloud" command
- Enter your one-time code from my.remarkable.com
- Run "Open reMarkable panel" to browse notebooks
- Click the download button on any notebook
Commands
| Command | Description |
|---|---|
| Open reMarkable panel | Opens the sidebar panel listing notebooks |
| Connect to reMarkable cloud | Opens the authentication modal |
| Disconnect from reMarkable cloud | Clears stored tokens |
| Import .rmdoc file | Import a local .rmdoc file as images |
Settings
| Setting | Default | Description |
|---|---|---|
| Target folder | "" (root) |
Vault folder for output files |
| Save images | true |
Save rendered page images |
| Image format | png |
PNG or JPEG |
| Use rmfakecloud | false |
Connect to a self-hosted rmfakecloud server instead of official cloud |
| Server URL | "" |
Base URL of your rmfakecloud server (only when rmfakecloud is enabled) |
Output Format
Page images are saved as: {NotebookName}-P{NNN}.png
Folder hierarchy is preserved:
{targetFolder}/Work/Meeting Notes/Meeting Notes-P001.png
Blank pages (no strokes) are skipped.
rmfakecloud
This plugin supports rmfakecloud, a self-hosted reMarkable cloud replacement. To use it:
- Enable "Use rmfakecloud" in plugin settings
- Enter your rmfakecloud server URL (e.g.,
https://cloud.example.com) - Run "Connect to reMarkable cloud" and enter a one-time code generated from your rmfakecloud web interface
The authentication flow and sync protocol are identical to the official cloud. All API requests go to your self-hosted server instead of reMarkable's servers.
Privacy
- Authentication tokens stored at
~/.remarkable-sync/token.json(outside vault) - No telemetry or third-party analytics
- Network requests only to reMarkable cloud (or your rmfakecloud server when enabled)
Development
See DEVELOPMENT.md for development instructions.
bun install
bun run dev
License
MIT License - see LICENSE for details.
Support
Created by Sébastien Dubois. Buy me a coffee to support development.