Files
goblin-store/README.md
T

28 lines
728 B
Markdown

# Goblin Store
Incremental backup tool using rclone.
## Usage
To backup a directory, simply run it like so:
```shell
./goblin-store backup -s <SOURCE_DIRECTORY> -d <DESTINATION_DIRECTORY>
```
Breaking down the above:
* `./goblin-store` - running the app binary
* `backup` - call the **backup** command
* `-s <SOURCE_DIRECTORY>` - the directory you'd wish to backup (REQUIRED)
* `-d <DESTINATION_DIRECTORY>` - the directory you'd wish to store the backups in (REQUIRED)
You may modify the behavior with these additional flags:
* `-w <NUMBER>` - the number of worker threads to use to backup (default is **4**)
* `-v` - enable verbose console logging
## License
This project is available under the BSD 3-Clause license.