Restic-Scripts

My useful Restic scripts

Table of Contents

• Restic-Scripts
  • Table of Contents
  • Why this script
  • Description
    • Clean-Restic
      • Clean-Restic - Prerequisites
      • Clean-Restic - How to use
      • Clean-Restic - Examples
    • Get-ResticGameSnapshots
      • Get-ResticGameSnapshots - Prerequisites
      • Get-ResticGameSnapshots - How to use
      • Get-ResticGameSnapshots - Examples

Why this script

I use the extension Ludusavi Restic Playnite Plugin to backup my save game with Restic after my playing session. But, I got a lot of snapshots for my games, and my repository took 12 GiB on my computer. I decided to clean my repository for a specific game, and I wrote the script Clean-Restic to do it automatically.

Description

I will describe each scripts. At the moment, there is this script available only:

• Clean-Restic
• Get-ResticGameSnapshots

This script is on beta:

• Nothing for the moment

I plan to do this script (not exhaustive):

• Remove-ResticSnapshot
• Restore-ResticSnapshot

Clean-Restic

This first script help me to clean my Restic repository for a specific game. It takes at least the game name as parameter. This parameter is used to filter Restic snapshots by tag. You have four more optional parameters:

• TagFilter (string): Let you filter the snapshots of the game (eg: gameplay, manual).
• SnapshotToKeep (int): by default set in the setting file. You can specify how many snapshots you want to keep.
• NoDelete (switch): if you want to run the script without delete any snapshots, like a dry run.
• NoStats (switch): if you don't want the script show you the stats about your repository

You can also use the common parameters of PowerShell (-Debug, -Verbose, etc.).

The Get-Help command works too: Get-Help .\Clean-Restic.ps1

The script will generate a log file for each run and show you at the end the stats before and after the run (unless you specified the NoStats parameter). Example:

    Snapshot numbers:   311 / 275
    Total files backup: 62980 / 54042
    Total files size:   85.78 GB / 27.38 GB
    Total blobs:        41806 / 26232
    Total blobs size:   12.23 GB / 4.87 GB
    Ratio:              14.26 % / 17.77 %

If you use the parameter NoDelete you will only have the current stats of your repository.

    Snapshot numbers:   275
    Total files backup: 54042
    Total files size:   27.38 GiB
    Total blobs:        26232
    Total blobs size:   4.87 GiB
    Ratio:              17.77 %

Clean-Restic - Prerequisites

This script has only been testing with:

• PowerShellCore
  • 7.2.5
  • 7.3.x
• Restic
  • 0.13.1 compiled with go1.18 on windows/amd64
  • 0.14.0 compiled with go1.19 on windows/amd64
  • 0.15.2 compiled with go1.20.3 on windows/amd64

Clean-Restic - How to use

The most important part of this Readme!

1. Download all the files and folders, and put it in folder of your choice and create a folder named logs if necessary
2. Run the script in a PowerShell console! At the the first run, the script will ask you a couple of questions to create all the settings.¹

Clean-Restic - Examples

1. .\Clean-Restic.ps1 -Game "V Rising" ² Will clean snapshots for the game "V Rising" and keep the 5 latest snapshots

2. .\Clean-Restic.ps1 -Game "Cyberpunk 2077" -SnapshotToKeep 1 Will clean snapshots for the game "Cyberpunk 2077" and keep the latest snapshot

3. .\Clean-Restic.ps1 -Game "Raft" -SnapshotToKeep 10 -NoDelete Will show you the snapshots that should be deleted

4. .\Clean-Restic.ps1 -Game "Project Zomboid" -TagFilter "gameplay" -SnapshotToKeep 0 ³ Will remove all the gameplay sansphots for Project Zomboid

Get-ResticGameSnapshots

This script help me to list my Restic snapshot for a specific game. You don't have to know the tag in Restic, it will list you unique game tag at the beginning. You have two optional parameters:

• CountOnly (switch): only show a list of game with their number of snapshots. You can use PowerShell cmdlets (Select-Object, Sort-Object, Format-* and Where-Object) to filter precisely.
• Game (string): let you set the game that you want to show snapshots details. If you are wrong on the game name, an error message will appear and stop.

