@ -14,7 +14,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
- Simple interface
- Simple interface
- Fully encrypted
- Fully encrypted
###### 📒 Docs
### 📒 Docs
- [Locations](#-locations)
- [Locations](#-locations)
- [Pruning & Deleting old files](#pruning-and-snapshot-policies)
- [Pruning & Deleting old files](#pruning-and-snapshot-policies)
@ -22,6 +22,20 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
- [Hooks](#before--after-hooks)
- [Hooks](#before--after-hooks)
- [Backends](#-backends)
- [Backends](#-backends)
### Commands
- info
- check
- backup
- forget
- restore
- exec
- intall
- uninstall
- upgrade
- help
## 🛳 Installation
## 🛳 Installation
Linux & macOS. Windows is not supported.
Linux & macOS. Windows is not supported.
@ -78,19 +92,10 @@ autorestic backup -a
### 📼 Restore
### 📼 Restore
```
autorestic restore -a --to /path/where/to/restore
```
This will restore all the locations to the selected target. If for one location there are more than one backends specified autorestic will take the first one.
Lets see a more realistic example (from the config above)
```
```
autorestic restore -l home --from hdd --to /path/where/to/restore
autorestic restore -l home --from hdd --to /path/where/to/restore
```
```
This will restore the location `home` to the `/path/where/to/restore` folder and taking the data from the backend `hdd`
### 📲 Updates
### 📲 Updates
Autorestic can update itself! Super handy right? Simply run `autorestic update` and we will check for you if there are updates for restic and autorestic and install them if necessary.
Autorestic can update itself! Super handy right? Simply run `autorestic update` and we will check for you if there are updates for restic and autorestic and install them if necessary.
@ -233,6 +238,93 @@ backends:
B2_ACCOUNT_KEY: backblaze_account_key
B2_ACCOUNT_KEY: backblaze_account_key
```
```
## Commands
### Info
```
autorestic info
```
Shows all the information in the config file. Usefull for a quick overview of what location backups where.
Pro tip: if it gets a bit long you can read it more easily with `autorestic info | less` 😉
### Check
```
autorestic check [-b, --backend] [-a, --all]
```
Checks the backends and configures them if needed. Can be applied to all with the `-a` flag or by specifying one or more backends with the `-b` or `--backend` flag.
### Backup
```
autorestic backup [-l, --location] [-a, --all]
```
Performes a backup of all locations if the `-a` flag is passed. To only backup some locations pass one or more `-l` or `--location` flags.
This will restore all the locations to the selected target. If for one location there are more than one backends specified autorestic will take the first one.
Lets see a more realistic example (from the config above)
```
autorestic restore -l home --from hdd --to /path/where/to/restore
```
This will restore the location `home` to the `/path/where/to/restore` folder and taking the data from the backend `hdd`
```
autorestic restore
```
Performes a backup of all locations if the `-a` flag is passed. To only backup some locations pass one or more `-l` or `--location` flags.
This will prune and remove old data form the backends according to the [keep policy you have specified for the location](#pruning-and-snapshot-policies)
The `--dry-run` flag will do a dry run showing what would have been deleted, but won't touch the actual data.
This is avery handy command which enables you to run any native restic command on desired backends. An example would be listing all the snapshots of all your backends: