Skip to main content
gandalf restore builds a restore plan from a saved snapshot and, with explicit opt-in flags, applies it. Dry-run is the default. Apply requires both --apply and --experimental (or GANDALF_EXPERIMENTAL=1), and Gandalf creates a pre-apply restore point before writing.

Synopsis

Flags

--dry-run and --apply are mutually exclusive.

Examples

Preview

Apply after review

Apply with automatic rollback on failure

Plan output shape

The dry-run text preview prints:
  • Snapshot name, target project, target home
  • Writable change count and unsupported item count
  • Risk summary (critical, high, medium, low, none)
  • Per-item entries with kind, action, source path, risk, rollback instruction, and changed fields
  • Unsupported items with reasons
Add --json for the full RestorePlan structure.
--apply requires --experimental or GANDALF_EXPERIMENTAL=1. Without either, Gandalf returns GANDALF_EXPERIMENTAL_REQUIRED and does not write.