Awesome reMarkable

The reMarkable is a paper tablet for those who prefer writing on paper, rather than keyboards. Its remarkably fast paper-white display, Linux based operating system and awesome community make it highly attractive amongst hackers and developers.

Contributions are welcome as long as they follow the guidelines.

Disclaimer

No project here is affiliated or endorsed by reMarkable AS. If you modify your device official support might refuse to help you.

Write down your SSH password

⚠️ WARNING, READ THIS FIRST ⚠️

Make sure you have saved your SSH password somewhere secure, or you have setup a SSH key

You can find the SSH password in your settings: Settings > Help > Copyrights and licenses > General information (scroll down).

Failure to do so could mean a bricked device and would require a hardware plug to recover from the bricked state. You have been warned!

Factory reset may brick your device

This function may not do what you are expecting. While it resets all user data, it will not restore the device to the original factory condition. It will reset your SSH password and remove all SSH keys, which may make it impossible to connect to your device if it is malfunctioning.

Take special care if you are using a reMarkable 2.

• System recovery requires some hardware. Check ddvk/remarkable2-recovery for what to do in case you lose ssh access.
• The screen on rm2 and rm1 are different. Workarounds have been developed to interact with the rM2 framebuffer but some projects might not work on it. See remarkable2-framebuffer repo and #14.

Contents

• APIs
  • Cloud API
  • Lines Format
  • Other APIs
• Applications
  • Games
  • Launchers
• Cloud Tools
• Device Tools
• GUI Clients
• Other
• Screen Sharing/Streaming
• Custom Templates

APIs

Cloud API

• google-drive-remarkable-sync - Apps Script API for reMarkable Cloud. Includes Synchronizer capability to automate mirroring of documents from Google Drive to reMarkable Cloud.
• jrmapi - A Java API for the reMarkable Cloud.
• reMarkableAPI - Docs and implementation of the reMarkable file sync API.
• reMarkable-typescript - TypeScript API for reMarkable Cloud.
• Remarkable.jl - Julia API Interface to the reMarkable cloud.
• remarkdav - A tool to sync PDF files from a WebDAV directory to the reMarkable Cloud.
• rMAPI - ReMarkable Cloud Go API.
• rmapy - ReMarkable Cloud Python API.
• rmcl- Asynchronous Python library for the reMarkable Cloud.
• rmfakecloud - Fake Cloud Sync, server implementation of the Cloud API.

Lines Format

• lines-are-beautiful - C++ File API for the reMarkable tablet.
• lines-are-rusty - Rust File API for the reMarkable tablet.
• reMarkable-kaitai - Kaitai Struct format specification for the binary lines format.
• reMarkable-layers - Python API for reading & writing reMarkable Lines format. Supports very basic conversion of PDFs and SVGs to Lines format.
• rmrl - The reMarkable Rendering Library for Python converts annotated documents to PDF files.

Other APIs

• libreMarkable - A framework for developing applications with native refresh support for reMarkable Tablet.

Applications

• harmony - a low latency sketching app with procedural brushes.
• KOReader - An ebook reader application supporting PDF, DjVu, EPUB, FB2 and many more formats.
• darvin/plato LinusCDE/plato - Plato reader port. Supports pdfs, epubs, many other formats.
• Rebook - The missing book store for reMarkable.
• reMarkable keywriter - A distraction free keyboard notes app.
• reMarkable wikipedia - Offline wikipedia reader for reMarkable.
• remarkaBot - Fetch your documents from Telegram.
• whiteboard-hypercard - Live collaboration, drawing, chat, whiteboarding.

Games

• chessMarkable - Play chess against a bot or a friend.
• DOOMarkable - Play DOOM on the reMarkable 1.
• minesweeper - A mine detection game.
• recrossable - Crossword game with simplistic handwriting recognition and automatic generation of crosswords.
• retris - Play a clone of the popular block stacking game with either buttons or swipe guestures.

Launchers

• draft-reMarkable - A launcher for the reMarkable tablet, which wraps around the standard interface.
• oxide - A launcher application for the reMarkable tablet.
• remux - A multi-tasking launcher for the reMarkable tablet.

Cloud Tools

