mirror of
https://github.com/cupcakearmy/autorestic.git
synced 2025-09-02 08:40:39 +00:00
docs
This commit is contained in:
13
docs/md/cli/backup.md
Normal file
13
docs/md/cli/backup.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Backup
|
||||
|
||||
```bash
|
||||
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.
|
||||
|
||||
```bash
|
||||
autorestic backup -l my-location
|
||||
```
|
||||
|
||||
> :ToCPrevNext
|
15
docs/md/cli/check.md
Normal file
15
docs/md/cli/check.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# check
|
||||
|
||||
```bash
|
||||
autorestic check [-b, --backend] [-a, --all]
|
||||
```
|
||||
|
||||
Cheks if one or more backend are configured properly and initializes them if they are not already.
|
||||
|
||||
This is mostly an internal command, but useful to verify if a backend is configured correctly.
|
||||
|
||||
```bash
|
||||
autorestic check -b my-backend
|
||||
```
|
||||
|
||||
> :ToCPrevNext
|
11
docs/md/cli/cron.md
Normal file
11
docs/md/cli/cron.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Cron
|
||||
|
||||
```bash
|
||||
autorestic cron
|
||||
```
|
||||
|
||||
This command is modtly intended to be triggered by an automated system like systemd or crontab.
|
||||
|
||||
It will run cron jobs es [specified in the cron section](/locations/cron) of a specific location.
|
||||
|
||||
> :ToCPrevNext
|
15
docs/md/cli/exec.md
Normal file
15
docs/md/cli/exec.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Exec
|
||||
|
||||
```bash
|
||||
autorestic exec [-b, --backend] [-a, --all] <command> -- [native options]
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
```bash
|
||||
autorestic exec -a -- snapshots
|
||||
```
|
||||
|
||||
With `exec` you can basically run every cli command that you would be able to run with the restic cli. It only prefillst path, key, etc.
|
||||
|
||||
> :ToCPrevNext
|
11
docs/md/cli/forget.md
Normal file
11
docs/md/cli/forget.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Forget
|
||||
|
||||
```bash
|
||||
autorestic forget [-l, --location] [-a, --all] [--dry-run]
|
||||
```
|
||||
|
||||
This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/locations/forget)
|
||||
|
||||
The `--dry-run` flag will do a dry run showing what would have been deleted, but won't touch the actual data.
|
||||
|
||||
> :ToCPrevNext
|
18
docs/md/cli/info.md
Normal file
18
docs/md/cli/info.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# info
|
||||
|
||||
Displays the config file that autorestic is refering to.
|
||||
Usefull when you want to quickly see what locations are being backuped where.
|
||||
|
||||
**Pro tip:** if it gets a bit long you can read it more easily with `autorestic info | less` 😉
|
||||
|
||||
```bash
|
||||
autorestic info
|
||||
```
|
||||
|
||||
## With a custom file
|
||||
|
||||
```bash
|
||||
autorestic -c path/to/some/config.yml info
|
||||
```
|
||||
|
||||
> :ToCPrevNext
|
9
docs/md/cli/install.md
Normal file
9
docs/md/cli/install.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Install
|
||||
|
||||
Installs both restic and autorestic to `/usr/local/bin`.
|
||||
|
||||
```bash
|
||||
autorestic install
|
||||
```
|
||||
|
||||
> :ToCPrevNext
|
17
docs/md/cli/restore.md
Normal file
17
docs/md/cli/restore.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Restore
|
||||
|
||||
```bash
|
||||
autorestic restore [-l, --location] [--from backend] [--to <out dir>]
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
## Example
|
||||
|
||||
```bash
|
||||
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`
|
||||
|
||||
> :ToCPrevNext
|
9
docs/md/cli/uninstall.md
Normal file
9
docs/md/cli/uninstall.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Uninstall
|
||||
|
||||
Installs both restic and autorestic from `/usr/local/bin`.
|
||||
|
||||
```bash
|
||||
autorestic uninstall
|
||||
```
|
||||
|
||||
> :ToCPrevNext
|
11
docs/md/cli/update.md
Normal file
11
docs/md/cli/update.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Update
|
||||
|
||||
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.
|
||||
|
||||
```bash
|
||||
autorestic update
|
||||
```
|
||||
|
||||
Updates both restic and autorestic automagically.
|
||||
|
||||
> :ToCPrevNext
|
Reference in New Issue
Block a user