Skip to main content

Bidirectional sync between reMarkable tablets and an Obsidian knowledge base with intelligent note processing

Project description

reMark

CI PyPI Downloads Python 3.11+ License: MIT

Bidirectional sync between reMarkable tablets and an Obsidian knowledge base with multi-engine OCR, intelligent note processing, and automatic action item extraction.

Write on your reMarkable. reMark handles the rest — your handwritten notes become structured, searchable Markdown in Obsidian, complete with tags, summaries, and extracted action items. Optionally push a response PDF back to your tablet.


Features

  • Multi-engine OCR pipeline — reMarkable built-in (MyScript), Google Cloud Vision, or VLM-based recognition with automatic fallback
  • Intelligent structuring — raw handwriting becomes clean Markdown with inferred headings, lists, and formatting
  • Action item extraction — detects tasks, questions, and follow-ups from both text patterns and pen color annotations
  • Auto-tagging — categorizes notes based on content
  • Obsidian vault integration — writes notes with full YAML frontmatter, wiki-links, and Git sync
  • Response push — auto-generates PDFs or native reMarkable notebooks that answer questions found in your notes, pushes them back to the tablet
  • Semantic search (RAG) — embed the entire vault and query it with natural language (remark-bridge ask) — backends for Voyage, OpenAI, or local sentence-transformers
  • Microsoft Outlook integration — action items flow into Microsoft To Do, deadlines become Outlook Calendar events
  • Deletion-aware — notes deleted on the tablet are archived in the vault automatically
  • Cost tracking — built-in token and cost accounting for every API call
  • Real-time sync — WebSocket-based live notifications or configurable cron schedule
  • Color-aware — uses reMarkable Paper Pro's color ink for semantic marking (red = action, blue = question, yellow = highlight)
  • MCP server — interact with your notes directly from Claude Desktop or Claude Code
  • Health checkremark-bridge doctor verifies config, auth, vault, API keys, and system deps
  • Idempotent — SQLite state tracking ensures notes are never processed twice

Architecture

┌─────────────────┐     reMarkable Cloud API      ┌──────────────────────┐
│  reMarkable      │◄──────────────────────────────►│  reMark              │
│  Paper Pro / rM2 │     (sync 1.5 / JWT auth)     │  (VPS - systemd)     │
└─────────────────┘                                 │                      │
                                                    │  ┌────────────────┐  │
                                                    │  │ sync_engine    │  │
                                                    │  │ ocr_pipeline   │  │
                                                    │  │ note_processor │  │
                                                    │  │ obsidian_write │  │
                                                    │  │ response_push  │  │
                                                    │  └────────────────┘  │
                                                    │         │            │
                                                    │         ▼            │
                                                    │  ┌────────────────┐  │
                                                    │  │ Obsidian Vault │  │
                                                    │  │ (Git-synced)   │  │
                                                    │  └────────────────┘  │
                                                    └──────────────────────┘

Data Flow

1. DETECT    → New/changed notebook on reMarkable Cloud
2. DOWNLOAD  → Fetch .rm files + metadata via sync 1.5 protocol
3. CONVERT   → Extract text (built-in conversion → fallback OCR)
4. PROCESS   → Extract structure, action items, tags
5. STORE     → Write Markdown + frontmatter to Obsidian vault
6. RESPOND   → Generate summary PDF, push back to reMarkable
7. TRACK     → Update sync state DB, commit vault to Git

Requirements

  • Python 3.11+
  • A reMarkable tablet (Paper Pro or reMarkable 2)
  • An Obsidian vault (local or Git-synced)
  • An Anthropic API key for note processing
  • (Optional) Google Cloud Vision credentials for OCR fallback

VPS Deployment

  • Ubuntu 22.04+ or Debian 12+
  • 1 GB RAM minimum (2 GB recommended if using VLM OCR)
  • 10 GB disk (vault + state + downloaded .rm files)
  • Outbound HTTPS to *.remarkable.com, api.anthropic.com, vision.googleapis.com