You can use the common parameters of PowerShell (-Debug, -Verbose, etc.). You can also use the Format-* cmdlet to pipeline (see examples below)

The Get-Help command works too: Get-Help .\Get-ResticGameSnapshots.ps1

The script will generate a log file for each run and show you at the end the list of snapshot for the game you choose. Example:

Game ShortId             DateTime Tags    No. Files Total Files Size No. Blobs Total Blobs Size  Ratio
---- -------             -------- ----    --------- ---------------- --------- ----------------  -----
Raft 5205211a 25/06/2022 13:23:12 stopped        19       940.73 KiB        20       946.35 KiB  100,6
Raft 95c83e6f 25/06/2022 17:58:25 stopped        27         2.21 MiB        28         2.22 MiB 100,36
Raft 967ca033 26/06/2022 16:12:01 stopped        29          2.6 MiB        30         2.61 MiB 100,31
Raft d2d5dea4 26/06/2022 17:06:51 stopped        29          2.6 MiB        30         2.61 MiB 100,31
Raft 94b6198d 26/06/2022 17:34:26 stopped        29         2.61 MiB        30         2.62 MiB 100,31
Raft b5a9838f 27/06/2022 08:41:32 stopped        29         2.63 MiB        30         2.64 MiB 100,34
Raft 9211b9ab 27/06/2022 13:23:16 stopped        29         2.65 MiB        30         2.66 MiB  100,3
Raft b0df7638 27/06/2022 15:33:08 stopped        29         2.66 MiB        30         2.67 MiB  100,3
Raft 79d79912 28/06/2022 08:43:42 stopped        29         2.67 MiB        30         2.68 MiB  100,3
Raft 6dd5e255 28/06/2022 09:19:11 stopped        29         2.67 MiB        30         2.67 MiB  100,3
Raft 40d79b4f 28/06/2022 11:05:54 stopped        29         2.69 MiB        30          2.7 MiB  100,3
Raft f516ad76 28/06/2022 17:06:08 stopped        29          2.7 MiB        30         2.71 MiB  100,3
Raft 76c746c0 29/06/2022 15:09:26 stopped        29         2.72 MiB        30         2.73 MiB 100,29
Raft 28c462ef 29/06/2022 16:03:06 stopped        29         2.75 MiB        30         2.75 MiB 100,29
Raft 61a7f899 29/06/2022 18:15:45 stopped        29         2.78 MiB        30         2.78 MiB 100,29
Raft c55d3ceb 30/06/2022 10:41:19 stopped        29         2.82 MiB        30         2.83 MiB 100,28
Raft 8940034c 11/07/2022 16:50:06 stopped        29         2.83 MiB        30         2.84 MiB 100,32

Get-ResticGameSnapshots - Prerequisites

This script has only been testing with:

• PowerShellCore
  • 7.2.5
  • 7.3.x
• Restic
  • 0.13.1 compiled with go1.18 on windows/amd64
  • 0.14.0 compiled with go1.19 on windows/amd64
  • 0.15.2 compiled with go1.20.3 on windows/amd64

Get-ResticGameSnapshots - How to use

Refer to Clean-Restic - How to use

Get-ResticGameSnapshots - Examples

1. Complete example for Weed Shop 3 .\Get-ResticGameSnapshots.ps1 | Format-Table -Autosize
2. Example for V Rising ^{4 5} .\Get-ResticGameSnapshots.ps1 -Game "V Rising" | Format-Table -Autosize
3. Shows the 10 games with the most snapshots ⁶ .\Get-ResticGameSnapshots.ps1 -CountOnly | Sort-Object Snapshots | Select-Object -Last 10

Footnotes

1. Settings creation in action: FR / EN ↩

2. Cleaning snapshots with default parameter in action: FR / EN ↩

3. Cleaning all gameplay snapshots in action: FR / EN ↩

4. Get snapshots for a game and format as table: FR / EN ↩

5. If game does not exist: FR / EN ↩

6. Show the 10 games with the most snapshots: FR / EN ↩