• CUPS Printing - Script to print directly to reMarkable Cloud from CUPS using rMAPI.
• mendeley-rMsync - Script to sync PDFs (with annotations) from/to a Mendeley folder.
• reCatchable - Turn websites into ebooks, upload them to reMarkable.
• reGitable - Backup your reMarkable with git and sync changes to a remote repository automatically.
• remarkable_simplenote - Sync simplenote notes to reMarkable (currently one-way)
• reMarkable-Sink - Turn a folder into a wormhole to your reMarkable.
• reMarkable_syncthing - Syncthing on reMarkable.
• remarkable-zapier - Zapier Integration for reMarkable Cloud
• remarking - CLI tool to extract highlights from any document in the reMarkable cloud.
• rm-pdf-tools - Service that allows users to insert and delete pages from annotated PDFs on the device.
• rM-sync - Sync script for reMarkable paper tablet.
• RMfuse - FUSE filesystem for the reMarkable Cloud.
• sync_zotero_remarkable - Sync PDFs from Zotero to reMarkable.
• url2epub - Telegram bot to generate ePub out of URL and send directly to reMarkable Cloud.
• zotero-reMarkable - Script to sync PDFs from the Zotero reference manager.

Device Tools

• ReCept - Fix for the rM2 jagged line issue.
• rM-signature-patch - Simple script to remove that pesky advert at the bottom of a mail originating from a reMarkable.
• WebInterface-Wifi - View the web interface if running, over wifi.

GUI Clients

• asTounding - A multiplatform GUI application for the reMarkable cloud, including Linux.
• RemaDroid - An alternative Android app to upload documents, webpages or images to the reMarkable tablet.
• RemaPy - GUI to browse, download/upload files and backup the tablet (also on Linux) using the cloud.
• reMarkable-assistant - Manage templates, splash screens, and settings on your reMarkable tablet.
• reMarkable Connection Utility (RCU) - A cross-platform client for offline management of backups, screenshots, notebooks, templates, wallpaper, and third-party software.
• reMarkable-hyutilities - A GUI written in java to backup your device, upload templates and modify splash screens.
• ReMy - A GUI to browse, preview documents, export documents with custom settings, all via SSH (no cloud needed); works from local raw backups too.
• rMExplorer - GUI to browse, download/upload files and backup the tablet without using the cloud.
• rmUploader - Simple web app to upload epub or pdf files to the reMarkable tablet via drag and drop.
• Slithin - Free Management Application for Windows/Linux/MacOS

Other