Installation

From PyPI (recommended)

pip install remark-bridge

From source

git clone https://github.com/BGGBTAC/reMark.git
cd reMark
pip install .

Note: reMark requires libcairo2 for SVG→PNG rendering. On Debian/Ubuntu: sudo apt install libcairo2-dev. On macOS: brew install cairo.

Setup

# Interactive setup — authenticates with reMarkable Cloud,
# creates config, initializes vault structure and state DB
remark-bridge setup

During setup you'll need a one-time code from my.remarkable.com/device/browser/connect.

Configuration

Copy and edit the example config:

cp config.example.yaml config.yaml

Key sections:

Section What it controls
remarkable Cloud auth, folder filters, response folder
ocr Primary/fallback OCR engines, confidence threshold
processing Model selection, what to extract (actions, tags, summaries)
obsidian Vault path, folder mapping, Git sync settings
sync Trigger mode (realtime/scheduled/manual), WebSocket config
response Response format (PDF/notebook), auto-trigger rules
search Semantic search — backend, chunking, synthesis
microsoft Outlook Tasks + Calendar integration

See config.example.yaml for the full reference with comments.

Usage

# One-shot sync
remark-bridge sync --once

# Continuous sync (scheduled + realtime based on config)
remark-bridge sync

# Real-time WebSocket watcher only
remark-bridge watch

# Process a specific notebook
remark-bridge process "Meeting Notes 2026-04-13"

# Push a generated response back to the tablet
remark-bridge respond "Meeting Notes 2026-04-13" --format pdf

# Ask your vault a question (semantic search)
remark-bridge ask "what did I decide about the API migration"

# Rebuild the semantic search index
remark-bridge reindex

# Authenticate Microsoft for Outlook/To Do
remark-bridge setup-microsoft

# Run a health check
remark-bridge doctor

# Upload a PDF to your reMarkable
remark-bridge push report.pdf --folder "Work"

# Check sync status + API cost summary
remark-bridge status

# Start MCP server (for Claude Desktop / Claude Code)
remark-bridge serve

# One-time import of all existing notebooks
remark-bridge migrate

Semantic Search

Enable semantic search by setting search.enabled: true in config.yaml. Three backends are supported:

  • local (default) — offline via sentence-transformers, no API costs. Install with pip install 'remark-bridge[local-embeddings]'.
  • voyage — highest quality, requires VOYAGE_API_KEY. Install with pip install 'remark-bridge[voyage]'.
  • openai — solid quality, requires OPENAI_API_KEY. Install with pip install 'remark-bridge[openai]'.

Embeddings are stored in the same SQLite database as the sync state (via sqlite-vec), so no extra infrastructure is needed.

Microsoft Outlook Integration

