You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-1Lines changed: 20 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,5 +41,24 @@ is only stored on disk one time. If snapshots are deleted and a given hashed con
41
41
then the `--gargbage-collect` flag will prompt `cacheback` to purge these unused hash-named files to recover storage space.
42
42
43
43
## Install
44
-
`pip install cacheback`
44
+
```
45
+
pip install cacheback-snapshot
46
+
```
45
47
48
+
## Usage
49
+
>[!NOTE]
50
+
> The first time taking a snapshot will take much longer than subsequent snapshots, since the first run will need to copy any and all files to the snapshot storage directory. The real magic of this tool happens on the *subsequent* snapshots that target mostly the same directories.
51
+
52
+
Installing the package will add an entrypoint executable `cacheback` to your configured executables directory. Run `cacheback --help` for detailed usage information.
53
+
54
+
### Sample
55
+
This example will create a snapshot in the directory in /archives/my-snapshot of the contents of /home/ and /opt/ on the current machine, and will omit including any directories or files that have the word "cache" in them. It will use 2 threads to scan over the directory hierarchies and compute hashes.
0 commit comments