RMfuse provides access to your reMarkable Cloud files in the form of a FUSE filesystem

Overview

RMfuse

RMfuse provides access to your reMarkable Cloud files in the form of a FUSE filesystem. These files are exposed either in their original format, or as PDF files that contain your annotations. This lets you manage files in the reMarkable Cloud using the same tools you use on your local system.

Installation

RMfuse requires Python 3.7 or later. It also requires the FUSE3 library. This should be available in most Linuxes (fuse3 and libfuse3-3 in Debian-based distributions) and BSDs. RMfuse may work with macFuse, but that is untested. Windows users may try WinFuse, also untested. Installation of RMfuse and its dependencies will likely require the FUSE3 headers and a C build system (libfuse3-dev and build-essential in Debian).

RMfuse can be installed with pip:

pip install rmfuse

Alternatively, you may clone this repository. Poetry is used for development, so once that is installed you can run

poetry install

Usage

RMfuse installs the script rmfuse. The script takes a single argument, the path at which the filesystem should be mounted. This must be an existing directory. Any files within that directory will be hidden as long as RMfuse is mounted.

mkdir ~/remarkable
rmfuse ~/remarkable

(If you installed with Poetry, you may need to run poetry run rmfuse.)

The first time RMfuse is run, it will need a one-time code to get access to your reMarkable Cloud account. You will be prompted to get that code from https://my.remarkable.com/connect/desktop, which may require logging in to your reMarkable account. RMfuse uses that code to obtain tokens which it uses in the future to authenticate itself.

To unmount and halt RMfuse, use the fusermount command:

fusermount -u ~/remarkable

Modes

RMfuse offers several modes to display your reMarkable Cloud files. You can choose the mode with the -m option.

annot: Displays all files in PDF format, with your annotations added. This is the default mode.

orig: Displays the original file for ebooks and PDF files. Notebooks are rendered as PDF files, as in the annot mode.

raw: Displays all files as ZIP files, reflecting the underlying format used by the reMarkable Cloud. This may be useful when working with other tools that expect files in this form.

meta: Displays metadata about the files in JSON format. Only useful for debugging.

RMfuse provides a special file named .mode in root directory. When read, this file gives the current mode. Writing a valid mode to this file will switch the mode RMfuse is in. Additionally, writing refresh to this file will cause RMfuse to refresh its information from the reMarkable Cloud. (By default, this happens every five minutes.)

~/remarkable $ cat .mode
annot
~/remarkable $ ls
book.pdf        document.pdf    notebook.pdf
~/remarkable $ echo orig > .mode
~/remarkable $ ls
book.epub       document.pdf    notebook.pdf

Capabilities

RMfuse allows reading of all files in the reMarkable Cloud. Since reading the file requires several HTTP requests, as well as local processing, reads make take some time. Running RMfuse in verbose mode (-v or -vv) will display information about the actions underway. The most recent file accessed is cached, to improve performance. More sophisticated caching is planned for the future.

RMfuse does its best to provide accurate metadata for the files. However, the reMarkable Cloud provides only modification dates, so that is reported for creation and access dates as well. File sizes in annot mode are only estimates until the file is read for the first time. This metadata is cached locally to improve responsiveness in the future.

Files can be renamed and moved within the RMfuse filesystem. These changes will be propagated to the reMarkable Cloud. Changes to the file extension will be ignored.

Deleting files from a RMfuse filesystem moves them into the reMarkable Cloud's trash area. These files are accessible in the .trash hidden directory in the root of the file system. Deleting files within the .trash folder removes them from the reMarkable Cloud. (N.B. It is not known if this deletes the files from the cloud, or just hides them from clients.)

EPUB and PDF files may be copied into the filesystem, and new directories can be created. These changes are uploaded to the reMarkable Cloud. Copying other types of files into the RMfuse filesystem will fail silently (unfortunately). File extensions are ignored by RMfuse, and thus may change when files are uploaded. For instance, if book.epub is uploaded and RMFuse is in annot mode, it will show up in the filesystem as book.pdf.

Existing files cannot be edited; they appear in read-only mode. If you want to edit the contents of a file, you will need to copy it to your local filesystem, edit it, and then copy it back to the RMfuse filesystem. This will cause annotations to be lost (in orig mode) or flattened into the document itself (in annot mode).

Known Limitations

  • The file size for annotated files is just an estimate before the file is first read. This can confuse some tools which use the file size to determine how much to read. After reading the file once, the file size will be correctly reported going forward; rerunning these tools a second time is usually enough to get them working.

  • To try to address this, RMfuse throws an error when a program tries to read past the end of a file. This can cause "No data available" errors to be reported. These are harmless.

  • Adding a file other than an EPUB or PDF silently fails. RMfuse does throw an error when it has been given an invalid file, but this comes too late for FUSE to pass the error back to the caller. RMfuse may be able to throw an error earlier, based on the first bytes it receives; this will be investigated in the future.

  • RMfuse caches the most-recently accessed file in memory. This is bad for large files (too much memory used) and small files (we could cache several files). A more sophisticated caching system is planned.

Libraries

RMfuse is powered by rmcl, for accessing the reMarkable Cloud, and by rmrl, for rendering annotated documents. The early development of RMfuse can be found in the rmcl repository

Trademarks

reMarkable(R) is a registered trademark of reMarkable AS. rmrl is not affiliated with, or endorsed by, reMarkable AS. The use of "reMarkable" in this work refers to the company’s e-paper tablet product(s).

Copyright

Copyright 2020-2021 Robert Schroll

RMfuse is released under the MIT license. See LICENSE.txt for details.

Disclaimer of Warranty

RMfuse is provided without any warranty. Users accept the risk of damages, including the loss of data on their local system, on their reMarkable device, and in the reMarkable Cloud.

If it breaks, you get to keep both halves.

Owner
Robert Schroll
Robert Schroll
Test app for importing contact information in CSV files.

Contact Import TestApp Test app for importing contact information in CSV files. Explore the docs » · Report Bug · Request Feature Table of Contents Ab

1 Feb 06, 2022
Organizer is a python program that organizes your downloads folder

Organizer Organizer is a python program that organizes your downloads folder, it can run as a service and so will start along with the system, and the

Gustavo 2 Oct 18, 2021
A Python script to backup your favorite Discord gifs

About the project Discord recently felt like it would be a good idea to limit the favorites to 250, which made me lose most of my gifs... Luckily for

4 Aug 03, 2022
Simple, convenient and cross-platform file date changing library. 📝📅

Simple, convenient and cross-platform file date changing library.

kubinka0505 15 Dec 18, 2022
Python's Filesystem abstraction layer

PyFilesystem2 Python's Filesystem abstraction layer. Documentation Wiki API Documentation GitHub Repository Blog Introduction Think of PyFilesystem's

pyFilesystem 1.8k Jan 02, 2023
gitfs is a FUSE file system that fully integrates with git - Version controlled file system

gitfs is a FUSE file system that fully integrates with git. You can mount a remote repository's branch locally, and any subsequent changes made to the files will be automatically committed to the rem

Presslabs 2.3k Jan 08, 2023
Read and write TIFF files

Read and write TIFF files Tifffile is a Python library to store numpy arrays in TIFF (Tagged Image File Format) files, and read image and metadata fro

Christoph Gohlke 346 Dec 18, 2022
Dragon Age: Origins toolset to extract/build .erf files, patch language-specific .dlg files, and view the contents of files in the ERF or GFF format

DAOTools This is a set of tools for Dragon Age: Origins modding. It can patch the text lines of .dlg files, extract and build an .erf file, and view t

8 Dec 06, 2022
Two scripts help you to convert csv file to md file by template

Two scripts help you to convert csv file to md file by template. One help you generate multiple md files with different filenames from the first colume of csv file. Another can generate one md file w

2 Oct 15, 2022
Simple Python File Manager

This script lets you automatically relocate files based on their extensions. Very useful from the downloads folder !

Aimé Risson 22 Dec 27, 2022
MetaMove is written in Python3 and aims at easing batch renaming operations based on file meta data.

MetaMove MetaMove is written in Python3 and aims at easing batch renaming operations based on file meta data. MetaMove abuses eval combined with f-str

Jan Philippi 2 Dec 28, 2021
QSynthesis is a Python3 API to perform I/O based program synthesis of bitvector expressions.

QSynthesis is a Python3 API to perform I/O based program synthesis of bitvector expressions. It aims at facilitating code deobfuscation. The algorithm is greybox approach combining both a blackbox I/

Quarkslab 103 Dec 30, 2022
This simple python script pcopy reads a list of file names and copies them to a separate folder

pCopy This simple python script pcopy reads a list of file names and copies them to a separate folder. Pre-requisites Python 3 (ver. 3.6) How to use

Madhuranga Rathnayake 0 Sep 03, 2021
This python project contains a class FileProcessor which allows one to grab a file and get some meta data and header information from it

This python project contains a class FileProcessor which allows one to grab a file and get some meta data and header information from it. In the current state, it outputs a PrettyTable to txt file as

Joshua Wren 1 Nov 09, 2021
Small Python script to generate a calendar (.ics) file from SIMASTER courses schedule.

simaster.ics Small Python script to generate a calendar (.ics) file from SIMASTER courses schedule. Usage Getting the events.json file from SIMASTER O

Faiz Jazadi 8 Nov 02, 2022
Fast Python reader and editor for ASAM MDF / MF4 (Measurement Data Format) files

asammdf is a fast parser and editor for ASAM (Association for Standardization of Automation and Measuring Systems) MDF (Measurement Data Format) files

Daniel Hrisca 440 Dec 31, 2022
BREP : Binary Search in plaintext and gzip files

BREP : Binary Search in plaintext and gzip files Search large files in O(log n) time using binary search. We support plaintext and Gzipped files. Benc

Arnaud de Saint Meloir 5 Dec 24, 2021
pytiff is a lightweight library for reading chunks from a tiff file

pytiff is a lightweight library for reading chunks from a tiff file. While it supports other formats to some extend, it is focused on reading tiled greyscale/rgb images, that can also be bigtiffs. Wr

Big Data Analytics group 9 Mar 21, 2022
ValveVMF - A python library to parse Valve's VMF files

ValveVMF ValveVMF is a Python library for parsing .vmf files for the Source Engi

pySourceSDK 2 Jan 02, 2022
Convert All TXT Files To One File.

AllToOne Convert All TXT Files To One File. Hi 👋 , I'm Alireza A Python Developer Boy 🔭 I’m currently working on my C# projects 🌱 I’m currently Lea

4 Jun 07, 2022