Skip to content

Commit ed4c153

Browse files
authored
add pypi install info
1 parent 6d715e4 commit ed4c153

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,24 @@ is only stored on disk one time. If snapshots are deleted and a given hashed con
4141
then the `--gargbage-collect` flag will prompt `cacheback` to purge these unused hash-named files to recover storage space.
4242

4343
## Install
44-
`pip install cacheback`
44+
```
45+
pip install cacheback-snapshot
46+
```
4547

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.
56+
57+
```sh
58+
cacheback \
59+
--snapshot-name 'my-snapshot' \
60+
--destination /archives/ \
61+
--targets /home /opt \
62+
--exclude '**/*cache*' \
63+
--threads 2
64+
```

0 commit comments

Comments
 (0)