• Calibre-Remarkable-Device-Driver-Plugin - A Calibre Plugin to Manage your Remarkable Books.
• Crazy Cow - Typewriter input from USB keyboard directly into reMarkable interface.
• Drawj2d - Create technical line drawings on an editable reMarkable notebook page. (Guidance how to upload the page to the device using rMAPI.)
• Funcky reMarkable Exporter - Export notes from a reMarkable Tablet to File System and External Services.
• Goosepaper: Deliver prettily-formatted RSS feeds, news articles, Wikipedia articles-of-the-day, and more to your reMarkable tablet.
• instapaper-as-pdf-to-reMarkable - Export Instapaper-Articles to PDF and send them to a connected rM tablet.
• landscape-pdf - Utility to convert pdf documents to read in landscape mode. Useful for papers and text books.
• morningpaper2reMarkable - A bot to sync the morning paper to a reMarkable tablet.
• nix-remarkable - Nix expressions for the reMarkable tablet leveraging the company's toolchain.
• paper2reMarkable - Download an academic paper or HTML article, crop it, and send it to the reMarkable with a single command.
• mail2rm - Mail PDF documents to your reMarkable cloud using your mail transport agent e.g. postfix.
• Parabola-rM - A Desktop GNU/Linux-libre replacement OS with fast partial refreshing and USB OTG.
• pdf2rmnotebook - Creates a reMarkable Notebook from multiple PDF files.
• pocket2rm - Synchronize articles from read-later platform pocket in PDF and epub.
• remailable - Email PDFs directly to your reMarkable. (Free publicly-hosted version available).
• reHackable/maxio - Companion daemon for the reMarkable paper tablet.
• reHackable/scripts - A set of bash scripts that may enhance your reMarkable experience.
• reMarkable CLI tooling - CLI-tooling to sync documents to a reMarkable, to clean deleted files etc. without needing cloud access
• reMarkable-crosswords - Get crosswords freshly delivered to your Remarkable every morning.
• reMarkable_entware - Package manager for reMarkable. Install common Unix utilities through the command line.
• reMarkable_keyboard - Software to use rM as wireless keyboard/mouse.
• reMarkable_mouse - Use your reMarkable as a graphics tablet.
• remarkable_news - Use daily news/comics/images as the suspend screen.
• reMarkable_pdflets - Dynamically updating PDFs.
• remarkable_printer - Print from any device to reMarkable without browser extensions or reMarkable cloud.
• reMarkable-fs - A FUSE filesystem wrapper for the reMarkable tablet.
• reMarkable-random-screens - Change your poweroff and suspend screens every 5 minutes with random images of your choice
• reMarkable-touchgestures - Touch gestures (swipe/touch) for easy page navigation.
• reMarkable-tweak - Tweak tool for the reMarkable paper tablet. Lets you organize your templates with no fuss.
• reMarkablePocket - Synchronize articles from read-later platform Pocket in epub format.
• reMarkableSync - A Microsoft OneNote addin for importing notebooks from reMarkable as text or images.
• remarks - Extract highlights, scribbles, and annotations from PDFs. Export to Markdown, PNG, and SVG.
• reMouseable - Use your reMarkable tablet as a mouse.
• remt - reMarkable tablet command-line tools.
• reSnap - Take snapshots of your reMarkable screen over SSH.
• rM-dl-annotated - Export annotated PDFs from reMarkable tablets.
• rMsync - Synchronisation script with a local dedicated "library" folder.
• rmTabletDriver - Application that allows you to simulate/clone rM input on your computer.
• rmWacomToMouse - Use the wacom pen as a mouse to draw on your pc.
• rmWebUiTools - View a file tree, see statistics and export/backup all files with some simple scripts utilizing the web ui.
• send_by_rmapi - A Calibre plugin to send books to your reMarkable, making use of rmapi.

Screen Sharing/Streaming

• pipes and paper - Stream pen strokes to browser canvas via websockets (blog post). Uses Python and SSH, nothing to compile or install on the reMarkable device.
• pipes and paper enhanced - Share the pen strokes to a browser without installling anything on the ReMarkable (a revived fork of the previous link with pen colors and eraser support, responsive interface).
• pipes and rust - (Made for rM2) Stream pen strokes to browser. A single executable on the reMarkable that hosts a tiny webserver in the local WLAN.
• reStream - Stream your reMarkable screen over SSH.
• rMview - A fast GUI to stream your reMarkable screen over vanilla-SSH or VNC.
• rM-vnc-server - A fast & efficient damage-tracking (sending only updated regions) VNC server for streaming the reMarkable's screen.
• srvfb - Alternative screen-streaming software. Written in Go.
• VNSee - VNC client for the reMarkable tablet allowing you to use the device as a second screen.
• goMarkableStream - Stream the screen of the reMarkable 2 (FW 2.5) easily (client/server in Go with no installation) along with the colors (with FW > 2.11.x).

Custom Templates

• latex-yearly-planner - PDF planner designed for e-ink devices.
• ReCalendar.me - Highly customizable online calendar generator optimized for reMarkable.
• ReCalendar - Highly customizable calendar generator in PHP optimized for reMarkable.
• reMarkable-bujo - "Bullet Journal" templates.
• remarkable-engineering - Engineering-style grid templates.
• reMarkable-gtd-templates - "Getting Things Done" templates.
• reMarkable Templates - A website to host and view community-built templates.
• reMarkable-Templates - To Do templates with lines, checkboxes or text blocks.
• reMarkable_templates - White lines/squares on gray background.
• reMarkabletemplates - Planner per 1 or 3 weeks.
• rM2Mods templates - Collection of different templates. E.g., micro dots/grids, checklists, budgeting, boxes.
• reMarkable planning/journaling templates - Collection of daily/weekly planning, journaling templates

Template Builders

• NoTeTo - Design templates by drag and drop components
• Remarkable Grid Template Generator - Generate pixel perfect line grid and dotted grid templates
• reMarkable Template Builder - Generate Isometric and Grid templates of all sizes