https://github.com/rmitchellscott/rmtree
A tree-style display tool for the reMarkable tablet's document filesystem, showing the hierarchical structure of documents and folders.
https://github.com/rmitchellscott/rmtree
remarkable-tablet
Last synced: 5 months ago
JSON representation
A tree-style display tool for the reMarkable tablet's document filesystem, showing the hierarchical structure of documents and folders.
- Host: GitHub
- URL: https://github.com/rmitchellscott/rmtree
- Owner: rmitchellscott
- License: mit
- Created: 2025-09-24T20:14:05.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2026-01-10T17:39:12.000Z (5 months ago)
- Last Synced: 2026-01-11T05:20:16.434Z (5 months ago)
- Topics: remarkable-tablet
- Language: Go
- Homepage:
- Size: 33.2 KB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-reMarkable - rmtree - Unix-style tree command for the reMarkable's document filesystem. (Device Tools / Template Builders)
README
# rmtree
[](https://remarkable.com/store/remarkable)
[](https://remarkable.com/store/remarkable-2)
[](https://remarkable.com/products/remarkable-paper/pro)
[](https://remarkable.com/products/remarkable-paper/pro-move)
A tree-style display tool for the reMarkable tablet's document filesystem, showing the hierarchical structure of documents and folders.
### Automatic Installation (Recommended)
> [!CAUTION]
> Piping code from the internet directly into `bash` can be dangerous. Make sure you trust the source and know what it will do to your system.
The easiest way to install is using the installation script that automatically detects your device architecture:
```bash
wget -qO- https://github.com/rmitchellscott/rmtree/raw/main/install.sh | bash
```
### Manual Installation
Download the correct binary for your device:
```bash
# For reMarkable 1/2 (ARMv7):
wget https://github.com/rmitchellscott/rmtree/releases/latest/download/rmtree-armv7.tar.gz
tar -xzf rmtree-armv7.tar.gz
mv rmtree-armv7 rmtree
chmod +x rmtree
# For reMarkable Paper Pro & Paper Pro Move (ARM64):
wget https://github.com/rmitchellscott/rmtree/releases/latest/download/rmtree-aarch64.tar.gz
tar -xzf rmtree-aarch64.tar.gz
mv rmtree-aarch64 rmtree
chmod +x rmtree
```
## Usage
```bash
./rmtree [path] [options]
```
**Default path**: `/home/root/.local/share/remarkable/xochitl`
## Options
- `--icons`, `-i` - Show emoji icons (📁 📕 📗 📓)
- `--labels`, `-l` - Show document type labels (pdf), (epub), (notebook)
- `--uuid`, `-u` - Show document UUIDs in square brackets (documents only, not folders)
- `--no-color`, `-n` - Disable colored output
- `--version`, `-v` - Show version information
## Examples
**Default** (clean, colored):
```
.
├── Books
│ └──Project Hail Mary
├── Calendar
│ └── Calendar-2025
└── To Do
```
**With labels** (`--labels`):
```
.
├── Books
│ └── Project Hail Mary (epub)
├── Calendar
│ └── Calendar-2025 (pdf)
└── To Do (notebook)
```
**With icons and labels** (`--icons --labels`):
```
.
├── 📁 Books
│ └── 📗 Project Hail Mary (epub)
├── 📁 Calendar
│ └── 📕 Calendar-2025 (pdf)
└── 📓 To Do (notebook)
```
**With UUIDs** (`--uuid`):
```
.
├── Books
│ └──Project Hail Mary [3f05b2d1-90e0-458a-b233-7966564d2172]
├── Calendar
│ └── Calendar-2025 [67f60935-7978-4fe4-b234-64b70ed17c3e]
└── To Do [d1a44483-3023-4b16-b677-ea75211252ca]
```