Common Commands

Common Commands

• diff - Displays differences between two repository objects (files or directories)
• list - List a directory stored in repository object
• restore - Restore a directory or a file
• show - Displays the contents of a repository object
• mount - Mount repository object as a local filesystem

Commands to test performance of algorithms

• benchmark compression - Run compression benchmarks
• benchmark crypto - Run combined hash and encryption benchmarks
• benchmark splitter - Run splitter benchmarks
• benchmark hashing - Run hashing function benchmarks
• benchmark encryption - Run encryption benchmarks
• benchmark ecc - Run ECC benchmarks

Commands to control HTTP API server

• server start - Start Kopia server
• server acl add - Add ACL entry
• server acl delete - Delete ACL entry
• server acl enable - Enable ACLs and install default entries
• server acl list - List ACL entries
• server users add - Add new repository user
• server users set - Set password for a repository user
• server users delete - Delete user
• server users info - Info about particular user
• server users list - List users
• server status - Status of Kopia server
• server refresh - Refresh the cache in Kopia server to observe new sources, etc
• server flush - Flush the state of Kopia server to persistent storage, etc
• server shutdown - Gracefully shutdown the server
• server snapshot - Trigger upload for one or more existing sources
• server cancel - Cancels in-progress uploads for one or more sources
• server pause - Pause the scheduled snapshots for one or more sources
• server resume - Resume the scheduled snapshots for one or more sources
• server throttle get - Get throttling parameters for a running server
• server throttle set - Set throttling parameters for a running server

Commands to manipulate snapshots

• snapshot copy-history - Performs a copy of the history of snapshots from another user or host
• snapshot move-history - Performs a move of the history of snapshots from another user or host
• snapshot create - Creates a snapshot of local directory or file
• snapshot delete - Explicitly delete a snapshot by providing a snapshot ID
• snapshot estimate - Estimate the snapshot size and upload time
• snapshot expire - Remove old snapshots according to defined expiration policies
• snapshot fix invalid-files - Remove references to any invalid (unreadable) files from snapshots
• snapshot fix remove-files - Remove references to the specified files from snapshots
• snapshot list - List snapshots of files and directories
• snapshot migrate - Migrate snapshots from another repository
• snapshot pin - Add or remove pins preventing snapshot deletion
• snapshot restore - Restore a directory or a file
• snapshot verify - Verify the contents of stored snapshot

Commands to manipulate snapshotting policies

• policy edit - Set snapshot policy for a single directory, user@host or a global policy
• policy list - List policies
• policy delete - Remove snapshot policy for a single directory, user@host or a global policy
• policy set - Set snapshot policy for a single directory, user@host or a global policy
• policy show - Show snapshot policy

Commands to manipulate repository

• repository connect server - Connect to a repository API Server
• repository connect from-config - Connect to repository in the provided configuration file
• repository connect azure - Connect to repository in an Azure blob storage
• repository connect b2 - Connect to repository in a B2 bucket
• repository connect filesystem - Connect to repository in a filesystem
• repository connect gcs - Connect to repository in a Google Cloud Storage bucket
• repository connect gdrive - Connect to repository in a Google Drive folder
• repository connect rclone - Connect to repository in a rclone-based provided
• repository connect s3 - Connect to repository in an S3 bucket
• repository connect sftp - Connect to repository in an SFTP storage
• repository connect webdav - Connect to repository in a WebDAV storage
• repository create from-config - Create repository in the provided configuration file
• repository create azure - Create repository in an Azure blob storage
• repository create b2 - Create repository in a B2 bucket
• repository create filesystem - Create repository in a filesystem
• repository create gcs - Create repository in a Google Cloud Storage bucket
• repository create gdrive - Create repository in a Google Drive folder
• repository create rclone - Create repository in a rclone-based provided
• repository create s3 - Create repository in an S3 bucket
• repository create sftp - Create repository in an SFTP storage
• repository create webdav - Create repository in a WebDAV storage
• repository disconnect - Disconnect from a repository
• repository repair from-config - Repair repository in the provided configuration file
• repository repair azure - Repair repository in an Azure blob storage
• repository repair b2 - Repair repository in a B2 bucket
• repository repair filesystem - Repair repository in a filesystem
• repository repair gcs - Repair repository in a Google Cloud Storage bucket
• repository repair gdrive - Repair repository in a Google Drive folder
• repository repair rclone - Repair repository in a rclone-based provided
• repository repair s3 - Repair repository in an S3 bucket
• repository repair sftp - Repair repository in an SFTP storage
• repository repair webdav - Repair repository in a WebDAV storage
• repository set-client - Set repository client options
• repository set-parameters - Set repository parameters
• repository status - Display the status of connected repository
• repository sync-to from-config - Synchronize repository data to another repository in the provided configuration file
• repository sync-to azure - Synchronize repository data to another repository in an Azure blob storage
• repository sync-to b2 - Synchronize repository data to another repository in a B2 bucket
• repository sync-to filesystem - Synchronize repository data to another repository in a filesystem
• repository sync-to gcs - Synchronize repository data to another repository in a Google Cloud Storage bucket
• repository sync-to gdrive - Synchronize repository data to another repository in a Google Drive folder
• repository sync-to rclone - Synchronize repository data to another repository in a rclone-based provided
• repository sync-to s3 - Synchronize repository data to another repository in an S3 bucket
• repository sync-to sftp - Synchronize repository data to another repository in an SFTP storage
• repository sync-to webdav - Synchronize repository data to another repository in a WebDAV storage
• repository throttle get - Get throttling parameters for a repository
• repository throttle set - Set throttling parameters for a repository
• repository change-password - Change repository password
• repository validate-provider - Validates that a repository provider is compatible with Kopia