Skip to content

Backups

manage backups of clan machines

Usage: clan backups

Commands

This subcommand provides an interface to backups that clan machines expose.

Examples

$ clan backups list [MACHINE]

List backups for the machine [MACHINE]

$ clan backups create [MACHINE]

Create a backup for the machine [MACHINE].

$ clan backups restore [MACHINE] [PROVIDER] [NAME]

The backup to restore for the machine [MACHINE] with the configured [PROVIDER] with the name [NAME].

For more detailed information, visit: https://docs.clan.lol/getting-started/backups/

Backups create

Usage: clan backups create

Positional arguments

  1. machine: machine in the flake to create backups of
Options
  • --provider: backup provider to use
  • --debug: Enable debug logging
  • --option: <('name', 'value')> Nix option to set
  • --flake: <PATH> path to the flake where the clan resides in, can be a remote flake or local, can be set through the [CLAN_DIR] environment variable

Backups list

Usage: clan backups list

Positional arguments

  1. machine: machine in the flake to show backups of
Options
  • --provider: backup provider to filter by
  • --debug: Enable debug logging
  • --option: <('name', 'value')> Nix option to set
  • --flake: <PATH> path to the flake where the clan resides in, can be a remote flake or local, can be set through the [CLAN_DIR] environment variable

Backups restore

Usage: clan backups restore

Positional arguments

  1. machine: machine in the flake to create backups of
  2. provider: backup provider to use
  3. name: Name of the backup to restore
Options
  • --service: name of the service to restore
  • --debug: Enable debug logging
  • --option: <('name', 'value')> Nix option to set
  • --flake: <PATH> path to the flake where the clan resides in, can be a remote flake or local, can be set through the [CLAN_DIR] environment variable