Common Commands
Common Commands
diff- Displays differences between two repository objects (files or directories)list- List a directory stored in repository objectrestore- Restore a directory or a fileshow- Displays the contents of a repository objectmount- Mount repository object as a local filesystem
Commands to test performance of algorithms
benchmark compression- Run compression benchmarksbenchmark crypto- Run combined hash and encryption benchmarksbenchmark splitter- Run splitter benchmarksbenchmark hashing- Run hashing function benchmarksbenchmark encryption- Run encryption benchmarksbenchmark ecc- Run ECC benchmarks
Notifications
notification profile configure email- E-mail notificationnotification profile configure pushover- Pushover notificationnotification profile configure webhook- Webhook notificationnotification profile delete- Delete notification profilenotification profile test- Send test notificationnotification profile list- List notification profilesnotification profile show- Show notification profilenotification template list- List templatesnotification template set- Set the notification templatenotification template show- Show templatenotification template remove- Remove the notification template
Commands to control HTTP API server
server start- Start Kopia serverserver acl add- Add ACL entryserver acl delete- Delete ACL entryserver acl enable- Enable ACLs and install default entriesserver acl list- List ACL entriesserver users add- Add new repository userserver users set- Set password for a repository userserver users delete- Delete userserver users hash-password- Hash a user password that can be passed to the ‘server user add/set’ commandserver users info- Info about particular userserver users list- List usersserver status- Status of Kopia serverserver refresh- Refresh the cache in Kopia server to observe new sources, etcserver flush- Flush the state of Kopia server to persistent storage, etcserver shutdown- Gracefully shutdown the serverserver snapshot- Trigger upload for one or more existing sourcesserver cancel- Cancels in-progress uploads for one or more sourcesserver pause- Pause the scheduled snapshots for one or more sourcesserver resume- Resume the scheduled snapshots for one or more sourcesserver throttle get- Get throttling parameters for a running serverserver 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 hostsnapshot move-history- Performs a move of the history of snapshots from another user or hostsnapshot create- Creates a snapshot of local directory or filesnapshot delete- Explicitly delete a snapshot by providing a snapshot IDsnapshot estimate- Estimate the snapshot size and upload timesnapshot expire- Remove old snapshots according to defined expiration policiessnapshot fix invalid-files- Remove references to any invalid (unreadable) files from snapshotssnapshot fix remove-files- Remove references to the specified files from snapshotssnapshot list- List snapshots of files and directoriessnapshot migrate- Migrate snapshots from another repositorysnapshot pin- Add or remove pins preventing snapshot deletionsnapshot restore- Restore a directory or a filesnapshot verify- Verify the contents of stored snapshot
Commands to manipulate snapshotting policies
policy edit- Edit policypolicy list- List policiespolicy delete- Remove policypolicy set- Set policypolicy show- Show snapshot policypolicy export- Exports the policies to the specified file, or to stdout if none is specifiedpolicy import- Imports policies from a specified file, or stdin if no file is specified
Commands to manipulate repository
repository connect server- Connect to a repository API Serverrepository connect from-config- Connect to repository in the provided configuration filerepository connect azure- Connect to repository in an Azure blob storagerepository connect b2- Connect to repository in a B2 bucketrepository connect filesystem- Connect to repository in a filesystemrepository connect gcs- Connect to repository in a Google Cloud Storage bucketrepository connect gdrive- Connect to repository in a Google Drive folderrepository connect rclone- Connect to repository in a rclone-based providedrepository connect s3- Connect to repository in an S3 bucketrepository connect sftp- Connect to repository in an SFTP storagerepository connect webdav- Connect to repository in a WebDAV storagerepository create from-config- Create repository in the provided configuration filerepository create azure- Create repository in an Azure blob storagerepository create b2- Create repository in a B2 bucketrepository create filesystem- Create repository in a filesystemrepository create gcs- Create repository in a Google Cloud Storage bucketrepository create gdrive- Create repository in a Google Drive folderrepository create rclone- Create repository in a rclone-based providedrepository create s3- Create repository in an S3 bucketrepository create sftp- Create repository in an SFTP storagerepository create webdav- Create repository in a WebDAV storagerepository disconnect- Disconnect from a repositoryrepository set-client- Set repository client optionsrepository set-parameters- Set repository parametersrepository status- Display the status of connected repositoryrepository sync-to from-config- Synchronize repository data to another repository in the provided configuration filerepository sync-to azure- Synchronize repository data to another repository in an Azure blob storagerepository sync-to b2- Synchronize repository data to another repository in a B2 bucketrepository sync-to filesystem- Synchronize repository data to another repository in a filesystemrepository sync-to gcs- Synchronize repository data to another repository in a Google Cloud Storage bucketrepository sync-to gdrive- Synchronize repository data to another repository in a Google Drive folderrepository sync-to rclone- Synchronize repository data to another repository in a rclone-based providedrepository sync-to s3- Synchronize repository data to another repository in an S3 bucketrepository sync-to sftp- Synchronize repository data to another repository in an SFTP storagerepository sync-to webdav- Synchronize repository data to another repository in a WebDAV storagerepository throttle get- Get throttling parameters for a repositoryrepository throttle set- Set throttling parameters for a repositoryrepository change-password- Change repository passwordrepository validate-provider- Validates that a repository provider is compatible with Kopia