docs: More help/usage

This commit is contained in:
mycroft committed 2024-10-08 21:33:37 +02:00
1 parent c115babaca
commit 3c52c40250
2 files changed
+34 -3

No files matched your search

+18 -1
View File
@@ -9,7 +9,24 @@ The included workflow that actually performs the backup can be manually run thro
## Usage
```sh
$ /bin/bash scripts/backup.sh -r <repository> -b <branch> -d </path/to/data> [-n <commit limit>] [-v] [-x]
$ scripts/backup.sh -h
Usage: scripts/backup.sh [-r <repository url>] [-b <branch>] [-d <path dest>] [-n <num>] [-v] [-x] [-i] [-h]
Ex: scripts/backup.sh \
-r https://github.com/descartes-underwriting/devops-technical-test-data.git \
-b main \
-d /home/mycroft/dev/private-backup/data
Available flags:
-r <repository url> - set remote repository url (suffixed by .git) to backup
-b <branch> - branch to backup
-d </path/to/path> - where to backup; relative or absolute
-n <num> - number of commit to backup (default: unlimited)
-i - ignore tracking information - to restart from scratch
-v - verbose mode
-x - debug mode
-h - this help
```
Ex: