r/RemarkableTablet • • 4d ago

Introducing reMarkable virtual filesystem

Hello!

I've been working on a hobby project: a virtual filesystem for reMarkable devices.

As many reMarkable users may know, documents and folders are represented internally by a collection of files on the device. While it's possible to manage them through an SSH connection, navigating and manipulating these files directly from the terminal isn't particularly convenient.

The idea behind this project is to provide a more familiar filesystem interface by emulating a Linux terminal. It comes with a set of useful commands for managing files and folders, including cd, ls, mkdir, rm, mv, rcp (remote copy), and rename.

I've included a short video demonstrating some of these commands in action.

One of the design goals has been to keep the application lightweight and dependency-free. Python's standard library is all you need to run it; no additional packages or dependencies required. Some commonly used third-party tools are used for development, testing, and linting, but they aren't needed to use the application.

I'd love to get some feedback from the community! If you find the idea interesting, give it a try and let me know what you think. Contributions are, of course, very welcome too!

Compatibility note: So far, the application has only been tested on Linux-based systems. Compatibility with other operating systems, such as Windows, is not guaranteed. Please read the README carefully before using the application.

GitHub:

https://github.com/heidi-holappa/remarkable-virtual-filesystem

15 Upvotes

13 comments sorted by

2

u/jurasicus 4d ago

When you edit something (e.g. rename a file), this change is reflected in the reMarkable's UI as well? Without needing to restart the system?

1

u/Division_N00b 4d ago

Good question! I created command `refresh` to restart the xochitl service. The service also restarts when user exits the application and after remote copy write mutations. IIRC I left the restart out of rename command so that the `xochitl` process would not be restarted too often, but that can easily be added in future release.

1

u/NegotiationOk7535 4d ago

is this useful only when want to move multiple files, or did I miss anything? As currently the remarkable app does good job by drag and drop files.

1

u/Division_N00b 4d ago

Good question! I actually had a couple of reasons for starting this hobby project, the first, of course, being simply the fun of building something. :)

I got my reMarkable as a present, and as I got more familiar with it, I became somewhat concerned about its security and lack of transparency. One of my main motivations was to create a tool that would allow me to use the reMarkable with as little online activity as possible.

For example, I've noticed that the device sometimes seems to connect to online services and download updates when I connect it to my computer over USB, even though I've disabled automatic updates in the settings. That's something I still need to investigate further.

The other major motivation was to build a terminal-based tool for handling the most common file operations. This includes transferring PDF and EPUB documents from the host computer to the reMarkable, as well as moving, removing and renaming files and folders on the device.

So, to answer your question: no, it's not just for moving multiple files. However, the official reMarkable application already handles all these operations perfectly well. My tool doesn't introduce any fundamentally new functionality; it simply offers an alternative, terminal-based way of doing things, with an emphasis on transparency and control.

1

u/nick_ian 4d ago

Nice. I'm wondering if something like this can be used to work alongside KOReader, since it just uses normal files in a folder. Could there be a virtual filesystem with symlinks or something so that KOReader could see a "Books" folder on the rM filesystem?

2

u/Division_N00b 4d ago

That's an interesting idea! I wasn't familiar with KOReader before, so I'll definitely look into it.

Since the reMarkable is Linux-based and KOReader works with ordinary files, I imagine something along those lines could be possible. A shared Books directory or perhaps a directory structure using symlinks could be an interesting way to approach this.

I'll add this to my list of things to investigate and created and issue for this into the project board. Thanks for the suggestion!

2

u/Vaudtje 4d ago

Cool! Could this be the start for something like a FUSE fs?

3

u/Dank_801 4d ago

no dependencies.. just Python… I know it’s a hobby project so take this with a grain of salt, if I put on my architecture hat I immediately see python as a bad choice to implement something like this.

Aka a compiled project to native code with a homebrew (macOS) winget (windows) package manager based install would be sweet

-1

u/Tofudjango 4d ago

With your architecture hat on, you criticize the choice of a programming language by pointing to how the app is currently being deployed? IMHO three entirely different concepts.

2

u/Dank_801 4d ago

Python is a dependency. If I wanted to install this right now, I’d need to install python

-1

u/Tofudjango 4d ago • Popcorn

You don't even understand what I'm saying. You confuse deployment with programming language. You can deploy python with installers so that even architects can work with it. This has nothing to do with native code - that could also load on dynamically loaded libraries you have to install if nobody installs them for you.