Skip to content

dsebastien/obsidian-remarkable-sync

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Remarkable Sync

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 folder hierarchy, download per notebook
  • 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)

Quick Start

  1. Install the plugin from Community Plugins
  2. Run "Connect to reMarkable cloud" command
  3. Enter your one-time code from my.remarkable.com
  4. Run "Open reMarkable panel" to browse notebooks
  5. 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:

  1. Enable "Use rmfakecloud" in plugin settings
  2. Enter your rmfakecloud server URL (e.g., https://cloud.example.com)
  3. 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.