Register an app at entra.microsoft.com (Public client, redirect URI https://login.microsoftonline.com/common/oauth2/nativeclient), add its client ID to config.yaml under microsoft.client_id, and run remark-bridge setup-microsoft. Action items will flow into Microsoft To Do; items with deadlines become Outlook Calendar events.

reMarkable Marking Conventions

Use pen colors and text patterns to mark up your notes. reMark detects both, so it works on the monochrome rM2 too (just use text patterns).

Mark Pen Color Meaning Detection
Action item Red Task to do Color filter
Question Blue Needs follow-up Color filter
Important Yellow highlight Key info Color filter
Done Green Completed Color filter
TODO: text Any Task Text pattern
Q: text Any Question Text pattern
! prefix Any Priority flag Text pattern
[ ] checkbox Any Task checkbox Text pattern

Deployment (systemd)

# Install on VPS
sudo apt install libcairo2-dev
pip install remark-bridge

# Run setup
remark-bridge setup

# Copy service files
sudo cp systemd/remarkable-bridge.service /etc/systemd/system/
sudo cp systemd/remarkable-bridge.timer /etc/systemd/system/

# Set your API key in the service file
sudo systemctl edit remarkable-bridge
# Add: Environment=ANTHROPIC_API_KEY=sk-ant-...

# Enable and start
sudo systemctl daemon-reload
sudo systemctl enable --now remarkable-bridge

For timer-based mode (instead of continuous):

sudo systemctl enable --now remarkable-bridge.timer

Project Structure

reMark/
├── src/
│   ├── main.py              # CLI entry point (Click)
│   ├── config.py            # Config loading + validation
│   ├── remarkable/          # reMarkable Cloud interaction
│   │   ├── auth.py          # JWT auth flow
│   │   ├── cloud.py         # Cloud API client (sync 1.5)
│   │   ├── documents.py     # Document listing, download, upload
│   │   ├── websocket.py     # Real-time change notifications
│   │   └── formats.py       # .rm file parsing (wraps rmscene)
│   ├── ocr/                 # Handwriting recognition pipeline
│   │   ├── pipeline.py      # OCR orchestrator (strategy pattern)
│   │   ├── remarkable_builtin.py
│   │   ├── google_vision.py
│   │   ├── vlm.py
│   │   └── renderer.py      # .rm → PNG/SVG rendering
│   ├── processing/          # Intelligent note processing
│   │   ├── structurer.py    # Raw text → structured Markdown
│   │   ├── actions.py       # Action item extraction
│   │   ├── tagger.py        # Auto-tagging
│   │   └── summarizer.py    # Note summarization
│   ├── obsidian/            # Obsidian vault management
│   │   ├── vault.py         # Read/write operations
│   │   ├── frontmatter.py   # YAML frontmatter generation
│   │   ├── templates.py     # Note templates
│   │   └── git_sync.py      # Git commit + push
│   ├── response/            # Push results back to reMarkable
│   │   ├── pdf_generator.py # Generate response PDFs
│   │   ├── notebook_writer.py
│   │   └── uploader.py
│   ├── sync/                # Sync orchestration
│   │   ├── engine.py        # Main sync loop
│   │   ├── state.py         # SQLite state tracking
│   │   ├── scheduler.py     # Cron / interval scheduling
│   │   └── watcher.py       # WebSocket real-time watcher
│   └── mcp/                 # MCP server
│       └── server.py
├── tests/
├── scripts/
├── systemd/
├── vault_template/          # Initial Obsidian vault structure
├── config.example.yaml
├── pyproject.toml
└── LICENSE

Development

git clone https://github.com/BGGBTAC/reMark.git
cd reMark

python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

# Run tests
pytest tests/ -v

# Lint
ruff check src/ tests/

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

remark_bridge-0.2.0.tar.gz (102.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

remark_bridge-0.2.0-py3-none-any.whl (100.8 kB view details)

Uploaded Python 3

File details

Details for the file remark_bridge-0.2.0.tar.gz.

File metadata

  • Download URL: remark_bridge-0.2.0.tar.gz
  • Upload date:
  • Size: 102.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for remark_bridge-0.2.0.tar.gz
Algorithm Hash digest
SHA256 dce4bbb5753728d7199a60fa205dbe1f38a7395f0ba769481f27ea214f8a7128
MD5 7e09802a111430a0eb701ffa81c93136
BLAKE2b-256 b20717c75907e4786a9ff5eb01abe11053b9b068d040fa17ed4e86653d90c06b

See more details on using hashes here.

Provenance

The following attestation bundles were made for remark_bridge-0.2.0.tar.gz:

Publisher: release.yml on BGGBTAC/reMark

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file remark_bridge-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: remark_bridge-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 100.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for remark_bridge-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ba51d5d0e28398ad66a415ca33db30ad699580dc3011c263b7dacf9c658c2b2
MD5 f544f41a6bca86d6a74f154a64c99afe
BLAKE2b-256 400691f2ec82d7e449c1e5389f493d044078793d7c02864dd8b20ceebcb4394d

See more details on using hashes here.

Provenance

The following attestation bundles were made for remark_bridge-0.2.0-py3-none-any.whl:

Publisher: release.yml on BGGBTAC/reMark

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page