don't miss out

sign-up for newsletter to stay in the loop

subscribe to our newsletter

Newsletter
download

Backuply CLI Commands

All-in-one solution for Backup, Restore and Migration.

Backuply CLI Commands

Install Backuply Server

This section explains how to install the Backuply Server using the official installation script.

wget -O backuply.sh https://a.softaculous.com/backuply-server/files/install.sh
chmod +x backuply.sh
./backuply.sh

Backuply Version

This command displays the currently installed Backuply version.

backuply -v

Update Backuply

Updates the Backuply installation to the latest available version directly from the terminal.

backuply --update

Backuply License Details

This command displays the current license details for Backuply.

backuply -l

Sample Output

Backuply License : BACSER--XXXXX-XXXXX-XXXXX-XXXXX
Type : Premium
Expires (DD/MM/YYYY) : Never
License IP : -XXXXX-XXXXX

Refresh License

This command Forces a license refresh from the Backuply licensing server.

backuply --refresh-license

Fix Permissions

Resets file and directory permissions to ensure proper functioning of Backuply.

backuply --fix_permissions

Backuply Repair

This command runs internal repair routines to fix issues related to:
1. 
Corrupted installation files
2. 
Missing binaries
3. 
Misconfigured components

backuply --repair

Rebuild Database

This command rebuilds Backuply’s internal SQLite databases to fix inconsistencies

backuply --db_rebuild

Backuply Logs – Commands & Usage

1. Error Logs

Shows live system errors and failures.

tail -f /var/backuply/logs/error_log.log

2. Admin Auto Backup Logs

This command shows real-time logs of automated (cron-based) backup processes.

tail -f /var/backuply/logs/admin_auto_backup.log

3. Enduser Backup Logs

This command Displays live logs of backups triggered by end users.

tail -f /var/backuply/logs/admin_enduser_backup.log

4. Admin Auto Restore Logs

This command Monitors automated restore operations in real-time.

tail -f /var/backuply/logs/admin_auto_restore.log

5. Enduser Restore Logs

This command Shows restore activities initiated by users.

tail -f /var/backuply/logs/admin_enduser_restore.log

6. Download Logs

Displays real-time logs of backup download activity.

tail -f /var/backuply/logs/download.log

7. Sync Logs

Monitors synchronization between local and remote backup storage.

tail -f /var/backuply/logs/sync_backups.log

8. Restic Cache Logs

This command show logs related to Restic cache operations.

tail -f /var/backuply/logs/restic_cache.log

9. Task Database Logs

Tracks internal task execution and database activities.

tail -f /var/backuply/logs/task_db.log

10. Installation Logs

Shows logs of package installation and dependency setup.

tail -f /var/backuply/logs/install_packages.log

Verify Cache Status & Restic Cache Cleanup

1. Verify Cache Status

Displays the current status and location of Restic cache directories.

restic cache

2. Cleanup Restic Cache

Removes all existing Restic cache directories immediately.

restic cache --cleanup --max-age=0

Install/Update Restic Engine

 Installs or updates the Restic backup engine used by Backuply.

backuply --install_restic

Install/Update Borg Engine

Installs or updates the Borg backup engine.

backuply --install_borg

Clean Orphaned Backups

Removes orphaned backup records that no longer exist on storage

backuply --clean_backups

    Was this page helpful?
    Newsletter Subscription
    Subscribing you to the mailing list