Command Line Interface Tool

The *.pyz file of Prime Backup is not only an MCDR plugin, but also a Command-Line Interface (CLI) tool. You can run it with a valid Python 3 interpreter, provided all requirements are installed

$ python3 PrimeBackup.pyz
usage: PrimeBackup.pyz [-h] [-d DB] [-c CONFIG] [--version] [--debug]
                       {back,overview,export,extract,fuse,import,init,list,make,migrate_db,show}
                       ...

Prime Backup v1.x.x CLI tools

options:
  -h, --help            show this help message and exit
  -d DB, --db DB        Path to the prime_backup.db database file, or path to
                        the directory that contains the prime_backup.db
                        database file, e.g. "/my/path/prime_backup.db", or
                        "/my/path" (default: ./pb_files)
  -c CONFIG, --config CONFIG
                        Path to the Prime Backup config.json file. If omitted,
                        attempt to load ../config/prime_backup/config.json
                        relative to the database directory (default: None)
  --version             Show version and exit (default: False)
  --debug               Enable debug logging (default: False)

Command:
  {back,overview,export,extract,fuse,import,init,list,make,migrate_db,show}
                        Available commands
    back                Restore the server files to a backup
    overview            Show overview information of the database
    export              Export the given backup to a single file
    extract             Extract a single file / directory from a backup
    fuse                Mount all backups as a file system using libfuse
    import              Import a backup from the given file. The backup file
                        needs to have a backup metadata file
                        '.prime_backup.meta.json', or the --auto-meta option
                        need to be supplied
    init                Initialize a new database at the directory given by --db
    list                List backups
    make                Create a new backup
    migrate_db          Migrate the database to the current version X
    show                Show detailed information of the given backup

You can append --help to each subcommand to display its help message. For example:

$ python3 PrimeBackup.pyz export --help
usage: PrimeBackup.pyz export [-h] [-f FORMAT] [--fail-soft] [--no-verify]
                              [--no-meta]
                              backup_id output

Export the given backup to a single file

positional arguments:
  backup_id             The ID of the backup to export. Besides an integer     
                        ID, it can also be "latest" and "latest_non_temp"      
  output                The output file name of the exported backup. Example:  
                        my_backup.tar

options:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        The format of the output file. If not given, attempt   
                        to infer from the output file name. Options: tar,      
                        tar_gz, tar_bz2, tar_xz, tar_zst, zip
  --fail-soft           Skip files with export failure in the backup, so a     
                        single failure will not abort the export. Notes: a     
                        corrupted file might damaged the tar-based file        
  --no-verify           Do not verify the exported file contents
  --no-meta             Do not add the backup metadata file
                        '.prime_backup.meta.json' in the exported file

As a demonstration, here's an example usage that shows the overview of the database

$ python3 PrimeBackup.pyz -d run/pb_files overview
[2023-12-09 20:31:39,929 INFO] Storage root set to 'run/pb_files'
[2023-12-09 20:31:39,948 INFO] DB version: 1
[2023-12-09 20:31:39,948 INFO] Hash method: xxh128
[2023-12-09 20:31:39,948 INFO] Backup count: 2
[2023-12-09 20:31:39,948 INFO] Blob count: 9108
[2023-12-09 20:31:39,949 INFO] Blob stored size sum: 5158485126 (4.80GiB)
[2023-12-09 20:31:39,949 INFO] Blob raw size sum: 8295323157 (7.73GiB)
[2023-12-09 20:31:39,949 INFO] File count: 22010
[2023-12-09 20:31:39,949 INFO] File raw size sum: 16610326638 (15.47GiB)