Rowankeep
Docs / Reference

Command line

All commands take the global flags below. rowankeep help COMMAND prints the help of a command.

Global flags

FlagDescription
--config FILEConfiguration file. Default: /etc/rowankeep/rowankeep.toml.
--log-level LEVELdebug, info, warn or error.
-h, --helpShow help for a command.
-v, --versionPrint the version and exit.

rowankeep init

Create a new repository. The repository is created at the location given by --repo or the repository option. You are asked for a password unless password_file is set.

rowankeep init [flags]
FlagDefaultDescription
--repo URL–Where to create the repository.
--compression MODEautoDefault compression for new data: off, auto or max.

rowankeep backup

Make a snapshot of the given paths. Only data that is not in the repository yet is read from disk and uploaded. Files whose size and modification time did not change since the last snapshot are not read at all.

rowankeep backup [flags] PATH...
FlagDefaultDescription
--exclude PATTERN–Leave out paths matching the pattern. May be given more than once.
--exclude-file FILE–Read exclude patterns from a file, one per line.
--tag TAG–Add a tag to the snapshot.
--one-file-systemfalseDo not cross into other mounted filesystems.
--dry-runfalseShow what would be backed up without writing anything.

rowankeep snapshots

List the snapshots in the repository.

rowankeep snapshots [flags]
FlagDefaultDescription
--tag TAG–Only list snapshots with this tag.
--host HOST–Only list snapshots made on this host.
--jsonfalsePrint the list as JSON.

rowankeep restore

Restore files from a snapshot. SNAPSHOT is a snapshot ID, a unique prefix of one, or latest.

rowankeep restore [flags] SNAPSHOT
FlagDefaultDescription
--target DIR–Folder to restore into. Required.
--include PATTERN–Only restore paths matching the pattern.
--verifyfalseRead the restored files back and compare them with the snapshot.

rowankeep prune

Remove snapshots the retention policy no longer keeps. Data that is no longer used by any snapshot is deleted from the repository afterwards.

rowankeep prune [flags]
FlagDefaultDescription
--keep-daily N7Keep the last snapshot of each of the last N days.
--keep-weekly N4Keep the last snapshot of each of the last N weeks.
--keep-monthly N12Keep the last snapshot of each of the last N months.
--dry-runfalseShow what would be removed.

rowankeep check

Verify the structure and data of the repository. Without flags only the index and the snapshot trees are checked, which is quick. --read-data downloads and decrypts every chunk.

rowankeep check [flags]
FlagDefaultDescription
--read-datafalseRead and verify all data.
--read-data-subset N%–Read and verify a random part of the data.

rowankeep mount

Mount a snapshot as a read-only folder. Available on Linux and macOS. The folder stays mounted until you press Ctrl+C or unmount it.

rowankeep mount [flags] SNAPSHOT DIR
FlagDefaultDescription
--allow-otherfalseLet other users read the mounted folder.

rowankeep completion

Print a shell completion script. SHELL is bash, zsh or fish.

rowankeep completion SHELL