Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Command Reference

CommandDescription
vykarRun full backup process: backup, prune, compact, check. This is useful for automation.
vykar configGenerate a starter configuration file
vykar initInitialize a new backup repository
vykar backupBack up files to a new snapshot
vykar restoreRestore files from a snapshot
vykar listList snapshots
vykar snapshot listShow files and directories inside a snapshot
vykar snapshot infoShow metadata for a snapshot
vykar snapshot findFind matching files across snapshots and show change timeline (added, modified, unchanged)
vykar snapshot deleteDelete a specific snapshot
vykar deleteDelete an entire repository permanently
vykar prunePrune snapshots according to retention policy
vykar break-lockRemove stale repository locks left by interrupted processes when lock conflicts block operations
vykar checkVerify repository integrity (--verify-data for full content verification)
vykar infoShow repository statistics (snapshot counts and size totals)
vykar compactFree space by repacking pack files after delete/prune
vykar mountBrowse snapshots via a local WebDAV server

Exit codes

  • 0: Success
  • 1: Error (command failed)
  • 3: Partial success (backup completed, but one or more files were skipped)

vykar backup and the default vykar workflow can return 3 when a backup succeeds with skipped unreadable/missing files.