Commands

/backup <operation>

[help]

Get help about all commands.

[reload]

Reload the configuration.

[create] [<comment>]

Create a new backup.

Example

You can add an optional comment to the backup. /backup create "House is done!"

[restore] (latest|<name>)

Restore a backup.

Example

/backup restore latest or /backup restore "2025.07.20_14-30-20.zip"

[delete] <name>

Delete a backup.

Example

/backup delete "2025.07.20_14-30-20.zip"

[abort]

Terminate the current action (ex. making a current backup or restoring a current backup).

[list]

Lists all available backups. Clicking on a backup will auto suggest the corresponding info command.

Example

/backup list outputs:

- "2025.07.20_14-30-20.zip" *House is done!*
- "2025.07.20_00-00-00.zip"

Clicking on "2025.07.20_00-00-00.zip" will auto suggest: /backup info "2025.07.20_00-00-00.zip"

[info] <name>

Get information about a backup. Clicking on [Copy to clipboard] will copy the information in the configured format to the clipboard.

Example

/backup info "2025.07.20_14-30-20.zip" outputs:

Backup "2025.07.20_14-30-20.zip" (manual)
*House is done!*

Date: 20.07.2025
Time: 14:30:20
Size: 2.4GB
Compression Level: 7
Files (root):
  - level.dat
  - ...

[Copy to clipboard]

Clicking on [Copy to clipboard] will copy the following to the clipboard (ex. json):

{
  "name": "2025.07.20_14-30-20.zip",
  "comment": "House is done!",
  "scheduled": false,
  "timestamp": "2025-07-20T14:30:20.000Z",
  "size": "2.4GB",
  "compressionLevel": 7,
  "files": [
    "level.dat"
  ]
}

[cleanup]

Start a cleanup procedure (deletes all old backups according to the config).