rmirro.py synchronizes files between your reMarkable and computer in both directions without cloud access.
It pulls PDFs of your reMarkable's documents to a folder on your computer,
and pushes PDFs and EPUBs that you add to this folder back to your reMarkable.
Effectively, this tool integrates your reMarkable with your computer's file system,
so you can build your own workflow on top.
- Passwordless SSH access to your reMarkable with
ssh remarkable. - Access to the reMarkable's official PDF renderer through its USB web interface or any third-party PDF renderer of raw reMarkable files on your computer, like maxio, rmrl or rmc.
- rsync (comes with most Linux distributions, by default).
Just run rmirro.py. Read rmirro.py --help to see how you can change its default behavior.
It synchronizes files between the reMarkable (RM) and the computer (PC) folder ./remarkable/.
The first run it processes all files on the reMarkable and may take a long time,
but following runs skip unchanged files and are quicker.
What is done to each file depends on where it is present and when it was last modified:
| If a file is ... | then rmirro.py will ... |
|---|---|
| added/modified on RM (more recently than on PC), | pull it to PC (overwriting any existing file). |
| added/modified on PC (more recently than on RM), | push it to RM (overwriting any existing file). |
| deleted on RM, | drop (delete) it on PC, too. |
| deleted on PC, | pull it to PC again (not delete it on RM, for safety). |
The program asks for confirmation before carrying out its intended file actions.
Beware that this is a hobby project with the potential to overwrite and delete files on your reMarkable and computer,
and that it may have bugs!
To mitigate this, rmirro.py begins by making a raw backup of your reMarkable in ./remarkable_backup/.
Run rm_sync_on_connect_setup.sh with root access to install an udev rule
that automatically runs rmirro.py when your reMarkable is connected to the computer with a USB cable.
rmirro is what you get by shifting the characters in mirror cyclically one step to the right.