SPIFFS Backup and Restore

SPIFFS Backup and Restore

Menu Path

Device>Backup SPIFFS
Device>Restore SPIFFS

Info

SPIFFS contains persistent Marauder files and settings stored in internal flash. Beginning with v1.16.0, supported devices with an SD card can copy the contents of SPIFFS to /spiffs on the card and restore that backup later.

This is primarily intended to preserve compatible user data during firmware or partition-layout migrations. It is not a substitute for keeping a separate copy of important files off the Marauder.

Create a Backup

1. Insert a writable SD card with enough free space.
2. Navigate to Device>Backup SPIFFS.
3. Selecting the item starts the operation immediately. Wait for completion before removing the card or powering the device off.

The backup is assembled in /spiffs.tmp and only moved to /spiffs after the copy succeeds. An incomplete copy does not replace the existing backup.

Restore a Backup

1. Confirm that the SD card contains the expected /spiffs directory.
2. Navigate to Device>Restore SPIFFS.
3. Selecting the item starts the operation immediately. Wait for completion.
4. Reboot the Marauder and verify its settings and files.

Before restoring, Marauder creates a temporary rollback copy of the current SPIFFS contents. If the restore fails, it attempts to recover the original contents automatically.

Restore only onto compatible firmware and hardware. Files or settings from a newer or materially different firmware build may not be understood by an older build.

CLI Usage

backupspiffs
backupstatus
restorespiffs

backupstatus verifies that /spiffs exists on the SD card and reports its file and byte counts.

The following commands expose a framed JSON protocol for installers and migration tools:

protocolinfo --machine <transaction-id>
backupspiffs --machine <transaction-id>
backupstatus --machine <transaction-id>
restorespiffs --machine <transaction-id>

Machine-mode responses begin with @MARAUDER: and include the protocol version, transaction ID, command, result, counts, and a stable error code. Normal users should use the menu or human-readable commands unless an installer specifically requires machine mode.