restic-ez

Welcome to restic-ez 🎉

restic-ez provides a simple configuration loader and CLI-API around restic.

Configuration example

[restic]
dirs = "/Development"
repo = "s3:https://<url to s3 bucket>"
safe_restore = true

[restic.flags]
backup = [
    "--exclude-caches",
    "--iexclude", "/Development/Code/Swift/*/.swiftpm",
    "--iexclude", "/Development/Code/Swift/*/.build"
]

[credentials.restic]
command = "set -euo pipefail; pass <path to password file> | sed -n 1p"

[credentials.s3]
id = { value = "<insert your s3 key id here>" }
secret = { command = "set -euo pipefail; pass <path to password file> | sed -n 2p" }

Man page

Usage: restic-ez [verb]

Possible verbs are:
    create      Creates a new archive
    list        Lists the existing archives
    restore     Restores the latest archiv tagged with \"backup\"
    shell       Opens a shell session configured for easy manual restic invocation
    check       Checks the repository for consistency
    prune       Removes all unused chunks from the repository
    break-lock  Breaks a stale lock
    help        Displays this help

Specify the configuration using environment variables:
    RESTIC_EZ_CONFIG_TOML  Specifies the raw configuration toml string
    RESTIC_EZ_CONFIG       Specifies a custom path to a configuration file

Per default, restic-ez looks for the following config files:
    ./restic-ez
    ./restic-ez.conf
    ./restic-ez.toml
    ./.restic-ez
    ./.restic-ez.conf
    ./.restic-ez.toml