Awesome reMarkable

<img src="Awesome.png"></p>

The reMarkable is a paper tablet for those who prefer writing on paper. 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: WARNING, READ THIS FIRST :warning:

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 result in a soft-bricked device that requires emergency recovery.

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.

See remarkable.guide for more information on how to properly factory reset your device.

Take special care if you are using a reMarkable 2.

• System recovery requires some hardware. See https://remarkable.guide/tech/recovery.html#remarkable-2-recovery for more information.
• 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 ddvk/remarkable2-framebuffer and ddvk/remarkable2-framebuffer#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

• (Unmaintained) 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.
• (Unmaintained) 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.
• reGenda - An agenda-based calendar for reMarkable.
• reMarkable keywriter - A distraction free keyboard notes app.
• reMarkable wikipedia - Offline wikipedia reader for reMarkable.
• (Unmaintained) 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.
• (Unmaintained) 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-substack - Syncs unread Substack posts to the reMarkable Cloud.
• 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.
• Zotero2reMarkable Bridge - Sync files from Zotero to reMarkable and back based on tags; supports v2.7< highlights.

Device Tools

• paginator - Physical foot pedal to turn pages on the device with no hands (e.g. for playing sheet music).
• 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.
• remarvin - Profile and file encrytion manager that allows to manage notebooks for different users and to optionally protect the files with a password through gocryptfs-based encryption (device only).
• Signature-rM - Remove the signature from the bottom of emails sent from the device.
• splash.dat converter - Simple script to convert an image to the rM2 .dat format for a splash screen.
• WebInterface-OnBoot - Enable the web interface on boot.
• WebInterface-Upload-Button - Upload button for the web interface, alternative to drag and drop.
• WebInterface-Wifi - View the web interface if running, over wifi.

GUI Clients

• asTounding - A multiplatform GUI application for the reMarkable cloud, including Linux.
• 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) - Cross-platform local/offline client for managing backups, screenshots, notebooks, templates, wallpaper, firmware, and third-party software. Typed text and snap highlight extraction. Virtual printer for native print-to-tablet.
• reMarkable-hyutilities - A GUI written in java to backup your device, upload templates and modify splash screens.
• reMarkable Remember - A cross-platform client for offline management of backups, notebooks, templates and hand writing recognition via MyScript.
• ReMy - A GUI to browse, preview documents, export documents with custom settings, all via SSH (no cloud needed); works from local raw backups too.
• rM2 Template Helper Windows tool for template management, and to download community templates.
• 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.
• rmWebUI - Simple web interface to the reMarkable® cloud.
• (Unmaintained) Slithin - Free Management Application for Windows/Linux/MacOS.

Other

• Book-safe - Hide books/documents between a given time period.
• (Unmaintained) 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.
• microSD - Tutorial for adding a microSD card reader to the reMarkable 1.
• neofetch - A command-line system information tool written in bash 3.2+.
• 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