A FUSE filesystem driver for reMarkable

remarkable-fs allows you to see the contents of your reMarkable as a normal folder on your computer. All your documents and folders are visible; you can copy documents to and from the reMarkable, create folders, and move and delete folders and files. You cannot, however, edit documents that are already on the reMarkable (apart from moving or deleting them).

It supports PDF files, EPUB files, and handwritten notes, but does not yet support annotated PDFs (they are exported without annotations).

This software is in an early stage of development. I take no responsibility if it deletes your files or bricks your reMarkable! Do not use it if you are unwilling to lose all your documents. Use at your own risk!

Installation

remarkable-fs works on both Linux and macOS. Support for macOS may be a bit patchy as I myself run Linux, but at least the basics should work. To install it, you will need to have first installed:

• FUSE. If on macOS, get this from the Fuse for macOS project. If on Linux, your package manager should have it.
• pip, the Python package installer. You can install this by running sudo easy_install pip in a terminal.

Then, to install remarkable-fs, run the following command in a terminal:

sudo pip install remarkable-fs

Note for Linux users: remarkable-fs supports both Python 2 and 3, but for handwritten notes it works much faster on Python 2.

Running

First make sure that your reMarkable is plugged into your computer.

Make an empty directory on your computer. This directory is where your documents will appear. Then run remarkable-fs. You will be prompted for the path to this directory; type it in. (On macOS, you can instead drag the directory to the terminal window at this point.)

You will then be prompted for the root password of your reMarkable. You can find this by opening the settings menu of the reMarkable, choosing "About", scrolling to the very bottom, and finding the paragraph beginning: "To do so, this device acts as a USB ethernet device..." (If you don't want to have to type in the root password every time you run remarkable-fs, follow the instructions on passwordless login from the reMarkable wiki.)

If all goes well, you will find all your documents in the directory you chose. You can copy PDF or EPUB files there, and they will appear on the reMarkable; you can also move files around. Go wild!

(On macOS, your reMarkable will also appear in the finder under the menu Go -> Computer.)

When you are finished, you can stop remarkable-fs by pressing ctrl-C.

Note that your reMarkable will be unresponsive for the time you have remarkable-fs running. It should start responding as soon as you close remarkable-fs or unplug the USB cable. If for some reason it doesn't, you can force your reMarkable to restart by holding down the power button for five seconds, letting go, and then pressing the power button for another second.

Copyright

The software is licensed under the MIT licence, apart from the file remarkable_fs/rM2svg.py. That file is is licensed under the GNU LGPL version 3, and is taken from https://github.com/phil777/maxio.