Skip to content

rmitchellscott/rmtree

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

28 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

rmtree

rm1 rm2 rmpp rmppm vellum

A tree-style display tool for the reMarkable tablet's document filesystem, showing the hierarchical structure of documents and folders.

Installation via Vellum package manager

vellum install rmtree

Automatic Installation

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:

wget -qO- https://github.com/rmitchellscott/rmtree/raw/main/install.sh | bash

Manual Installation

Download the correct binary for your device:

# 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

./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]

About

A tree-style display tool for the reMarkable tablet's document filesystem, showing the hierarchical structure of documents and folders.

Topics

Resources

License

Stars

Watchers

Forks

Contributors