remarkable-backup

CLI in Go per backup manuale del reMarkable 2 via USB (SSH).

Scope MVP

• Backup manuale on-demand (run)
• Decodifica locale in copie leggibili (decode)
• Comando diagnostico (doctor)
• Mirror locale singolo (senza storico snapshot)
• Target iniziale: Windows

Build

go build ./...

Build Windows artifacts (PowerShell):

./scripts/build-windows.ps1 -Version v0.1.0

This generates:

• dist/windows-amd64/remarkable-backup.exe
• dist/windows-arm64/remarkable-backup.exe
• ZIP packages in dist/

Install the amd64 binary in user space and update user PATH:

./scripts/install-windows.ps1

GitHub Release automation

When a GitHub Release is published, the workflow .github/workflows/release-assets.yml builds and attaches:

• remarkable-backup-<tag>-windows-amd64.exe
• remarkable-backup-<tag>-windows-arm64.exe

Configurazione

Wizard rapido (consigliato):

remarkable-backup configure --config config.yaml

Il wizard chiede:

• password SSH del reMarkable
• cartella locale di backup

e crea un config.yaml completo con gli altri valori a default.

Alternativa manuale: copia config.example.yaml in config.yaml e aggiorna:

• device.password
• backup.local_destination

Comandi

Se --config non è specificato, il tool usa automaticamente ./config.yaml se presente nella directory corrente. Se avvii remarkable-backup senza argomenti, parte direttamente un backup (run) usando ./config.yaml. Su Windows questo permette anche il doppio click su remarkable-backup.exe (la finestra resta aperta fino a Invio).

Verifica prerequisiti:

remarkable-backup doctor --config config.yaml

Esegui backup:

remarkable-backup run --config config.yaml

Decodifica il backup raw in copie leggibili dentro una cartella sorella Documents:

remarkable-backup decode --config config.yaml

Il comando decode:

• copia *.pdf e *.epub con il nome leggibile preso da *.metadata
• ricrea la gerarchia delle cartelle del tablet
• esporta i notebook *.rm in PDF vettoriali con nome leggibile
• scrive tutto in Documents accanto alla cartella di backup raw

Esempio: se backup.local_destination è D:\backup\remarkable, l'output va in D:\backup\Documents.

Durante run viene mostrato avanzamento in tempo reale per file (COPY, SKIP, DELETE) oltre al riepilogo finale.

Override da CLI (precedenza rispetto al file YAML):

remarkable-backup run --config config.yaml --host 10.11.99.1 --dest D:\\backup\\remarkable --delete --dry-run

Flag principali

• --config: percorso YAML
• --host, --port, --user, --password
• --dest: destinazione locale
• --delete: rimuove file locali non più presenti sul device
• --dry-run: mostra azioni senza scrivere file
• --verify-hash: calcola hash locale post-sync
• --verbose: log dettagliato
• decode --dest: usa una cartella raw diversa da backup.local_destination

Limiti decode

• L'export dei notebook supporta il formato .rm version 5.
• I PDF esportati dai notebook usano una resa vettoriale semplice su sfondo bianco, senza template del tablet.

Note sicurezza

Nel MVP la password è salvata in chiaro nel file YAML, come richiesto.