https://github.com/Penguin-Guru/remarkable-ssh
A Bash script to manage files on Remarkable devices via C.L.I. and S.S.H.
https://github.com/Penguin-Guru/remarkable-ssh
remarkable-tablet
Last synced: 3 months ago
JSON representation
A Bash script to manage files on Remarkable devices via C.L.I. and S.S.H.
- Host: GitHub
- URL: https://github.com/Penguin-Guru/remarkable-ssh
- Owner: Penguin-Guru
- License: gpl-3.0
- Created: 2026-02-18T21:32:58.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2026-03-04T03:20:58.000Z (4 months ago)
- Last Synced: 2026-03-04T05:27:06.485Z (4 months ago)
- Topics: remarkable-tablet
- Language: Shell
- Homepage:
- Size: 125 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-reMarkable - remarkable-ssh - A bash script to manage files on reMarkable devices via CLI and SSH. (Other / Template Builders)
README
## A Bash script to manage files on Remarkable devices via C.L.I. and S.S.H.
Remarkable's local A.P.I. and web interface are slow and lack essential features. I don't like cloud services and I couldn't find a script that worked, so I wrote my own. This is a work in progress but it already works very well for me. Please report any issues or incompatibilities-- there may be differences between product models, software versions, and personal workflows. I'm not currently aware of any product models or software versions this script will not work with, but I've created a [wiki page tracking compatibility](https://github.com/Penguin-Guru/remarkable-ssh/wiki/Known-To-Work-with) anyway.
### Dependencies:
- Bash (probably at least version 5.0).
- ssh.
- rsync.
- jq.
- find.
- sed.
## Usage:
Syntax, operations, parameters, and some introductory notes are all output by `remarkable-ssh help`. In fact, `help` is optional in that case. The `help` operation can also be specified with other operations for more topical information. What I have written here is intended to give prospective users a sense for what this script can do.
### Operations:
- `Help` by printing usage information.
- `Cache` scope operations.
- `Push` cache directory to Remarkable device.
- `Diff` (rsync format)
- `Pull` from Remarkable device to cache directory.
- `Diff` (rsync format)
- `Diff` (neutral table format)
- `List` objects, optionally within a folder and with optional recursive depth limit.
- `Add` files of supported types.
- `Rename` objects.
- `Delete` objects.
- `Make folder` objects.
- `Move objects` with respect to folders.
### Parameters:
- `Path` to cache directory.
- S.S.H. `host` value for Remarkable device.
- `Config` file path.
- Do `not add` new things.
- Do `not delete` anything.
- `Only add` new things.
- `Only delete` removed things.
- `Include unsupported` file types.
Running `cache push` or `cache pull` without any sync-related parameters will perform a full sync, including additions, deletions, and updates. Only updates can be achieved by specifying both `--no-add` and `--no-delete`.
## Set-up:
For this script to work, you will need S.S.H. access to your Remarkable device.
In theory, this should work on any operating system so long as the dependencies listed above are available. I do not know what Windows Subsystem for Linux provides. I have described the requirements for and process of connecting to Remarkable devices from a Linux host [here](https://wiki.gentoo.org/wiki/User:Penguin-Guru/Remarkable). Note that distribution kernels probably already support the necessary drivers and do not need to be rebuilt.
Once you've downloaded this script, run its `help` operation to get started. You are responsible for knowing what the commands you run will do. I strongly suggest running the `diff` sub-operations before any `push` or `pull` operations. This prints out what changes would be made without actually making them.
You may also want to create a backup of the files on your device. That can be achieved by running `remarkable-ssh --cache= --host= --unsupported-files cache pull`, where the backup cache directory specified is different from the cache directory you will normally be using. If you need to restore from the backup directory, just run the same command with `push` instead of `pull`.
### Config file:
Since the `--cache` and `--host` parameters must be specified for many operations, most users will want to define them in the optional config file.
Unless otherwise specified (by the `--config` parameter), the script will look for a file named "remarkable-ssh.conf" in either "$XDG_CONFIG_HOME" (if defined) or (otherwise) "~/.config".
The config file syntax is very simple:
- Lines must take the form of: `[=]`
- Whitespace leading and trailing each line is trimmed.
- Whitespace surrounding the '=' symbol is trimmed.
- If the first non-whitespace character on a line is the '[#](https://en.wikipedia.org/wiki/Number_sign)' symbol, the line is ignored.
- If the first two characters in a value string are a [tilde (~)](https://en.wikipedia.org/wiki/Tilde) and then forward slash, the tilde is [expanded](https://www.gnu.org/software/bash/manual/html_node/Tilde-Expansion.html).