vellum-cli

An opinionated wrapper for Vellum's fork of Alpine's apk-tools that has been adapted for the constraints of the reMarkable platform.

Installation

wget --no-check-certificate -O bootstrap.sh https://github.com/vellum-dev/vellum-cli/releases/latest/download/bootstrap.sh
echo "3f2a4c721fa71919f747cec8047d34305179bf069be20db78ae98041525f2da4  bootstrap.sh" | sha256sum -c && bash bootstrap.sh

Usage

vellum add <package>       # Install a package
vellum del <package>       # Remove a package
vellum update              # Update package index
vellum upgrade             # Upgrade installed packages
vellum search <query>      # Search for packages
vellum info <package>      # Show package details
vellum check-os <version>  # Check package compatibility with an OS version
vellum reenable            # Restore system files after OS upgrade
vellum self uninstall      # Uninstall vellum (--all to include packages)

Most apk commands are passed through directly.

OS Compatibility

Before upgrading your reMarkable OS, check if installed packages will still work:

vellum check-os 3.24.0.149

After an OS upgrade, vellum detects the version change and requires vellum upgrade to sync packages.

How it works

• Keeps all package manager state in /home/root/.vellum/
• Generates virtual packages for device detection (rmpp, rm2, etc.) and OS version (remarkable-os)
• Checks package compatibility before OS upgrades
• Uses a local package repository for virtual packages
• Passes through to a statically-linked apk binary

Building

Requires Rust and cross for cross-compilation.

# Install cross
cargo install cross --git https://github.com/cross-rs/cross

# Build for arm64
cross build --release --target aarch64-unknown-linux-musl

# Build for armv7
cross build --release --target armv7-unknown-linux-musleabihf

Binaries will be in:

• target/aarch64-unknown-linux-musl/release/vellum (arm64)
• target/armv7-unknown-linux-musleabihf/release/vellum (armv7)

Related repositories

• vellum - Package registry
• apk-tools - Static apk binary

License

MIT