Skip to main content

lium bk

Configure backups, inspect their progress, restore data, and manage active or completed operations.

lium bk SUBCOMMAND [ARGS] [OPTIONS]

Subcommands​

SubcommandPurpose
nowTrigger an immediate one-off backup
setConfigure a recurring backup schedule for a pod
showShow the backup config and recent backups for a pod
cancelCancel an active backup while keeping its history
deleteDelete the stored data for a completed backup
restoreRestore a backup into a pod
restore-cancelCancel an active restore
rmDelete the backup config for a pod
logsShow backup job logs
restore-logsShow restore job logs

lium bk now POD_ID​

Trigger a backup right now.

FlagEffect
-n, --name NAMEBackup name (e.g. pre-release)
-d, --description TEXTBackup description
lium bk now my-pod -n pre-release -d "snapshot before deploy"

lium bk set POD_ID​

Configure a recurring backup schedule.

FlagEffect
--path PATHRequired. Explicit path inside the pod's local volume
--every DURATIONFrequency (e.g. 1h, 6h, 24h)
--keep DURATIONRetention (e.g. 1d, 7d, 30d)
-y, --yesSkip the confirmation prompt
lium bk set my-pod --path /root/checkpoints --every 6h --keep 7d
lium bk set my-pod --path /root --every 24h --keep 30d -y

Backing up the entire local volume is allowed, but the CLI warns that a stable subdirectory is usually more reliable.

lium bk show POD_ID​

Show the backup config and history for a pod.

lium bk show my-pod

lium bk cancel --id BACKUP_ID​

Cancel an active backup. Cancellation retains the backup row and its last reported progress.

FlagEffect
--id BACKUP_IDRequired. Active backup ID
-y, --yesSkip the confirmation prompt
lium bk cancel --id 8fbb30f6

lium bk delete --id BACKUP_ID​

Delete the stored data for a completed backup. This is separate from cancelling an active backup or removing a backup configuration.

FlagEffect
--id BACKUP_IDRequired. Completed backup ID
-y, --yesSkip the confirmation prompt
lium bk delete --id 8fbb30f6

lium bk restore POD_ID --id BACKUP_ID​

Restore a backup into a pod.

FlagEffect
--id BACKUP_IDRequired. Backup ID to restore
--to PATHNew or empty restore directory (default: <volume path>/restored)
-y, --yesSkip confirmation
lium bk restore my-pod --id 8fbb30f6
lium bk restore my-pod --id 8fbb30f6 --to /root/checkpoints-restored -y

The restore runs in the background. Do not modify the destination until lium bk restore-logs reports that the operation has completed.

lium bk restore-cancel --id RESTORE_ID​

Cancel an active restore. Files already written to the destination may remain.

FlagEffect
--id RESTORE_IDRequired. Active restore ID
-y, --yesSkip the confirmation prompt
lium bk restore-cancel --id 9b6c8d90

lium bk rm POD_ID​

Delete the backup configuration for a pod. Existing completed backups remain available until they expire or are deleted separately.

lium bk rm my-pod -y

lium bk logs [POD_ID]​

Show backup history and progress. POD_ID is optional; use --id to inspect one backup directly, including after its source pod has been deleted.

The command displays lifecycle status, percentage, bytes and files, throughput, elapsed time, and an estimate when the backend has enough data to provide one.

lium bk logs                          # Recent jobs across all pods
lium bk logs my-pod # Jobs for one pod
lium bk logs --id 8fbb30f6 # Details for one backup

lium bk restore-logs [POD_ID]​

Show restore status and progress for one pod. With --id, show details for one restore. Specify either POD_ID or --id.

FlagEffect
--id RESTORE_IDRestore log ID to inspect
lium bk restore-logs my-pod           # Restore jobs for one pod
lium bk restore-logs --id 9b6c8d90 # Details for one restore

The --id options accept either a full UUID or the eight-character ID printed by CLI history tables. Matching is scoped to the authenticated user's data.

See also​

  • Backups — concept guide and schedule policies
  • Restores — concept guide
  • lium volumes — for detached storage instead of pod backups